{"items":[{"type":"link","label":"Jiko Partner API","link":"/products/partner-api/reference","routeSlug":"/products/partner-api/reference","content":{"contentType":"overview","meta":{"name":"Jiko Partner API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"reference.json","url":"/_bundle/products/partner-api/reference.json?download"},{"kind":"download","label":"reference.yaml","url":"/_bundle/products/partner-api/reference.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name","description":"Your organization's unique identifier"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name","description":"Your organization's unique identifier"}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Jiko Partner API (Version: cf52545e)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/products/partner-api/reference"}],"sectionId":"/products/partner-api/reference"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/introduction"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Introduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Welcome to the Jiko API Reference! Jiko enables you to integrate money storage and movement, backed by the safety and security of US Treasury Bills. Use the Partner API if you are building an application that embeds Jiko’s services and offers Jiko products to your own customers. The Partner API will then enable your application to interact with Jiko on behalf of your customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At the core of our platform is the Jiko Pocket: a pair consisting of a bank account and a brokerage account. When money is deposited into a Pocket, the funds are automatically invested in T-bills. When a payment or withdrawal is made, T-bills are immediately liquidated and used as cash. Customers can have multiple Pockets, and each Pocket is associated with a single T-bill maturity: 4-week, 13-week, 26-week or 52-week."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API Reference covers everything you need to build a full application leveraging the Jiko platform:"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Onboarding customers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding Pockets via ACH or Wire"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viewing and managing Pockets (including monthly statements and trade confirmations)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Making payments and transfers via ACH, Wire, On-Us (Book) Transfer or Debit Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you’re ready to start building, please contact us at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:partner.support@jiko.io"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partner.support@jiko.io"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to request sandbox access."},"children":[]}]}]}]}],"sectionId":"/products/partner-api/reference/section/introduction"}]}]}},{"type":"link","label":"Introduction","link":"/products/partner-api/reference/section/introduction","routeSlug":"/products/partner-api/reference/section/introduction","content":null},{"type":"separator","label":"Accounts","content":null},{"type":"group","label":"Accounts","link":"/products/partner-api/reference/accounts","routeSlug":"/products/partner-api/reference/accounts","items":[{"label":"List Customer Accounts","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/accounts/list_customer_accounts_api_v1_customers__customer_id__jiko_accounts__get","routeSlug":"/products/partner-api/reference/accounts/list_customer_accounts_api_v1_customers__customer_id__jiko_accounts__get","metadata":{"seo":{"title":"List Customer Accounts","description":"Get a list of all accounts for a specified customer. Deprecated: Use List Pockets for Customer instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_customer_accounts_api_v1_customers__customer_id__jiko_accounts__get","name":"List Customer Accounts","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1jiko-accounts~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customer Accounts","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a list of all accounts for a specified customer. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/pockets/list-pockets-v2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List Pockets for Customer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1jiko-accounts~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_306"},{"name":"limit","in":"query","schemaId":"schema_307"},{"name":"omit[]","in":"query","schemaId":"schema_308"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1jiko-accounts~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1jiko-accounts~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customers/{customer_id}/jiko-accounts/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[{"name":"offset","in":"query","required":false,"schemaId":"schema_306"},{"name":"limit","in":"query","required":false,"schemaId":"schema_307"},{"name":"omit[]","in":"query","required":false,"schemaId":"schema_308"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/customers/{customer_id}/jiko-accounts/","href":"accounts/list_customer_accounts_api_v1_customers__customer_id__jiko_accounts__get","openApiOperationId":"list_customer_accounts_api_v1_customers__customer_id__jiko_accounts__get","summary":"List Customer Accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAccountsResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1jiko-accounts~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListAccountsResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1jiko-accounts~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1jiko-accounts~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAccountsResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1jiko-accounts~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAccountsResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1jiko-accounts~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/list_customer_accounts_api_v1_customers__customer_id__jiko_accounts__get"}],"panels":[]}]},"httpPath":"/api/v1/customers/{customer_id}/jiko-accounts/"},{"label":"Get Customer Account","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/accounts/get_customer_account_api_v1_jiko_accounts__account_id___get","routeSlug":"/products/partner-api/reference/accounts/get_customer_account_api_v1_jiko_accounts__account_id___get","metadata":{"seo":{"title":"Get Customer Account","description":"Get a specific account. Deprecated: Use Get Customer Pocket instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_customer_account_api_v1_jiko_accounts__account_id___get","name":"Get Customer Account","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Customer Account","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a specific account. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/pockets/get-pocket-v2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Customer Pocket"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"omit[]","in":"query","schemaId":"schema_308"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jiko-accounts/{account_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"}],"query":[{"name":"omit[]","in":"query","required":false,"schemaId":"schema_308"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/","href":"accounts/get_customer_account_api_v1_jiko_accounts__account_id___get","openApiOperationId":"get_customer_account_api_v1_jiko_accounts__account_id___get","summary":"Get Customer Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Account","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Account","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Account","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Account","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/get_customer_account_api_v1_jiko_accounts__account_id___get"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/"}],"content":{"contentType":"group","meta":{"name":"Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounts","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these endpoints to view Account information. Jiko Accounts (also known as Pockets) consist of a bank account and a brokerage account. When funds are deposited into a Pocket, they’re immediately invested in T-bills."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the API interface, the Account object encapsulates both accounts and can be treated as a single account to deposit to or withdraw from."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/customers/{customer_id}/jiko-accounts/","summary":"List Customer Accounts","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/accounts/list_customer_accounts_api_v1_customers__customer_id__jiko_accounts__get","deprecated":true},{"title":"/api/v1/jiko-accounts/{account_id}/","summary":"Get Customer Account","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/accounts/get_customer_account_api_v1_jiko_accounts__account_id___get","deprecated":true}]}]}]}]}},{"type":"group","label":"Customers","link":"/products/partner-api/reference/customers","routeSlug":"/products/partner-api/reference/customers","items":[{"label":"Get Customer Data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/customers/get_customer_data_api_v1_customers__customer_id___get","routeSlug":"/products/partner-api/reference/customers/get_customer_data_api_v1_customers__customer_id___get","metadata":{"seo":{"title":"Get Customer Data","description":"Retrieve customer details for the customer given by the customer ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_customer_data_api_v1_customers__customer_id___get","name":"Get Customer Data","isWebhook":false,"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Customer Data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve customer details for the customer given by the customer ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customers/{customer_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/customers/{customer_id}/","href":"customers/get_customer_data_api_v1_customers__customer_id___get","openApiOperationId":"get_customer_data_api_v1_customers__customer_id___get","summary":"Get Customer Data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Customer","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Customer","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/get_customer_data_api_v1_customers__customer_id___get"}],"panels":[]}]},"httpPath":"/api/v1/customers/{customer_id}/"},{"label":"Update Customer Data","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/customers/update_customer_data_api_v1_customers__customer_id___patch","routeSlug":"/products/partner-api/reference/customers/update_customer_data_api_v1_customers__customer_id___patch","metadata":{"seo":{"title":"Update Customer Data","description":"Updates details for a given Customer, including contact information and Trusted Contact information. This endpoint can also be used to close customer accounts with the CloseCustomerAccount request body schema. Before closing a customer's account, all customer Pockets must have a zero balance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_customer_data_api_v1_customers__customer_id___patch","name":"Update Customer Data","isWebhook":false,"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Customer Data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates details for a given Customer, including contact information and Trusted Contact information. This endpoint can also be used to close customer accounts with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CloseCustomerAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request body schema. Before closing a customer's account, all customer Pockets must have a zero balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Update Customer Data isn’t available by default and must be enabled — please contact your Jiko point of contact to learn more."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_312","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/requestBody/content/application~1json/examples/update_customer_data","paths/~1api~1v1~1customers~1{customer_id}~1/patch/requestBody/content/application~1json/examples/close_customer_account"]}},"schemaId":"schema_312","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/requestBody/content/application~1json/examples/update_customer_data","paths/~1api~1v1~1customers~1{customer_id}~1/patch/requestBody/content/application~1json/examples/close_customer_account"],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/customers/{customer_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_312","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/requestBody/content/application~1json/examples/update_customer_data","paths/~1api~1v1~1customers~1{customer_id}~1/patch/requestBody/content/application~1json/examples/close_customer_account"]}},"responseCodes":["200","404","409","422"],"pointer":"/api/v1/customers/{customer_id}/","href":"customers/update_customer_data_api_v1_customers__customer_id___patch","openApiOperationId":"update_customer_data_api_v1_customers__customer_id___patch","summary":"Update Customer Data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_312","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/requestBody/content/application~1json/examples/update_customer_data","paths/~1api~1v1~1customers~1{customer_id}~1/patch/requestBody/content/application~1json/examples/close_customer_account"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_312","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/requestBody/content/application~1json/examples/update_customer_data","paths/~1api~1v1~1customers~1{customer_id}~1/patch/requestBody/content/application~1json/examples/close_customer_account"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/200/content/application~1json/examples/updated_customer","paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/200/content/application~1json/examples/customer_closed"]}},"schemaId":"components/schemas/Customer","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/200/content/application~1json/examples/updated_customer","paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/200/content/application~1json/examples/customer_closed"]},{"code":"404","description":"Not found"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/409/content/application~1json/example"]},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Customer","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/200/content/application~1json/examples/updated_customer","paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/200/content/application~1json/examples/customer_closed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Customer","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/200/content/application~1json/examples/updated_customer","paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/200/content/application~1json/examples/customer_closed"]}}},{"code":"404"},{"code":"409","schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/update_customer_data_api_v1_customers__customer_id___patch"}],"panels":[]}]},"httpPath":"/api/v1/customers/{customer_id}/"},{"label":"Get Beneficial Owners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/customers/get_beneficial_owners_api_v1_customers__customer_id__beneficial_owners__get","routeSlug":"/products/partner-api/reference/customers/get_beneficial_owners_api_v1_customers__customer_id__beneficial_owners__get","metadata":{"seo":{"title":"Get Beneficial Owners","description":"Gets a list of beneficial owners for a given customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_beneficial_owners_api_v1_customers__customer_id__beneficial_owners__get","name":"Get Beneficial Owners","isWebhook":false,"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1beneficial-owners~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Beneficial Owners","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of beneficial owners for a given customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1beneficial-owners~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1beneficial-owners~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customers/{customer_id}/beneficial-owners/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/customers/{customer_id}/beneficial-owners/","href":"customers/get_beneficial_owners_api_v1_customers__customer_id__beneficial_owners__get","openApiOperationId":"get_beneficial_owners_api_v1_customers__customer_id__beneficial_owners__get","summary":"Get Beneficial Owners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBeneficialOwnersResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1beneficial-owners~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListBeneficialOwnersResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1beneficial-owners~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1beneficial-owners~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListBeneficialOwnersResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1beneficial-owners~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBeneficialOwnersResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1beneficial-owners~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/get_beneficial_owners_api_v1_customers__customer_id__beneficial_owners__get"}],"panels":[]}]},"httpPath":"/api/v1/customers/{customer_id}/beneficial-owners/"},{"label":"Upload Document To Customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/customers/upload-customer-document","routeSlug":"/products/partner-api/reference/customers/upload-customer-document","metadata":{"seo":{"title":"Upload Document To Customer","description":"Upload files for an approved customer. Used to verify customer requests (e.g. Customer change request, close account request, ACH request). Refer to the Upload Document To Application for more detailed info."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upload-customer-document","name":"Upload Document To Customer","isWebhook":false,"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1documents~1{document_type}~1file~1/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload Document To Customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload files for an approved customer. Used to verify customer requests (e.g. Customer change request, close account request, ACH request). Refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/individuals/upload_document_to_application_api_v1_applications__application_id__documents__document_type__file__post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload Document To Application"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more detailed info."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true},{"name":"document_type","in":"path","schemaId":"schema_313","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1documents~1{document_type}~1file~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"content-type","in":"header","schemaId":"schema_314","required":true},{"name":"content-length","in":"header","schemaId":"schema_315","required":true},{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1documents~1{document_type}~1file~1/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/customers/{customer_id}/documents/{document_type}/file/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"},{"name":"document_type","in":"path","required":true,"schemaId":"schema_313"}],"query":[],"querystring":[],"header":[{"name":"content-type","in":"header","required":true,"schemaId":"schema_314"},{"name":"content-length","in":"header","required":true,"schemaId":"schema_315"},{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/customers/{customer_id}/documents/{document_type}/file/","href":"customers/upload-customer-document","openApiOperationId":"upload-customer-document","summary":"Upload Document To Customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadDocumentResponse"}},"schemaId":"components/schemas/UploadDocumentResponse"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1documents~1{document_type}~1file~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UploadDocumentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadDocumentResponse"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/upload-customer-document"}],"panels":[]}]},"httpPath":"/api/v1/customers/{customer_id}/documents/{document_type}/file/"}],"content":{"contentType":"group","meta":{"name":"Customers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to view and manage personal details for a Customer."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/customers/{customer_id}/","summary":"Get Customer Data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/get_customer_data_api_v1_customers__customer_id___get","deprecated":false},{"title":"/api/v1/customers/{customer_id}/","summary":"Update Customer Data","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/customers/update_customer_data_api_v1_customers__customer_id___patch","deprecated":false},{"title":"/api/v1/customers/{customer_id}/beneficial-owners/","summary":"Get Beneficial Owners","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/get_beneficial_owners_api_v1_customers__customer_id__beneficial_owners__get","deprecated":false},{"title":"/api/v1/customers/{customer_id}/documents/{document_type}/file/","summary":"Upload Document To Customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/upload-customer-document","deprecated":false}]}]}]}]}},{"type":"group","label":"Transactions","link":"/products/partner-api/reference/transactions","routeSlug":"/products/partner-api/reference/transactions","items":[{"label":"List Customer Transactions","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/transactions/list_customer_transactions_api_v1_customers__customer_id__transactions__get","routeSlug":"/products/partner-api/reference/transactions/list_customer_transactions_api_v1_customers__customer_id__transactions__get","metadata":{"seo":{"title":"List Customer Transactions","description":"Returns a list of transactions from a customer's bank accounts. It does not include transactions between the bank account and brokerage account. Deprecated: Use List Customer Transactions instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_customer_transactions_api_v1_customers__customer_id__transactions__get","name":"List Customer Transactions","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1transactions~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customer Transactions","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of transactions from a customer's "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It does not include transactions between the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brokerage account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/transactions-v2/list-customer-transactions-v2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List Customer Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1transactions~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"order","in":"query","schemaId":"schema_316","description":"Ordered by the transaction timestamp, descending by default."},{"name":"account[]","in":"query","schemaId":"schema_317"},{"name":"filter[card]","in":"query","schemaId":"schema_318"},{"name":"filter[portal]","in":"query","schemaId":"schema_319"},{"name":"filter[types]","in":"query","schemaId":"schema_320"},{"name":"filter[on_us_transfer]","in":"query","schemaId":"schema_321"},{"name":"filter[wire]","in":"query","schemaId":"schema_322"},{"name":"timestamp_from","in":"query","schemaId":"schema_323"},{"name":"timestamp_to","in":"query","schemaId":"schema_324"},{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_326"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1transactions~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1transactions~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customers/{customer_id}/transactions/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[{"name":"order","in":"query","required":false,"schemaId":"schema_316"},{"name":"account[]","in":"query","required":false,"schemaId":"schema_317"},{"name":"filter[card]","in":"query","required":false,"schemaId":"schema_318"},{"name":"filter[portal]","in":"query","required":false,"schemaId":"schema_319"},{"name":"filter[types]","in":"query","required":false,"schemaId":"schema_320"},{"name":"filter[on_us_transfer]","in":"query","required":false,"schemaId":"schema_321"},{"name":"filter[wire]","in":"query","required":false,"schemaId":"schema_322"},{"name":"timestamp_from","in":"query","required":false,"schemaId":"schema_323"},{"name":"timestamp_to","in":"query","required":false,"schemaId":"schema_324"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_326"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/customers/{customer_id}/transactions/","href":"transactions/list_customer_transactions_api_v1_customers__customer_id__transactions__get","openApiOperationId":"list_customer_transactions_api_v1_customers__customer_id__transactions__get","summary":"List Customer Transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1transactions~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/TransactionListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1transactions~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1transactions~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransactionListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1transactions~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1transactions~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/list_customer_transactions_api_v1_customers__customer_id__transactions__get"}],"panels":[]}]},"httpPath":"/api/v1/customers/{customer_id}/transactions/"},{"label":"List Account Transactions","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/transactions/list_account_transactions_api_v1_jiko_accounts__account_id__transactions__get","routeSlug":"/products/partner-api/reference/transactions/list_account_transactions_api_v1_jiko_accounts__account_id__transactions__get","metadata":{"seo":{"title":"List Account Transactions","description":"Returns a list of bank account transactions. It does not include transactions between the bank account and brokerage account. Deprecated: Use List Pocket Transactions instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_account_transactions_api_v1_jiko_accounts__account_id__transactions__get","name":"List Account Transactions","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Account Transactions","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions. It does not include transactions between the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brokerage account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/transactions-v2/list-pocket-transactions-v2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List Pocket Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"order","in":"query","schemaId":"schema_316","description":"Ordered by the transaction timestamp, descending by default."},{"name":"filter[card]","in":"query","schemaId":"schema_318"},{"name":"filter[portal]","in":"query","schemaId":"schema_319"},{"name":"filter[types]","in":"query","schemaId":"schema_320"},{"name":"filter[on_us_transfer]","in":"query","schemaId":"schema_321"},{"name":"filter[wire]","in":"query","schemaId":"schema_322"},{"name":"timestamp_from","in":"query","schemaId":"schema_323"},{"name":"timestamp_to","in":"query","schemaId":"schema_324"},{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_326"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jiko-accounts/{account_id}/transactions/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"}],"query":[{"name":"order","in":"query","required":false,"schemaId":"schema_316"},{"name":"filter[card]","in":"query","required":false,"schemaId":"schema_318"},{"name":"filter[portal]","in":"query","required":false,"schemaId":"schema_319"},{"name":"filter[types]","in":"query","required":false,"schemaId":"schema_320"},{"name":"filter[on_us_transfer]","in":"query","required":false,"schemaId":"schema_321"},{"name":"filter[wire]","in":"query","required":false,"schemaId":"schema_322"},{"name":"timestamp_from","in":"query","required":false,"schemaId":"schema_323"},{"name":"timestamp_to","in":"query","required":false,"schemaId":"schema_324"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_326"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/transactions/","href":"transactions/list_account_transactions_api_v1_jiko_accounts__account_id__transactions__get","openApiOperationId":"list_account_transactions_api_v1_jiko_accounts__account_id__transactions__get","summary":"List Account Transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/TransactionListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransactionListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/list_account_transactions_api_v1_jiko_accounts__account_id__transactions__get"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/transactions/"},{"label":"Get Account Transaction","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/transactions/get_account_transaction_api_v1_jiko_accounts__account_id__transactions__transaction_id___get","routeSlug":"/products/partner-api/reference/transactions/get_account_transaction_api_v1_jiko_accounts__account_id__transactions__transaction_id___get","metadata":{"seo":{"title":"Get Account Transaction","description":"Returns a specific transaction for a specific account, based on the provided account_id and transaction_id in question. Deprecated: Use Get Transaction instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_account_transaction_api_v1_jiko_accounts__account_id__transactions__transaction_id___get","name":"Get Account Transaction","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1{transaction_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Account Transaction","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a specific transaction for a specific account, based on the provided account_id and transaction_id in question. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/transactions-v2/get-transaction-v2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Transaction"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true},{"name":"transaction_id","in":"path","schemaId":"schema_327","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1{transaction_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1{transaction_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jiko-accounts/{account_id}/transactions/{transaction_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"},{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_327"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/transactions/{transaction_id}/","href":"transactions/get_account_transaction_api_v1_jiko_accounts__account_id__transactions__transaction_id___get","openApiOperationId":"get_account_transaction_api_v1_jiko_accounts__account_id__transactions__transaction_id___get","summary":"Get Account Transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1{transaction_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Transaction","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1{transaction_id}~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1{transaction_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transaction","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1{transaction_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1{transaction_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/get_account_transaction_api_v1_jiko_accounts__account_id__transactions__transaction_id___get"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/transactions/{transaction_id}/"}],"content":{"contentType":"group","meta":{"name":"Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these endpoints to view Transactions of funds moving in and out of Jiko Accounts, specifically the bank account component (cash deposits and withdrawals). For viewing information regarding the brokerage account component (buying and selling of T-bills), use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/trades"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trades"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/customers/{customer_id}/transactions/","summary":"List Customer Transactions","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/transactions/list_customer_transactions_api_v1_customers__customer_id__transactions__get","deprecated":true},{"title":"/api/v1/jiko-accounts/{account_id}/transactions/","summary":"List Account Transactions","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/transactions/list_account_transactions_api_v1_jiko_accounts__account_id__transactions__get","deprecated":true},{"title":"/api/v1/jiko-accounts/{account_id}/transactions/{transaction_id}/","summary":"Get Account Transaction","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/transactions/get_account_transaction_api_v1_jiko_accounts__account_id__transactions__transaction_id___get","deprecated":true}]}]}]}]}},{"type":"group","label":"Trades","link":"/products/partner-api/reference/trades","routeSlug":"/products/partner-api/reference/trades","items":[{"label":"List Customer Trades","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/trades/list_customer_trades_api_v1_customers__customer_id__trades__get","routeSlug":"/products/partner-api/reference/trades/list_customer_trades_api_v1_customers__customer_id__trades__get","metadata":{"seo":{"title":"List Customer Trades","description":"Returns a list of trades from a customer's brokerage accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_customer_trades_api_v1_customers__customer_id__trades__get","name":"List Customer Trades","isWebhook":false,"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1trades~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customer Trades","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of trades from a customer's "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brokerage accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1trades~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"trade_datetime_from","in":"query","schemaId":"schema_328"},{"name":"trade_datetime_to","in":"query","schemaId":"schema_329"},{"name":"book_date_from","in":"query","schemaId":"schema_330","description":"Filters the resulting trade list by book date from the provided ISO8601 date, inclusively"},{"name":"book_date_to","in":"query","schemaId":"schema_331","description":"Filters the resulting trade list by book date to the provided ISO8601 date, inclusively"},{"name":"settlement_date_from","in":"query","schemaId":"schema_332","description":"Filters the resulting trade list by settlement date from the provided ISO8601 date, inclusively"},{"name":"settlement_date_to","in":"query","schemaId":"schema_333","description":"Filters the resulting trade list by settlement date to the provided ISO8601 date, inclusively"},{"name":"account[]","in":"query","schemaId":"schema_317"},{"name":"order","in":"query","schemaId":"schema_316","description":"Ordered by the trade creation time, descending by default."},{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_326"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1trades~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1trades~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customers/{customer_id}/trades/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[{"name":"trade_datetime_from","in":"query","required":false,"schemaId":"schema_328"},{"name":"trade_datetime_to","in":"query","required":false,"schemaId":"schema_329"},{"name":"book_date_from","in":"query","required":false,"schemaId":"schema_330"},{"name":"book_date_to","in":"query","required":false,"schemaId":"schema_331"},{"name":"settlement_date_from","in":"query","required":false,"schemaId":"schema_332"},{"name":"settlement_date_to","in":"query","required":false,"schemaId":"schema_333"},{"name":"account[]","in":"query","required":false,"schemaId":"schema_317"},{"name":"order","in":"query","required":false,"schemaId":"schema_316"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_326"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/customers/{customer_id}/trades/","href":"trades/list_customer_trades_api_v1_customers__customer_id__trades__get","openApiOperationId":"list_customer_trades_api_v1_customers__customer_id__trades__get","summary":"List Customer Trades"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradeListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1trades~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/TradeListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1trades~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1trades~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TradeListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1trades~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradeListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1trades~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trades/list_customer_trades_api_v1_customers__customer_id__trades__get"}],"panels":[]}]},"httpPath":"/api/v1/customers/{customer_id}/trades/"},{"label":"List Account Trades","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/trades/list_account_trades_api_v1_jiko_accounts__account_id__trades__get","routeSlug":"/products/partner-api/reference/trades/list_account_trades_api_v1_jiko_accounts__account_id__trades__get","metadata":{"seo":{"title":"List Account Trades","description":"Get a list of trades. This is the equivalent of fetching transactions for the brokerage account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_account_trades_api_v1_jiko_accounts__account_id__trades__get","name":"List Account Trades","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1trades~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Account Trades","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a list of trades. This is the equivalent of fetching transactions for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brokerage"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" account."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1trades~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"trade_datetime_from","in":"query","schemaId":"schema_328"},{"name":"trade_datetime_to","in":"query","schemaId":"schema_329"},{"name":"book_date_from","in":"query","schemaId":"schema_330","description":"Filters the resulting trade list by book date from the provided ISO8601 date, inclusively"},{"name":"book_date_to","in":"query","schemaId":"schema_331","description":"Filters the resulting trade list by book date to the provided ISO8601 date, inclusively"},{"name":"settlement_date_from","in":"query","schemaId":"schema_332","description":"Filters the resulting trade list by settlement date from the provided ISO8601 date, inclusively"},{"name":"settlement_date_to","in":"query","schemaId":"schema_333","description":"Filters the resulting trade list by settlement date to the provided ISO8601 date, inclusively"},{"name":"order","in":"query","schemaId":"schema_316","description":"Ordered by the trade creation time, descending by default."},{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_326"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1trades~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1trades~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jiko-accounts/{account_id}/trades/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"}],"query":[{"name":"trade_datetime_from","in":"query","required":false,"schemaId":"schema_328"},{"name":"trade_datetime_to","in":"query","required":false,"schemaId":"schema_329"},{"name":"book_date_from","in":"query","required":false,"schemaId":"schema_330"},{"name":"book_date_to","in":"query","required":false,"schemaId":"schema_331"},{"name":"settlement_date_from","in":"query","required":false,"schemaId":"schema_332"},{"name":"settlement_date_to","in":"query","required":false,"schemaId":"schema_333"},{"name":"order","in":"query","required":false,"schemaId":"schema_316"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_326"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/trades/","href":"trades/list_account_trades_api_v1_jiko_accounts__account_id__trades__get","openApiOperationId":"list_account_trades_api_v1_jiko_accounts__account_id__trades__get","summary":"List Account Trades"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradeListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1trades~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/TradeListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1trades~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1trades~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TradeListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1trades~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradeListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1trades~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trades/list_account_trades_api_v1_jiko_accounts__account_id__trades__get"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/trades/"},{"label":"Get Trade Confirmation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/trades/get_trade_confirmation_api_v1_jiko_accounts__account_id__trades__trade_id__confirmation__get","routeSlug":"/products/partner-api/reference/trades/get_trade_confirmation_api_v1_jiko_accounts__account_id__trades__trade_id__confirmation__get","metadata":{"seo":{"title":"Get Trade Confirmation","description":"Get a trade's trade confirmation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_trade_confirmation_api_v1_jiko_accounts__account_id__trades__trade_id__confirmation__get","name":"Get Trade Confirmation","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1trades~1{trade_id}~1confirmation~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Trade Confirmation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a trade's trade confirmation."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trade confirmations are sensitive documents. For security reasons, we return trade confirmations as PDFs through a URL with a 10-minute TTL. Trade confirmation PDFs should be fetched and served just-in-time, not stored in databases. Trades with \"activity\": \"MATURITY\" do not have trade confirmations."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true},{"name":"trade_id","in":"path","schemaId":"schema_334","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1trades~1{trade_id}~1confirmation~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1trades~1{trade_id}~1confirmation~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jiko-accounts/{account_id}/trades/{trade_id}/confirmation/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"},{"name":"trade_id","in":"path","required":true,"schemaId":"schema_334"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/trades/{trade_id}/confirmation/","href":"trades/get_trade_confirmation_api_v1_jiko_accounts__account_id__trades__trade_id__confirmation__get","openApiOperationId":"get_trade_confirmation_api_v1_jiko_accounts__account_id__trades__trade_id__confirmation__get","summary":"Get Trade Confirmation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradeConfirmation"}},"schemaId":"components/schemas/TradeConfirmation"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1trades~1{trade_id}~1confirmation~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TradeConfirmation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradeConfirmation"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trades/get_trade_confirmation_api_v1_jiko_accounts__account_id__trades__trade_id__confirmation__get"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/trades/{trade_id}/confirmation/"}],"content":{"contentType":"group","meta":{"name":"Trades"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trades","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to view Trades, or transactions related to the buying and selling of T-bills, within the brokerage account component of Jiko Pockets."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/customers/{customer_id}/trades/","summary":"List Customer Trades","prefix":{"name":"get","color":"get"},"badges":[],"link":"/trades/list_customer_trades_api_v1_customers__customer_id__trades__get","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/trades/","summary":"List Account Trades","prefix":{"name":"get","color":"get"},"badges":[],"link":"/trades/list_account_trades_api_v1_jiko_accounts__account_id__trades__get","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/trades/{trade_id}/confirmation/","summary":"Get Trade Confirmation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/trades/get_trade_confirmation_api_v1_jiko_accounts__account_id__trades__trade_id__confirmation__get","deprecated":false}]}]}]}]}},{"type":"group","label":"Statements","link":"/products/partner-api/reference/statements","routeSlug":"/products/partner-api/reference/statements","items":[{"label":"List Customer Statements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/statements/list_customer_statements_api_v1_customers__customer_id__statements__get","routeSlug":"/products/partner-api/reference/statements/list_customer_statements_api_v1_customers__customer_id__statements__get","metadata":{"seo":{"title":"List Customer Statements","description":"Get all statements for all accounts of a specific customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_customer_statements_api_v1_customers__customer_id__statements__get","name":"List Customer Statements","isWebhook":false,"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1statements~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customer Statements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all statements for all accounts of a specific customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1statements~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"account[]","in":"query","schemaId":"schema_317"},{"name":"order","in":"query","schemaId":"schema_316"},{"name":"type[]","in":"query","schemaId":"schema_335"},{"name":"key","in":"query","schemaId":"schema_336","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date formatted either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM"},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_337"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1statements~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1statements~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customers/{customer_id}/statements/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[{"name":"account[]","in":"query","required":false,"schemaId":"schema_317"},{"name":"order","in":"query","required":false,"schemaId":"schema_316"},{"name":"type[]","in":"query","required":false,"schemaId":"schema_335"},{"name":"key","in":"query","required":false,"schemaId":"schema_336"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_337"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/customers/{customer_id}/statements/","href":"statements/list_customer_statements_api_v1_customers__customer_id__statements__get","openApiOperationId":"list_customer_statements_api_v1_customers__customer_id__statements__get","summary":"List Customer Statements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1statements~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/StatementListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1statements~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1statements~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatementListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1statements~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1statements~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/list_customer_statements_api_v1_customers__customer_id__statements__get"}],"panels":[]}]},"httpPath":"/api/v1/customers/{customer_id}/statements/"},{"label":"List Account Statements","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/statements/list_account_statements_api_v1_jiko_accounts__account_id__statements__get","routeSlug":"/products/partner-api/reference/statements/list_account_statements_api_v1_jiko_accounts__account_id__statements__get","metadata":{"seo":{"title":"List Account Statements","description":"Lists all statements for an account. Partners can expect monthly statements to be available by the 15th of every month."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_account_statements_api_v1_jiko_accounts__account_id__statements__get","name":"List Account Statements","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1statements~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Account Statements","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all statements for an account. Partners can expect monthly statements to be available by the 15th of every month."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank and Broker dealer statements are sensitive documents. For security reasons, these URLs have a 10 minute TTL. Therefore, they should be fetched and served just-in-time, not stored in databases."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1statements~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"order","in":"query","schemaId":"schema_316"},{"name":"type[]","in":"query","schemaId":"schema_335"},{"name":"key","in":"query","schemaId":"schema_336","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date formatted either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM"},"children":[]}]}]}]},{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_337"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1statements~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1statements~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jiko-accounts/{account_id}/statements/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"}],"query":[{"name":"order","in":"query","required":false,"schemaId":"schema_316"},{"name":"type[]","in":"query","required":false,"schemaId":"schema_335"},{"name":"key","in":"query","required":false,"schemaId":"schema_336"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_337"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/statements/","href":"statements/list_account_statements_api_v1_jiko_accounts__account_id__statements__get","openApiOperationId":"list_account_statements_api_v1_jiko_accounts__account_id__statements__get","summary":"List Account Statements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1statements~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/StatementListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1statements~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1statements~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatementListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1statements~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1statements~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/list_account_statements_api_v1_jiko_accounts__account_id__statements__get"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/statements/"}],"content":{"contentType":"group","meta":{"name":"Statements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Statements","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to retrieve monthly statements for bank and brokerage accounts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/customers/{customer_id}/statements/","summary":"List Customer Statements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statements/list_customer_statements_api_v1_customers__customer_id__statements__get","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/statements/","summary":"List Account Statements","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/statements/list_account_statements_api_v1_jiko_accounts__account_id__statements__get","deprecated":true}]}]}]}]}},{"type":"separator","label":"Cards","content":null},{"type":"group","label":"Manage Cards","link":"/products/partner-api/reference/manage-cards","routeSlug":"/products/partner-api/reference/manage-cards","items":[{"label":"List Account Cards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/manage-cards/list_account_cards_api_v1_jiko_accounts__account_id__cards__get","routeSlug":"/products/partner-api/reference/manage-cards/list_account_cards_api_v1_jiko_accounts__account_id__cards__get","metadata":{"seo":{"title":"List Account Cards","description":"Get all cards for a specific account. Includes the card_id and metadata, but sensitive data like CVV's, expiration dates and card numbers are omitted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_account_cards_api_v1_jiko_accounts__account_id__cards__get","name":"List Account Cards","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Account Cards","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all cards for a specific account. Includes the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and metadata, but sensitive data like CVV's, expiration dates and card numbers are omitted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_338"},{"name":"cursor","in":"query","schemaId":"schema_339"},{"name":"filter[status]","in":"query","schemaId":"schema_340"},{"name":"type","in":"query","schemaId":"schema_341"},{"name":"created_from","in":"query","schemaId":"schema_342"},{"name":"created_to","in":"query","schemaId":"schema_343"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jiko-accounts/{account_id}/cards/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_338"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_339"},{"name":"filter[status]","in":"query","required":false,"schemaId":"schema_340"},{"name":"type","in":"query","required":false,"schemaId":"schema_341"},{"name":"created_from","in":"query","required":false,"schemaId":"schema_342"},{"name":"created_to","in":"query","required":false,"schemaId":"schema_343"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/cards/","href":"manage-cards/list_account_cards_api_v1_jiko_accounts__account_id__cards__get","openApiOperationId":"list_account_cards_api_v1_jiko_accounts__account_id__cards__get","summary":"List Account Cards"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CardListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CardListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage-cards/list_account_cards_api_v1_jiko_accounts__account_id__cards__get"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/cards/"},{"label":"List Customer Cards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/manage-cards/list_customer_cards_api_v1_customers__customer_id__cards__get","routeSlug":"/products/partner-api/reference/manage-cards/list_customer_cards_api_v1_customers__customer_id__cards__get","metadata":{"seo":{"title":"List Customer Cards","description":"Get all cards for a specific account. Includes the card_id and metadata, but sensitive data like CVV's, expiration dates and card numbers are omitted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_customer_cards_api_v1_customers__customer_id__cards__get","name":"List Customer Cards","isWebhook":false,"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1cards~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customer Cards","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all cards for a specific account. Includes the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and metadata, but sensitive data like CVV's, expiration dates and card numbers are omitted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1cards~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_338"},{"name":"cursor","in":"query","schemaId":"schema_339"},{"name":"filter[status]","in":"query","schemaId":"schema_340"},{"name":"type","in":"query","schemaId":"schema_341"},{"name":"created_from","in":"query","schemaId":"schema_342"},{"name":"created_to","in":"query","schemaId":"schema_343"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1cards~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1cards~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customers/{customer_id}/cards/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_338"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_339"},{"name":"filter[status]","in":"query","required":false,"schemaId":"schema_340"},{"name":"type","in":"query","required":false,"schemaId":"schema_341"},{"name":"created_from","in":"query","required":false,"schemaId":"schema_342"},{"name":"created_to","in":"query","required":false,"schemaId":"schema_343"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/customers/{customer_id}/cards/","href":"manage-cards/list_customer_cards_api_v1_customers__customer_id__cards__get","openApiOperationId":"list_customer_cards_api_v1_customers__customer_id__cards__get","summary":"List Customer Cards"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1cards~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CardListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1cards~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1cards~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CardListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1cards~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1cards~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage-cards/list_customer_cards_api_v1_customers__customer_id__cards__get"}],"panels":[]}]},"httpPath":"/api/v1/customers/{customer_id}/cards/"},{"label":"Get Card Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/manage-cards/get_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__get","routeSlug":"/products/partner-api/reference/manage-cards/get_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__get","metadata":{"seo":{"title":"Get Card Status","description":"Get a card's current status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__get","name":"Get Card Status","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1status~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Card Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a card's current status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true},{"name":"card_id","in":"path","schemaId":"schema_344","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1status~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1status~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/status/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"},{"name":"card_id","in":"path","required":true,"schemaId":"schema_344"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/status/","href":"manage-cards/get_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__get","openApiOperationId":"get_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__get","summary":"Get Card Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardStatusResponse"}},"schemaId":"components/schemas/CardStatusResponse"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1status~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CardStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardStatusResponse"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage-cards/get_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__get"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/status/"},{"label":"Set Card Status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/manage-cards/set_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__patch","routeSlug":"/products/partner-api/reference/manage-cards/set_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__patch","metadata":{"seo":{"title":"Set Card Status","description":"Set a primary card's status. Note that once a card's primary status is set to CLOSED, it can never be used again. Optionally include a magstripe status to enable or disable swipes. Magstripe updates affect only PHYSICAL cards and require the primary status to be set as OPENto take effect."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"set_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__patch","name":"Set Card Status","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1status~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set Card Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set a primary card's status. Note that once a card's primary status is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it can never be used again. Optionally include a magstripe status to enable or disable swipes. Magstripe updates affect only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHYSICAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cards and require the primary status to be set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OPEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to take effect."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true},{"name":"card_id","in":"path","schemaId":"schema_344","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1status~1/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1status~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChangeCardStatusRequest"}},"schemaId":"components/schemas/ChangeCardStatusRequest","pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1status~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/status/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"},{"name":"card_id","in":"path","required":true,"schemaId":"schema_344"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChangeCardStatusRequest"}},"responseCodes":["200","404","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/status/","href":"manage-cards/set_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__patch","openApiOperationId":"set_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__patch","summary":"Set Card Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/ChangeCardStatusRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChangeCardStatusRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardStatusResponse"}},"schemaId":"components/schemas/CardStatusResponse"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1status~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CardStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardStatusResponse"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage-cards/set_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__patch"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/status/"},{"label":"Set Card PIN","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/manage-cards/set_card_pin_api_v1_jiko_accounts__account_id__cards__card_id__pin__post","routeSlug":"/products/partner-api/reference/manage-cards/set_card_pin_api_v1_jiko_accounts__account_id__cards__card_id__pin__post","metadata":{"seo":{"title":"Set Card PIN","description":"Set PIN for physical cards (by card_id) before they are activated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"set_card_pin_api_v1_jiko_accounts__account_id__cards__card_id__pin__post","name":"Set Card PIN","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1pin~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set Card PIN","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set PIN for physical cards (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") before they are activated."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true},{"name":"card_id","in":"path","schemaId":"schema_344","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1pin~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1pin~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CardPinBase"}},"schemaId":"components/schemas/CardPinBase","pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1pin~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/pin/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"},{"name":"card_id","in":"path","required":true,"schemaId":"schema_344"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CardPinBase"}},"responseCodes":["200","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/pin/","href":"manage-cards/set_card_pin_api_v1_jiko_accounts__account_id__cards__card_id__pin__post","openApiOperationId":"set_card_pin_api_v1_jiko_accounts__account_id__cards__card_id__pin__post","summary":"Set Card PIN"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/CardPinBase","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CardPinBase"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardPinResponse"}},"schemaId":"components/schemas/CardPinResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1pin~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CardPinResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CardPinResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage-cards/set_card_pin_api_v1_jiko_accounts__account_id__cards__card_id__pin__post"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/pin/"},{"label":"Close Card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/manage-cards/close_card_api_v1_jiko_accounts__account_id__cards__card_id__close__post","routeSlug":"/products/partner-api/reference/manage-cards/close_card_api_v1_jiko_accounts__account_id__cards__card_id__close__post","metadata":{"seo":{"title":"Close Card","description":"Close a card, virtual or physical. Physical cards require a closure_reason. If the reason is STOLEN or LOST, a lost_stolen_date is required."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"close_card_api_v1_jiko_accounts__account_id__cards__card_id__close__post","name":"Close Card","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1close~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close Card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Close a card, virtual or physical. Physical cards require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closure_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the reason is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STOLEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lost_stolen_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true},{"name":"card_id","in":"path","schemaId":"schema_344","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1close~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1close~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloseCardRequest"}},"schemaId":"components/schemas/CloseCardRequest","pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1close~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/close/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"},{"name":"card_id","in":"path","required":true,"schemaId":"schema_344"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CloseCardRequest"}},"responseCodes":["204","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/close/","href":"manage-cards/close_card_api_v1_jiko_accounts__account_id__cards__card_id__close__post","openApiOperationId":"close_card_api_v1_jiko_accounts__account_id__cards__card_id__close__post","summary":"Close Card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/CloseCardRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloseCardRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1{card_id}~1close~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manage-cards/close_card_api_v1_jiko_accounts__account_id__cards__card_id__close__post"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/close/"}],"content":{"contentType":"group","meta":{"name":"Manage Cards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manage Cards","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to view and manage Card information."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/jiko-accounts/{account_id}/cards/","summary":"List Account Cards","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manage-cards/list_account_cards_api_v1_jiko_accounts__account_id__cards__get","deprecated":false},{"title":"/api/v1/customers/{customer_id}/cards/","summary":"List Customer Cards","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manage-cards/list_customer_cards_api_v1_customers__customer_id__cards__get","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/status/","summary":"Get Card Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/manage-cards/get_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__get","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/status/","summary":"Set Card Status","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/manage-cards/set_card_status_api_v1_jiko_accounts__account_id__cards__card_id__status__patch","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/pin/","summary":"Set Card PIN","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-cards/set_card_pin_api_v1_jiko_accounts__account_id__cards__card_id__pin__post","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/cards/{card_id}/close/","summary":"Close Card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manage-cards/close_card_api_v1_jiko_accounts__account_id__cards__card_id__close__post","deprecated":false}]}]}]}]}},{"type":"group","label":"Physical Cards","link":"/products/partner-api/reference/physical-cards","routeSlug":"/products/partner-api/reference/physical-cards","items":[{"label":"List Card Orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/physical-cards/list_card_orders_api_v1_jiko_accounts__account_id__card_orders__get","routeSlug":"/products/partner-api/reference/physical-cards/list_card_orders_api_v1_jiko_accounts__account_id__card_orders__get","metadata":{"seo":{"title":"List Card Orders","description":"List all card orders for this account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_card_orders_api_v1_jiko_accounts__account_id__card_orders__get","name":"List Card Orders","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Card Orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all card orders for this account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_326"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jiko-accounts/{account_id}/card-orders/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_326"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/card-orders/","href":"physical-cards/list_card_orders_api_v1_jiko_accounts__account_id__card_orders__get","openApiOperationId":"list_card_orders_api_v1_jiko_accounts__account_id__card_orders__get","summary":"List Card Orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhysicalCardOrderListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PhysicalCardOrderListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PhysicalCardOrderListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhysicalCardOrderListResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/physical-cards/list_card_orders_api_v1_jiko_accounts__account_id__card_orders__get"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/card-orders/"},{"label":"Create Physical Card Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/physical-cards/create_physical_card_order_api_v1_jiko_accounts__account_id__card_orders__post","routeSlug":"/products/partner-api/reference/physical-cards/create_physical_card_order_api_v1_jiko_accounts__account_id__card_orders__post","metadata":{"seo":{"title":"Create Physical Card Order","description":"Order a new, physical card for an account. It will be delivered to the specified address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_physical_card_order_api_v1_jiko_accounts__account_id__card_orders__post","name":"Create Physical Card Order","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Physical Card Order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Order a new, physical card for an account. It will be delivered to the specified address."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PhysicalCardOrder"}},"schemaId":"components/schemas/PhysicalCardOrder","pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/jiko-accounts/{account_id}/card-orders/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PhysicalCardOrder"}},"responseCodes":["201","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/card-orders/","href":"physical-cards/create_physical_card_order_api_v1_jiko_accounts__account_id__card_orders__post","openApiOperationId":"create_physical_card_order_api_v1_jiko_accounts__account_id__card_orders__post","summary":"Create Physical Card Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/PhysicalCardOrder","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PhysicalCardOrder"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhysicalCardOrderResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/PhysicalCardOrderResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/post/responses/201/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PhysicalCardOrderResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhysicalCardOrderResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/post/responses/201/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/physical-cards/create_physical_card_order_api_v1_jiko_accounts__account_id__card_orders__post"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/card-orders/"},{"label":"List Customer Card Orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/physical-cards/list_customer_card_orders_api_v1_customers__customer_id__card_orders__get","routeSlug":"/products/partner-api/reference/physical-cards/list_customer_card_orders_api_v1_customers__customer_id__card_orders__get","metadata":{"seo":{"title":"List Customer Card Orders","description":"List all card orders for the customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_customer_card_orders_api_v1_customers__customer_id__card_orders__get","name":"List Customer Card Orders","isWebhook":false,"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1card-orders~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customer Card Orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all card orders for the customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1card-orders~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_326"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1card-orders~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1card-orders~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customers/{customer_id}/card-orders/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_326"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/customers/{customer_id}/card-orders/","href":"physical-cards/list_customer_card_orders_api_v1_customers__customer_id__card_orders__get","openApiOperationId":"list_customer_card_orders_api_v1_customers__customer_id__card_orders__get","summary":"List Customer Card Orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhysicalCardOrderListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1card-orders~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PhysicalCardOrderListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1card-orders~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1card-orders~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PhysicalCardOrderListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1card-orders~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhysicalCardOrderListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1card-orders~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/physical-cards/list_customer_card_orders_api_v1_customers__customer_id__card_orders__get"}],"panels":[]}]},"httpPath":"/api/v1/customers/{customer_id}/card-orders/"},{"label":"Get Card Order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/physical-cards/get_card_order_api_v1_jiko_accounts__account_id__card_orders__card_order_id___get","routeSlug":"/products/partner-api/reference/physical-cards/get_card_order_api_v1_jiko_accounts__account_id__card_orders__card_order_id___get","metadata":{"seo":{"title":"Get Card Order","description":"Retrieve card order information by provided card_order_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_card_order_api_v1_jiko_accounts__account_id__card_orders__card_order_id___get","name":"Get Card Order","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1{card_order_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Card Order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve card order information by provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true},{"name":"card_order_id","in":"path","schemaId":"schema_345","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1{card_order_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1{card_order_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jiko-accounts/{account_id}/card-orders/{card_order_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"},{"name":"card_order_id","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/card-orders/{card_order_id}/","href":"physical-cards/get_card_order_api_v1_jiko_accounts__account_id__card_orders__card_order_id___get","openApiOperationId":"get_card_order_api_v1_jiko_accounts__account_id__card_orders__card_order_id___get","summary":"Get Card Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhysicalCardOrderResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1{card_order_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PhysicalCardOrderResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1{card_order_id}~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1{card_order_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PhysicalCardOrderResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1{card_order_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhysicalCardOrderResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1{card_order_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/physical-cards/get_card_order_api_v1_jiko_accounts__account_id__card_orders__card_order_id___get"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/card-orders/{card_order_id}/"},{"label":"Get Physical Card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/physical-cards/get_physical_card_api_v1_jiko_accounts__account_id__physical_cards__card_id___post","routeSlug":"/products/partner-api/reference/physical-cards/get_physical_card_api_v1_jiko_accounts__account_id__physical_cards__card_id___post","metadata":{"seo":{"title":"Get Physical Card","description":"Retrieve physical card detail by given card_id. Generate a single-use 4096-bit RSA key-pair at the (end user) client side and pass the public key PEM encoded upstream in PKCS#1 or PKCS#1.5 format to ensure confidentiality and encryption of the card's PAN, CVV and expiration date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_physical_card_api_v1_jiko_accounts__account_id__physical_cards__card_id___post","name":"Get Physical Card","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1physical-cards~1{card_id}~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Physical Card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve physical card detail by given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Generate a single-use 4096-bit RSA key-pair at the (end user) client side and pass the public key PEM encoded upstream in PKCS#1 or PKCS#1.5 format to ensure confidentiality and encryption of the card's PAN, CVV and expiration date."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true},{"name":"card_id","in":"path","schemaId":"schema_344","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1physical-cards~1{card_id}~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1physical-cards~1{card_id}~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicKeyRequest"}},"schemaId":"components/schemas/PublicKeyRequest","pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1physical-cards~1{card_id}~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/jiko-accounts/{account_id}/physical-cards/{card_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"},{"name":"card_id","in":"path","required":true,"schemaId":"schema_344"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PublicKeyRequest"}},"responseCodes":["200","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/physical-cards/{card_id}/","href":"physical-cards/get_physical_card_api_v1_jiko_accounts__account_id__physical_cards__card_id___post","openApiOperationId":"get_physical_card_api_v1_jiko_accounts__account_id__physical_cards__card_id___post","summary":"Get Physical Card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/PublicKeyRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicKeyRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhysicalCardResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1physical-cards~1{card_id}~1/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PhysicalCardResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1physical-cards~1{card_id}~1/post/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1physical-cards~1{card_id}~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PhysicalCardResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1physical-cards~1{card_id}~1/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhysicalCardResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1physical-cards~1{card_id}~1/post/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/physical-cards/get_physical_card_api_v1_jiko_accounts__account_id__physical_cards__card_id___post"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/physical-cards/{card_id}/"}],"content":{"contentType":"group","meta":{"name":"Physical Cards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Physical Cards","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to create, view, and manage Physical Debit Cards."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/jiko-accounts/{account_id}/card-orders/","summary":"List Card Orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/physical-cards/list_card_orders_api_v1_jiko_accounts__account_id__card_orders__get","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/card-orders/","summary":"Create Physical Card Order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/physical-cards/create_physical_card_order_api_v1_jiko_accounts__account_id__card_orders__post","deprecated":false},{"title":"/api/v1/customers/{customer_id}/card-orders/","summary":"List Customer Card Orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/physical-cards/list_customer_card_orders_api_v1_customers__customer_id__card_orders__get","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/card-orders/{card_order_id}/","summary":"Get Card Order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/physical-cards/get_card_order_api_v1_jiko_accounts__account_id__card_orders__card_order_id___get","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/physical-cards/{card_id}/","summary":"Get Physical Card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/physical-cards/get_physical_card_api_v1_jiko_accounts__account_id__physical_cards__card_id___post","deprecated":false}]}]}]}]}},{"type":"group","label":"Virtual Cards","link":"/products/partner-api/reference/virtual-cards","routeSlug":"/products/partner-api/reference/virtual-cards","items":[{"label":"Get Virtual Card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/virtual-cards/get_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___post","routeSlug":"/products/partner-api/reference/virtual-cards/get_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___post","metadata":{"seo":{"title":"Get Virtual Card","description":"Retrieve virtual card detail by given card_id. Generate a single-use 4096-bit RSA key-pair at the (end user) client side and pass the public key PEM encoded upstream in PKCS#1 or PKCS#1.5 format to ensure confidentiality and encryption of the card's PAN, CVV and expiration date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___post","name":"Get Virtual Card","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1{card_id}~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Virtual Card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve virtual card detail by given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Generate a single-use 4096-bit RSA key-pair at the (end user) client side and pass the public key PEM encoded upstream in PKCS#1 or PKCS#1.5 format to ensure confidentiality and encryption of the card's PAN, CVV and expiration date."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true},{"name":"card_id","in":"path","schemaId":"schema_344","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1{card_id}~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1{card_id}~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicKeyRequest"}},"schemaId":"components/schemas/PublicKeyRequest","pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1{card_id}~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/jiko-accounts/{account_id}/virtual-cards/{card_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"},{"name":"card_id","in":"path","required":true,"schemaId":"schema_344"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PublicKeyRequest"}},"responseCodes":["200","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/virtual-cards/{card_id}/","href":"virtual-cards/get_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___post","openApiOperationId":"get_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___post","summary":"Get Virtual Card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/PublicKeyRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicKeyRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualCardResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1{card_id}~1/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/VirtualCardResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1{card_id}~1/post/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1{card_id}~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualCardResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1{card_id}~1/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualCardResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1{card_id}~1/post/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-cards/get_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___post"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/virtual-cards/{card_id}/"},{"label":"Close Virtual Card","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/virtual-cards/close_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___delete","routeSlug":"/products/partner-api/reference/virtual-cards/close_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___delete","metadata":{"seo":{"title":"Close Virtual Card","description":"Close a virtual card. This is an irreversible action."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"close_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___delete","name":"Close Virtual Card","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1{card_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close Virtual Card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Close a virtual card. This is an irreversible action."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true},{"name":"card_id","in":"path","schemaId":"schema_344","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1{card_id}~1/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1{card_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/jiko-accounts/{account_id}/virtual-cards/{card_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"},{"name":"card_id","in":"path","required":true,"schemaId":"schema_344"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/virtual-cards/{card_id}/","href":"virtual-cards/close_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___delete","openApiOperationId":"close_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___delete","summary":"Close Virtual Card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1{card_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-cards/close_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___delete"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/virtual-cards/{card_id}/"},{"label":"Create Virtual Card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/virtual-cards/create_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__post","routeSlug":"/products/partner-api/reference/virtual-cards/create_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__post","metadata":{"seo":{"title":"Create Virtual Card","description":"Create a virtual card for an account. Generate a single-use 4096-bit RSA key-pair at the (end user) client side and pass the public key PEM encoded upstream in PKCS#1 or PKCS#1.5 format to ensure confidentiality and encryption of the card's PAN, CVV and expiration date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__post","name":"Create Virtual Card","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Virtual Card","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a virtual card for an account. Generate a single-use 4096-bit RSA key-pair at the (end user) client side and pass the public key PEM encoded upstream in PKCS#1 or PKCS#1.5 format to ensure confidentiality and encryption of the card's PAN, CVV and expiration date."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicKeyRequest"}},"schemaId":"components/schemas/PublicKeyRequest","pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/jiko-accounts/{account_id}/virtual-cards/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PublicKeyRequest"}},"responseCodes":["201","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/virtual-cards/","href":"virtual-cards/create_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__post","openApiOperationId":"create_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__post","summary":"Create Virtual Card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/PublicKeyRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicKeyRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualCardResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/VirtualCardResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1/post/responses/201/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/VirtualCardResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualCardResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1/post/responses/201/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-cards/create_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__post"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/virtual-cards/"}],"content":{"contentType":"group","meta":{"name":"Virtual Cards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Virtual Cards","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to create, view, and manage Virtual Debit Cards."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/jiko-accounts/{account_id}/virtual-cards/{card_id}/","summary":"Get Virtual Card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-cards/get_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___post","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/virtual-cards/{card_id}/","summary":"Close Virtual Card","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtual-cards/close_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__card_id___delete","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/virtual-cards/","summary":"Create Virtual Card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-cards/create_virtual_card_api_v1_jiko_accounts__account_id__virtual_cards__post","deprecated":false}]}]}]}]}},{"type":"separator","label":"Onboarding","content":null},{"type":"group","label":"Businesses","link":"/products/partner-api/reference/businesses","routeSlug":"/products/partner-api/reference/businesses","items":[{"label":"Create Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/create-business-application","routeSlug":"/products/partner-api/reference/businesses/create-business-application","metadata":{"seo":{"title":"Create Application","description":"Create a Business Application. The Business Application object contains general information related to the business and the overall status of the application."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-business-application","name":"Create Application","isWebhook":false,"pointer":"/paths/~1api~1v1~1business-applications~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Business Application. The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Application"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object contains general information related to the business and the overall status of the application."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/guides/building/onboarding-businesses"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Onboarding Businesses Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessApplicationRequest"}},"schemaId":"components/schemas/BusinessApplicationRequest","pointer":"/paths/~1api~1v1~1business-applications~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/business-applications/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessApplicationRequest"}},"responseCodes":["201","422"],"pointer":"/api/v1/business-applications/","href":"businesses/create-business-application","openApiOperationId":"create-business-application","summary":"Create Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/BusinessApplicationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessApplicationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1/post/responses/201/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1business-applications~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1/post/responses/201/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/create-business-application"}],"panels":[]}]},"httpPath":"/api/v1/business-applications/"},{"label":"Get Application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/get-business-application","routeSlug":"/products/partner-api/reference/businesses/get-business-application","metadata":{"seo":{"title":"Get Application","description":"Fetch a Business Application."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-business-application","name":"Get Application","isWebhook":false,"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch a Business Application."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_346","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/business-applications/{application_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_346"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/business-applications/{application_id}/","href":"businesses/get-business-application","openApiOperationId":"get-business-application","summary":"Get Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/get-business-application"}],"panels":[]}]},"httpPath":"/api/v1/business-applications/{application_id}/"},{"label":"Update Application","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/update-business-application","routeSlug":"/products/partner-api/reference/businesses/update-business-application","metadata":{"seo":{"title":"Update Application","description":"Update Application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-business-application","name":"Update Application","isWebhook":false,"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_346","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessApplicationRequest"}},"schemaId":"components/schemas/BusinessApplicationRequest","pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/business-applications/{application_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_346"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessApplicationRequest"}},"responseCodes":["200","422"],"pointer":"/api/v1/business-applications/{application_id}/","href":"businesses/update-business-application","openApiOperationId":"update-business-application","summary":"Update Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/BusinessApplicationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessApplicationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1/patch/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1/patch/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/update-business-application"}],"panels":[]}]},"httpPath":"/api/v1/business-applications/{application_id}/"},{"label":"Apply","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/business-application-apply","routeSlug":"/products/partner-api/reference/businesses/business-application-apply","metadata":{"seo":{"title":"Apply","description":"When the Business Application object has been completed, along with Related Party Applications and Document Requests (see the Onboarding Businesses Guide), call this endpoint to submit the business application for review."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"business-application-apply","name":"Apply","isWebhook":false,"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1apply~1/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the Business Application object has been completed, along with Related Party Applications and Document Requests (see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/guides/building/onboarding-businesses"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Onboarding Businesses Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), call this endpoint to submit the business application for review."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_346","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1apply~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1apply~1/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/business-applications/{application_id}/apply/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_346"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/business-applications/{application_id}/apply/","href":"businesses/business-application-apply","openApiOperationId":"business-application-apply","summary":"Apply"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1apply~1/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1apply~1/post/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1apply~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1apply~1/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1apply~1/post/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/business-application-apply"}],"panels":[]}]},"httpPath":"/api/v1/business-applications/{application_id}/apply/"},{"label":"Create Related Party Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/create-related-party-application","routeSlug":"/products/partner-api/reference/businesses/create-related-party-application","metadata":{"seo":{"title":"Create Related Party Application","description":"Create Related Party Application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-related-party-application","name":"Create Related Party Application","isWebhook":false,"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Related Party Application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_346","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RelatedPartyApplicationRequest"}},"schemaId":"components/schemas/RelatedPartyApplicationRequest","pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/business-applications/{application_id}/related-party-applications/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_346"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RelatedPartyApplicationRequest"}},"responseCodes":["201","422"],"pointer":"/api/v1/business-applications/{application_id}/related-party-applications/","href":"businesses/create-related-party-application","openApiOperationId":"create-related-party-application","summary":"Create Related Party Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/RelatedPartyApplicationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RelatedPartyApplicationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RelatedPartyApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/RelatedPartyApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/post/responses/201/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/RelatedPartyApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RelatedPartyApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/post/responses/201/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/create-related-party-application"}],"panels":[]}]},"httpPath":"/api/v1/business-applications/{application_id}/related-party-applications/"},{"label":"List Related Party Application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/list-related-party-application","routeSlug":"/products/partner-api/reference/businesses/list-related-party-application","metadata":{"seo":{"title":"List Related Party Application","description":"List Related Party Application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-related-party-application","name":"List Related Party Application","isWebhook":false,"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Related Party Application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_346","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/business-applications/{application_id}/related-party-applications/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_346"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/business-applications/{application_id}/related-party-applications/","href":"businesses/list-related-party-application","openApiOperationId":"list-related-party-application","summary":"List Related Party Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_347","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_347","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/list-related-party-application"}],"panels":[]}]},"httpPath":"/api/v1/business-applications/{application_id}/related-party-applications/"},{"label":"Update Related Party Application","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/update-related-party-application","routeSlug":"/products/partner-api/reference/businesses/update-related-party-application","metadata":{"seo":{"title":"Update Related Party Application","description":"Update Related Party Application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-related-party-application","name":"Update Related Party Application","isWebhook":false,"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Related Party Application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_346","required":true},{"name":"related_party_application_id","in":"path","schemaId":"schema_348","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RelatedPartyApplicationRequest"}},"schemaId":"components/schemas/RelatedPartyApplicationRequest","pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/business-applications/{application_id}/related-party-applications/{related_party_application_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_346"},{"name":"related_party_application_id","in":"path","required":true,"schemaId":"schema_348"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RelatedPartyApplicationRequest"}},"responseCodes":["200","422"],"pointer":"/api/v1/business-applications/{application_id}/related-party-applications/{related_party_application_id}/","href":"businesses/update-related-party-application","openApiOperationId":"update-related-party-application","summary":"Update Related Party Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/RelatedPartyApplicationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RelatedPartyApplicationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RelatedPartyApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/RelatedPartyApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/patch/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RelatedPartyApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RelatedPartyApplicationResponse","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/patch/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/update-related-party-application"}],"panels":[]}]},"httpPath":"/api/v1/business-applications/{application_id}/related-party-applications/{related_party_application_id}/"},{"label":"Delete Related Party Application","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/delete-related-party-application","routeSlug":"/products/partner-api/reference/businesses/delete-related-party-application","metadata":{"seo":{"title":"Delete Related Party Application","description":"Delete Related Party Application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-related-party-application","name":"Delete Related Party Application","isWebhook":false,"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Related Party Application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_346","required":true},{"name":"related_party_application_id","in":"path","schemaId":"schema_348","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/business-applications/{application_id}/related-party-applications/{related_party_application_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_346"},{"name":"related_party_application_id","in":"path","required":true,"schemaId":"schema_348"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","422"],"pointer":"/api/v1/business-applications/{application_id}/related-party-applications/{related_party_application_id}/","href":"businesses/delete-related-party-application","openApiOperationId":"delete-related-party-application","summary":"Delete Related Party Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/delete-related-party-application"}],"panels":[]}]},"httpPath":"/api/v1/business-applications/{application_id}/related-party-applications/{related_party_application_id}/"},{"label":"List Related Party Document Requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/list-related-party-document-requests-businesses","routeSlug":"/products/partner-api/reference/businesses/list-related-party-document-requests-businesses","metadata":{"seo":{"title":"List Related Party Document Requests","description":"Fetch the list of outstanding Document Requests. Document Requests vary depending on the information provided in the Business Application and Related Party Application objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-related-party-document-requests-businesses","name":"List Related Party Document Requests","isWebhook":false,"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Related Party Document Requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch the list of outstanding Document Requests. Document Requests vary depending on the information provided in the Business Application and Related Party Application objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/guides/building/onboarding-businesses"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Onboarding Businesses Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_346","required":true},{"name":"related_party_application_id","in":"path","schemaId":"schema_348","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/business-applications/{application_id}/related-party-applications/{related_party_application_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_346"},{"name":"related_party_application_id","in":"path","required":true,"schemaId":"schema_348"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/business-applications/{application_id}/related-party-applications/{related_party_application_id}/","href":"businesses/list-related-party-document-requests-businesses","openApiOperationId":"list-related-party-document-requests-businesses","summary":"List Related Party Document Requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_349","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_349","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/list-related-party-document-requests-businesses"}],"panels":[]}]},"httpPath":"/api/v1/business-applications/{application_id}/related-party-applications/{related_party_application_id}/"},{"label":"List Document Requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/list-document-requests-businesses","routeSlug":"/products/partner-api/reference/businesses/list-document-requests-businesses","metadata":{"seo":{"title":"List Document Requests","description":"Fetch the list of outstanding Document Requests. Document Requests vary depending on the information provided in the Business Application and Related Party Application objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-document-requests-businesses","name":"List Document Requests","isWebhook":false,"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1documents~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Document Requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch the list of outstanding Document Requests. Document Requests vary depending on the information provided in the Business Application and Related Party Application objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/guides/building/onboarding-businesses"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Onboarding Businesses Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_346","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1documents~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1documents~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/business-applications/{application_id}/documents/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_346"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/business-applications/{application_id}/documents/","href":"businesses/list-document-requests-businesses","openApiOperationId":"list-document-requests-businesses","summary":"List Document Requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_350","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1documents~1/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_350","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1documents~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1business-applications~1{application_id}~1documents~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_350","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1documents~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_350","exampleIds":["paths/~1api~1v1~1business-applications~1{application_id}~1documents~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/list-document-requests-businesses"}],"panels":[]}]},"httpPath":"/api/v1/business-applications/{application_id}/documents/"},{"label":"Upload Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/businesses/upload-application-document","routeSlug":"/products/partner-api/reference/businesses/upload-application-document","metadata":{"seo":{"title":"Upload Document","description":"Upload Document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upload-application-document","name":"Upload Document","isWebhook":false,"pointer":"/paths/~1api~1v1~1documents~1{document_id}~1/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"document_id","in":"path","schemaId":"schema_351","required":true}],"pointer":"/paths/~1api~1v1~1documents~1{document_id}~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"content-type","in":"header","schemaId":"schema_314","required":true},{"name":"content-length","in":"header","schemaId":"schema_315","required":true},{"name":"content-disposition","in":"header","schemaId":"schema_352","required":true},{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true}],"pointer":"/paths/~1api~1v1~1documents~1{document_id}~1/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/documents/{document_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"document_id","in":"path","required":true,"schemaId":"schema_351"}],"query":[],"querystring":[],"header":[{"name":"content-type","in":"header","required":true,"schemaId":"schema_314"},{"name":"content-length","in":"header","required":true,"schemaId":"schema_315"},{"name":"content-disposition","in":"header","required":true,"schemaId":"schema_352"},{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","412","422"],"pointer":"/api/v1/documents/{document_id}/","href":"businesses/upload-application-document","openApiOperationId":"upload-application-document","summary":"Upload Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Document","exampleIds":["paths/~1api~1v1~1documents~1{document_id}~1/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Document","exampleIds":["paths/~1api~1v1~1documents~1{document_id}~1/post/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"412","description":"Document has already been reviewed and approved."},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1documents~1{document_id}~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Document","exampleIds":["paths/~1api~1v1~1documents~1{document_id}~1/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Document","exampleIds":["paths/~1api~1v1~1documents~1{document_id}~1/post/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"412"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/businesses/upload-application-document"}],"panels":[]}]},"httpPath":"/api/v1/documents/{document_id}/"}],"content":{"contentType":"group","meta":{"name":"Businesses"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Businesses","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these endpoints to initiate, manage, and complete KYB for Businesses. When an application has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: “APPROVED”"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/customers/get_customer_data_api_v1_customers__customer_id___get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created for the Business. Customers can have multiple "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/pockets/list-pockets-v2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pockets"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/business-applications/","summary":"Create Application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/businesses/create-business-application","deprecated":false},{"title":"/api/v1/business-applications/{application_id}/","summary":"Get Application","prefix":{"name":"get","color":"get"},"badges":[],"link":"/businesses/get-business-application","deprecated":false},{"title":"/api/v1/business-applications/{application_id}/","summary":"Update Application","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/businesses/update-business-application","deprecated":false},{"title":"/api/v1/business-applications/{application_id}/apply/","summary":"Apply","prefix":{"name":"post","color":"post"},"badges":[],"link":"/businesses/business-application-apply","deprecated":false},{"title":"/api/v1/business-applications/{application_id}/related-party-applications/","summary":"Create Related Party Application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/businesses/create-related-party-application","deprecated":false},{"title":"/api/v1/business-applications/{application_id}/related-party-applications/","summary":"List Related Party Application","prefix":{"name":"get","color":"get"},"badges":[],"link":"/businesses/list-related-party-application","deprecated":false},{"title":"/api/v1/business-applications/{application_id}/related-party-applications/{related_party_application_id}/","summary":"Update Related Party Application","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/businesses/update-related-party-application","deprecated":false},{"title":"/api/v1/business-applications/{application_id}/related-party-applications/{related_party_application_id}/","summary":"Delete Related Party Application","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/businesses/delete-related-party-application","deprecated":false},{"title":"/api/v1/business-applications/{application_id}/related-party-applications/{related_party_application_id}/","summary":"List Related Party Document Requests","prefix":{"name":"get","color":"get"},"badges":[],"link":"/businesses/list-related-party-document-requests-businesses","deprecated":false},{"title":"/api/v1/business-applications/{application_id}/documents/","summary":"List Document Requests","prefix":{"name":"get","color":"get"},"badges":[],"link":"/businesses/list-document-requests-businesses","deprecated":false},{"title":"/api/v1/documents/{document_id}/","summary":"Upload Document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/businesses/upload-application-document","deprecated":false}]}]}]}]}},{"type":"group","label":"Individuals","link":"/products/partner-api/reference/individuals","routeSlug":"/products/partner-api/reference/individuals","items":[{"label":"Create Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/individuals/create_application_api_v1_applications__post","routeSlug":"/products/partner-api/reference/individuals/create_application_api_v1_applications__post","metadata":{"seo":{"title":"Create Application","description":"Create an application. You must apply to potentially create a customer using the application, assuming KYC is successful."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_application_api_v1_applications__post","name":"Create Application","isWebhook":false,"pointer":"/paths/~1api~1v1~1applications~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an application. You must "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/individuals/apply_api_v1_applications__application_id__apply__post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"apply"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to potentially create a customer using the application, assuming KYC is successful."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating an application, keep in mind that customers must be at least 18 years old to open an account with Jiko."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1applications~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InternationalApplicationRequest"}},"schemaId":"components/schemas/InternationalApplicationRequest","pointer":"/paths/~1api~1v1~1applications~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/applications/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InternationalApplicationRequest"}},"responseCodes":["201","422"],"pointer":"/api/v1/applications/","href":"individuals/create_application_api_v1_applications__post","openApiOperationId":"create_application_api_v1_applications__post","summary":"Create Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/InternationalApplicationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InternationalApplicationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalApplication","exampleIds":["paths/~1api~1v1~1applications~1/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/InternationalApplication","exampleIds":["paths/~1api~1v1~1applications~1/post/responses/201/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1applications~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/InternationalApplication","exampleIds":["paths/~1api~1v1~1applications~1/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalApplication","exampleIds":["paths/~1api~1v1~1applications~1/post/responses/201/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individuals/create_application_api_v1_applications__post"}],"panels":[]}]},"httpPath":"/api/v1/applications/"},{"label":"Get Application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/individuals/get_application_api_v1_applications__application_id___get","routeSlug":"/products/partner-api/reference/individuals/get_application_api_v1_applications__application_id___get","metadata":{"seo":{"title":"Get Application","description":"Fetch and observe an existing application."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_application_api_v1_applications__application_id___get","name":"Get Application","isWebhook":false,"pointer":"/paths/~1api~1v1~1applications~1{application_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch and observe an existing application."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_346","required":true}],"pointer":"/paths/~1api~1v1~1applications~1{application_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1applications~1{application_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/applications/{application_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_346"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/applications/{application_id}/","href":"individuals/get_application_api_v1_applications__application_id___get","openApiOperationId":"get_application_api_v1_applications__application_id___get","summary":"Get Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalApplication","exampleIds":["paths/~1api~1v1~1applications~1{application_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/InternationalApplication","exampleIds":["paths/~1api~1v1~1applications~1{application_id}~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1applications~1{application_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InternationalApplication","exampleIds":["paths/~1api~1v1~1applications~1{application_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalApplication","exampleIds":["paths/~1api~1v1~1applications~1{application_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individuals/get_application_api_v1_applications__application_id___get"}],"panels":[]}]},"httpPath":"/api/v1/applications/{application_id}/"},{"label":"Apply","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/individuals/apply_api_v1_applications__application_id__apply__post","routeSlug":"/products/partner-api/reference/individuals/apply_api_v1_applications__application_id__apply__post","metadata":{"seo":{"title":"Apply","description":"Initiate automatic KYC. Transitions the application from CREATED status to SUBMITTED status. Once the async KYC process is completed, the application will move from SUBMITTED to another status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"apply_api_v1_applications__application_id__apply__post","name":"Apply","isWebhook":false,"pointer":"/paths/~1api~1v1~1applications~1{application_id}~1apply~1/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiate automatic KYC. Transitions the application from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUBMITTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. Once the async KYC process is completed, the application will move from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUBMITTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to another status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_346","required":true}],"pointer":"/paths/~1api~1v1~1applications~1{application_id}~1apply~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1applications~1{application_id}~1apply~1/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/applications/{application_id}/apply/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_346"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/applications/{application_id}/apply/","href":"individuals/apply_api_v1_applications__application_id__apply__post","openApiOperationId":"apply_api_v1_applications__application_id__apply__post","summary":"Apply"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalApplication","exampleIds":["paths/~1api~1v1~1applications~1{application_id}~1apply~1/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/InternationalApplication","exampleIds":["paths/~1api~1v1~1applications~1{application_id}~1apply~1/post/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1applications~1{application_id}~1apply~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InternationalApplication","exampleIds":["paths/~1api~1v1~1applications~1{application_id}~1apply~1/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternationalApplication","exampleIds":["paths/~1api~1v1~1applications~1{application_id}~1apply~1/post/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individuals/apply_api_v1_applications__application_id__apply__post"}],"panels":[]}]},"httpPath":"/api/v1/applications/{application_id}/apply/"},{"label":"List Agreements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/individuals/list_agreements_api_v1_agreements__get","routeSlug":"/products/partner-api/reference/individuals/list_agreements_api_v1_agreements__get","metadata":{"seo":{"title":"List Agreements","description":"Partner agreements and disclosures are available through the API in a versioned bundle. The version of the fetched bundle must be attached to all incoming applications."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_agreements_api_v1_agreements__get","name":"List Agreements","isWebhook":false,"pointer":"/paths/~1api~1v1~1agreements~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Agreements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner agreements and disclosures are available through the API in a versioned bundle. The version of the fetched bundle must be attached to all incoming applications."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partners who onboard more than one kind of customer have a separate bundle per customer type. Use the optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to select one. A bundle that is not restricted to a customer type is returned for any requested type."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outcome"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exactly one bundle matches"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the bundle"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No bundle is published for the requested customer type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jiko.errors.agreements.NoMatchingAgreementBundle"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"More than one bundle matches, typically because "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jiko.errors.agreements.AmbiguousAgreementBundle"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INDIVIDUAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" validation error"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"customer_type","in":"query","schemaId":"schema_353","description":"Selects the bundle published for this customer type. Omit it only when a single bundle applies to every customer type."}],"pointer":"/paths/~1api~1v1~1agreements~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1agreements~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/agreements/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[{"name":"customer_type","in":"query","required":false,"schemaId":"schema_353"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404","422"],"pointer":"/api/v1/agreements/","href":"individuals/list_agreements_api_v1_agreements__get","openApiOperationId":"list_agreements_api_v1_agreements__get","summary":"List Agreements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Agreement","exampleIds":["paths/~1api~1v1~1agreements~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Agreement","exampleIds":["paths/~1api~1v1~1agreements~1/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"More than one bundle matches. Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"code":"404","description":"No bundle is published for the requested customer type."},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1agreements~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Agreement","exampleIds":["paths/~1api~1v1~1agreements~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Agreement","exampleIds":["paths/~1api~1v1~1agreements~1/get/responses/200/content/application~1json/example"]}}},{"code":"400"},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individuals/list_agreements_api_v1_agreements__get"}],"panels":[]}]},"httpPath":"/api/v1/agreements/"},{"label":"Upload Document To Application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/individuals/upload_document_to_application_api_v1_applications__application_id__documents__document_type__file__post","routeSlug":"/products/partner-api/reference/individuals/upload_document_to_application_api_v1_applications__application_id__documents__document_type__file__post","metadata":{"seo":{"title":"Upload Document To Application","description":"Upload documents to the application for more detailed KYC or manual review."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Upload_document_to_Application_api_v1_applications__application_id__documents__document_type__file__post","name":"Upload Document To Application","isWebhook":false,"pointer":"/paths/~1api~1v1~1applications~1{application_id}~1documents~1{document_type}~1file~1/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload Document To Application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload documents to the application for more detailed KYC or manual review."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As with all other endpoints, the bearer token and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-jiko-idempotency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is needed, but "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-jiko-signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not needed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file should be posted unprocessed in the request body, in the same manner as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"curl -X POST --data-binary @my_file.png"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum file size for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID_FRONT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID_BACK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELFIE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PASSPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 5 MB. Other files can be up to 50 MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documents can be uploaded before and after calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/individuals/apply_api_v1_applications__application_id__apply__post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_346","required":true},{"name":"document_type","in":"path","schemaId":"schema_313","required":true}],"pointer":"/paths/~1api~1v1~1applications~1{application_id}~1documents~1{document_type}~1file~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"content-type","in":"header","schemaId":"schema_314","required":true},{"name":"content-length","in":"header","schemaId":"schema_315","required":true},{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true}],"pointer":"/paths/~1api~1v1~1applications~1{application_id}~1documents~1{document_type}~1file~1/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/applications/{application_id}/documents/{document_type}/file/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_346"},{"name":"document_type","in":"path","required":true,"schemaId":"schema_313"}],"query":[],"querystring":[],"header":[{"name":"content-type","in":"header","required":true,"schemaId":"schema_314"},{"name":"content-length","in":"header","required":true,"schemaId":"schema_315"},{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/applications/{application_id}/documents/{document_type}/file/","href":"individuals/upload_document_to_application_api_v1_applications__application_id__documents__document_type__file__post","openApiOperationId":"Upload_document_to_Application_api_v1_applications__application_id__documents__document_type__file__post","summary":"Upload Document To Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadDocumentResponse"}},"schemaId":"components/schemas/UploadDocumentResponse"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1applications~1{application_id}~1documents~1{document_type}~1file~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UploadDocumentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadDocumentResponse"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individuals/upload_document_to_application_api_v1_applications__application_id__documents__document_type__file__post"}],"panels":[]}]},"httpPath":"/api/v1/applications/{application_id}/documents/{document_type}/file/"},{"label":"Upload Document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/individuals/upload-application-document","routeSlug":"/products/partner-api/reference/individuals/upload-application-document","metadata":{"seo":{"title":"Upload Document","description":"Upload Document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upload-application-document","name":"Upload Document","isWebhook":false,"pointer":"/paths/~1api~1v1~1documents~1{document_id}~1/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload Document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"document_id","in":"path","schemaId":"schema_351","required":true}],"pointer":"/paths/~1api~1v1~1documents~1{document_id}~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"content-type","in":"header","schemaId":"schema_314","required":true},{"name":"content-length","in":"header","schemaId":"schema_315","required":true},{"name":"content-disposition","in":"header","schemaId":"schema_352","required":true},{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true}],"pointer":"/paths/~1api~1v1~1documents~1{document_id}~1/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/documents/{document_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"document_id","in":"path","required":true,"schemaId":"schema_351"}],"query":[],"querystring":[],"header":[{"name":"content-type","in":"header","required":true,"schemaId":"schema_314"},{"name":"content-length","in":"header","required":true,"schemaId":"schema_315"},{"name":"content-disposition","in":"header","required":true,"schemaId":"schema_352"},{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","412","422"],"pointer":"/api/v1/documents/{document_id}/","href":"individuals/upload-application-document","openApiOperationId":"upload-application-document","summary":"Upload Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Document","exampleIds":["paths/~1api~1v1~1documents~1{document_id}~1/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Document","exampleIds":["paths/~1api~1v1~1documents~1{document_id}~1/post/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"412","description":"Document has already been reviewed and approved."},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1documents~1{document_id}~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Document","exampleIds":["paths/~1api~1v1~1documents~1{document_id}~1/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Document","exampleIds":["paths/~1api~1v1~1documents~1{document_id}~1/post/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"412"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/individuals/upload-application-document"}],"panels":[]}]},"httpPath":"/api/v1/documents/{document_id}/"}],"content":{"contentType":"group","meta":{"name":"Individuals"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Individuals","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these endpoints to initiate, manage, and complete KYC for Individuals. When an application has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: “APPROVED”"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/customers/get_customer_data_api_v1_customers__customer_id___get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created for the Individual. Customers can have multiple "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/pockets/list-pockets-v2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pockets"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/applications/","summary":"Create Application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/individuals/create_application_api_v1_applications__post","deprecated":false},{"title":"/api/v1/applications/{application_id}/","summary":"Get Application","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individuals/get_application_api_v1_applications__application_id___get","deprecated":false},{"title":"/api/v1/applications/{application_id}/apply/","summary":"Apply","prefix":{"name":"post","color":"post"},"badges":[],"link":"/individuals/apply_api_v1_applications__application_id__apply__post","deprecated":false},{"title":"/api/v1/agreements/","summary":"List Agreements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/individuals/list_agreements_api_v1_agreements__get","deprecated":false},{"title":"/api/v1/applications/{application_id}/documents/{document_type}/file/","summary":"Upload Document To Application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/individuals/upload_document_to_application_api_v1_applications__application_id__documents__document_type__file__post","deprecated":false},{"title":"/api/v1/documents/{document_id}/","summary":"Upload Document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/individuals/upload-application-document","deprecated":false}]}]}]}]}},{"type":"separator","label":"Platform","content":null},{"type":"group","label":"Events","link":"/products/partner-api/reference/events","routeSlug":"/products/partner-api/reference/events","items":[{"label":"List Event Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/events/list_event_types_api_v1_events_types__get","routeSlug":"/products/partner-api/reference/events/list_event_types_api_v1_events_types__get","metadata":{"seo":{"title":"List Event Types","description":"List all event types."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_event_types_api_v1_events_types__get","name":"List Event Types","isWebhook":false,"pointer":"/paths/~1api~1v1~1events~1types~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Event Types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all event types."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1events~1types~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/events/types/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/events/types/","href":"events/list_event_types_api_v1_events_types__get","openApiOperationId":"list_event_types_api_v1_events_types__get","summary":"List Event Types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventListResponse","exampleIds":["paths/~1api~1v1~1events~1types~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EventListResponse","exampleIds":["paths/~1api~1v1~1events~1types~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1events~1types~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EventListResponse","exampleIds":["paths/~1api~1v1~1events~1types~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventListResponse","exampleIds":["paths/~1api~1v1~1events~1types~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/list_event_types_api_v1_events_types__get"}],"panels":[]}]},"httpPath":"/api/v1/events/types/"},{"label":"List Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/events/list_events_api_v1_events__get","routeSlug":"/products/partner-api/reference/events/list_events_api_v1_events__get","metadata":{"seo":{"title":"List Events","description":"List all past events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_events_api_v1_events__get","name":"List Events","isWebhook":false,"pointer":"/paths/~1api~1v1~1events~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all past events."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"subscription_id","in":"query","schemaId":"schema_354"},{"name":"after","in":"query","schemaId":"schema_355"},{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_326"}],"pointer":"/paths/~1api~1v1~1events~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1events~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/events/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[{"name":"subscription_id","in":"query","required":false,"schemaId":"schema_354"},{"name":"after","in":"query","required":false,"schemaId":"schema_355"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_326"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/events/","href":"events/list_events_api_v1_events__get","openApiOperationId":"list_events_api_v1_events__get","summary":"List Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_PartnerEvent_","exampleIds":["paths/~1api~1v1~1events~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CursorListResponse_PartnerEvent_","exampleIds":["paths/~1api~1v1~1events~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1events~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorListResponse_PartnerEvent_","exampleIds":["paths/~1api~1v1~1events~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_PartnerEvent_","exampleIds":["paths/~1api~1v1~1events~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/list_events_api_v1_events__get"}],"panels":[]}]},"httpPath":"/api/v1/events/"}],"content":{"contentType":"group","meta":{"name":"Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to view Events."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/events/types/","summary":"List Event Types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/list_event_types_api_v1_events_types__get","deprecated":false},{"title":"/api/v1/events/","summary":"List Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/list_events_api_v1_events__get","deprecated":false}]}]}]}]}},{"type":"group","label":"Health","link":"/products/partner-api/reference/health","routeSlug":"/products/partner-api/reference/health","items":[{"label":"Get Health Check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/health/get-health-check","routeSlug":"/products/partner-api/reference/health/get-health-check","metadata":{"seo":{"title":"Get Health Check","description":"A health check endpoint, which returns \"OK\" if the Partner API is up and running."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-health-check","name":"Get Health Check","isWebhook":false,"pointer":"/paths/~1health/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Health Check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A health check endpoint, which returns \"OK\" if the Partner API is up and running."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/health","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/health","href":"health/get-health-check","openApiOperationId":"get-health-check","summary":"Get Health Check"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}},"schemaId":"schema_356"}],"pointer":"/paths/~1health/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_356","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/health/get-health-check"}],"panels":[]}]},"httpPath":"/health"}],"content":{"contentType":"group","meta":{"name":"Health"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Health","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to setup automatic health checks for the Partner API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/health","summary":"Get Health Check","prefix":{"name":"get","color":"get"},"badges":[],"link":"/health/get-health-check","deprecated":false}]}]}]}]}},{"type":"group","label":"Sandbox","link":"/products/partner-api/reference/sandbox","routeSlug":"/products/partner-api/reference/sandbox","items":[{"label":"Submit Card Swipe","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/sandbox/submit_card_swipe_api_v1_sandbox_card_swipe__post","routeSlug":"/products/partner-api/reference/sandbox/submit_card_swipe_api_v1_sandbox_card_swipe__post","metadata":{"seo":{"title":"Submit Card Swipe","description":"Simulate a card swipe with the given card_id for a given amount_usdc in USD cents. Note: Only for virtual cards at the moment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submit_card_swipe_api_v1_sandbox_card_swipe__post","name":"Submit Card Swipe","isWebhook":false,"pointer":"/paths/~1api~1v1~1sandbox~1card-swipe~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit Card Swipe","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simulate a card swipe with the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_usdc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in USD cents. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Only for virtual cards at the moment."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1sandbox~1card-swipe~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CardSwipe"}},"schemaId":"components/schemas/CardSwipe","pointer":"/paths/~1api~1v1~1sandbox~1card-swipe~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/sandbox/card-swipe/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CardSwipe"}},"responseCodes":["202","422"],"pointer":"/api/v1/sandbox/card-swipe/","href":"sandbox/submit_card_swipe_api_v1_sandbox_card_swipe__post","openApiOperationId":"submit_card_swipe_api_v1_sandbox_card_swipe__post","summary":"Submit Card Swipe"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/CardSwipe","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CardSwipe"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1sandbox~1card-swipe~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sandbox/submit_card_swipe_api_v1_sandbox_card_swipe__post"}],"panels":[]}]},"httpPath":"/api/v1/sandbox/card-swipe/"},{"label":"Generate Physical Card From Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/sandbox/generate_physical_card_from_order_api_v1_sandbox_generate_card__post","routeSlug":"/products/partner-api/reference/sandbox/generate_physical_card_from_order_api_v1_sandbox_generate_card__post","metadata":{"seo":{"title":"Generate Physical Card From Order","description":"Generate a physical card from a card order with a given card_order_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generate_physical_card_from_order_api_v1_sandbox_generate_card__post","name":"Generate Physical Card From Order","isWebhook":false,"pointer":"/paths/~1api~1v1~1sandbox~1generate-card~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate Physical Card From Order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate a physical card from a card order with a given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1sandbox~1generate-card~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GeneratePhysicalCardFromOrder"}},"schemaId":"components/schemas/GeneratePhysicalCardFromOrder","pointer":"/paths/~1api~1v1~1sandbox~1generate-card~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/sandbox/generate-card/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GeneratePhysicalCardFromOrder"}},"responseCodes":["202","422"],"pointer":"/api/v1/sandbox/generate-card/","href":"sandbox/generate_physical_card_from_order_api_v1_sandbox_generate_card__post","openApiOperationId":"generate_physical_card_from_order_api_v1_sandbox_generate_card__post","summary":"Generate Physical Card From Order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/GeneratePhysicalCardFromOrder","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GeneratePhysicalCardFromOrder"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1sandbox~1generate-card~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sandbox/generate_physical_card_from_order_api_v1_sandbox_generate_card__post"}],"panels":[]}]},"httpPath":"/api/v1/sandbox/generate-card/"},{"label":"Trigger Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/sandbox/trigger-webhook","routeSlug":"/products/partner-api/reference/sandbox/trigger-webhook","metadata":{"seo":{"title":"Trigger Webhook","description":"Simulates a webhook event according to the payload. This will trigger requests to subscribed callback URLs, if any."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"trigger-webhook","name":"Trigger Webhook","isWebhook":false,"pointer":"/paths/~1api~1v1~1sandbox~1webhook~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Simulates a webhook event according to the payload. This will trigger requests to subscribed callback URLs, if any."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1sandbox~1webhook~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EventDetails"}},"schemaId":"components/schemas/EventDetails","pointer":"/paths/~1api~1v1~1sandbox~1webhook~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/sandbox/webhook/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EventDetails"}},"responseCodes":["202","422"],"pointer":"/api/v1/sandbox/webhook/","href":"sandbox/trigger-webhook","openApiOperationId":"trigger-webhook","summary":"Trigger Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/EventDetails","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EventDetails"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1sandbox~1webhook~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sandbox/trigger-webhook"}],"panels":[]}]},"httpPath":"/api/v1/sandbox/webhook/"},{"label":"Fund Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/sandbox/fund_account_api_v1_sandbox_fund__post","routeSlug":"/products/partner-api/reference/sandbox/fund_account_api_v1_sandbox_fund__post","metadata":{"seo":{"title":"Fund Account","description":"Simulates an ACH credit to the provided Jiko account. Requires a portal to use. A portal can be created using the Create Portal endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fund_account_api_v1_sandbox_fund__post","name":"Fund Account","isWebhook":false,"pointer":"/paths/~1api~1v1~1sandbox~1fund~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fund Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simulates an ACH credit to the provided Jiko account. Requires a portal to use. A portal can be created using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/portals/create_portal_api_v1_jiko_accounts__account_id__portals__post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1sandbox~1fund~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FundPortalRequest"}},"schemaId":"components/schemas/FundPortalRequest","pointer":"/paths/~1api~1v1~1sandbox~1fund~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/sandbox/fund/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FundPortalRequest"}},"responseCodes":["202","422"],"pointer":"/api/v1/sandbox/fund/","href":"sandbox/fund_account_api_v1_sandbox_fund__post","openApiOperationId":"fund_account_api_v1_sandbox_fund__post","summary":"Fund Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/FundPortalRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FundPortalRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1sandbox~1fund~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sandbox/fund_account_api_v1_sandbox_fund__post"}],"panels":[]}]},"httpPath":"/api/v1/sandbox/fund/"}],"content":{"contentType":"group","meta":{"name":"Sandbox"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sandbox","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to initiate sandbox functionality."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/sandbox/card-swipe/","summary":"Submit Card Swipe","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sandbox/submit_card_swipe_api_v1_sandbox_card_swipe__post","deprecated":false},{"title":"/api/v1/sandbox/generate-card/","summary":"Generate Physical Card From Order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sandbox/generate_physical_card_from_order_api_v1_sandbox_generate_card__post","deprecated":false},{"title":"/api/v1/sandbox/webhook/","summary":"Trigger Webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sandbox/trigger-webhook","deprecated":false},{"title":"/api/v1/sandbox/fund/","summary":"Fund Account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sandbox/fund_account_api_v1_sandbox_fund__post","deprecated":false}]}]}]}]}},{"type":"group","label":"Security","link":"/products/partner-api/reference/security","routeSlug":"/products/partner-api/reference/security","items":[{"label":"Login","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/security/login_api_v1_login__post","routeSlug":"/products/partner-api/reference/security/login_api_v1_login__post","metadata":{"seo":{"title":"Login","description":"Provide the username and password in a request body to receive a bearer token to authenticate to the API's other endpoints."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"login_api_v1_login__post","name":"Login","isWebhook":false,"pointer":"/paths/~1api~1v1~1login~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Login","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the username and password in a request body to receive a bearer token to authenticate to the API's other endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoginInput"}},"schemaId":"components/schemas/LoginInput","pointer":"/paths/~1api~1v1~1login~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/login/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/LoginInput"}},"responseCodes":["200","401","422"],"pointer":"/api/v1/login/","href":"security/login_api_v1_login__post","openApiOperationId":"login_api_v1_login__post","summary":"Login"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/LoginInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoginInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LoginResponse","exampleIds":["paths/~1api~1v1~1login~1/post/responses/200/content/application~1json/examples/0"]}},"schemaId":"components/schemas/LoginResponse","exampleIds":["paths/~1api~1v1~1login~1/post/responses/200/content/application~1json/examples/0"]},{"code":"401","description":"Unauthorized"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1login~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/LoginResponse","exampleIds":["paths/~1api~1v1~1login~1/post/responses/200/content/application~1json/examples/0"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LoginResponse","exampleIds":["paths/~1api~1v1~1login~1/post/responses/200/content/application~1json/examples/0"]}}},{"code":"401"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/security/login_api_v1_login__post"}],"panels":[]}]},"httpPath":"/api/v1/login/"},{"label":"List Public Keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/security/list_public_keys_api_v1_public_keys__get","routeSlug":"/products/partner-api/reference/security/list_public_keys_api_v1_public_keys__get","metadata":{"seo":{"title":"List Public Keys","description":"Returns all relevant asymmetric encryption keys."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_public_keys_api_v1_public_keys__get","name":"List Public Keys","isWebhook":false,"pointer":"/paths/~1api~1v1~1public-keys~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Public Keys","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all relevant asymmetric encryption keys."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/public-keys/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/api/v1/public-keys/","href":"security/list_public_keys_api_v1_public_keys__get","openApiOperationId":"list_public_keys_api_v1_public_keys__get","summary":"List Public Keys"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EncryptionKeysResponse","exampleIds":["paths/~1api~1v1~1public-keys~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EncryptionKeysResponse","exampleIds":["paths/~1api~1v1~1public-keys~1/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1public-keys~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EncryptionKeysResponse","exampleIds":["paths/~1api~1v1~1public-keys~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EncryptionKeysResponse","exampleIds":["paths/~1api~1v1~1public-keys~1/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/security/list_public_keys_api_v1_public_keys__get"}],"panels":[]}]},"httpPath":"/api/v1/public-keys/"}],"content":{"contentType":"group","meta":{"name":"Security"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Security","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to authenticate requests to the Jiko API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/login/","summary":"Login","prefix":{"name":"post","color":"post"},"badges":[],"link":"/security/login_api_v1_login__post","deprecated":false},{"title":"/api/v1/public-keys/","summary":"List Public Keys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/security/list_public_keys_api_v1_public_keys__get","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscriptions","link":"/products/partner-api/reference/subscriptions","routeSlug":"/products/partner-api/reference/subscriptions","items":[{"label":"List Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/subscriptions/list_subscriptions_api_v1_subscriptions__get","routeSlug":"/products/partner-api/reference/subscriptions/list_subscriptions_api_v1_subscriptions__get","metadata":{"seo":{"title":"List Subscriptions","description":"List a partner's subscriptions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_subscriptions_api_v1_subscriptions__get","name":"List Subscriptions","isWebhook":false,"pointer":"/paths/~1api~1v1~1subscriptions~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List a partner's subscriptions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_326"}],"pointer":"/paths/~1api~1v1~1subscriptions~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1subscriptions~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/subscriptions/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_326"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/subscriptions/","href":"subscriptions/list_subscriptions_api_v1_subscriptions__get","openApiOperationId":"list_subscriptions_api_v1_subscriptions__get","summary":"List Subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Subscription_","exampleIds":["paths/~1api~1v1~1subscriptions~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CursorListResponse_Subscription_","exampleIds":["paths/~1api~1v1~1subscriptions~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1subscriptions~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorListResponse_Subscription_","exampleIds":["paths/~1api~1v1~1subscriptions~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Subscription_","exampleIds":["paths/~1api~1v1~1subscriptions~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/list_subscriptions_api_v1_subscriptions__get"}],"panels":[]}]},"httpPath":"/api/v1/subscriptions/"},{"label":"Create Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/subscriptions/create_subscription_api_v1_subscriptions__post","routeSlug":"/products/partner-api/reference/subscriptions/create_subscription_api_v1_subscriptions__post","metadata":{"seo":{"title":"Create Subscription","description":"Creates a webhook subscription for the specified event types and the given URL."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_subscription_api_v1_subscriptions__post","name":"Create Subscription","isWebhook":false,"pointer":"/paths/~1api~1v1~1subscriptions~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a webhook subscription for the specified event types and the given URL."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1subscriptions~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSubscriptionRequest"}},"schemaId":"components/schemas/CreateSubscriptionRequest","pointer":"/paths/~1api~1v1~1subscriptions~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/subscriptions/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateSubscriptionRequest"}},"responseCodes":["201","404","422"],"pointer":"/api/v1/subscriptions/","href":"subscriptions/create_subscription_api_v1_subscriptions__post","openApiOperationId":"create_subscription_api_v1_subscriptions__post","summary":"Create Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/CreateSubscriptionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSubscriptionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1api~1v1~1subscriptions~1/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1api~1v1~1subscriptions~1/post/responses/201/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1subscriptions~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Subscription","exampleIds":["paths/~1api~1v1~1subscriptions~1/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1api~1v1~1subscriptions~1/post/responses/201/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/create_subscription_api_v1_subscriptions__post"}],"panels":[]}]},"httpPath":"/api/v1/subscriptions/"},{"label":"Get Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/subscriptions/get_subscription_api_v1_subscriptions__subscription_id___get","routeSlug":"/products/partner-api/reference/subscriptions/get_subscription_api_v1_subscriptions__subscription_id___get","metadata":{"seo":{"title":"Get Subscription","description":"Retrieve a webhook subscription by given subscription_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_subscription_api_v1_subscriptions__subscription_id___get","name":"Get Subscription","isWebhook":false,"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a webhook subscription by given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_357","required":true}],"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/subscriptions/{subscription_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_357"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/subscriptions/{subscription_id}/","href":"subscriptions/get_subscription_api_v1_subscriptions__subscription_id___get","openApiOperationId":"get_subscription_api_v1_subscriptions__subscription_id___get","summary":"Get Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1api~1v1~1subscriptions~1{subscription_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1api~1v1~1subscriptions~1{subscription_id}~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subscription","exampleIds":["paths/~1api~1v1~1subscriptions~1{subscription_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1api~1v1~1subscriptions~1{subscription_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/get_subscription_api_v1_subscriptions__subscription_id___get"}],"panels":[]}]},"httpPath":"/api/v1/subscriptions/{subscription_id}/"},{"label":"Update Subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/subscriptions/update_subscription_api_v1_subscriptions__subscription_id___patch","routeSlug":"/products/partner-api/reference/subscriptions/update_subscription_api_v1_subscriptions__subscription_id___patch","metadata":{"seo":{"title":"Update Subscription","description":"Updates webhook subscription by specified subscription_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_subscription_api_v1_subscriptions__subscription_id___patch","name":"Update Subscription","isWebhook":false,"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates webhook subscription by specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_357","required":true}],"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSubscriptionRequest"}},"schemaId":"components/schemas/UpdateSubscriptionRequest","pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/subscriptions/{subscription_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_357"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateSubscriptionRequest"}},"responseCodes":["200","404","422"],"pointer":"/api/v1/subscriptions/{subscription_id}/","href":"subscriptions/update_subscription_api_v1_subscriptions__subscription_id___patch","openApiOperationId":"update_subscription_api_v1_subscriptions__subscription_id___patch","summary":"Update Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/UpdateSubscriptionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSubscriptionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1api~1v1~1subscriptions~1{subscription_id}~1/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1api~1v1~1subscriptions~1{subscription_id}~1/patch/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subscription","exampleIds":["paths/~1api~1v1~1subscriptions~1{subscription_id}~1/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription","exampleIds":["paths/~1api~1v1~1subscriptions~1{subscription_id}~1/patch/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/update_subscription_api_v1_subscriptions__subscription_id___patch"}],"panels":[]}]},"httpPath":"/api/v1/subscriptions/{subscription_id}/"},{"label":"Delete Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/subscriptions/delete_subscription_api_v1_subscriptions__subscription_id___delete","routeSlug":"/products/partner-api/reference/subscriptions/delete_subscription_api_v1_subscriptions__subscription_id___delete","metadata":{"seo":{"title":"Delete Subscription","description":"Deletes a webhook subscription matching the given ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_subscription_api_v1_subscriptions__subscription_id___delete","name":"Delete Subscription","isWebhook":false,"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a webhook subscription matching the given ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_357","required":true}],"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/subscriptions/{subscription_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_357"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","404","422"],"pointer":"/api/v1/subscriptions/{subscription_id}/","href":"subscriptions/delete_subscription_api_v1_subscriptions__subscription_id___delete","openApiOperationId":"delete_subscription_api_v1_subscriptions__subscription_id___delete","summary":"Delete Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1subscriptions~1{subscription_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/delete_subscription_api_v1_subscriptions__subscription_id___delete"}],"panels":[]}]},"httpPath":"/api/v1/subscriptions/{subscription_id}/"}],"content":{"contentType":"group","meta":{"name":"Subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to create, view, and manage Subscriptions. Subscriptions provide Partners with the ability to subscribe to Events. Once subscribed, Events will be sent to the specified URL."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/subscriptions/","summary":"List Subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/list_subscriptions_api_v1_subscriptions__get","deprecated":false},{"title":"/api/v1/subscriptions/","summary":"Create Subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/create_subscription_api_v1_subscriptions__post","deprecated":false},{"title":"/api/v1/subscriptions/{subscription_id}/","summary":"Get Subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/get_subscription_api_v1_subscriptions__subscription_id___get","deprecated":false},{"title":"/api/v1/subscriptions/{subscription_id}/","summary":"Update Subscription","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/subscriptions/update_subscription_api_v1_subscriptions__subscription_id___patch","deprecated":false},{"title":"/api/v1/subscriptions/{subscription_id}/","summary":"Delete Subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscriptions/delete_subscription_api_v1_subscriptions__subscription_id___delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/products/partner-api/reference/webhooks","routeSlug":"/products/partner-api/reference/webhooks","items":[{"label":"application.approved","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_application_approved_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_application_approved_post","metadata":{"seo":{"title":"application.approved","description":"Application - Approved Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_application_approved_post","name":"application.approved","isWebhook":true,"pointer":"/paths/application.approved/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"application.approved","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Application - Approved Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_358"}},"schemaId":"schema_358","pointer":"/paths/application.approved/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"application.approved","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_358"}},"responseCodes":["200"],"pointer":"application.approved","href":"webhooks/webhook_application_approved_post","openApiOperationId":"webhook_application_approved_post","summary":"application.approved"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_358","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_358"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/application.approved/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_application_approved_post"}],"panels":[]}]},"httpPath":"application.approved"},{"label":"application.manual_review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_application_manual_review_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_application_manual_review_post","metadata":{"seo":{"title":"application.manual_review","description":"Application - Manual Review Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_application_manual_review_post","name":"application.manual_review","isWebhook":true,"pointer":"/paths/application.manual_review/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"application.manual_review","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Application - Manual Review Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_360"}},"schemaId":"schema_360","pointer":"/paths/application.manual_review/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"application.manual_review","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_360"}},"responseCodes":["200"],"pointer":"application.manual_review","href":"webhooks/webhook_application_manual_review_post","openApiOperationId":"webhook_application_manual_review_post","summary":"application.manual_review"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_360","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_360"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/application.manual_review/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_application_manual_review_post"}],"panels":[]}]},"httpPath":"application.manual_review"},{"label":"application.documents_needed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_application_documents_needed_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_application_documents_needed_post","metadata":{"seo":{"title":"application.documents_needed","description":"Application - Documents Needed Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_application_documents_needed_post","name":"application.documents_needed","isWebhook":true,"pointer":"/paths/application.documents_needed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"application.documents_needed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Application - Documents Needed Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_361"}},"schemaId":"schema_361","pointer":"/paths/application.documents_needed/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"application.documents_needed","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_361"}},"responseCodes":["200"],"pointer":"application.documents_needed","href":"webhooks/webhook_application_documents_needed_post","openApiOperationId":"webhook_application_documents_needed_post","summary":"application.documents_needed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_361","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_361"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/application.documents_needed/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_application_documents_needed_post"}],"panels":[]}]},"httpPath":"application.documents_needed"},{"label":"application.rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_application_rejected_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_application_rejected_post","metadata":{"seo":{"title":"application.rejected","description":"Application - Rejected Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_application_rejected_post","name":"application.rejected","isWebhook":true,"pointer":"/paths/application.rejected/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"application.rejected","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Application - Rejected Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","pointer":"/paths/application.rejected/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"application.rejected","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_362"}},"responseCodes":["200"],"pointer":"application.rejected","href":"webhooks/webhook_application_rejected_post","openApiOperationId":"webhook_application_rejected_post","summary":"application.rejected"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_362"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/application.rejected/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_application_rejected_post"}],"panels":[]}]},"httpPath":"application.rejected"},{"label":"transfers.ach.in.success","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_ach_in_success_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_ach_in_success_post","metadata":{"seo":{"title":"transfers.ach.in.success","description":"Incoming ACH Transfer - Success Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_transfers_ach_in_success_post","name":"transfers.ach.in.success","isWebhook":true,"pointer":"/paths/transfers.ach.in.success/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"transfers.ach.in.success","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incoming ACH Transfer - Success Event"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when Jiko, when acting as the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.nacha.org/content/how-ach-payments-work"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RDFI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has successfully processed an ACH transfer it received and settled it against the receiving pocket."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","pointer":"/paths/transfers.ach.in.success/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers.ach.in.success","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_363"}},"responseCodes":["200"],"pointer":"transfers.ach.in.success","href":"webhooks/webhook_transfers_ach_in_success_post","openApiOperationId":"webhook_transfers_ach_in_success_post","summary":"transfers.ach.in.success"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_363"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/transfers.ach.in.success/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_transfers_ach_in_success_post"}],"panels":[]}]},"httpPath":"transfers.ach.in.success"},{"label":"transfers.ach.in.rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_ach_in_rejected_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_ach_in_rejected_post","metadata":{"seo":{"title":"transfers.ach.in.rejected","description":"Incoming ACH Transfer - Rejected Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_transfers_ach_in_rejected_post","name":"transfers.ach.in.rejected","isWebhook":true,"pointer":"/paths/transfers.ach.in.rejected/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"transfers.ach.in.rejected","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incoming ACH Transfer - Rejected Event"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when Jiko, when acting as the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.nacha.org/content/how-ach-payments-work"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RDFI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has rejected and returned an ACH transfer it received back to the ACH network."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_364"}},"schemaId":"schema_364","pointer":"/paths/transfers.ach.in.rejected/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers.ach.in.rejected","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_364"}},"responseCodes":["200"],"pointer":"transfers.ach.in.rejected","href":"webhooks/webhook_transfers_ach_in_rejected_post","openApiOperationId":"webhook_transfers_ach_in_rejected_post","summary":"transfers.ach.in.rejected"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_364","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_364"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/transfers.ach.in.rejected/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_transfers_ach_in_rejected_post"}],"panels":[]}]},"httpPath":"transfers.ach.in.rejected"},{"label":"transfers.ach.out.success","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_ach_out_success_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_ach_out_success_post","metadata":{"seo":{"title":"transfers.ach.out.success","description":"Outgoing ACH Transfer - Success Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_transfers_ach_out_success_post","name":"transfers.ach.out.success","isWebhook":true,"pointer":"/paths/transfers.ach.out.success/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"transfers.ach.out.success","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outgoing ACH Transfer - Success Event"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when Jiko, when acting as the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.nacha.org/content/how-ach-payments-work"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ODFI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has originated an ACH transfer and sent it to the ACH network. More information on ACH originations can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/ach/create_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create ACH Origination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reference documentation."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_365"}},"schemaId":"schema_365","pointer":"/paths/transfers.ach.out.success/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers.ach.out.success","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_365"}},"responseCodes":["200"],"pointer":"transfers.ach.out.success","href":"webhooks/webhook_transfers_ach_out_success_post","openApiOperationId":"webhook_transfers_ach_out_success_post","summary":"transfers.ach.out.success"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_365","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_365"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/transfers.ach.out.success/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_transfers_ach_out_success_post"}],"panels":[]}]},"httpPath":"transfers.ach.out.success"},{"label":"transfers.ach.out.rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_ach_out_rejected_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_ach_out_rejected_post","metadata":{"seo":{"title":"transfers.ach.out.rejected","description":"Outgoing ACH Transfer - Rejected Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_transfers_ach_out_rejected_post","name":"transfers.ach.out.rejected","isWebhook":true,"pointer":"/paths/transfers.ach.out.rejected/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"transfers.ach.out.rejected","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outgoing ACH Transfer - Rejected Event"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when an ACH transfer originated by Jiko, when acting as the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.nacha.org/content/how-ach-payments-work"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ODFI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", has been returned by the receiving depository financial institution. More information on ACH originations can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/ach/create_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create ACH Origination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reference documentation."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","pointer":"/paths/transfers.ach.out.rejected/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers.ach.out.rejected","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_366"}},"responseCodes":["200"],"pointer":"transfers.ach.out.rejected","href":"webhooks/webhook_transfers_ach_out_rejected_post","openApiOperationId":"webhook_transfers_ach_out_rejected_post","summary":"transfers.ach.out.rejected"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_366"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/transfers.ach.out.rejected/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_transfers_ach_out_rejected_post"}],"panels":[]}]},"httpPath":"transfers.ach.out.rejected"},{"label":"transfers.ach.out.sent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_ach_out_sent_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_ach_out_sent_post","metadata":{"seo":{"title":"transfers.ach.out.sent","description":"Outgoing ACH Transfer - Sent Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_transfers_ach_out_sent_post","name":"transfers.ach.out.sent","isWebhook":true,"pointer":"/paths/transfers.ach.out.sent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"transfers.ach.out.sent","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outgoing ACH Transfer - Sent Event"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when an ACH transfer originated by Jiko, when acting as the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.nacha.org/content/how-ach-payments-work"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ODFI"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", has been sent to the ACH network for processing. More information on ACH originations can be found in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/ach/create_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create ACH Origination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reference documentation."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_367"}},"schemaId":"schema_367","pointer":"/paths/transfers.ach.out.sent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers.ach.out.sent","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_367"}},"responseCodes":["200"],"pointer":"transfers.ach.out.sent","href":"webhooks/webhook_transfers_ach_out_sent_post","openApiOperationId":"webhook_transfers_ach_out_sent_post","summary":"transfers.ach.out.sent"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_367","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_367"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/transfers.ach.out.sent/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_transfers_ach_out_sent_post"}],"panels":[]}]},"httpPath":"transfers.ach.out.sent"},{"label":"card.status.closed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_status_closed_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_status_closed_post","metadata":{"seo":{"title":"card.status.closed","description":"Card Status - Closed Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_card_status_closed_post","name":"card.status.closed","isWebhook":true,"pointer":"/paths/card.status.closed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"card.status.closed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Card Status - Closed Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_368"}},"schemaId":"schema_368","pointer":"/paths/card.status.closed/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"card.status.closed","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_368"}},"responseCodes":["200"],"pointer":"card.status.closed","href":"webhooks/webhook_card_status_closed_post","openApiOperationId":"webhook_card_status_closed_post","summary":"card.status.closed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_368","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_368"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/card.status.closed/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_card_status_closed_post"}],"panels":[]}]},"httpPath":"card.status.closed"},{"label":"card.status.open","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_status_open_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_status_open_post","metadata":{"seo":{"title":"card.status.open","description":"Card Status - Open Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_card_status_open_post","name":"card.status.open","isWebhook":true,"pointer":"/paths/card.status.open/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"card.status.open","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Card Status - Open Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/card.status.open/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"card.status.open","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200"],"pointer":"card.status.open","href":"webhooks/webhook_card_status_open_post","openApiOperationId":"webhook_card_status_open_post","summary":"card.status.open"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/card.status.open/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_card_status_open_post"}],"panels":[]}]},"httpPath":"card.status.open"},{"label":"card.status.frozen","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_status_frozen_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_status_frozen_post","metadata":{"seo":{"title":"card.status.frozen","description":"Card Status - Frozen Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_card_status_frozen_post","name":"card.status.frozen","isWebhook":true,"pointer":"/paths/card.status.frozen/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"card.status.frozen","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Card Status - Frozen Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_370"}},"schemaId":"schema_370","pointer":"/paths/card.status.frozen/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"card.status.frozen","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_370"}},"responseCodes":["200"],"pointer":"card.status.frozen","href":"webhooks/webhook_card_status_frozen_post","openApiOperationId":"webhook_card_status_frozen_post","summary":"card.status.frozen"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_370","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_370"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/card.status.frozen/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_card_status_frozen_post"}],"panels":[]}]},"httpPath":"card.status.frozen"},{"label":"card.status.locked","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_status_locked_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_status_locked_post","metadata":{"seo":{"title":"card.status.locked","description":"Card Status - Locked Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_card_status_locked_post","name":"card.status.locked","isWebhook":true,"pointer":"/paths/card.status.locked/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"card.status.locked","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Card Status - Locked Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_371"}},"schemaId":"schema_371","pointer":"/paths/card.status.locked/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"card.status.locked","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_371"}},"responseCodes":["200"],"pointer":"card.status.locked","href":"webhooks/webhook_card_status_locked_post","openApiOperationId":"webhook_card_status_locked_post","summary":"card.status.locked"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_371","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_371"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/card.status.locked/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_card_status_locked_post"}],"panels":[]}]},"httpPath":"card.status.locked"},{"label":"card.transaction.approved","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_transaction_approved_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_transaction_approved_post","metadata":{"seo":{"title":"card.transaction.approved","description":"Card Transaction - Approved Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_card_transaction_approved_post","name":"card.transaction.approved","isWebhook":true,"pointer":"/paths/card.transaction.approved/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"card.transaction.approved","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Card Transaction - Approved Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372","pointer":"/paths/card.transaction.approved/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"card.transaction.approved","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_372"}},"responseCodes":["200"],"pointer":"card.transaction.approved","href":"webhooks/webhook_card_transaction_approved_post","openApiOperationId":"webhook_card_transaction_approved_post","summary":"card.transaction.approved"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_372"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/card.transaction.approved/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_card_transaction_approved_post"}],"panels":[]}]},"httpPath":"card.transaction.approved"},{"label":"card.transaction.on_hold","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_transaction_on_hold_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_transaction_on_hold_post","metadata":{"seo":{"title":"card.transaction.on_hold","description":"Card Transaction - On Hold Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_card_transaction_on_hold_post","name":"card.transaction.on_hold","isWebhook":true,"pointer":"/paths/card.transaction.on_hold/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"card.transaction.on_hold","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Card Transaction - On Hold Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_373"}},"schemaId":"schema_373","pointer":"/paths/card.transaction.on_hold/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"card.transaction.on_hold","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_373"}},"responseCodes":["200"],"pointer":"card.transaction.on_hold","href":"webhooks/webhook_card_transaction_on_hold_post","openApiOperationId":"webhook_card_transaction_on_hold_post","summary":"card.transaction.on_hold"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_373","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_373"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/card.transaction.on_hold/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_card_transaction_on_hold_post"}],"panels":[]}]},"httpPath":"card.transaction.on_hold"},{"label":"card.transaction.reversed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_transaction_reversed_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_transaction_reversed_post","metadata":{"seo":{"title":"card.transaction.reversed","description":"Card Transaction - Reversed Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_card_transaction_reversed_post","name":"card.transaction.reversed","isWebhook":true,"pointer":"/paths/card.transaction.reversed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"card.transaction.reversed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Card Transaction - Reversed Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_374"}},"schemaId":"schema_374","pointer":"/paths/card.transaction.reversed/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"card.transaction.reversed","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_374"}},"responseCodes":["200"],"pointer":"card.transaction.reversed","href":"webhooks/webhook_card_transaction_reversed_post","openApiOperationId":"webhook_card_transaction_reversed_post","summary":"card.transaction.reversed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_374","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_374"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/card.transaction.reversed/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_card_transaction_reversed_post"}],"panels":[]}]},"httpPath":"card.transaction.reversed"},{"label":"card.transaction.rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_card_transaction_rejected_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_card_transaction_rejected_post","metadata":{"seo":{"title":"card.transaction.rejected","description":"Card Transaction - Rejected Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_card_transaction_rejected_post","name":"card.transaction.rejected","isWebhook":true,"pointer":"/paths/card.transaction.rejected/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"card.transaction.rejected","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Card Transaction - Rejected Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_375"}},"schemaId":"schema_375","pointer":"/paths/card.transaction.rejected/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"card.transaction.rejected","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_375"}},"responseCodes":["200"],"pointer":"card.transaction.rejected","href":"webhooks/webhook_card_transaction_rejected_post","openApiOperationId":"webhook_card_transaction_rejected_post","summary":"card.transaction.rejected"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_375","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_375"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/card.transaction.rejected/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_card_transaction_rejected_post"}],"panels":[]}]},"httpPath":"card.transaction.rejected"},{"label":"transfers.wire.out.success","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_wire_out_success_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_wire_out_success_post","metadata":{"seo":{"title":"transfers.wire.out.success","description":"Outgoing Wire Transfer - Success Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_transfers_wire_out_success_post","name":"transfers.wire.out.success","isWebhook":true,"pointer":"/paths/transfers.wire.out.success/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"transfers.wire.out.success","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Outgoing Wire Transfer - Success Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_376"}},"schemaId":"schema_376","pointer":"/paths/transfers.wire.out.success/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers.wire.out.success","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_376"}},"responseCodes":["200"],"pointer":"transfers.wire.out.success","href":"webhooks/webhook_transfers_wire_out_success_post","openApiOperationId":"webhook_transfers_wire_out_success_post","summary":"transfers.wire.out.success"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_376","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_376"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/transfers.wire.out.success/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_transfers_wire_out_success_post"}],"panels":[]}]},"httpPath":"transfers.wire.out.success"},{"label":"transfers.wire.out.processing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_wire_out_processing_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_wire_out_processing_post","metadata":{"seo":{"title":"transfers.wire.out.processing","description":"Outgoing Wire Transfer - Processing Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_transfers_wire_out_processing_post","name":"transfers.wire.out.processing","isWebhook":true,"pointer":"/paths/transfers.wire.out.processing/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"transfers.wire.out.processing","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Outgoing Wire Transfer - Processing Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_377"}},"schemaId":"schema_377","pointer":"/paths/transfers.wire.out.processing/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers.wire.out.processing","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_377"}},"responseCodes":["200"],"pointer":"transfers.wire.out.processing","href":"webhooks/webhook_transfers_wire_out_processing_post","openApiOperationId":"webhook_transfers_wire_out_processing_post","summary":"transfers.wire.out.processing"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_377","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_377"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/transfers.wire.out.processing/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_transfers_wire_out_processing_post"}],"panels":[]}]},"httpPath":"transfers.wire.out.processing"},{"label":"transfers.wire.out.rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_wire_out_rejected_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_wire_out_rejected_post","metadata":{"seo":{"title":"transfers.wire.out.rejected","description":"Outgoing Wire Transfer - Rejected Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_transfers_wire_out_rejected_post","name":"transfers.wire.out.rejected","isWebhook":true,"pointer":"/paths/transfers.wire.out.rejected/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"transfers.wire.out.rejected","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Outgoing Wire Transfer - Rejected Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_378"}},"schemaId":"schema_378","pointer":"/paths/transfers.wire.out.rejected/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers.wire.out.rejected","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_378"}},"responseCodes":["200"],"pointer":"transfers.wire.out.rejected","href":"webhooks/webhook_transfers_wire_out_rejected_post","openApiOperationId":"webhook_transfers_wire_out_rejected_post","summary":"transfers.wire.out.rejected"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_378","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_378"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/transfers.wire.out.rejected/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_transfers_wire_out_rejected_post"}],"panels":[]}]},"httpPath":"transfers.wire.out.rejected"},{"label":"transfers.wire.in.success","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_wire_in_success_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_wire_in_success_post","metadata":{"seo":{"title":"transfers.wire.in.success","description":"Incoming Wire Transfer - Success Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_transfers_wire_in_success_post","name":"transfers.wire.in.success","isWebhook":true,"pointer":"/paths/transfers.wire.in.success/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"transfers.wire.in.success","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Incoming Wire Transfer - Success Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_379"}},"schemaId":"schema_379","pointer":"/paths/transfers.wire.in.success/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers.wire.in.success","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_379"}},"responseCodes":["200"],"pointer":"transfers.wire.in.success","href":"webhooks/webhook_transfers_wire_in_success_post","openApiOperationId":"webhook_transfers_wire_in_success_post","summary":"transfers.wire.in.success"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_379","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_379"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/transfers.wire.in.success/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_transfers_wire_in_success_post"}],"panels":[]}]},"httpPath":"transfers.wire.in.success"},{"label":"transfers.wire.in.rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_wire_in_rejected_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_wire_in_rejected_post","metadata":{"seo":{"title":"transfers.wire.in.rejected","description":"Incoming Wire Transfer - Rejected Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_transfers_wire_in_rejected_post","name":"transfers.wire.in.rejected","isWebhook":true,"pointer":"/paths/transfers.wire.in.rejected/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"transfers.wire.in.rejected","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Incoming Wire Transfer - Rejected Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/transfers.wire.in.rejected/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers.wire.in.rejected","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_380"}},"responseCodes":["200"],"pointer":"transfers.wire.in.rejected","href":"webhooks/webhook_transfers_wire_in_rejected_post","openApiOperationId":"webhook_transfers_wire_in_rejected_post","summary":"transfers.wire.in.rejected"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/transfers.wire.in.rejected/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_transfers_wire_in_rejected_post"}],"panels":[]}]},"httpPath":"transfers.wire.in.rejected"},{"label":"transfers.on-us.success","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_success_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_success_post","metadata":{"seo":{"title":"transfers.on-us.success","description":"Transfers On-Us Success Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_transfers_on_us_success_post","name":"transfers.on-us.success","isWebhook":true,"pointer":"/paths/transfers.on-us.success/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"transfers.on-us.success","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Transfers On-Us Success Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381","pointer":"/paths/transfers.on-us.success/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers.on-us.success","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_381"}},"responseCodes":["200"],"pointer":"transfers.on-us.success","href":"webhooks/webhook_transfers_on_us_success_post","openApiOperationId":"webhook_transfers_on_us_success_post","summary":"transfers.on-us.success"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_381"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/transfers.on-us.success/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_transfers_on_us_success_post"}],"panels":[]}]},"httpPath":"transfers.on-us.success"},{"label":"transfers.on-us.processing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_processing_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_processing_post","metadata":{"seo":{"title":"transfers.on-us.processing","description":"Transfers On-Us Processing Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_transfers_on_us_processing_post","name":"transfers.on-us.processing","isWebhook":true,"pointer":"/paths/transfers.on-us.processing/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"transfers.on-us.processing","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Transfers On-Us Processing Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_382"}},"schemaId":"schema_382","pointer":"/paths/transfers.on-us.processing/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers.on-us.processing","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_382"}},"responseCodes":["200"],"pointer":"transfers.on-us.processing","href":"webhooks/webhook_transfers_on_us_processing_post","openApiOperationId":"webhook_transfers_on_us_processing_post","summary":"transfers.on-us.processing"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_382","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_382"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/transfers.on-us.processing/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_transfers_on_us_processing_post"}],"panels":[]}]},"httpPath":"transfers.on-us.processing"},{"label":"transfers.on-us.rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_rejected_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_rejected_post","metadata":{"seo":{"title":"transfers.on-us.rejected","description":"Transfers On-Us Rejected Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_transfers_on_us_rejected_post","name":"transfers.on-us.rejected","isWebhook":true,"pointer":"/paths/transfers.on-us.rejected/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"transfers.on-us.rejected","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Transfers On-Us Rejected Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_383"}},"schemaId":"schema_383","pointer":"/paths/transfers.on-us.rejected/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers.on-us.rejected","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_383"}},"responseCodes":["200"],"pointer":"transfers.on-us.rejected","href":"webhooks/webhook_transfers_on_us_rejected_post","openApiOperationId":"webhook_transfers_on_us_rejected_post","summary":"transfers.on-us.rejected"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_383","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_383"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/transfers.on-us.rejected/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_transfers_on_us_rejected_post"}],"panels":[]}]},"httpPath":"transfers.on-us.rejected"},{"label":"transfers.on-us.received","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_received_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_transfers_on_us_received_post","metadata":{"seo":{"title":"transfers.on-us.received","description":"Transfers On-Us Received Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_transfers_on_us_received_post","name":"transfers.on-us.received","isWebhook":true,"pointer":"/paths/transfers.on-us.received/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"transfers.on-us.received","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Transfers On-Us Received Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_384"}},"schemaId":"schema_384","pointer":"/paths/transfers.on-us.received/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"transfers.on-us.received","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_384"}},"responseCodes":["200"],"pointer":"transfers.on-us.received","href":"webhooks/webhook_transfers_on_us_received_post","openApiOperationId":"webhook_transfers_on_us_received_post","summary":"transfers.on-us.received"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_384","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_384"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/transfers.on-us.received/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_transfers_on_us_received_post"}],"panels":[]}]},"httpPath":"transfers.on-us.received"},{"label":"tradable.maturity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_tradable_maturity_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_tradable_maturity_post","metadata":{"seo":{"title":"tradable.maturity","description":"Tradable - Maturity Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_tradable_maturity_post","name":"tradable.maturity","isWebhook":true,"pointer":"/paths/tradable.maturity/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"tradable.maturity","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Tradable - Maturity Event\n\nTriggered when a treasury bill held by the pocket referenced in the event payload has matured."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_385"}},"schemaId":"schema_385","pointer":"/paths/tradable.maturity/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"tradable.maturity","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_385"}},"responseCodes":["200"],"pointer":"tradable.maturity","href":"webhooks/webhook_tradable_maturity_post","openApiOperationId":"webhook_tradable_maturity_post","summary":"tradable.maturity"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_385","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_385"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/tradable.maturity/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_tradable_maturity_post"}],"panels":[]}]},"httpPath":"tradable.maturity"},{"label":"report.status.available","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_report_status_available_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_report_status_available_post","metadata":{"seo":{"title":"report.status.available","description":"Report - Download Available Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_report_status_available_post","name":"report.status.available","isWebhook":true,"pointer":"/paths/report.status.available/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"report.status.available","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Report - Download Available Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_386"}},"schemaId":"schema_386","pointer":"/paths/report.status.available/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"report.status.available","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_386"}},"responseCodes":["200"],"pointer":"report.status.available","href":"webhooks/webhook_report_status_available_post","openApiOperationId":"webhook_report_status_available_post","summary":"report.status.available"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_386","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_386"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/report.status.available/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_report_status_available_post"}],"panels":[]}]},"httpPath":"report.status.available"},{"label":"report.status.pending","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_report_status_pending_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_report_status_pending_post","metadata":{"seo":{"title":"report.status.pending","description":"Report - Pending Creation Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_report_status_pending_post","name":"report.status.pending","isWebhook":true,"pointer":"/paths/report.status.pending/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"report.status.pending","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Report - Pending Creation Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_387","pointer":"/paths/report.status.pending/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"report.status.pending","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_387"}},"responseCodes":["200"],"pointer":"report.status.pending","href":"webhooks/webhook_report_status_pending_post","openApiOperationId":"webhook_report_status_pending_post","summary":"report.status.pending"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_387","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_387"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/report.status.pending/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_report_status_pending_post"}],"panels":[]}]},"httpPath":"report.status.pending"},{"label":"report.status.failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_report_status_failed_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_report_status_failed_post","metadata":{"seo":{"title":"report.status.failed","description":"Report Status Failed Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_report_status_failed_post","name":"report.status.failed","isWebhook":true,"pointer":"/paths/report.status.failed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"report.status.failed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Report Status Failed Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_388"}},"schemaId":"schema_388","pointer":"/paths/report.status.failed/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"report.status.failed","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_388"}},"responseCodes":["200"],"pointer":"report.status.failed","href":"webhooks/webhook_report_status_failed_post","openApiOperationId":"webhook_report_status_failed_post","summary":"report.status.failed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_388","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_388"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/report.status.failed/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_report_status_failed_post"}],"panels":[]}]},"httpPath":"report.status.failed"},{"label":"counterparty.status.linked","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_counterparty_status_linked_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_counterparty_status_linked_post","metadata":{"seo":{"title":"counterparty.status.linked","description":"Counterparty Status - Linked Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_counterparty_status_linked_post","name":"counterparty.status.linked","isWebhook":true,"pointer":"/paths/counterparty.status.linked/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"counterparty.status.linked","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Counterparty Status - Linked Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_389"}},"schemaId":"schema_389","pointer":"/paths/counterparty.status.linked/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"counterparty.status.linked","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_389"}},"responseCodes":["200"],"pointer":"counterparty.status.linked","href":"webhooks/webhook_counterparty_status_linked_post","openApiOperationId":"webhook_counterparty_status_linked_post","summary":"counterparty.status.linked"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_389","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_389"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/counterparty.status.linked/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_counterparty_status_linked_post"}],"panels":[]}]},"httpPath":"counterparty.status.linked"},{"label":"counterparty.status.unlinked","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_counterparty_status_unlinked_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_counterparty_status_unlinked_post","metadata":{"seo":{"title":"counterparty.status.unlinked","description":"Counterparty Status - Unlinked Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_counterparty_status_unlinked_post","name":"counterparty.status.unlinked","isWebhook":true,"pointer":"/paths/counterparty.status.unlinked/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"counterparty.status.unlinked","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Counterparty Status - Unlinked Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_390"}},"schemaId":"schema_390","pointer":"/paths/counterparty.status.unlinked/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"counterparty.status.unlinked","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_390"}},"responseCodes":["200"],"pointer":"counterparty.status.unlinked","href":"webhooks/webhook_counterparty_status_unlinked_post","openApiOperationId":"webhook_counterparty_status_unlinked_post","summary":"counterparty.status.unlinked"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_390","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_390"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/counterparty.status.unlinked/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_counterparty_status_unlinked_post"}],"panels":[]}]},"httpPath":"counterparty.status.unlinked"},{"label":"counterparty.status.failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/partner-api/reference/webhooks/webhook_counterparty_status_failed_post","routeSlug":"/products/partner-api/reference/webhooks/webhook_counterparty_status_failed_post","metadata":{"seo":{"title":"counterparty.status.failed","description":"Counterparty Status - Failed Event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_counterparty_status_failed_post","name":"counterparty.status.failed","isWebhook":true,"pointer":"/paths/counterparty.status.failed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"counterparty.status.failed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Counterparty Status - Failed Event"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_391"}},"schemaId":"schema_391","pointer":"/paths/counterparty.status.failed/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"counterparty.status.failed","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_391"}},"responseCodes":["200"],"pointer":"counterparty.status.failed","href":"webhooks/webhook_counterparty_status_failed_post","openApiOperationId":"webhook_counterparty_status_failed_post","summary":"counterparty.status.failed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_391","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_391"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/counterparty.status.failed/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_counterparty_status_failed_post"}],"panels":[]}]},"httpPath":"counterparty.status.failed"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"application.approved","summary":"application.approved","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_application_approved_post","deprecated":false},{"title":"application.manual_review","summary":"application.manual_review","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_application_manual_review_post","deprecated":false},{"title":"application.documents_needed","summary":"application.documents_needed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_application_documents_needed_post","deprecated":false},{"title":"application.rejected","summary":"application.rejected","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_application_rejected_post","deprecated":false},{"title":"transfers.ach.in.success","summary":"transfers.ach.in.success","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_transfers_ach_in_success_post","deprecated":false},{"title":"transfers.ach.in.rejected","summary":"transfers.ach.in.rejected","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_transfers_ach_in_rejected_post","deprecated":false},{"title":"transfers.ach.out.success","summary":"transfers.ach.out.success","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_transfers_ach_out_success_post","deprecated":false},{"title":"transfers.ach.out.rejected","summary":"transfers.ach.out.rejected","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_transfers_ach_out_rejected_post","deprecated":false},{"title":"transfers.ach.out.sent","summary":"transfers.ach.out.sent","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_transfers_ach_out_sent_post","deprecated":false},{"title":"card.status.closed","summary":"card.status.closed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_card_status_closed_post","deprecated":false},{"title":"card.status.open","summary":"card.status.open","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_card_status_open_post","deprecated":false},{"title":"card.status.frozen","summary":"card.status.frozen","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_card_status_frozen_post","deprecated":false},{"title":"card.status.locked","summary":"card.status.locked","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_card_status_locked_post","deprecated":false},{"title":"card.transaction.approved","summary":"card.transaction.approved","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_card_transaction_approved_post","deprecated":false},{"title":"card.transaction.on_hold","summary":"card.transaction.on_hold","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_card_transaction_on_hold_post","deprecated":false},{"title":"card.transaction.reversed","summary":"card.transaction.reversed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_card_transaction_reversed_post","deprecated":false},{"title":"card.transaction.rejected","summary":"card.transaction.rejected","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_card_transaction_rejected_post","deprecated":false},{"title":"transfers.wire.out.success","summary":"transfers.wire.out.success","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_transfers_wire_out_success_post","deprecated":false},{"title":"transfers.wire.out.processing","summary":"transfers.wire.out.processing","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_transfers_wire_out_processing_post","deprecated":false},{"title":"transfers.wire.out.rejected","summary":"transfers.wire.out.rejected","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_transfers_wire_out_rejected_post","deprecated":false},{"title":"transfers.wire.in.success","summary":"transfers.wire.in.success","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_transfers_wire_in_success_post","deprecated":false},{"title":"transfers.wire.in.rejected","summary":"transfers.wire.in.rejected","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_transfers_wire_in_rejected_post","deprecated":false},{"title":"transfers.on-us.success","summary":"transfers.on-us.success","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_transfers_on_us_success_post","deprecated":false},{"title":"transfers.on-us.processing","summary":"transfers.on-us.processing","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_transfers_on_us_processing_post","deprecated":false},{"title":"transfers.on-us.rejected","summary":"transfers.on-us.rejected","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_transfers_on_us_rejected_post","deprecated":false},{"title":"transfers.on-us.received","summary":"transfers.on-us.received","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_transfers_on_us_received_post","deprecated":false},{"title":"tradable.maturity","summary":"tradable.maturity","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_tradable_maturity_post","deprecated":false},{"title":"report.status.available","summary":"report.status.available","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_report_status_available_post","deprecated":false},{"title":"report.status.pending","summary":"report.status.pending","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_report_status_pending_post","deprecated":false},{"title":"report.status.failed","summary":"report.status.failed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_report_status_failed_post","deprecated":false},{"title":"counterparty.status.linked","summary":"counterparty.status.linked","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_counterparty_status_linked_post","deprecated":false},{"title":"counterparty.status.unlinked","summary":"counterparty.status.unlinked","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_counterparty_status_unlinked_post","deprecated":false},{"title":"counterparty.status.failed","summary":"counterparty.status.failed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_counterparty_status_failed_post","deprecated":false}]}]}]}]}},{"type":"separator","label":"Reports","content":null},{"type":"group","label":"Reports","link":"/products/partner-api/reference/reports","routeSlug":"/products/partner-api/reference/reports","items":[{"label":"List Report Requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/reports/list_report_requests_api_v1_report_requests__get","routeSlug":"/products/partner-api/reference/reports/list_report_requests_api_v1_report_requests__get","metadata":{"seo":{"title":"List Report Requests","description":"Returns a list of report requests"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_report_requests_api_v1_report_requests__get","name":"List Report Requests","isWebhook":false,"pointer":"/paths/~1api~1v1~1report-requests~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Report Requests","badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of report requests"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"customer_id","in":"query","schemaId":"schema_392"},{"name":"cursor","in":"query","schemaId":"schema_339"},{"name":"limit","in":"query","schemaId":"schema_393"},{"name":"type","in":"query","schemaId":"schema_394"},{"name":"date_from","in":"query","schemaId":"schema_395"},{"name":"date_to","in":"query","schemaId":"schema_396"}],"pointer":"/paths/~1api~1v1~1report-requests~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1report-requests~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/report-requests/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[{"name":"customer_id","in":"query","required":false,"schemaId":"schema_392"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_339"},{"name":"limit","in":"query","required":false,"schemaId":"schema_393"},{"name":"type","in":"query","required":false,"schemaId":"schema_394"},{"name":"date_from","in":"query","required":false,"schemaId":"schema_395"},{"name":"date_to","in":"query","required":false,"schemaId":"schema_396"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/report-requests/","href":"reports/list_report_requests_api_v1_report_requests__get","openApiOperationId":"list_report_requests_api_v1_report_requests__get","summary":"List Report Requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_ReportRequest_","exampleIds":["paths/~1api~1v1~1report-requests~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CursorListResponse_ReportRequest_","exampleIds":["paths/~1api~1v1~1report-requests~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1report-requests~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorListResponse_ReportRequest_","exampleIds":["paths/~1api~1v1~1report-requests~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_ReportRequest_","exampleIds":["paths/~1api~1v1~1report-requests~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/list_report_requests_api_v1_report_requests__get"}],"panels":[]}]},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/report-requests/"},{"label":"Create Report Request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/reports/create_report_request_api_v1_report_requests__post","routeSlug":"/products/partner-api/reference/reports/create_report_request_api_v1_report_requests__post","metadata":{"seo":{"title":"Create Report Request","description":"This endpoint triggers an asynchronous process to create a report request based on the provided parameters. Available report types are:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_report_request_api_v1_report_requests__post","name":"Create Report Request","isWebhook":false,"pointer":"/paths/~1api~1v1~1report-requests~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Report Request","badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint triggers an asynchronous process to create a report request based on the provided parameters. Available report types are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"reports/create_report_request_api_v1_report_requests__post/request/type-bank_statement_report","deepLinkHash":"/reports/create_report_request_api_v1_report_requests__post#reports/create_report_request_api_v1_report_requests__post/request/type-bank_statement_report"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_STATEMENT_REPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End-of-day bank statement for the pocket’s bank account, exported in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022 camt.053 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Transactions reported in this statement include fund deposits and withdrawals, incoming and outgoing third-party payments (when applicable), fees, automated sweep transactions between the pocket’s bank account and its linked brokerage account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" since Jiko automatically sweeps funds between the bank account and the associated brokerage account in the pocket, the bank account’s end-of-day balance is always 0. To report on balances held with Jiko, we invite you to use:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either the Brokerage statement, to import the value of held T-bills in the cash position of your treasury management system, reported as the closing balance of an account,"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or the Trade report, to import individual buy and sell transactions into your treasury management system and derive the corresponding position."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"output_formats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CAMT053"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"reports/create_report_request_api_v1_report_requests__post/request/type-brokerage_statement_report","deepLinkHash":"/reports/create_report_request_api_v1_report_requests__post#reports/create_report_request_api_v1_report_requests__post/request/type-brokerage_statement_report"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BROKERAGE_STATEMENT_REPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End-of-day statement for the pocket’s brokerage account, exported in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 20022 camt.053 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". With the opening value and closing value of the T-bills held in the pocket on the selected reporting date, represented as the account balance. Values are based on end-of-day market prices, or on the current market price if the report is generated before day-end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The statement also includes the following records that explain the change between the opening and closing values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additions: new funds deposited into the brokerage account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subtractions: funds withdrawn from the brokerage account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gains/Losses from T-bills held in the account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fees charged and deducted from the brokerage account."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"output_formats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CAMT053"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"reports/create_report_request_api_v1_report_requests__post/request/type-trade_report","deepLinkHash":"/reports/create_report_request_api_v1_report_requests__post#reports/create_report_request_api_v1_report_requests__post/request/type-trade_report"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRADE_REPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of T-bill buy & sell trades within a user-defined range of trade dates, exported in CSV format. Each trade in the file includes three categories of information:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security master data: CUSIP, issuer, issue date, maturity date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trading entity parameters: transaction code, custodian details."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trade details: buy/sell indicator, trade date, price, amount, reference."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date ranges filter has a maximum range of 31 days. Optionally, the date range filter can be configured to be based on either settlement dates, or book dates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"output_formats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KYRIBA_CSV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CSV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"reports/create_report_request_api_v1_report_requests__post/request/type-security_price_report","deepLinkHash":"/reports/create_report_request_api_v1_report_requests__post#reports/create_report_request_api_v1_report_requests__post/request/type-security_price_report"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SECURITY_PRICE_REPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End-of-day security prices within a user-defined range of dates, exported in CSV format. With:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An “SE” field identifying the entry as a security price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the price provider: “JIKO”."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The CUSIP of the security."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The pricing date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end-of-day price."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"output_formats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KYRIBA_CSV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"reports/create_report_request_api_v1_report_requests__post/request/type-position_summary_report","deepLinkHash":"/reports/create_report_request_api_v1_report_requests__post#reports/create_report_request_api_v1_report_requests__post/request/type-position_summary_report"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POSITION_SUMMARY_REPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides a snapshot of holdings as of a user-selected date, showing CUSIP-level positions by pocket along with associated cash values. The report includes the following key fields: Pocket, CUSIP, Quantity, Market Price, Market Value, and Historical Cost Value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers use this report to export pocket-level valuations to downstream systems and to reconcile imported buy and sell transactions against the quantities reflected in the Position Summary"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"output_formats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PDF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CSV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1report-requests~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateReportRequest"}},"schemaId":"components/schemas/CreateReportRequest","pointer":"/paths/~1api~1v1~1report-requests~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/report-requests/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateReportRequest"}},"responseCodes":["201","404","422"],"pointer":"/api/v1/report-requests/","href":"reports/create_report_request_api_v1_report_requests__post","openApiOperationId":"create_report_request_api_v1_report_requests__post","summary":"Create Report Request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/CreateReportRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateReportRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1report-requests~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/create_report_request_api_v1_report_requests__post"}],"panels":[]}]},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/report-requests/"},{"label":"Get Report Request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/reports/get_report_request_api_v1_report_requests__report_request_id___get","routeSlug":"/products/partner-api/reference/reports/get_report_request_api_v1_report_requests__report_request_id___get","metadata":{"seo":{"title":"Get Report Request","description":"Retrieves a single report request by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_report_request_api_v1_report_requests__report_request_id___get","name":"Get Report Request","isWebhook":false,"pointer":"/paths/~1api~1v1~1report-requests~1{report_request_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Report Request","badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single report request by ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_request_id","in":"path","schemaId":"schema_397","required":true}],"pointer":"/paths/~1api~1v1~1report-requests~1{report_request_id}~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"customer_id","in":"query","schemaId":"schema_392"}],"pointer":"/paths/~1api~1v1~1report-requests~1{report_request_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1report-requests~1{report_request_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/report-requests/{report_request_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"report_request_id","in":"path","required":true,"schemaId":"schema_397"}],"query":[{"name":"customer_id","in":"query","required":false,"schemaId":"schema_392"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/report-requests/{report_request_id}/","href":"reports/get_report_request_api_v1_report_requests__report_request_id___get","openApiOperationId":"get_report_request_api_v1_report_requests__report_request_id___get","summary":"Get Report Request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportRequest","exampleIds":["paths/~1api~1v1~1report-requests~1{report_request_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ReportRequest","exampleIds":["paths/~1api~1v1~1report-requests~1{report_request_id}~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1report-requests~1{report_request_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportRequest","exampleIds":["paths/~1api~1v1~1report-requests~1{report_request_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportRequest","exampleIds":["paths/~1api~1v1~1report-requests~1{report_request_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/get_report_request_api_v1_report_requests__report_request_id___get"}],"panels":[]}]},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/report-requests/{report_request_id}/"},{"label":"Get Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/reports/get_report_api_v1_reports__report_id___get","routeSlug":"/products/partner-api/reference/reports/get_report_api_v1_reports__report_id___get","metadata":{"seo":{"title":"Get Report","description":"Retrieves a single report by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_report_api_v1_reports__report_id___get","name":"Get Report","isWebhook":false,"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Report","badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single report by ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_398","required":true}],"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"customer_id","in":"query","schemaId":"schema_392"}],"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/reports/{report_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"schemaId":"schema_398"}],"query":[{"name":"customer_id","in":"query","required":false,"schemaId":"schema_392"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/reports/{report_id}/","href":"reports/get_report_api_v1_reports__report_id___get","openApiOperationId":"get_report_api_v1_reports__report_id___get","summary":"Get Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Report","exampleIds":["paths/~1api~1v1~1reports~1{report_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Report","exampleIds":["paths/~1api~1v1~1reports~1{report_id}~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Report","exampleIds":["paths/~1api~1v1~1reports~1{report_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Report","exampleIds":["paths/~1api~1v1~1reports~1{report_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/get_report_api_v1_reports__report_id___get"}],"panels":[]}]},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/reports/{report_id}/"},{"label":"Download Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/reports/download_report_api_v1_reports__report_id__download__post","routeSlug":"/products/partner-api/reference/reports/download_report_api_v1_reports__report_id__download__post","metadata":{"seo":{"title":"Download Report","description":"Creates a temporary, time-limited URL for downloading the report corresponding to the given ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"download_report_api_v1_reports__report_id__download__post","name":"Download Report","isWebhook":false,"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1download~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Report","badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a temporary, time-limited URL for downloading the report corresponding to the given ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_398","required":true}],"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1download~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1download~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReportDownloadRequest"}},"schemaId":"components/schemas/ReportDownloadRequest","pointer":"/paths/~1api~1v1~1reports~1{report_id}~1download~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/reports/{report_id}/download/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"schemaId":"schema_398"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReportDownloadRequest"}},"responseCodes":["200","404","422"],"pointer":"/api/v1/reports/{report_id}/download/","href":"reports/download_report_api_v1_reports__report_id__download__post","openApiOperationId":"download_report_api_v1_reports__report_id__download__post","summary":"Download Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/ReportDownloadRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReportDownloadRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportDownload","exampleIds":["paths/~1api~1v1~1reports~1{report_id}~1download~1/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ReportDownload","exampleIds":["paths/~1api~1v1~1reports~1{report_id}~1download~1/post/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1download~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportDownload","exampleIds":["paths/~1api~1v1~1reports~1{report_id}~1download~1/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportDownload","exampleIds":["paths/~1api~1v1~1reports~1{report_id}~1download~1/post/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/download_report_api_v1_reports__report_id__download__post"}],"panels":[]}]},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/reports/{report_id}/download/"},{"label":"Render Report Formats","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/reports/render_report_formats_api_v1_reports__report_id__formats__post","routeSlug":"/products/partner-api/reference/reports/render_report_formats_api_v1_reports__report_id__formats__post","metadata":{"seo":{"title":"Render Report Formats","description":"Triggers rendering of additional output formats for an existing report"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"render_report_formats_api_v1_reports__report_id__formats__post","name":"Render Report Formats","isWebhook":false,"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1formats~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Render Report Formats","badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggers rendering of additional output formats for an existing report"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_398","required":true}],"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1formats~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1formats~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RenderFormatsRequest"}},"schemaId":"components/schemas/RenderFormatsRequest","pointer":"/paths/~1api~1v1~1reports~1{report_id}~1formats~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/reports/{report_id}/formats/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"schemaId":"schema_398"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RenderFormatsRequest"}},"responseCodes":["202","404","422"],"pointer":"/api/v1/reports/{report_id}/formats/","href":"reports/render_report_formats_api_v1_reports__report_id__formats__post","openApiOperationId":"render_report_formats_api_v1_reports__report_id__formats__post","summary":"Render Report Formats"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/RenderFormatsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RenderFormatsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1reports~1{report_id}~1formats~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/render_report_formats_api_v1_reports__report_id__formats__post"}],"panels":[]}]},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v1/reports/{report_id}/formats/"}],"content":{"contentType":"group","meta":{"name":"Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ Experimental ⚠️"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" These endpoints are subject to change."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these endpoints to interact with Reports."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/report-requests/","summary":"List Report Requests","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"link":"/reports/list_report_requests_api_v1_report_requests__get","deprecated":false},{"title":"/api/v1/report-requests/","summary":"Create Report Request","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"link":"/reports/create_report_request_api_v1_report_requests__post","deprecated":false},{"title":"/api/v1/report-requests/{report_request_id}/","summary":"Get Report Request","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"link":"/reports/get_report_request_api_v1_report_requests__report_request_id___get","deprecated":false},{"title":"/api/v1/reports/{report_id}/","summary":"Get Report","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"link":"/reports/get_report_api_v1_reports__report_id___get","deprecated":false},{"title":"/api/v1/reports/{report_id}/download/","summary":"Download Report","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"link":"/reports/download_report_api_v1_reports__report_id__download__post","deprecated":false},{"title":"/api/v1/reports/{report_id}/formats/","summary":"Render Report Formats","prefix":{"name":"post","color":"post"},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"link":"/reports/render_report_formats_api_v1_reports__report_id__formats__post","deprecated":false}]}]}]}]}},{"type":"separator","label":"Transfers","content":null},{"type":"group","label":"ACH","link":"/products/partner-api/reference/ach","routeSlug":"/products/partner-api/reference/ach","items":[{"label":"List ACH Originations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/ach/list_ach_originations_api_v1_jiko_accounts__account_id__ach_originating__get","routeSlug":"/products/partner-api/reference/ach/list_ach_originations_api_v1_jiko_accounts__account_id__ach_originating__get","metadata":{"seo":{"title":"List ACH Originations","description":"List all ACH transfer originations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_ach_originations_api_v1_jiko_accounts__account_id__ach_originating__get","name":"List ACH Originations","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List ACH Originations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all ACH transfer originations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[status]","in":"query","schemaId":"schema_399"},{"name":"direction","in":"query","schemaId":"schema_400"},{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_326"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jiko-accounts/{account_id}/ach-originating/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"}],"query":[{"name":"filter[status]","in":"query","required":false,"schemaId":"schema_399"},{"name":"direction","in":"query","required":false,"schemaId":"schema_400"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_326"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/ach-originating/","href":"ach/list_ach_originations_api_v1_jiko_accounts__account_id__ach_originating__get","openApiOperationId":"list_ach_originations_api_v1_jiko_accounts__account_id__ach_originating__get","summary":"List ACH Originations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_ACHResponse_","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CursorListResponse_ACHResponse_","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorListResponse_ACHResponse_","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_ACHResponse_","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ach/list_ach_originations_api_v1_jiko_accounts__account_id__ach_originating__get"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/ach-originating/"},{"label":"Create ACH Origination","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/ach/create_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__post","routeSlug":"/products/partner-api/reference/ach/create_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__post","metadata":{"seo":{"title":"Create ACH Origination","description":"Originate an ACH transaction with the counterparty.This can only be done after creating a Counterparty for the account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__post","name":"Create ACH Origination","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create ACH Origination","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Originate an ACH transaction with the counterparty."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This can only be done after creating a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/counterparties-v2/create_counterparty_api_v2_customers__customer_id__counterparties__post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counterparty"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"ach/create_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__post/request/ach-origination-limitations","deepLinkHash":"/ach/create_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__post#ach/create_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__post/request/ach-origination-limitations"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Origination Limitations"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All transfers that are below 25k and scheduled before 12:00 ET are sent with settlement same-day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All transfers above 25k scheduled before 12:00 ET are sent with settlement next day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All transfers scheduled after 12:00 ET follow the above rules the following day"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ACHRequest"}},"schemaId":"components/schemas/ACHRequest","pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/jiko-accounts/{account_id}/ach-originating/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ACHRequest"}},"responseCodes":["200","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/ach-originating/","href":"ach/create_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__post","openApiOperationId":"create_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__post","summary":"Create ACH Origination"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/ACHRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ACHRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ACHResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ACHResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/post/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ACHResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ACHResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/post/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ach/create_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__post"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/ach-originating/"},{"label":"Get ACH Origination","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/ach/get_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__transfer_id___get","routeSlug":"/products/partner-api/reference/ach/get_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__transfer_id___get","metadata":{"seo":{"title":"Get ACH Origination","description":"Get a specific ACH transfer origination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__transfer_id___get","name":"Get ACH Origination","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1{transfer_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get ACH Origination","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a specific ACH transfer origination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true},{"name":"transfer_id","in":"path","schemaId":"schema_401","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1{transfer_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1{transfer_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jiko-accounts/{account_id}/ach-originating/{transfer_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"},{"name":"transfer_id","in":"path","required":true,"schemaId":"schema_401"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/ach-originating/{transfer_id}/","href":"ach/get_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__transfer_id___get","openApiOperationId":"get_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__transfer_id___get","summary":"Get ACH Origination"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ACHResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1{transfer_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ACHResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1{transfer_id}~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1{transfer_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ACHResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1{transfer_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ACHResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1{transfer_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ach/get_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__transfer_id___get"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/ach-originating/{transfer_id}/"},{"label":"List Customer ACH Originations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/ach/list_customer_ach_originations_api_v1_customers__customer_id__ach_originating__get","routeSlug":"/products/partner-api/reference/ach/list_customer_ach_originations_api_v1_customers__customer_id__ach_originating__get","metadata":{"seo":{"title":"List Customer ACH Originations","description":"List all ACH transfer originations across a customer's accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_customer_ach_originations_api_v1_customers__customer_id__ach_originating__get","name":"List Customer ACH Originations","isWebhook":false,"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1ach-originating~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customer ACH Originations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all ACH transfer originations across a customer's accounts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1ach-originating~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[status]","in":"query","schemaId":"schema_399"},{"name":"direction","in":"query","schemaId":"schema_400"},{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_326"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1ach-originating~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1ach-originating~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customers/{customer_id}/ach-originating/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[{"name":"filter[status]","in":"query","required":false,"schemaId":"schema_399"},{"name":"direction","in":"query","required":false,"schemaId":"schema_400"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_326"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/customers/{customer_id}/ach-originating/","href":"ach/list_customer_ach_originations_api_v1_customers__customer_id__ach_originating__get","openApiOperationId":"list_customer_ach_originations_api_v1_customers__customer_id__ach_originating__get","summary":"List Customer ACH Originations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ACHListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1ach-originating~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ACHListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1ach-originating~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1ach-originating~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ACHListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1ach-originating~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ACHListResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1ach-originating~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ach/list_customer_ach_originations_api_v1_customers__customer_id__ach_originating__get"}],"panels":[]}]},"httpPath":"/api/v1/customers/{customer_id}/ach-originating/"}],"content":{"contentType":"group","meta":{"name":"ACH"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ACH","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to create, view, and manage ACH Transfers."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/jiko-accounts/{account_id}/ach-originating/","summary":"List ACH Originations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ach/list_ach_originations_api_v1_jiko_accounts__account_id__ach_originating__get","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/ach-originating/","summary":"Create ACH Origination","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ach/create_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__post","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/ach-originating/{transfer_id}/","summary":"Get ACH Origination","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ach/get_ach_origination_api_v1_jiko_accounts__account_id__ach_originating__transfer_id___get","deprecated":false},{"title":"/api/v1/customers/{customer_id}/ach-originating/","summary":"List Customer ACH Originations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ach/list_customer_ach_originations_api_v1_customers__customer_id__ach_originating__get","deprecated":false}]}]}]}]}},{"type":"group","label":"Counterparties","link":"/products/partner-api/reference/counterparties","routeSlug":"/products/partner-api/reference/counterparties","items":[{"label":"List Counterparties","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/counterparties/list_counterparties_api_v1_customers__customer_id__counterparties__get","routeSlug":"/products/partner-api/reference/counterparties/list_counterparties_api_v1_customers__customer_id__counterparties__get","metadata":{"seo":{"title":"List Counterparties","description":"List all counterparties for a customer. Deprecated: Use List Counterparties instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_counterparties_api_v1_customers__customer_id__counterparties__get","name":"List Counterparties","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Counterparties","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all counterparties for a customer. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/counterparties-v2/list_counterparties_api_v2_customers__customer_id__counterparties__get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List Counterparties"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_402"},{"name":"limit","in":"query","schemaId":"schema_403"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customers/{customer_id}/counterparties/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_402"},{"name":"limit","in":"query","required":false,"schemaId":"schema_403"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/customers/{customer_id}/counterparties/","href":"counterparties/list_counterparties_api_v1_customers__customer_id__counterparties__get","openApiOperationId":"list_counterparties_api_v1_customers__customer_id__counterparties__get","summary":"List Counterparties"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCounterpartiesResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListCounterpartiesResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCounterpartiesResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCounterpartiesResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/counterparties/list_counterparties_api_v1_customers__customer_id__counterparties__get"}],"panels":[]}]},"httpPath":"/api/v1/customers/{customer_id}/counterparties/"},{"label":"Get Counterparty","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/counterparties/get_counterparty_api_v1_customers__customer_id__counterparties__counterparty_id___get","routeSlug":"/products/partner-api/reference/counterparties/get_counterparty_api_v1_customers__customer_id__counterparties__counterparty_id___get","metadata":{"seo":{"title":"Get Counterparty","description":"Deprecated: Use Get Counterparty instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_counterparty_api_v1_customers__customer_id__counterparties__counterparty_id___get","name":"Get Counterparty","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Counterparty","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/counterparties-v2/get_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Counterparty"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Poll this endpoint to monitor the progress of the verification process for a single counterparty."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"counterparties/get_counterparty_api_v1_customers__customer_id__counterparties__counterparty_id___get/request/plaid:","deepLinkHash":"/counterparties/get_counterparty_api_v1_customers__customer_id__counterparties__counterparty_id___get#counterparties/get_counterparty_api_v1_customers__customer_id__counterparties__counterparty_id___get/request/plaid:"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plaid:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"plaid.verification_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_MANUAL_VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the user is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://plaid.com/docs/auth/coverage/same-day/","target":"_blank","rel":" noreferrer noopener"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same Day Micro-deposits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flow and must return in 1-2 business days and go through the Plaid Link flow again, this time using a new Link token where the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"counterparty_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is passed to Jiko."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true},{"name":"counterparty_id","in":"path","schemaId":"schema_404","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customers/{customer_id}/counterparties/{counterparty_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"},{"name":"counterparty_id","in":"path","required":true,"schemaId":"schema_404"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/customers/{customer_id}/counterparties/{counterparty_id}/","href":"counterparties/get_counterparty_api_v1_customers__customer_id__counterparties__counterparty_id___get","openApiOperationId":"get_counterparty_api_v1_customers__customer_id__counterparties__counterparty_id___get","summary":"Get Counterparty"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Counterparty","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Counterparty","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Counterparty","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Counterparty","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/counterparties/get_counterparty_api_v1_customers__customer_id__counterparties__counterparty_id___get"}],"panels":[]}]},"httpPath":"/api/v1/customers/{customer_id}/counterparties/{counterparty_id}/"}],"content":{"contentType":"group","meta":{"name":"Counterparties"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Counterparties","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these endpoints to view Counterparties. Counterparties represent external accounts when moving funds in or out of a Jiko Account. Jiko will only transfer funds between accounts where the Counterparty has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: “VERIFIED”"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", meaning ownership of the account has been confirmed."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/customers/{customer_id}/counterparties/","summary":"List Counterparties","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/counterparties/list_counterparties_api_v1_customers__customer_id__counterparties__get","deprecated":true},{"title":"/api/v1/customers/{customer_id}/counterparties/{counterparty_id}/","summary":"Get Counterparty","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/counterparties/get_counterparty_api_v1_customers__customer_id__counterparties__counterparty_id___get","deprecated":true}]}]}]}]}},{"type":"group","label":"On-Us Transfers","link":"/products/partner-api/reference/on-us-transfers","routeSlug":"/products/partner-api/reference/on-us-transfers","items":[{"label":"Create On-Us Transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/on-us-transfers/create-on-us-transfer","routeSlug":"/products/partner-api/reference/on-us-transfers/create-on-us-transfer","metadata":{"seo":{"title":"Create On-Us Transfer","description":"Initiates an On-Us Transfer between two Pockets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-on-us-transfer","name":"Create On-Us Transfer","isWebhook":false,"pointer":"/paths/~1api~1v1~1transfers~1on-us~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create On-Us Transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates an On-Us Transfer between two Pockets."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On-Us Transfers can be made in four directions (defined by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTNER_CUSTOMER_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": From a Partner’s Pocket to a Customer’s Pocket"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTNER_CUSTOMER_DEFUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": From a Customer’s Pocket to a Partner’s Pocket"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNAL_REALLOCATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Between two Pockets belonging to the same Customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PEER_TO_PEER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": From a Customer’s Pockets to Customer’s On-Us Counterparty"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On-Us Transfer amounts can be specified two ways (defined by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUESTED_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Transfer a specified dollar amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FULL_WITHDRAWAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Transfer the Pocket's total available balance (net of fees). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FULL_WITHDRAWAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTNER_CUSTOMER_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On-Us Transfers can be processed asynchronously or synchronously. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We strongly recommend processing On-Us Transfers asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"async_mode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Asynchronous transfers will be created in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state and status updates will be delivered via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/guides/building/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1transfers~1on-us~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OnUsTransferDetailsRequest"}},"schemaId":"components/schemas/OnUsTransferDetailsRequest","pointer":"/paths/~1api~1v1~1transfers~1on-us~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/transfers/on-us/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OnUsTransferDetailsRequest"}},"responseCodes":["201","422"],"pointer":"/api/v1/transfers/on-us/","href":"on-us-transfers/create-on-us-transfer","openApiOperationId":"create-on-us-transfer","summary":"Create On-Us Transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/OnUsTransferDetailsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OnUsTransferDetailsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OnUsTransfer","exampleIds":["paths/~1api~1v1~1transfers~1on-us~1/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/OnUsTransfer","exampleIds":["paths/~1api~1v1~1transfers~1on-us~1/post/responses/201/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1transfers~1on-us~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/OnUsTransfer","exampleIds":["paths/~1api~1v1~1transfers~1on-us~1/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OnUsTransfer","exampleIds":["paths/~1api~1v1~1transfers~1on-us~1/post/responses/201/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/on-us-transfers/create-on-us-transfer"}],"panels":[]}]},"httpPath":"/api/v1/transfers/on-us/"},{"label":"Quote Same-Entity Security Transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/on-us-transfers/preview-on-us-transfer","routeSlug":"/products/partner-api/reference/on-us-transfers/preview-on-us-transfer","metadata":{"seo":{"title":"Quote Same-Entity Security Transfer","description":"Returns a dry-run quote for a same-entity on-us security transfer (an INTERNAL_REALLOCATION of type SECURITY_TRANSFER), running the same validation and ruleset evaluation as creating the transfer but booking no trades and persisting nothing. The quote reports whether the transfer would be allowed, its settlement type, and the eligible transfer amount. Only the security-transfer type is quotable; other on-us types are rejected. It is indicative only: a successful quote is not a guarantee that the transfer will book."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"preview-on-us-transfer","name":"Quote Same-Entity Security Transfer","isWebhook":false,"pointer":"/paths/~1api~1v1~1transfers~1on-us~1quotes~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote Same-Entity Security Transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a dry-run quote for a same-entity on-us security transfer (an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNAL_REALLOCATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SECURITY_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), running the same validation and ruleset evaluation as creating the transfer but booking no trades and persisting nothing. The quote reports whether the transfer would be allowed, its settlement type, and the eligible transfer amount. Only the security-transfer type is quotable; other on-us types are rejected. It is indicative only: a successful quote is not a guarantee that the transfer will book."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1transfers~1on-us~1quotes~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OnUsTransferQuoteRequest"}},"schemaId":"components/schemas/OnUsTransferQuoteRequest","pointer":"/paths/~1api~1v1~1transfers~1on-us~1quotes~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/transfers/on-us/quotes/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OnUsTransferQuoteRequest"}},"responseCodes":["200","422"],"pointer":"/api/v1/transfers/on-us/quotes/","href":"on-us-transfers/preview-on-us-transfer","openApiOperationId":"preview-on-us-transfer","summary":"Quote Same-Entity Security Transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/OnUsTransferQuoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OnUsTransferQuoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OnUsTransferQuote","exampleIds":["paths/~1api~1v1~1transfers~1on-us~1quotes~1/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/OnUsTransferQuote","exampleIds":["paths/~1api~1v1~1transfers~1on-us~1quotes~1/post/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1transfers~1on-us~1quotes~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OnUsTransferQuote","exampleIds":["paths/~1api~1v1~1transfers~1on-us~1quotes~1/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OnUsTransferQuote","exampleIds":["paths/~1api~1v1~1transfers~1on-us~1quotes~1/post/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/on-us-transfers/preview-on-us-transfer"}],"panels":[]}]},"httpPath":"/api/v1/transfers/on-us/quotes/"},{"label":"Get On-Us Transfer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/on-us-transfers/get-on-us-transfer","routeSlug":"/products/partner-api/reference/on-us-transfers/get-on-us-transfer","metadata":{"seo":{"title":"Get On-Us Transfer","description":"Gets a single on-us transfer by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-on-us-transfer","name":"Get On-Us Transfer","isWebhook":false,"pointer":"/paths/~1api~1v1~1transfers~1on-us~1{transfer_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get On-Us Transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a single on-us transfer by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_id","in":"path","schemaId":"schema_401","required":true}],"pointer":"/paths/~1api~1v1~1transfers~1on-us~1{transfer_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1transfers~1on-us~1{transfer_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/transfers/on-us/{transfer_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"transfer_id","in":"path","required":true,"schemaId":"schema_401"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/transfers/on-us/{transfer_id}/","href":"on-us-transfers/get-on-us-transfer","openApiOperationId":"get-on-us-transfer","summary":"Get On-Us Transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OnUsTransfer","exampleIds":["paths/~1api~1v1~1transfers~1on-us~1{transfer_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/OnUsTransfer","exampleIds":["paths/~1api~1v1~1transfers~1on-us~1{transfer_id}~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1transfers~1on-us~1{transfer_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OnUsTransfer","exampleIds":["paths/~1api~1v1~1transfers~1on-us~1{transfer_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OnUsTransfer","exampleIds":["paths/~1api~1v1~1transfers~1on-us~1{transfer_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/on-us-transfers/get-on-us-transfer"}],"panels":[]}]},"httpPath":"/api/v1/transfers/on-us/{transfer_id}/"}],"content":{"contentType":"group","meta":{"name":"On-Us Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"On-Us Transfers","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to create and view On-Us (Book) Transfers between Jiko accounts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/transfers/on-us/","summary":"Create On-Us Transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/on-us-transfers/create-on-us-transfer","deprecated":false},{"title":"/api/v1/transfers/on-us/quotes/","summary":"Quote Same-Entity Security Transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/on-us-transfers/preview-on-us-transfer","deprecated":false},{"title":"/api/v1/transfers/on-us/{transfer_id}/","summary":"Get On-Us Transfer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/on-us-transfers/get-on-us-transfer","deprecated":false}]}]}]}]}},{"type":"group","label":"Portals","link":"/products/partner-api/reference/portals","routeSlug":"/products/partner-api/reference/portals","items":[{"label":"List Portals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals/list_account_portals_api_v1_jiko_accounts__account_id__portals__get","routeSlug":"/products/partner-api/reference/portals/list_account_portals_api_v1_jiko_accounts__account_id__portals__get","metadata":{"seo":{"title":"List Portals","description":"Get a list of portals associated with an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_account_portals_api_v1_jiko_accounts__account_id__portals__get","name":"List Portals","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Portals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of portals associated with an account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jiko-accounts/{account_id}/portals/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/portals/","href":"portals/list_account_portals_api_v1_jiko_accounts__account_id__portals__get","openApiOperationId":"list_account_portals_api_v1_jiko_accounts__account_id__portals__get","summary":"List Portals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPortalsResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListPortalsResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPortalsResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPortalsResponse","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/list_account_portals_api_v1_jiko_accounts__account_id__portals__get"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/portals/"},{"label":"Create Portal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals/create_portal_api_v1_jiko_accounts__account_id__portals__post","routeSlug":"/products/partner-api/reference/portals/create_portal_api_v1_jiko_accounts__account_id__portals__post","metadata":{"seo":{"title":"Create Portal","description":"Create a portal for an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_portal_api_v1_jiko_accounts__account_id__portals__post","name":"Create Portal","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Portal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a portal for an account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortalCreateRequest"}},"schemaId":"components/schemas/PortalCreateRequest","pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/jiko-accounts/{account_id}/portals/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PortalCreateRequest"}},"responseCodes":["201","404","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/portals/","href":"portals/create_portal_api_v1_jiko_accounts__account_id__portals__post","openApiOperationId":"create_portal_api_v1_jiko_accounts__account_id__portals__post","summary":"Create Portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/PortalCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortalCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Portal","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/Portal","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/post/responses/201/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Portal","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Portal","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/post/responses/201/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/create_portal_api_v1_jiko_accounts__account_id__portals__post"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/portals/"},{"label":"Get Account Portal","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals/get-account-portal","routeSlug":"/products/partner-api/reference/portals/get-account-portal","metadata":{"seo":{"title":"Get Account Portal","description":"Get a specific portal associated with an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-account-portal","name":"Get Account Portal","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Account Portal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a specific portal associated with an account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true},{"name":"portal_id","in":"path","schemaId":"schema_405","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/jiko-accounts/{account_id}/portals/{portal_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"},{"name":"portal_id","in":"path","required":true,"schemaId":"schema_405"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/portals/{portal_id}/","href":"portals/get-account-portal","openApiOperationId":"get-account-portal","summary":"Get Account Portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Portal","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Portal","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Portal","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Portal","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/get-account-portal"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/portals/{portal_id}/"},{"label":"Update Portal","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals/update_portal_api_v1_jiko_accounts__account_id__portals__portal_id___patch","routeSlug":"/products/partner-api/reference/portals/update_portal_api_v1_jiko_accounts__account_id__portals__portal_id___patch","metadata":{"seo":{"title":"Update Portal","description":"Update a portal's name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_portal_api_v1_jiko_accounts__account_id__portals__portal_id___patch","name":"Update Portal","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Portal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a portal's name."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true},{"name":"portal_id","in":"path","schemaId":"schema_405","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/partner_api__interface__models__portals__PortalUpdateRequest"}},"schemaId":"components/schemas/partner_api__interface__models__portals__PortalUpdateRequest","pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/jiko-accounts/{account_id}/portals/{portal_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"},{"name":"portal_id","in":"path","required":true,"schemaId":"schema_405"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/partner_api__interface__models__portals__PortalUpdateRequest"}},"responseCodes":["200","404","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/portals/{portal_id}/","href":"portals/update_portal_api_v1_jiko_accounts__account_id__portals__portal_id___patch","openApiOperationId":"update_portal_api_v1_jiko_accounts__account_id__portals__portal_id___patch","summary":"Update Portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/partner_api__interface__models__portals__PortalUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/partner_api__interface__models__portals__PortalUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Portal","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Portal","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/patch/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Portal","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Portal","exampleIds":["paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/patch/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/update_portal_api_v1_jiko_accounts__account_id__portals__portal_id___patch"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/portals/{portal_id}/"},{"label":"Close Portal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals/close_portal_api_v1_jiko_accounts__account_id__portals__portal_id__close__post","routeSlug":"/products/partner-api/reference/portals/close_portal_api_v1_jiko_accounts__account_id__portals__portal_id__close__post","metadata":{"seo":{"title":"Close Portal","description":"Close a portal. This is an irreversible action."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"close_portal_api_v1_jiko_accounts__account_id__portals__portal_id__close__post","name":"Close Portal","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1close~1/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close Portal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Close a portal. This is an irreversible action."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true},{"name":"portal_id","in":"path","schemaId":"schema_405","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1close~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1close~1/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/jiko-accounts/{account_id}/portals/{portal_id}/close/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"},{"name":"portal_id","in":"path","required":true,"schemaId":"schema_405"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","404","412","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/portals/{portal_id}/close/","href":"portals/close_portal_api_v1_jiko_accounts__account_id__portals__portal_id__close__post","openApiOperationId":"close_portal_api_v1_jiko_accounts__account_id__portals__portal_id__close__post","summary":"Close Portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful Response"},{"code":"404","description":"Not found"},{"code":"412","description":"Portal is already closed."},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1close~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"404"},{"code":"412"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/close_portal_api_v1_jiko_accounts__account_id__portals__portal_id__close__post"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/portals/{portal_id}/close/"},{"label":"List Customer Portals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals/list_customer_portals_api_v1_customers__customer_id__portals__get","routeSlug":"/products/partner-api/reference/portals/list_customer_portals_api_v1_customers__customer_id__portals__get","metadata":{"seo":{"title":"List Customer Portals","description":"Get a list of portals associated with customer's accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_customer_portals_api_v1_customers__customer_id__portals__get","name":"List Customer Portals","isWebhook":false,"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1portals~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customer Portals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of portals associated with customer's accounts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1portals~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1portals~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customers/{customer_id}/portals/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","404","422"],"pointer":"/api/v1/customers/{customer_id}/portals/","href":"portals/list_customer_portals_api_v1_customers__customer_id__portals__get","openApiOperationId":"list_customer_portals_api_v1_customers__customer_id__portals__get","summary":"List Customer Portals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPortalsResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1portals~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListPortalsResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1portals~1/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not found"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1customers~1{customer_id}~1portals~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPortalsResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1portals~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPortalsResponse","exampleIds":["paths/~1api~1v1~1customers~1{customer_id}~1portals~1/get/responses/200/content/application~1json/example"]}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals/list_customer_portals_api_v1_customers__customer_id__portals__get"}],"panels":[]}]},"httpPath":"/api/v1/customers/{customer_id}/portals/"}],"content":{"contentType":"group","meta":{"name":"Portals"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Portals","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to create and view Portals. Portals allow third-party financial institutions to initiate ACH and wire transfers. A Portal consists of a routing and an account number. Multiple Portals can be created for a single Pocket."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/jiko-accounts/{account_id}/portals/","summary":"List Portals","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portals/list_account_portals_api_v1_jiko_accounts__account_id__portals__get","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/portals/","summary":"Create Portal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/portals/create_portal_api_v1_jiko_accounts__account_id__portals__post","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/portals/{portal_id}/","summary":"Get Account Portal","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portals/get-account-portal","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/portals/{portal_id}/","summary":"Update Portal","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/portals/update_portal_api_v1_jiko_accounts__account_id__portals__portal_id___patch","deprecated":false},{"title":"/api/v1/jiko-accounts/{account_id}/portals/{portal_id}/close/","summary":"Close Portal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/portals/close_portal_api_v1_jiko_accounts__account_id__portals__portal_id__close__post","deprecated":false},{"title":"/api/v1/customers/{customer_id}/portals/","summary":"List Customer Portals","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portals/list_customer_portals_api_v1_customers__customer_id__portals__get","deprecated":false}]}]}]}]}},{"type":"group","label":"Wires","link":"/products/partner-api/reference/wires","routeSlug":"/products/partner-api/reference/wires","items":[{"label":"Create Wire","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/wires/create-wire","routeSlug":"/products/partner-api/reference/wires/create-wire","metadata":{"seo":{"title":"Create Wire","description":"Initiates a Wire Transfer. Wires can only be sent to accounts created and verified via Create Counterparty.Initiating outgoing wire transfers isn’t available by default and must be enabled — please contact your Jiko point of contact to learn more."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-wire","name":"Create Wire","isWebhook":false,"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1wires~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Wire","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a Wire Transfer. Wires can only be sent to accounts created and verified via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/counterparties-v2/create_counterparty_api_v2_customers__customer_id__counterparties__post"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Counterparty"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiating outgoing wire transfers isn’t available by default and must be enabled — please contact your Jiko point of contact to learn more."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When implementing our Wire Transfer entry screens in your application's UI, you must include the following instructions for your end-users: "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"“By using this service, you hereby acknowledge that sending wires to third parties presents an increased risk of fraud, and that as per the terms of your Commercial Bank Account Agreement (the \"Agreement\"), you agree that our security measures are commercially reasonable methods of providing security against unauthorized Funds Transfers, and that you shall be bound by any request for a Funds Transfer received by the Bank, whether or not authorized, issued in your name and accepted by the Bank in compliance with the security measures.”"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_311","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1wires~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1wires~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WireRequest"}},"schemaId":"components/schemas/WireRequest","pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1wires~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/jiko-accounts/{account_id}/wires/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_311"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WireRequest"}},"responseCodes":["201","422"],"pointer":"/api/v1/jiko-accounts/{account_id}/wires/","href":"wires/create-wire","openApiOperationId":"create-wire","summary":"Create Wire"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/WireRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WireRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1jiko-accounts~1{account_id}~1wires~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/wires/create-wire"}],"panels":[]}]},"httpPath":"/api/v1/jiko-accounts/{account_id}/wires/"},{"label":"List Wires","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/wires/list-wires-v1","routeSlug":"/products/partner-api/reference/wires/list-wires-v1","metadata":{"seo":{"title":"List Wires","description":"List Wires"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-wires-v1","name":"List Wires","isWebhook":false,"pointer":"/paths/~1api~1v1~1wires~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Wires","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"customer_id","in":"query","schemaId":"schema_392"},{"name":"pocket_id","in":"query","schemaId":"schema_406"},{"name":"direction","in":"query","schemaId":"schema_407"},{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_326"}],"pointer":"/paths/~1api~1v1~1wires~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1wires~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/wires/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[{"name":"customer_id","in":"query","required":false,"schemaId":"schema_392"},{"name":"pocket_id","in":"query","required":false,"schemaId":"schema_406"},{"name":"direction","in":"query","required":false,"schemaId":"schema_407"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_326"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/wires/","href":"wires/list-wires-v1","openApiOperationId":"list-wires-v1","summary":"List Wires"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Annotated_Union_IncomingWireResponse__OutgoingWireResponse___FieldInfo_annotation_NoneType__required_True__discriminator__direction____"}},"schemaId":"components/schemas/CursorListResponse_Annotated_Union_IncomingWireResponse__OutgoingWireResponse___FieldInfo_annotation_NoneType__required_True__discriminator__direction____"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1wires~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorListResponse_Annotated_Union_IncomingWireResponse__OutgoingWireResponse___FieldInfo_annotation_NoneType__required_True__discriminator__direction____","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Annotated_Union_IncomingWireResponse__OutgoingWireResponse___FieldInfo_annotation_NoneType__required_True__discriminator__direction____"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/wires/list-wires-v1"}],"panels":[]}]},"httpPath":"/api/v1/wires/"},{"label":"Get Wire","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/wires/get-wire-v1","routeSlug":"/products/partner-api/reference/wires/get-wire-v1","metadata":{"seo":{"title":"Get Wire","description":"Get Wire"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-wire-v1","name":"Get Wire","isWebhook":false,"pointer":"/paths/~1api~1v1~1wires~1{wire_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Wire","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"wire_id","in":"path","schemaId":"schema_408","required":true}],"pointer":"/paths/~1api~1v1~1wires~1{wire_id}~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"customer_id","in":"query","schemaId":"schema_392"}],"pointer":"/paths/~1api~1v1~1wires~1{wire_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v1~1wires~1{wire_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/wires/{wire_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"wire_id","in":"path","required":true,"schemaId":"schema_408"}],"query":[{"name":"customer_id","in":"query","required":false,"schemaId":"schema_392"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v1/wires/{wire_id}/","href":"wires/get-wire-v1","openApiOperationId":"get-wire-v1","summary":"Get Wire"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v1~1wires~1{wire_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/wires/get-wire-v1"}],"panels":[]}]},"httpPath":"/api/v1/wires/{wire_id}/"}],"content":{"contentType":"group","meta":{"name":"Wires"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Wires","showPageActions":true},{"nodeType":"markdoc","content":"Use this endpoint to initiate Wire Transfers."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/jiko-accounts/{account_id}/wires/","summary":"Create Wire","prefix":{"name":"post","color":"post"},"badges":[],"link":"/wires/create-wire","deprecated":false},{"title":"/api/v1/wires/","summary":"List Wires","prefix":{"name":"get","color":"get"},"badges":[],"link":"/wires/list-wires-v1","deprecated":false},{"title":"/api/v1/wires/{wire_id}/","summary":"Get Wire","prefix":{"name":"get","color":"get"},"badges":[],"link":"/wires/get-wire-v1","deprecated":false}]}]}]}]}},{"type":"separator","label":"Pockets V2","content":null},{"type":"group","label":"Pockets","link":"/products/partner-api/reference/pockets","routeSlug":"/products/partner-api/reference/pockets","items":[{"label":"Create Pocket","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/create_pocket_api_v2_customers__customer_id__pockets__post","routeSlug":"/products/partner-api/reference/pockets/create_pocket_api_v2_customers__customer_id__pockets__post","metadata":{"seo":{"title":"Create Pocket","description":"Creates a single Pocket for a customer. Trading strategy for the Pocket is specified with a Pocket Configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_pocket_api_v2_customers__customer_id__pockets__post","name":"Create Pocket","isWebhook":false,"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Pocket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a single Pocket for a customer. Trading strategy for the Pocket is specified with a Pocket Configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePocketRequest"}},"schemaId":"components/schemas/CreatePocketRequest","pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/customers/{customer_id}/pockets/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePocketRequest"}},"responseCodes":["201","422"],"pointer":"/api/v2/customers/{customer_id}/pockets/","href":"pockets/create_pocket_api_v2_customers__customer_id__pockets__post","openApiOperationId":"create_pocket_api_v2_customers__customer_id__pockets__post","summary":"Create Pocket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/CreatePocketRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePocketRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pocket","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/Pocket","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/responses/201/content/application~1json/example"]},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/responses/422/content/application~1json/examples/pocket_limit"]}},"schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/responses/422/content/application~1json/examples/pocket_limit"]}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Pocket","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pocket","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/responses/201/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/responses/422/content/application~1json/examples/pocket_limit"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/responses/422/content/application~1json/examples/pocket_limit"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pockets/create_pocket_api_v2_customers__customer_id__pockets__post"}],"panels":[]}]},"httpPath":"/api/v2/customers/{customer_id}/pockets/"},{"label":"List Pockets For Customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/list-pockets-v2","routeSlug":"/products/partner-api/reference/pockets/list-pockets-v2","metadata":{"seo":{"title":"List Pockets For Customer","description":"Retrieve all Pockets for a single Customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-pockets-v2","name":"List Pockets For Customer","isWebhook":false,"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Pockets For Customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all Pockets for a single Customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"omit[]","in":"query","schemaId":"schema_410"},{"name":"offset","in":"query","schemaId":"schema_306"},{"name":"limit","in":"query","schemaId":"schema_393"},{"name":"valuation_type","in":"query","schemaId":"schema_411"},{"name":"filter[status]","in":"query","schemaId":"schema_412"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/customers/{customer_id}/pockets/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[{"name":"omit[]","in":"query","required":false,"schemaId":"schema_410"},{"name":"offset","in":"query","required":false,"schemaId":"schema_306"},{"name":"limit","in":"query","required":false,"schemaId":"schema_393"},{"name":"valuation_type","in":"query","required":false,"schemaId":"schema_411"},{"name":"filter[status]","in":"query","required":false,"schemaId":"schema_412"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/customers/{customer_id}/pockets/","href":"pockets/list-pockets-v2","openApiOperationId":"list-pockets-v2","summary":"List Pockets For Customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pockets","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Pockets","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Pockets","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pockets","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pockets/list-pockets-v2"}],"panels":[]}]},"httpPath":"/api/v2/customers/{customer_id}/pockets/"},{"label":"List Pockets For Customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/list-all-pockets-v2","routeSlug":"/products/partner-api/reference/pockets/list-all-pockets-v2","metadata":{"seo":{"title":"List Pockets For Customers","description":"Retrieve all Pockets for a list of Customers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-all-pockets-v2","name":"List Pockets For Customers","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Pockets For Customers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all Pockets for a list of Customers."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"omit[]","in":"query","schemaId":"schema_410"},{"name":"cursor","in":"query","schemaId":"schema_339"},{"name":"limit","in":"query","schemaId":"schema_393"},{"name":"valuation_type","in":"query","schemaId":"schema_411"},{"name":"filter[status]","in":"query","schemaId":"schema_412"}],"pointer":"/paths/~1api~1v2~1pockets~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/pockets/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[{"name":"omit[]","in":"query","required":false,"schemaId":"schema_410"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_339"},{"name":"limit","in":"query","required":false,"schemaId":"schema_393"},{"name":"valuation_type","in":"query","required":false,"schemaId":"schema_411"},{"name":"filter[status]","in":"query","required":false,"schemaId":"schema_412"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/pockets/","href":"pockets/list-all-pockets-v2","openApiOperationId":"list-all-pockets-v2","summary":"List Pockets For Customers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerPocketsResponse","exampleIds":["paths/~1api~1v2~1pockets~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CustomerPocketsResponse","exampleIds":["paths/~1api~1v2~1pockets~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerPocketsResponse","exampleIds":["paths/~1api~1v2~1pockets~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerPocketsResponse","exampleIds":["paths/~1api~1v2~1pockets~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pockets/list-all-pockets-v2"}],"panels":[]}]},"httpPath":"/api/v2/pockets/"},{"label":"Get Customer Pocket","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/get-pocket-v2","routeSlug":"/products/partner-api/reference/pockets/get-pocket-v2","metadata":{"seo":{"title":"Get Customer Pocket","description":"Retrieve a single Pocket for a given pocket_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-pocket-v2","name":"Get Customer Pocket","isWebhook":false,"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Customer Pocket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a single Pocket for a given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pocket_id."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true},{"name":"pocket_id","in":"path","schemaId":"schema_413","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"omit[]","in":"query","schemaId":"schema_410"},{"name":"valuation_type","in":"query","schemaId":"schema_411"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/customers/{customer_id}/pockets/{pocket_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"},{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_413"}],"query":[{"name":"omit[]","in":"query","required":false,"schemaId":"schema_410"},{"name":"valuation_type","in":"query","required":false,"schemaId":"schema_411"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/customers/{customer_id}/pockets/{pocket_id}/","href":"pockets/get-pocket-v2","openApiOperationId":"get-pocket-v2","summary":"Get Customer Pocket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerPocket","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CustomerPocket","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerPocket","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerPocket","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pockets/get-pocket-v2"}],"panels":[]}]},"httpPath":"/api/v2/customers/{customer_id}/pockets/{pocket_id}/"},{"label":"Update Pocket","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/update-pocket-v2","routeSlug":"/products/partner-api/reference/pockets/update-pocket-v2","metadata":{"seo":{"title":"Update Pocket","description":"Update a Pocket's name, or update a Pocket's status. If the intent is to close a Pocket, then there are two requirements: The Pocket needs to be empty, and there has to be at least one other open Pocket belonging to the customer. Additionally, when you close a Pocket, you also need to pass a closure_reason along with the status update."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-pocket-v2","name":"Update Pocket","isWebhook":false,"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Pocket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a Pocket's name, or update a Pocket's status. If the intent is to close a Pocket, then there are two requirements: The Pocket needs to be empty, and there has to be at least one other open Pocket belonging to the customer. Additionally, when you close a Pocket, you also need to pass a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closure_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" along with the status update."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true},{"name":"pocket_id","in":"path","schemaId":"schema_413","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePocketRequest","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/requestBody/content/application~1json/examples/pocket_name","paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/requestBody/content/application~1json/examples/close"]}},"schemaId":"components/schemas/UpdatePocketRequest","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/requestBody/content/application~1json/examples/pocket_name","paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/requestBody/content/application~1json/examples/close"],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v2/customers/{customer_id}/pockets/{pocket_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"},{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_413"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePocketRequest","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/requestBody/content/application~1json/examples/pocket_name","paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/requestBody/content/application~1json/examples/close"]}},"responseCodes":["200","422"],"pointer":"/api/v2/customers/{customer_id}/pockets/{pocket_id}/","href":"pockets/update-pocket-v2","openApiOperationId":"update-pocket-v2","summary":"Update Pocket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/UpdatePocketRequest","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/requestBody/content/application~1json/examples/pocket_name","paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/requestBody/content/application~1json/examples/close"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePocketRequest","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/requestBody/content/application~1json/examples/pocket_name","paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/requestBody/content/application~1json/examples/close"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pocket","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/Pocket","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/200/content/application~1json/example"]},{"code":"422","description":"Unprocessable Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/422/content/application~1json/examples/invalid_transition","paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/422/content/application~1json/examples/pocket_has_balance"]}},"schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/422/content/application~1json/examples/invalid_transition","paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/422/content/application~1json/examples/pocket_has_balance"]}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Pocket","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pocket","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/422/content/application~1json/examples/invalid_transition","paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/422/content/application~1json/examples/pocket_has_balance"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseModel","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/422/content/application~1json/examples/invalid_transition","paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/422/content/application~1json/examples/pocket_has_balance"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pockets/update-pocket-v2"}],"panels":[]}]},"httpPath":"/api/v2/customers/{customer_id}/pockets/{pocket_id}/"},{"label":"Get Pocket","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/get-single-pocket-v2","routeSlug":"/products/partner-api/reference/pockets/get-single-pocket-v2","metadata":{"seo":{"title":"Get Pocket","description":"Retrieve a single Pocket for a given pocket_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-single-pocket-v2","name":"Get Pocket","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Pocket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a single Pocket for a given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pocket_id."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pocket_id","in":"path","schemaId":"schema_413","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"omit[]","in":"query","schemaId":"schema_410"},{"name":"valuation_type","in":"query","schemaId":"schema_411"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/pockets/{pocket_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_413"}],"query":[{"name":"omit[]","in":"query","required":false,"schemaId":"schema_410"},{"name":"valuation_type","in":"query","required":false,"schemaId":"schema_411"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/pockets/{pocket_id}/","href":"pockets/get-single-pocket-v2","openApiOperationId":"get-single-pocket-v2","summary":"Get Pocket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerPocket","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CustomerPocket","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerPocket","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerPocket","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pockets/get-single-pocket-v2"}],"panels":[]}]},"httpPath":"/api/v2/pockets/{pocket_id}/"},{"label":"Get Earnings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/get-earnings-v2","routeSlug":"/products/partner-api/reference/pockets/get-earnings-v2","metadata":{"seo":{"title":"Get Earnings","description":"Get Earnings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-earnings-v2","name":"Get Earnings","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1earnings~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Earnings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pocket_id","in":"path","schemaId":"schema_413","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1earnings~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"period","in":"query","schemaId":"schema_414","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period to fetch earnings for. Can be one of"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ytd (Year-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mtd (Month-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wtd (Week-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all-time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"range"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When 'range' is chosen, you need to specify 'date_from' and 'date_to' (inclusive)."},"children":[]}]}]}]},{"name":"date_from","in":"query","schemaId":"schema_415"},{"name":"date_to","in":"query","schemaId":"schema_416"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1earnings~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1earnings~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/pockets/{pocket_id}/earnings/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_413"}],"query":[{"name":"period","in":"query","required":false,"schemaId":"schema_414"},{"name":"date_from","in":"query","required":false,"schemaId":"schema_415"},{"name":"date_to","in":"query","required":false,"schemaId":"schema_416"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/pockets/{pocket_id}/earnings/","href":"pockets/get-earnings-v2","openApiOperationId":"get-earnings-v2","summary":"Get Earnings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EarningsResponse","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1earnings~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EarningsResponse","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1earnings~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1earnings~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EarningsResponse","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1earnings~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EarningsResponse","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1earnings~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pockets/get-earnings-v2"}],"panels":[]}]},"httpPath":"/api/v2/pockets/{pocket_id}/earnings/"},{"label":"Get Customer Earnings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/pockets/get-customer-earnings-v2","routeSlug":"/products/partner-api/reference/pockets/get-customer-earnings-v2","metadata":{"seo":{"title":"Get Customer Earnings","description":"Returns current-period earnings for each of a customer's Pockets plus their exact aggregate, in a single call. The aggregate is the field-wise sum of the per-Pocket entries (sum of earnings, sum of appreciation_per_second, earliest pricing_timestamp), so it always matches the total of the individual rows. By default every Pocket that is not closed is covered; a closed Pocket's earnings can still be fetched by listing it explicitly in pocket_id[]. At most 30 Pockets can be covered per call — a request covering more is rejected with a 400 and should be narrowed with the pocket_id[] filter. Only the defined periods (wtd, mtd, ytd, all-time) are supported — for a custom date range, use the single-Pocket earnings endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-customer-earnings-v2","name":"Get Customer Earnings","isWebhook":false,"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1earnings~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Customer Earnings","badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns current-period earnings for each of a customer's Pockets plus their exact aggregate, in a single call. The aggregate is the field-wise sum of the per-Pocket entries (sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"earnings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appreciation_per_second"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", earliest "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), so it always matches the total of the individual rows. By default every Pocket that is not closed is covered; a closed Pocket's earnings can still be fetched by listing it explicitly in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pocket_id[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". At most 30 Pockets can be covered per call — a request covering more is rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and should be narrowed with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pocket_id[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter. Only the defined periods ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wtd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mtd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ytd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all-time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are supported — for a custom date range, use the single-Pocket earnings endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1earnings~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"period","in":"query","schemaId":"schema_417","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period to fetch earnings for. Can be one of"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ytd (Year-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mtd (Month-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wtd (Week-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all-time"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom date ranges are not supported at the customer level; use the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single-pocket earnings endpoint with 'range' instead."},"children":[]}]}]}]},{"name":"pocket_id[]","in":"query","schemaId":"schema_418","description":"Restricts the earnings to the given pockets. Defaults to all of the customer's pockets except closed ones; a closed pocket's earnings are included only when it is listed here explicitly."}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1earnings~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1earnings~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/customers/{customer_id}/earnings/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[{"name":"period","in":"query","required":false,"schemaId":"schema_417"},{"name":"pocket_id[]","in":"query","required":false,"schemaId":"schema_418"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/customers/{customer_id}/earnings/","href":"pockets/get-customer-earnings-v2","openApiOperationId":"get-customer-earnings-v2","summary":"Get Customer Earnings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerEarningsResponse"}},"schemaId":"components/schemas/CustomerEarningsResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1earnings~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomerEarningsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomerEarningsResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pockets/get-customer-earnings-v2"}],"panels":[]}]},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v2/customers/{customer_id}/earnings/"}],"content":{"contentType":"group","meta":{"name":"Pockets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pockets","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/customers/{customer_id}/pockets/","summary":"Create Pocket","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pockets/create_pocket_api_v2_customers__customer_id__pockets__post","deprecated":false},{"title":"/api/v2/customers/{customer_id}/pockets/","summary":"List Pockets For Customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pockets/list-pockets-v2","deprecated":false},{"title":"/api/v2/pockets/","summary":"List Pockets For Customers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pockets/list-all-pockets-v2","deprecated":false},{"title":"/api/v2/customers/{customer_id}/pockets/{pocket_id}/","summary":"Get Customer Pocket","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pockets/get-pocket-v2","deprecated":false},{"title":"/api/v2/customers/{customer_id}/pockets/{pocket_id}/","summary":"Update Pocket","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/pockets/update-pocket-v2","deprecated":false},{"title":"/api/v2/pockets/{pocket_id}/","summary":"Get Pocket","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pockets/get-single-pocket-v2","deprecated":false},{"title":"/api/v2/pockets/{pocket_id}/earnings/","summary":"Get Earnings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pockets/get-earnings-v2","deprecated":false},{"title":"/api/v2/customers/{customer_id}/earnings/","summary":"Get Customer Earnings","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"link":"/pockets/get-customer-earnings-v2","deprecated":false}]}]}]}]}},{"type":"group","label":"Portals V2","link":"/products/partner-api/reference/portals-v2","routeSlug":"/products/partner-api/reference/portals-v2","items":[{"label":"List Portals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals-v2/list_pocket_portals_api_v2_pockets__pocket_id__portals__get","routeSlug":"/products/partner-api/reference/portals-v2/list_pocket_portals_api_v2_pockets__pocket_id__portals__get","metadata":{"seo":{"title":"List Portals","description":"Get a list of portals associated with a pocket."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_pocket_portals_api_v2_pockets__pocket_id__portals__get","name":"List Portals","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Portals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of portals associated with a pocket."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pocket_id","in":"path","schemaId":"schema_413","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type[]","in":"query","schemaId":"schema_419"},{"name":"status[]","in":"query","schemaId":"schema_420"},{"name":"cursor","in":"query","schemaId":"schema_339"},{"name":"limit","in":"query","schemaId":"schema_338"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/pockets/{pocket_id}/portals/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_413"}],"query":[{"name":"type[]","in":"query","required":false,"schemaId":"schema_419"},{"name":"status[]","in":"query","required":false,"schemaId":"schema_420"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_339"},{"name":"limit","in":"query","required":false,"schemaId":"schema_338"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/pockets/{pocket_id}/portals/","href":"portals-v2/list_pocket_portals_api_v2_pockets__pocket_id__portals__get","openApiOperationId":"list_pocket_portals_api_v2_pockets__pocket_id__portals__get","summary":"List Portals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalListResponse","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PortalListResponse","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PortalListResponse","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalListResponse","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals-v2/list_pocket_portals_api_v2_pockets__pocket_id__portals__get"}],"panels":[]}]},"httpPath":"/api/v2/pockets/{pocket_id}/portals/"},{"label":"Create Portal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals-v2/create_portal_api_v2_pockets__pocket_id__portals__post","routeSlug":"/products/partner-api/reference/portals-v2/create_portal_api_v2_pockets__pocket_id__portals__post","metadata":{"seo":{"title":"Create Portal","description":"Create a portal for an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_portal_api_v2_pockets__pocket_id__portals__post","name":"Create Portal","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Portal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a portal for an account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pocket_id","in":"path","schemaId":"schema_413","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_421"}},"schemaId":"schema_421","pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/pockets/{pocket_id}/portals/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_413"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_421"}},"responseCodes":["201","422"],"pointer":"/api/v2/pockets/{pocket_id}/portals/","href":"portals-v2/create_portal_api_v2_pockets__pocket_id__portals__post","openApiOperationId":"create_portal_api_v2_pockets__pocket_id__portals__post","summary":"Create Portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_421","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_421"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_422","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_422","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/post/responses/201/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_422","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_422","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/post/responses/201/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals-v2/create_portal_api_v2_pockets__pocket_id__portals__post"}],"panels":[]}]},"httpPath":"/api/v2/pockets/{pocket_id}/portals/"},{"label":"List Customer Portals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals-v2/list_customer_portals_api_v2_customers__customer_id__portals__get","routeSlug":"/products/partner-api/reference/portals-v2/list_customer_portals_api_v2_customers__customer_id__portals__get","metadata":{"seo":{"title":"List Customer Portals","description":"Get a list of portals associated with customer's pockets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_customer_portals_api_v2_customers__customer_id__portals__get","name":"List Customer Portals","isWebhook":false,"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1portals~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customer Portals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of portals associated with customer's pockets."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1portals~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type[]","in":"query","schemaId":"schema_419"},{"name":"status[]","in":"query","schemaId":"schema_420"},{"name":"cursor","in":"query","schemaId":"schema_339"},{"name":"limit","in":"query","schemaId":"schema_338"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1portals~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1portals~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/customers/{customer_id}/portals/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[{"name":"type[]","in":"query","required":false,"schemaId":"schema_419"},{"name":"status[]","in":"query","required":false,"schemaId":"schema_420"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_339"},{"name":"limit","in":"query","required":false,"schemaId":"schema_338"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/customers/{customer_id}/portals/","href":"portals-v2/list_customer_portals_api_v2_customers__customer_id__portals__get","openApiOperationId":"list_customer_portals_api_v2_customers__customer_id__portals__get","summary":"List Customer Portals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalListResponse","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1portals~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PortalListResponse","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1portals~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1portals~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PortalListResponse","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1portals~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalListResponse","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1portals~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals-v2/list_customer_portals_api_v2_customers__customer_id__portals__get"}],"panels":[]}]},"httpPath":"/api/v2/customers/{customer_id}/portals/"},{"label":"Get Account Portal","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals-v2/get-pocket-portal","routeSlug":"/products/partner-api/reference/portals-v2/get-pocket-portal","metadata":{"seo":{"title":"Get Account Portal","description":"Get a specific portal associated with an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-pocket-portal","name":"Get Account Portal","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Account Portal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a specific portal associated with an account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pocket_id","in":"path","schemaId":"schema_413","required":true},{"name":"portal_id","in":"path","schemaId":"schema_405","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_413"},{"name":"portal_id","in":"path","required":true,"schemaId":"schema_405"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/","href":"portals-v2/get-pocket-portal","openApiOperationId":"get-pocket-portal","summary":"Get Account Portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_423","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_423","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals-v2/get-pocket-portal"}],"panels":[]}]},"httpPath":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/"},{"label":"Update Portal","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals-v2/update_portal_api_v2_pockets__pocket_id__portals__portal_id___patch","routeSlug":"/products/partner-api/reference/portals-v2/update_portal_api_v2_pockets__pocket_id__portals__portal_id___patch","metadata":{"seo":{"title":"Update Portal","description":"Update a portal's name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_portal_api_v2_pockets__pocket_id__portals__portal_id___patch","name":"Update Portal","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Portal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a portal's name."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pocket_id","in":"path","schemaId":"schema_413","required":true},{"name":"portal_id","in":"path","schemaId":"schema_405","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/partner_api__interface__models__v2__portals__PortalUpdateRequest"}},"schemaId":"components/schemas/partner_api__interface__models__v2__portals__PortalUpdateRequest","pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_413"},{"name":"portal_id","in":"path","required":true,"schemaId":"schema_405"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/partner_api__interface__models__v2__portals__PortalUpdateRequest"}},"responseCodes":["200","422"],"pointer":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/","href":"portals-v2/update_portal_api_v2_pockets__pocket_id__portals__portal_id___patch","openApiOperationId":"update_portal_api_v2_pockets__pocket_id__portals__portal_id___patch","summary":"Update Portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/partner_api__interface__models__v2__portals__PortalUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/partner_api__interface__models__v2__portals__PortalUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_424","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_424","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/patch/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_424","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_424","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/patch/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals-v2/update_portal_api_v2_pockets__pocket_id__portals__portal_id___patch"}],"panels":[]}]},"httpPath":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/"},{"label":"Get Funding Instructions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/portals-v2/portal-list-funding-instructions","routeSlug":"/products/partner-api/reference/portals-v2/portal-list-funding-instructions","metadata":{"seo":{"title":"Get Funding Instructions","description":"Returns funding instructions for all payment rails supported by the portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"portal-list-funding-instructions","name":"Get Funding Instructions","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1funding-instructions~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Funding Instructions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns funding instructions for all payment rails supported by the portal."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pocket_id","in":"path","schemaId":"schema_413","required":true},{"name":"portal_id","in":"path","schemaId":"schema_405","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1funding-instructions~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1funding-instructions~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/funding-instructions/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_413"},{"name":"portal_id","in":"path","required":true,"schemaId":"schema_405"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/funding-instructions/","href":"portals-v2/portal-list-funding-instructions","openApiOperationId":"portal-list-funding-instructions","summary":"Get Funding Instructions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundingInstructionsResponse","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1funding-instructions~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/FundingInstructionsResponse","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1funding-instructions~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1funding-instructions~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FundingInstructionsResponse","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1funding-instructions~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundingInstructionsResponse","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1funding-instructions~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/portals-v2/portal-list-funding-instructions"}],"panels":[]}]},"httpPath":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/funding-instructions/"}],"content":{"contentType":"group","meta":{"name":"Portals V2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Portals V2","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/pockets/{pocket_id}/portals/","summary":"List Portals","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portals-v2/list_pocket_portals_api_v2_pockets__pocket_id__portals__get","deprecated":false},{"title":"/api/v2/pockets/{pocket_id}/portals/","summary":"Create Portal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/portals-v2/create_portal_api_v2_pockets__pocket_id__portals__post","deprecated":false},{"title":"/api/v2/customers/{customer_id}/portals/","summary":"List Customer Portals","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portals-v2/list_customer_portals_api_v2_customers__customer_id__portals__get","deprecated":false},{"title":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/","summary":"Get Account Portal","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portals-v2/get-pocket-portal","deprecated":false},{"title":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/","summary":"Update Portal","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/portals-v2/update_portal_api_v2_pockets__pocket_id__portals__portal_id___patch","deprecated":false},{"title":"/api/v2/pockets/{pocket_id}/portals/{portal_id}/funding-instructions/","summary":"Get Funding Instructions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/portals-v2/portal-list-funding-instructions","deprecated":false}]}]}]}]}},{"type":"group","label":"Trading Strategies","link":"/products/partner-api/reference/trading-strategies","routeSlug":"/products/partner-api/reference/trading-strategies","items":[{"label":"List Trading Strategies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/trading-strategies/list_trading_strategies_api_v2_trading_strategies__get","routeSlug":"/products/partner-api/reference/trading-strategies/list_trading_strategies_api_v2_trading_strategies__get","metadata":{"seo":{"title":"List Trading Strategies","description":"List Trading Strategies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_trading_strategies_api_v2_trading_strategies__get","name":"List Trading Strategies","isWebhook":false,"pointer":"/paths/~1api~1v2~1trading-strategies~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Trading Strategies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"applicable_to","in":"query","schemaId":"schema_425"}],"pointer":"/paths/~1api~1v2~1trading-strategies~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1trading-strategies~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/trading-strategies/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[{"name":"applicable_to","in":"query","required":false,"schemaId":"schema_425"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/trading-strategies/","href":"trading-strategies/list_trading_strategies_api_v2_trading_strategies__get","openApiOperationId":"list_trading_strategies_api_v2_trading_strategies__get","summary":"List Trading Strategies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradingStrategies","exampleIds":["paths/~1api~1v2~1trading-strategies~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/TradingStrategies","exampleIds":["paths/~1api~1v2~1trading-strategies~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1trading-strategies~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TradingStrategies","exampleIds":["paths/~1api~1v2~1trading-strategies~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradingStrategies","exampleIds":["paths/~1api~1v2~1trading-strategies~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trading-strategies/list_trading_strategies_api_v2_trading_strategies__get"}],"panels":[]}]},"httpPath":"/api/v2/trading-strategies/"}],"content":{"contentType":"group","meta":{"name":"Trading Strategies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trading Strategies","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/trading-strategies/","summary":"List Trading Strategies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/trading-strategies/list_trading_strategies_api_v2_trading_strategies__get","deprecated":false}]}]}]}]}},{"type":"group","label":"Transactions V2","link":"/products/partner-api/reference/transactions-v2","routeSlug":"/products/partner-api/reference/transactions-v2","items":[{"label":"List Pocket Transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/transactions-v2/list-pocket-transactions-v2","routeSlug":"/products/partner-api/reference/transactions-v2/list-pocket-transactions-v2","metadata":{"seo":{"title":"List Pocket Transactions","description":"Returns a list of pocket transactions. It does not include transactions between the bank account and brokerage account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-pocket-transactions-v2","name":"List Pocket Transactions","isWebhook":false,"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1transactions~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Pocket Transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pocket"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions. It does not include transactions between the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brokerage account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pocket_id","in":"path","schemaId":"schema_413","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1transactions~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_326"},{"name":"order","in":"query","schemaId":"schema_316"},{"name":"direction","in":"query","schemaId":"schema_400"},{"name":"amount_from","in":"query","schemaId":"schema_426"},{"name":"amount_to","in":"query","schemaId":"schema_427"},{"name":"filter[card]","in":"query","schemaId":"schema_318"},{"name":"filter[portal]","in":"query","schemaId":"schema_319"},{"name":"filter[type]","in":"query","schemaId":"schema_428"},{"name":"filter[on_us_transfer]","in":"query","schemaId":"schema_321"},{"name":"filter[wire]","in":"query","schemaId":"schema_322"},{"name":"time_booked_from","in":"query","schemaId":"schema_429"},{"name":"time_booked_to","in":"query","schemaId":"schema_430"},{"name":"time_settled_from","in":"query","schemaId":"schema_431"},{"name":"time_settled_to","in":"query","schemaId":"schema_432"},{"name":"include_sweeps","in":"query","schemaId":"schema_433"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1transactions~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1transactions~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/pockets/{pocket_id}/transactions/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"pocket_id","in":"path","required":true,"schemaId":"schema_413"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_326"},{"name":"order","in":"query","required":false,"schemaId":"schema_316"},{"name":"direction","in":"query","required":false,"schemaId":"schema_400"},{"name":"amount_from","in":"query","required":false,"schemaId":"schema_426"},{"name":"amount_to","in":"query","required":false,"schemaId":"schema_427"},{"name":"filter[card]","in":"query","required":false,"schemaId":"schema_318"},{"name":"filter[portal]","in":"query","required":false,"schemaId":"schema_319"},{"name":"filter[type]","in":"query","required":false,"schemaId":"schema_428"},{"name":"filter[on_us_transfer]","in":"query","required":false,"schemaId":"schema_321"},{"name":"filter[wire]","in":"query","required":false,"schemaId":"schema_322"},{"name":"time_booked_from","in":"query","required":false,"schemaId":"schema_429"},{"name":"time_booked_to","in":"query","required":false,"schemaId":"schema_430"},{"name":"time_settled_from","in":"query","required":false,"schemaId":"schema_431"},{"name":"time_settled_to","in":"query","required":false,"schemaId":"schema_432"},{"name":"include_sweeps","in":"query","required":false,"schemaId":"schema_433"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/pockets/{pocket_id}/transactions/","href":"transactions-v2/list-pocket-transactions-v2","openApiOperationId":"list-pocket-transactions-v2","summary":"List Pocket Transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1transactions~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1transactions~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1pockets~1{pocket_id}~1transactions~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1transactions~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____","exampleIds":["paths/~1api~1v2~1pockets~1{pocket_id}~1transactions~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions-v2/list-pocket-transactions-v2"}],"panels":[]}]},"httpPath":"/api/v2/pockets/{pocket_id}/transactions/"},{"label":"List Customer Transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/transactions-v2/list-customer-transactions-v2","routeSlug":"/products/partner-api/reference/transactions-v2/list-customer-transactions-v2","metadata":{"seo":{"title":"List Customer Transactions","description":"Returns a list of customer transactions. It does not include transactions between the bank account and brokerage account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-customer-transactions-v2","name":"List Customer Transactions","isWebhook":false,"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1transactions~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customer Transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions. It does not include transactions between the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brokerage account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1transactions~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[pocket]","in":"query","schemaId":"schema_434"},{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_326"},{"name":"order","in":"query","schemaId":"schema_316"},{"name":"direction","in":"query","schemaId":"schema_400"},{"name":"amount_from","in":"query","schemaId":"schema_426"},{"name":"amount_to","in":"query","schemaId":"schema_427"},{"name":"filter[card]","in":"query","schemaId":"schema_318"},{"name":"filter[portal]","in":"query","schemaId":"schema_319"},{"name":"filter[type]","in":"query","schemaId":"schema_428"},{"name":"filter[on_us_transfer]","in":"query","schemaId":"schema_321"},{"name":"filter[wire]","in":"query","schemaId":"schema_322"},{"name":"time_booked_from","in":"query","schemaId":"schema_429"},{"name":"time_booked_to","in":"query","schemaId":"schema_430"},{"name":"time_settled_from","in":"query","schemaId":"schema_431"},{"name":"time_settled_to","in":"query","schemaId":"schema_432"},{"name":"include_sweeps","in":"query","schemaId":"schema_433"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1transactions~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1transactions~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/customers/{customer_id}/transactions/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[{"name":"filter[pocket]","in":"query","required":false,"schemaId":"schema_434"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_326"},{"name":"order","in":"query","required":false,"schemaId":"schema_316"},{"name":"direction","in":"query","required":false,"schemaId":"schema_400"},{"name":"amount_from","in":"query","required":false,"schemaId":"schema_426"},{"name":"amount_to","in":"query","required":false,"schemaId":"schema_427"},{"name":"filter[card]","in":"query","required":false,"schemaId":"schema_318"},{"name":"filter[portal]","in":"query","required":false,"schemaId":"schema_319"},{"name":"filter[type]","in":"query","required":false,"schemaId":"schema_428"},{"name":"filter[on_us_transfer]","in":"query","required":false,"schemaId":"schema_321"},{"name":"filter[wire]","in":"query","required":false,"schemaId":"schema_322"},{"name":"time_booked_from","in":"query","required":false,"schemaId":"schema_429"},{"name":"time_booked_to","in":"query","required":false,"schemaId":"schema_430"},{"name":"time_settled_from","in":"query","required":false,"schemaId":"schema_431"},{"name":"time_settled_to","in":"query","required":false,"schemaId":"schema_432"},{"name":"include_sweeps","in":"query","required":false,"schemaId":"schema_433"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/customers/{customer_id}/transactions/","href":"transactions-v2/list-customer-transactions-v2","openApiOperationId":"list-customer-transactions-v2","summary":"List Customer Transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1transactions~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1transactions~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1transactions~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1transactions~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1transactions~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions-v2/list-customer-transactions-v2"}],"panels":[]}]},"httpPath":"/api/v2/customers/{customer_id}/transactions/"},{"label":"List Partner Transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/transactions-v2/list-partner-transactions-v2","routeSlug":"/products/partner-api/reference/transactions-v2/list-partner-transactions-v2","metadata":{"seo":{"title":"List Partner Transactions","description":"Returns a list of pocket transactions. It does not include transactions between the bank account and brokerage account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-partner-transactions-v2","name":"List Partner Transactions","isWebhook":false,"pointer":"/paths/~1api~1v2~1transactions~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Partner Transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pocket"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions. It does not include transactions between the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bank account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brokerage account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_326"},{"name":"order","in":"query","schemaId":"schema_316"},{"name":"direction","in":"query","schemaId":"schema_400"},{"name":"amount_from","in":"query","schemaId":"schema_426"},{"name":"amount_to","in":"query","schemaId":"schema_427"},{"name":"filter[card]","in":"query","schemaId":"schema_318"},{"name":"filter[portal]","in":"query","schemaId":"schema_319"},{"name":"filter[type]","in":"query","schemaId":"schema_428"},{"name":"filter[on_us_transfer]","in":"query","schemaId":"schema_321"},{"name":"filter[wire]","in":"query","schemaId":"schema_322"},{"name":"time_booked_from","in":"query","schemaId":"schema_429"},{"name":"time_booked_to","in":"query","schemaId":"schema_430"},{"name":"time_settled_from","in":"query","schemaId":"schema_431"},{"name":"time_settled_to","in":"query","schemaId":"schema_432"},{"name":"include_sweeps","in":"query","schemaId":"schema_433"}],"pointer":"/paths/~1api~1v2~1transactions~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1transactions~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/transactions/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_326"},{"name":"order","in":"query","required":false,"schemaId":"schema_316"},{"name":"direction","in":"query","required":false,"schemaId":"schema_400"},{"name":"amount_from","in":"query","required":false,"schemaId":"schema_426"},{"name":"amount_to","in":"query","required":false,"schemaId":"schema_427"},{"name":"filter[card]","in":"query","required":false,"schemaId":"schema_318"},{"name":"filter[portal]","in":"query","required":false,"schemaId":"schema_319"},{"name":"filter[type]","in":"query","required":false,"schemaId":"schema_428"},{"name":"filter[on_us_transfer]","in":"query","required":false,"schemaId":"schema_321"},{"name":"filter[wire]","in":"query","required":false,"schemaId":"schema_322"},{"name":"time_booked_from","in":"query","required":false,"schemaId":"schema_429"},{"name":"time_booked_to","in":"query","required":false,"schemaId":"schema_430"},{"name":"time_settled_from","in":"query","required":false,"schemaId":"schema_431"},{"name":"time_settled_to","in":"query","required":false,"schemaId":"schema_432"},{"name":"include_sweeps","in":"query","required":false,"schemaId":"schema_433"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/transactions/","href":"transactions-v2/list-partner-transactions-v2","openApiOperationId":"list-partner-transactions-v2","summary":"List Partner Transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____","exampleIds":["paths/~1api~1v2~1transactions~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____","exampleIds":["paths/~1api~1v2~1transactions~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1transactions~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____","exampleIds":["paths/~1api~1v2~1transactions~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____","exampleIds":["paths/~1api~1v2~1transactions~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions-v2/list-partner-transactions-v2"}],"panels":[]}]},"httpPath":"/api/v2/transactions/"},{"label":"Get Transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/transactions-v2/get-transaction-v2","routeSlug":"/products/partner-api/reference/transactions-v2/get-transaction-v2","metadata":{"seo":{"title":"Get Transaction","description":"Retrieves a single transaction activity by ID. A transaction activity represents a single side (debit/credit) of a transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-transaction-v2","name":"Get Transaction","isWebhook":false,"pointer":"/paths/~1api~1v2~1transactions~1{transaction_activity_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a single transaction activity by ID. A transaction activity represents a single side (debit/credit) of a transaction."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_activity_id","in":"path","schemaId":"schema_435","required":true}],"pointer":"/paths/~1api~1v2~1transactions~1{transaction_activity_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1transactions~1{transaction_activity_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/transactions/{transaction_activity_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"transaction_activity_id","in":"path","required":true,"schemaId":"schema_435"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/transactions/{transaction_activity_id}/","href":"transactions-v2/get-transaction-v2","openApiOperationId":"get-transaction-v2","summary":"Get Transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_436","exampleIds":["paths/~1api~1v2~1transactions~1{transaction_activity_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_436","exampleIds":["paths/~1api~1v2~1transactions~1{transaction_activity_id}~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1transactions~1{transaction_activity_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_436","exampleIds":["paths/~1api~1v2~1transactions~1{transaction_activity_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_436","exampleIds":["paths/~1api~1v2~1transactions~1{transaction_activity_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions-v2/get-transaction-v2"}],"panels":[]}]},"httpPath":"/api/v2/transactions/{transaction_activity_id}/"}],"content":{"contentType":"group","meta":{"name":"Transactions V2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions V2","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/pockets/{pocket_id}/transactions/","summary":"List Pocket Transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions-v2/list-pocket-transactions-v2","deprecated":false},{"title":"/api/v2/customers/{customer_id}/transactions/","summary":"List Customer Transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions-v2/list-customer-transactions-v2","deprecated":false},{"title":"/api/v2/transactions/","summary":"List Partner Transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions-v2/list-partner-transactions-v2","deprecated":false},{"title":"/api/v2/transactions/{transaction_activity_id}/","summary":"Get Transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions-v2/get-transaction-v2","deprecated":false}]}]}]}]}},{"type":"group","label":"Trades V2","link":"/products/partner-api/reference/trades-v2","routeSlug":"/products/partner-api/reference/trades-v2","items":[{"label":"List Customer Trades","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/trades-v2/list-customer-trades-v2","routeSlug":"/products/partner-api/reference/trades-v2/list-customer-trades-v2","metadata":{"seo":{"title":"List Customer Trades","description":"Returns a list of trades from a customer's brokerage accounts. Includes standard trades (BUY, SELL, MATURITY) and security transfer trades."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-customer-trades-v2","name":"List Customer Trades","isWebhook":false,"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1trades~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Customer Trades","badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of trades from a customer's brokerage accounts. Includes standard trades (BUY, SELL, MATURITY) and security transfer trades."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1trades~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"trade_datetime_from","in":"query","schemaId":"schema_328"},{"name":"trade_datetime_to","in":"query","schemaId":"schema_329"},{"name":"book_date_from","in":"query","schemaId":"schema_330","description":"Filters the resulting trade list by book date from the provided ISO8601 date, inclusively"},{"name":"book_date_to","in":"query","schemaId":"schema_331","description":"Filters the resulting trade list by book date to the provided ISO8601 date, inclusively"},{"name":"settlement_date_from","in":"query","schemaId":"schema_332","description":"Filters the resulting trade list by settlement date from the provided ISO8601 date, inclusively"},{"name":"settlement_date_to","in":"query","schemaId":"schema_333","description":"Filters the resulting trade list by settlement date to the provided ISO8601 date, inclusively"},{"name":"pocket_id[]","in":"query","schemaId":"schema_437"},{"name":"order","in":"query","schemaId":"schema_316","description":"Ordered by the trade creation time, descending by default."},{"name":"cursor","in":"query","schemaId":"schema_325"},{"name":"limit","in":"query","schemaId":"schema_326"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1trades~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1trades~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/customers/{customer_id}/trades/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[{"name":"trade_datetime_from","in":"query","required":false,"schemaId":"schema_328"},{"name":"trade_datetime_to","in":"query","required":false,"schemaId":"schema_329"},{"name":"book_date_from","in":"query","required":false,"schemaId":"schema_330"},{"name":"book_date_to","in":"query","required":false,"schemaId":"schema_331"},{"name":"settlement_date_from","in":"query","required":false,"schemaId":"schema_332"},{"name":"settlement_date_to","in":"query","required":false,"schemaId":"schema_333"},{"name":"pocket_id[]","in":"query","required":false,"schemaId":"schema_437"},{"name":"order","in":"query","required":false,"schemaId":"schema_316"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_325"},{"name":"limit","in":"query","required":false,"schemaId":"schema_326"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/customers/{customer_id}/trades/","href":"trades-v2/list-customer-trades-v2","openApiOperationId":"list-customer-trades-v2","summary":"List Customer Trades"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradeListResponseV2"}},"schemaId":"components/schemas/TradeListResponseV2"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1trades~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TradeListResponseV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TradeListResponseV2"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trades-v2/list-customer-trades-v2"}],"panels":[]}]},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"httpPath":"/api/v2/customers/{customer_id}/trades/"}],"content":{"contentType":"group","meta":{"name":"Trades V2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trades V2","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/customers/{customer_id}/trades/","summary":"List Customer Trades","prefix":{"name":"get","color":"get"},"badges":[{"name":"Experimental","color":"#9c27b0","position":"after"}],"link":"/trades-v2/list-customer-trades-v2","deprecated":false}]}]}]}]}},{"type":"separator","label":"Platform V2","content":null},{"type":"group","label":"Health","link":"/products/partner-api/reference/health","routeSlug":"/products/partner-api/reference/health","items":[{"label":"Get Health Check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/health/get-health-check","routeSlug":"/products/partner-api/reference/health/get-health-check","metadata":{"seo":{"title":"Get Health Check","description":"A health check endpoint, which returns \"OK\" if the Partner API is up and running."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-health-check","name":"Get Health Check","isWebhook":false,"pointer":"/paths/~1health/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Health Check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A health check endpoint, which returns \"OK\" if the Partner API is up and running."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/health","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/health","href":"health/get-health-check","openApiOperationId":"get-health-check","summary":"Get Health Check"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}},"schemaId":"schema_356"}],"pointer":"/paths/~1health/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_356","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/health/get-health-check"}],"panels":[]}]},"httpPath":"/health"}],"content":{"contentType":"group","meta":{"name":"Health"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Health","showPageActions":true},{"nodeType":"markdoc","content":"Use these endpoints to setup automatic health checks for the Partner API."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/health","summary":"Get Health Check","prefix":{"name":"get","color":"get"},"badges":[],"link":"/health/get-health-check","deprecated":false}]}]}]}]}},{"type":"separator","label":"Transfers V2","content":null},{"type":"group","label":"Counterparties V2","link":"/products/partner-api/reference/counterparties-v2","routeSlug":"/products/partner-api/reference/counterparties-v2","items":[{"label":"List Counterparties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/counterparties-v2/list_counterparties_api_v2_customers__customer_id__counterparties__get","routeSlug":"/products/partner-api/reference/counterparties-v2/list_counterparties_api_v2_customers__customer_id__counterparties__get","metadata":{"seo":{"title":"List Counterparties","description":"Retrieve a list of counterparties for a given account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_counterparties_api_v2_customers__customer_id__counterparties__get","name":"List Counterparties","isWebhook":false,"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Counterparties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of counterparties for a given account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_339"},{"name":"limit","in":"query","schemaId":"schema_338"},{"name":"type","in":"query","schemaId":"schema_438"},{"name":"status","in":"query","schemaId":"schema_439"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/customers/{customer_id}/counterparties/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_339"},{"name":"limit","in":"query","required":false,"schemaId":"schema_338"},{"name":"type","in":"query","required":false,"schemaId":"schema_438"},{"name":"status","in":"query","required":false,"schemaId":"schema_439"}],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/customers/{customer_id}/counterparties/","href":"counterparties-v2/list_counterparties_api_v2_customers__customer_id__counterparties__get","openApiOperationId":"list_counterparties_api_v2_customers__customer_id__counterparties__get","summary":"List Counterparties"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CounterpartyListResponseV2","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CounterpartyListResponseV2","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CounterpartyListResponseV2","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CounterpartyListResponseV2","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/counterparties-v2/list_counterparties_api_v2_customers__customer_id__counterparties__get"}],"panels":[]}]},"httpPath":"/api/v2/customers/{customer_id}/counterparties/"},{"label":"Create Counterparty","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/counterparties-v2/create_counterparty_api_v2_customers__customer_id__counterparties__post","routeSlug":"/products/partner-api/reference/counterparties-v2/create_counterparty_api_v2_customers__customer_id__counterparties__post","metadata":{"seo":{"title":"Create Counterparty","description":"Creates a counterparty with the provided parameters. There are currently two types of verification available - verification with supporting documents, and with an incoming wire."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_counterparty_api_v2_customers__customer_id__counterparties__post","name":"Create Counterparty","isWebhook":false,"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Counterparty","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a counterparty with the provided parameters. There are currently two types of verification available - verification with supporting documents, and with an incoming wire."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_440","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_ind","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_biz","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_ind","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz_supporting_documents"]}},"schemaId":"schema_440","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_ind","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_biz","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_ind","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz_supporting_documents"],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/customers/{customer_id}/counterparties/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_440","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_ind","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_biz","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_ind","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz_supporting_documents"]}},"responseCodes":["201","422"],"pointer":"/api/v2/customers/{customer_id}/counterparties/","href":"counterparties-v2/create_counterparty_api_v2_customers__customer_id__counterparties__post","openApiOperationId":"create_counterparty_api_v2_customers__customer_id__counterparties__post","summary":"Create Counterparty"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"schema_440","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_ind","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_biz","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_ind","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz_supporting_documents"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_440","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_ind","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_biz","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_ind","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz_supporting_documents"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_441","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/wire","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_business_iban","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_individual_iban","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_business_local","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_individual_local"]}},"schemaId":"schema_441","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/wire","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_business_iban","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_individual_iban","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_business_local","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_individual_local"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_441","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/wire","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_business_iban","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_individual_iban","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_business_local","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_individual_local"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_441","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/wire","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_business_iban","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_individual_iban","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_business_local","paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_individual_local"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/counterparties-v2/create_counterparty_api_v2_customers__customer_id__counterparties__post"}],"panels":[]}]},"httpPath":"/api/v2/customers/{customer_id}/counterparties/"},{"label":"Get Counterparty","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/counterparties-v2/get_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___get","routeSlug":"/products/partner-api/reference/counterparties-v2/get_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___get","metadata":{"seo":{"title":"Get Counterparty","description":"Get Counterparty"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___get","name":"Get Counterparty","isWebhook":false,"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Counterparty","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true},{"name":"counterparty_id","in":"path","schemaId":"schema_404","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/customers/{customer_id}/counterparties/{counterparty_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"},{"name":"counterparty_id","in":"path","required":true,"schemaId":"schema_404"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/api/v2/customers/{customer_id}/counterparties/{counterparty_id}/","href":"counterparties-v2/get_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___get","openApiOperationId":"get_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___get","summary":"Get Counterparty"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_442","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_442","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/counterparties-v2/get_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___get"}],"panels":[]}]},"httpPath":"/api/v2/customers/{customer_id}/counterparties/{counterparty_id}/"},{"label":"Update Counterparty","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/partner-api/reference/counterparties-v2/update_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___patch","routeSlug":"/products/partner-api/reference/counterparties-v2/update_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___patch","metadata":{"seo":{"title":"Update Counterparty","description":"Update Counterparty"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___patch","name":"Update Counterparty","isWebhook":false,"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Counterparty","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customer_id","in":"path","schemaId":"schema_305","required":true},{"name":"counterparty_id","in":"path","schemaId":"schema_404","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-jiko-idempotency","in":"header","schemaId":"schema_309","required":true},{"name":"x-jiko-signature","in":"header","schemaId":"schema_310","required":true}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCounterpartyRequest"}},"schemaId":"components/schemas/UpdateCounterpartyRequest","pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v2/customers/{customer_id}/counterparties/{counterparty_id}/","servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"parameters":{"path":[{"name":"customer_id","in":"path","required":true,"schemaId":"schema_305"},{"name":"counterparty_id","in":"path","required":true,"schemaId":"schema_404"}],"query":[],"querystring":[],"header":[{"name":"x-jiko-idempotency","in":"header","required":true,"schemaId":"schema_309"},{"name":"x-jiko-signature","in":"header","required":true,"schemaId":"schema_310"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCounterpartyRequest"}},"responseCodes":["200","422"],"pointer":"/api/v2/customers/{customer_id}/counterparties/{counterparty_id}/","href":"counterparties-v2/update_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___patch","openApiOperationId":"update_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___patch","summary":"Update Counterparty"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name"}}}],"schemaId":"components/schemas/UpdateCounterpartyRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCounterpartyRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_443","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_443","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/patch/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_443","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_443","exampleIds":["paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/patch/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/counterparties-v2/update_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___patch"}],"panels":[]}]},"httpPath":"/api/v2/customers/{customer_id}/counterparties/{counterparty_id}/"}],"content":{"contentType":"group","meta":{"name":"Counterparties V2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Counterparties V2","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/customers/{customer_id}/counterparties/","summary":"List Counterparties","prefix":{"name":"get","color":"get"},"badges":[],"link":"/counterparties-v2/list_counterparties_api_v2_customers__customer_id__counterparties__get","deprecated":false},{"title":"/api/v2/customers/{customer_id}/counterparties/","summary":"Create Counterparty","prefix":{"name":"post","color":"post"},"badges":[],"link":"/counterparties-v2/create_counterparty_api_v2_customers__customer_id__counterparties__post","deprecated":false},{"title":"/api/v2/customers/{customer_id}/counterparties/{counterparty_id}/","summary":"Get Counterparty","prefix":{"name":"get","color":"get"},"badges":[],"link":"/counterparties-v2/get_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___get","deprecated":false},{"title":"/api/v2/customers/{customer_id}/counterparties/{counterparty_id}/","summary":"Update Counterparty","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/counterparties-v2/update_counterparty_api_v2_customers__customer_id__counterparties__counterparty_id___patch","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ACHCounterparty":{"id":"components/schemas/ACHCounterparty","kind":"json-schema","title":"ACHCounterparty","data":{"properties":{"time_created":{"type":"string","format":"date-time","title":"Time Created"},"verification_type":{"type":"string","enum":["MICRO_DEPOSITS","PLAID","PRE_VERIFIED","INCOMING_WIRE","SUPPORTING_DOCUMENTS"],"title":"Verification Type"},"status":{"type":"string","enum":["IN_PROGRESS","FAILED","VERIFIED"],"title":"Status"},"account_number":{"type":"string","title":"Account Number"},"routing_number":{"type":"string","title":"Routing Number"},"name_on_account":{"type":"string","title":"Name On Account"},"account_type":{"type":"string","enum":["SAVINGS","CHECKING"],"title":"Account Type"},"institution_name":{"type":"string","title":"Institution Name"},"plaid":{"anyOf":[{"$ref":"#/components/schemas/CounterpartyPlaid"},{"type":"null"}]},"micro_deposits":{"anyOf":[{"$ref":"#/components/schemas/CounterpartyMicroDeposits"},{"type":"null"}]}},"type":"object","required":["time_created","verification_type","status","account_number","routing_number","name_on_account","account_type","institution_name"],"title":"ACHCounterparty"}},"components/schemas/ACHCounterpartyV2":{"id":"components/schemas/ACHCounterpartyV2","kind":"json-schema","title":"ACH Counterparty","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"status":{"type":"string","enum":["PENDING","FAILED","LINKED","UNLINKED","CLOSED"],"title":"Status"},"verification":{"oneOf":[{"$ref":"#/components/schemas/SupportingDocumentsVerification"},{"$ref":"#/components/schemas/IncomingWireVerification"},{"$ref":"#/components/schemas/PreVerifiedVerification"},{"$ref":"#/components/schemas/PlaidVerification"},{"$ref":"#/components/schemas/MicroDepositsVerification"},{"$ref":"#/components/schemas/NameMatchVerification"},{"$ref":"#/components/schemas/UnverifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"incoming_wire":"#/components/schemas/IncomingWireVerification","micro_deposits":"#/components/schemas/MicroDepositsVerification","name_match":"#/components/schemas/NameMatchVerification","plaid":"#/components/schemas/PlaidVerification","pre_verified":"#/components/schemas/PreVerifiedVerification","supporting_documents":"#/components/schemas/SupportingDocumentsVerification","unverified":"#/components/schemas/UnverifiedVerification"}}},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"type":{"type":"string","const":"ach","title":"Type"},"counterparty_name":{"type":"string","title":"Counterparty Name"},"institution_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Institution Name"},"routing_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Routing Number"},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number"},"account_type":{"type":"string","enum":["CHECKING","SAVINGS"],"title":"Account Type"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","time_created","status","verification","type","counterparty_name","institution_name","routing_number","account_number","account_type","object_type"],"title":"ACH Counterparty"}},"components/schemas/ACHDirection":{"id":"components/schemas/ACHDirection","kind":"json-schema","title":"ACHDirection","data":{"type":"string","enum":["RECEIVING","ORIGINATION"],"title":"ACHDirection"}},"components/schemas/ACHFundingInstruction":{"id":"components/schemas/ACHFundingInstruction","kind":"json-schema","title":"ACHFundingInstruction","data":{"properties":{"type":{"type":"string","const":"ACH","title":"Type"},"routing_number":{"type":"string","title":"Routing Number","description":"ABA routing number"},"account_number":{"type":"string","title":"Account Number","description":"Account number"},"account_type":{"type":"string","title":"Account Type","description":"Account type"}},"type":"object","required":["type","routing_number","account_number","account_type"],"title":"ACHFundingInstruction"}},"components/schemas/ACHIncomingEvent":{"id":"components/schemas/ACHIncomingEvent","kind":"json-schema","title":"ACHIncomingEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ACHIncomingPayload"},"event_type":{"type":"string","enum":["transfers.ach.in.success","transfers.ach.in.rejected"],"title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"ACHIncomingEvent"}},"components/schemas/ACHIncomingPayload":{"id":"components/schemas/ACHIncomingPayload","kind":"json-schema","title":"ACHIncomingPayload","data":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"}},"type":"object","required":["jiko_account_id"],"title":"ACHIncomingPayload"}},"components/schemas/ACHListResponse":{"id":"components/schemas/ACHListResponse","kind":"json-schema","title":"ACHListResponse","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/ACHResponse"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"ACHListResponse"}},"components/schemas/ACHOutgoingEvent":{"id":"components/schemas/ACHOutgoingEvent","kind":"json-schema","title":"ACHOutgoingEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ACHOutgoingPayload"},"event_type":{"type":"string","enum":["transfers.ach.out.success","transfers.ach.out.rejected","transfers.ach.out.sent"],"title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"ACHOutgoingEvent"}},"components/schemas/ACHOutgoingPayload":{"id":"components/schemas/ACHOutgoingPayload","kind":"json-schema","title":"ACHOutgoingPayload","data":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"ach_origination_id":{"type":"string","format":"uuid","title":"Ach Origination Id"}},"type":"object","required":["jiko_account_id","ach_origination_id"],"title":"ACHOutgoingPayload"}},"components/schemas/ACHRequest":{"id":"components/schemas/ACHRequest","kind":"json-schema","title":"ACHRequest","data":{"properties":{"counterparty_id":{"type":"string","format":"uuid","title":"Counterparty Id"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"sec_code":{"type":"string","enum":["CCD","WEB"],"title":"Sec Code","default":"WEB"},"payment_related_information":{"items":{"type":"string"},"type":"array","title":"Payment Related Information"},"amount_usdc":{"type":"integer","title":"Amount Usdc"},"company_entry_description":{"anyOf":[{"type":"string","pattern":"^[ a-zA-Z0-9]{1,10}$"},{"type":"null"}],"title":"Company Entry Description","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Short description of the purpose of the entry (Maximum of 10 characters). Required for sec_code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"CCD\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"PPD\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For sec_code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"WEB\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the default value for DEBIT is \"Funding TX\" and \"Release TX\" for CREDIT."},"children":[]}]}]}]}},"type":"object","required":["counterparty_id","direction","amount_usdc"],"title":"ACHRequest"}},"components/schemas/ACHResponse":{"id":"components/schemas/ACHResponse","kind":"json-schema","title":"ACHResponse","data":{"properties":{"counterparty_id":{"type":"string","format":"uuid","title":"Counterparty Id"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"sec_code":{"type":"string","enum":["CCD","PPD","WEB"],"title":"Sec Code"},"payment_related_information":{"items":{"type":"string"},"type":"array","title":"Payment Related Information"},"id":{"type":"string","format":"uuid","title":"Id"},"amount":{"$ref":"#/components/schemas/Amount"},"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"status":{"type":"string","enum":["PENDING","FAILED","REJECTED","PROCESSED","APPROVED","IN_TRANSIT","CANCELLED"],"title":"Status"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"company_entry_description":{"type":"string","title":"Company Entry Description"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["counterparty_id","direction","sec_code","payment_related_information","id","amount","jiko_account_id","status","time_created","company_entry_description","object_type"],"title":"ACHResponse"}},"components/schemas/ACHTransactionActivity":{"id":"components/schemas/ACHTransactionActivity","kind":"json-schema","title":"ACHTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"ACH","title":"Type"},"company_name":{"type":"string","title":"Company Name"},"company_entry_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Entry Description"},"individual_identification_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Individual Identification Number"},"trace_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trace Number"},"ach_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Ach Id"},"ach_direction":{"$ref":"#/components/schemas/ACHDirection"},"portal_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Portal Id"}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type","company_name","ach_direction"],"title":"ACHTransactionActivity"}},"components/schemas/ACHTransactionDetails":{"id":"components/schemas/ACHTransactionDetails","kind":"json-schema","title":"ACHTransactionDetails","data":{"properties":{"company_name":{"type":"string","title":"Company Name"},"company_entry_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Entry Description"},"individual_identification_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Individual Identification Number"},"trace_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trace Number"},"ach_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Ach Id","description":"The ID of the transfer object associated with this transaction. This field will be not be populated for originations before July 2024."},"ach_direction":{"$ref":"#/components/schemas/ACHDirection"},"portal_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Portal Id","description":"The ID of the portal used to receive this ACH transfer."}},"type":"object","required":["company_name","ach_direction"],"title":"ACHTransactionDetails"}},"components/schemas/AUMFee":{"id":"components/schemas/AUMFee","kind":"json-schema","title":"AUMFee","data":{"properties":{"amount":{"$ref":"#/components/schemas/Amount"},"type":{"type":"string","const":"AUM_FEE","title":"Type"}},"type":"object","required":["amount","type"],"title":"AUMFee"}},"components/schemas/Account":{"id":"components/schemas/Account","kind":"json-schema","title":"Account","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name","description":"The account name"},"total_value":{"$ref":"#/components/schemas/Amount","description":"Current total value of account"},"status":{"type":"string","enum":["OPEN","CLOSED","FROZEN"],"title":"Status","description":"Account status"},"portfolio":{"$ref":"#/components/schemas/partner_api__interface__models__accounts__Portfolio","description":"Total liquid cash and holdings"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","name","total_value","status","portfolio","object_type"],"title":"Account"}},"components/schemas/Agreement":{"id":"components/schemas/Agreement","kind":"json-schema","title":"Agreement","data":{"properties":{"version":{"type":"string","title":"Version"},"release_date":{"type":"string","format":"date","title":"Release Date"},"documents":{"items":{"$ref":"#/components/schemas/AgreementDocument"},"type":"array","title":"Documents"}},"type":"object","required":["version","release_date","documents"],"title":"Agreement"}},"components/schemas/AgreementConsent":{"id":"components/schemas/AgreementConsent","kind":"json-schema","title":"AgreementConsent","data":{"properties":{"version":{"type":"string","title":"Version","description":"Agreement version"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Timestamp of applicant's acknowledgement of the agreements"}},"type":"object","required":["version","timestamp"],"title":"AgreementConsent"}},"components/schemas/AgreementDocument":{"id":"components/schemas/AgreementDocument","kind":"json-schema","title":"AgreementDocument","data":{"properties":{"pdf_download_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Pdf Download Url"},"title":{"type":"string","title":"Title"},"type":{"type":"string","enum":["PRIVACY_POLICY","PRIVACY_NOTICE","BUSINESS_CONTINUITY_PLAN","FINANCIAL_STATEMENT","US_TREASURIES_RISK","ELECTRONIC_COMMUNICATIONS","TAX_CERTIFICATION_FOR_US_PERSON","BANK_ACCOUNT","LIMITATIONS","BROKERAGE","CARD","CASHBACK","FORM_CRS","AUTHORIZED_REPRESENTATIVE_CERTIFICATION","TERMS_OF_USE","ELECTRONIC_FUND_TRANSFERS","TRUTH_IN_SAVINGS","FEE_NOTICE","FUNDS_AVAILABILITY","REGULATION_E"],"title":"Type"},"category":{"type":"string","enum":["BANK","BROKERAGE","GENERAL","E-SIGN"],"title":"Category"}},"type":"object","required":["pdf_download_url","title","type","category"],"title":"AgreementDocument"}},"components/schemas/Amount":{"id":"components/schemas/Amount","kind":"json-schema","title":"Amount","data":{"properties":{"value":{"type":"integer","title":"Value","description":"USD values are always in cents."},"currency":{"type":"string","title":"Currency"},"formatted":{"type":"string","title":"Formatted","default":""}},"type":"object","required":["value","currency"],"title":"Amount"}},"components/schemas/ApplicationUpdateEvent":{"id":"components/schemas/ApplicationUpdateEvent","kind":"json-schema","title":"ApplicationUpdateEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ApplicationUpdatePayload"},"event_type":{"type":"string","enum":["application.approved","application.manual_review","application.documents_needed","application.rejected"],"title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"ApplicationUpdateEvent"}},"components/schemas/ApplicationUpdatePayload":{"id":"components/schemas/ApplicationUpdatePayload","kind":"json-schema","title":"ApplicationUpdatePayload","data":{"properties":{"application_id":{"type":"string","format":"uuid","title":"Application Id"}},"type":"object","required":["application_id"],"title":"ApplicationUpdatePayload"}},"components/schemas/BankStatementReport":{"id":"components/schemas/BankStatementReport","kind":"json-schema","title":"BankStatementReport","data":{"properties":{"pocket_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Pocket Ids"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id"},"date":{"type":"string","format":"date","title":"Date"},"type":{"type":"string","const":"BANK_STATEMENT_REPORT","title":"Type"}},"type":"object","required":["pocket_ids","customer_id","date","type"],"title":"BankStatementReport"}},"components/schemas/Beneficiary":{"id":"components/schemas/Beneficiary","kind":"json-schema","title":"Beneficiary","data":{"properties":{"account_number":{"type":"string","title":"Account Number","description":"Beneficiary account number"},"name":{"type":"string","title":"Name","description":"Beneficiary name"},"address":{"type":"string","title":"Address","description":"Beneficiary address"}},"type":"object","required":["account_number","name","address"],"title":"Beneficiary"}},"components/schemas/BrokerageStatementReport":{"id":"components/schemas/BrokerageStatementReport","kind":"json-schema","title":"BrokerageStatementReport","data":{"properties":{"customer_id":{"type":"string","format":"uuid","title":"Customer Id"},"date":{"type":"string","format":"date","title":"Date"},"pocket_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Pocket Ids"},"type":{"type":"string","const":"BROKERAGE_STATEMENT_REPORT","title":"Type"}},"type":"object","required":["customer_id","date","pocket_ids","type"],"title":"BrokerageStatementReport"}},"components/schemas/Business":{"id":"components/schemas/Business","kind":"json-schema","title":"Business","data":{"properties":{"address":{"$ref":"#/components/schemas/GeneralAddress"},"email":{"type":"string","title":"Email"},"phone_number":{"type":"string","title":"Phone Number"},"account_status":{"type":"string","enum":["OPEN","CLOSED","FROZEN","PENDING"],"title":"Account Status"},"type":{"type":"string","const":"BUSINESS","title":"Type"},"name":{"type":"string","title":"Name"},"identification_number":{"$ref":"#/components/schemas/BusinessIdentificationNumber"}},"type":"object","required":["address","email","phone_number","account_status","type","name","identification_number"],"title":"Business"}},"components/schemas/BusinessApplicationRequest":{"id":"components/schemas/BusinessApplicationRequest","kind":"json-schema","title":"BusinessApplicationRequest","data":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"entity_type":{"anyOf":[{"type":"string","enum":["SOLE_PROPRIETOR","CORPORATE","LLC","PARTNERSHIP","INCORPORATED_ASSOCIATION","UNINCORPORATED_ASSOCIATION","REGULATED_FINANCIAL_INSTITUTION","NON_BANK_FINANCIAL_INSTITUTION","NON_PROFIT","SPECIAL_PURPOSE_ACQUISITION_COMPANY","TRUST"]},{"type":"null"}],"title":"Entity Type"},"doing_business_as":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doing Business As"},"identification_number":{"anyOf":[{"$ref":"#/components/schemas/BusinessIdentificationNumber"},{"type":"null"}]},"address":{"anyOf":[{"$ref":"#/components/schemas/ISOAddressRequest"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website"},"contact":{"anyOf":[{"$ref":"#/components/schemas/BusinessContact"},{"type":"null"}]},"formation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Formation Date"},"risk_info":{"anyOf":[{"$ref":"#/components/schemas/RiskInfo"},{"type":"null"}]},"industry":{"anyOf":[{"$ref":"#/components/schemas/IndustryInfo"},{"type":"null"}]},"agreement_consent":{"anyOf":[{"$ref":"#/components/schemas/AgreementConsent"},{"type":"null"}]}},"type":"object","title":"BusinessApplicationRequest"}},"components/schemas/BusinessApplicationResponse":{"id":"components/schemas/BusinessApplicationResponse","kind":"json-schema","title":"BusinessApplicationResponse","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"exception_reasons":{"items":{"type":"string"},"type":"array","title":"Exception Reasons","default":[]},"customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Customer Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until application status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]}]}]}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"entity_type":{"anyOf":[{"type":"string","enum":["SOLE_PROPRIETOR","CORPORATE","LLC","PARTNERSHIP","INCORPORATED_ASSOCIATION","UNINCORPORATED_ASSOCIATION","REGULATED_FINANCIAL_INSTITUTION","NON_BANK_FINANCIAL_INSTITUTION","NON_PROFIT","SPECIAL_PURPOSE_ACQUISITION_COMPANY","TRUST"]},{"type":"null"}],"title":"Entity Type"},"doing_business_as":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doing Business As"},"identification_number":{"anyOf":[{"$ref":"#/components/schemas/BusinessIdentificationNumber"},{"type":"null"}]},"address":{"anyOf":[{"$ref":"#/components/schemas/ISOAddress"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website"},"contact":{"anyOf":[{"$ref":"#/components/schemas/BusinessContact"},{"type":"null"}]},"formation_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Formation Date"},"risk_info":{"anyOf":[{"$ref":"#/components/schemas/RiskInfo"},{"type":"null"}]},"industry":{"anyOf":[{"$ref":"#/components/schemas/IndustryInfo"},{"type":"null"}]},"agreement_consent":{"anyOf":[{"$ref":"#/components/schemas/AgreementConsent"},{"type":"null"}]},"status":{"type":"string","enum":["CREATED","SUBMITTED","CLOSED","APPROVED","REJECTED","MANUAL_REVIEW","DOCUMENTS_NEEDED","PENDING"],"title":"Status"}},"type":"object","required":["id","time_created","updated_at","status"],"title":"BusinessApplicationResponse"}},"components/schemas/BusinessContact":{"id":"components/schemas/BusinessContact","kind":"json-schema","title":"BusinessContact","data":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/Name"},{"type":"null"}]},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"}},"type":"object","title":"BusinessContact"}},"components/schemas/BusinessIdentificationNumber":{"id":"components/schemas/BusinessIdentificationNumber","kind":"json-schema","title":"BusinessIdentificationNumber","data":{"properties":{"identification_number":{"type":"string","title":"Identification Number"},"issuing_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuing Country","description":"A ISO-3166 Alpha-2 country code (Abbreviated. Example: \"US\")"},"type":{"type":"string","enum":["TIN","EIN","NON_US_BUSINESS_ID"],"title":"Type"}},"type":"object","required":["identification_number","type"],"title":"BusinessIdentificationNumber"}},"components/schemas/BusinessIndividual":{"id":"components/schemas/BusinessIndividual","kind":"json-schema","title":"BusinessIndividual","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"$ref":"#/components/schemas/Name"},"title":{"type":"string","title":"Title"}},"type":"object","required":["id","name","title"],"title":"BusinessIndividual"}},"components/schemas/BusinessName":{"id":"components/schemas/BusinessName","kind":"json-schema","title":"BusinessName","data":{"properties":{"business_name":{"type":"string","title":"Business Name","description":"The name of the business counterparty."},"type":{"type":"string","const":"business","title":"Type"}},"type":"object","required":["business_name","type"],"title":"BusinessName"}},"components/schemas/Card":{"id":"components/schemas/Card","kind":"json-schema","title":"Card","data":{"properties":{"card_id":{"type":"string","format":"uuid","title":"Card Id"},"name":{"type":"string","title":"Name"},"status":{"type":"string","enum":["OPEN","LOCKED","CLOSED","NOT_ACTIVATED","FROZEN"],"title":"Status"},"type":{"type":"string","enum":["VIRTUAL","PHYSICAL"],"title":"Type"},"creation_time":{"type":"string","format":"date-time","title":"Creation Time"},"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"}},"type":"object","required":["card_id","name","status","type","creation_time","jiko_account_id"],"title":"Card"}},"components/schemas/CardListResponse":{"id":"components/schemas/CardListResponse","kind":"json-schema","title":"CardListResponse","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/Card"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"CardListResponse"}},"components/schemas/CardPinBase":{"id":"components/schemas/CardPinBase","kind":"json-schema","title":"CardPinBase","data":{"properties":{"encrypted_pin":{"type":"string","format":"password","title":"Encrypted PIN","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 digit PIN encrypted by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"set_pin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" public key"},"children":[]}]}]}],"writeOnly":true}},"type":"object","required":["encrypted_pin"],"title":"CardPinBase"}},"components/schemas/CardPinResponse":{"id":"components/schemas/CardPinResponse","kind":"json-schema","title":"CardPinResponse","data":{"properties":{"success":{"type":"boolean","title":"Success"}},"type":"object","required":["success"],"title":"CardPinResponse"}},"components/schemas/CardStatusResponse":{"id":"components/schemas/CardStatusResponse","kind":"json-schema","title":"CardStatusResponse","data":{"properties":{"card_id":{"type":"string","format":"uuid","title":"Card Id"},"status":{"type":"string","enum":["OPEN","LOCKED","CLOSED","NOT_ACTIVATED","FROZEN"],"title":"Status"},"magstripe_status":{"anyOf":[{"type":"string","enum":["OFF","ON"]},{"type":"null"}],"title":"Magstripe Status"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["card_id","status","object_type"],"title":"CardStatusResponse"}},"components/schemas/CardStatusUpdateEvent":{"id":"components/schemas/CardStatusUpdateEvent","kind":"json-schema","title":"CardStatusUpdateEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/CardStatusUpdatePayload"},"event_type":{"type":"string","enum":["card.status.closed","card.status.open","card.status.frozen","card.status.locked"],"title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"CardStatusUpdateEvent","example":{"event_id":"ca9785f9-29f0-43d2-9f54-b7e77bf13f6b","event_type":"card.status.locked","payload":{"card_id":"cd1f9950-bed4-4692-aca6-ac101b0904e1","status":"LOCKED"},"timestamp":"2026-08-22T14:34:30.255284"}}},"components/schemas/CardStatusUpdatePayload":{"id":"components/schemas/CardStatusUpdatePayload","kind":"json-schema","title":"CardStatusUpdatePayload","data":{"properties":{"card_id":{"type":"string","format":"uuid","title":"Card Id"},"status":{"type":"string","enum":["OPEN","LOCKED","CLOSED","NOT_ACTIVATED","FROZEN"],"title":"Status"}},"type":"object","required":["card_id","status"],"title":"CardStatusUpdatePayload"}},"components/schemas/CardSwipe":{"id":"components/schemas/CardSwipe","kind":"json-schema","title":"CardSwipe","data":{"properties":{"card_id":{"type":"string","format":"uuid","title":"Card Id"},"amount_usdc":{"type":"integer","exclusiveMinimum":0,"title":"Amount Usdc"}},"type":"object","required":["card_id","amount_usdc"],"title":"CardSwipe"}},"components/schemas/CardTransactionActivity":{"id":"components/schemas/CardTransactionActivity","kind":"json-schema","title":"CardTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"CARD","title":"Type"},"location":{"anyOf":[{"$ref":"#/components/schemas/TransactionLocation"},{"type":"null"}]},"counterparty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty"},"terminal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Terminal Id"},"merchant_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Merchant Type"},"pre_authorization":{"type":"boolean","title":"Pre Authorization"},"issue_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issue Id"}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type","pre_authorization"],"title":"CardTransactionActivity"}},"components/schemas/CardTransactionDetails":{"id":"components/schemas/CardTransactionDetails","kind":"json-schema","title":"CardTransactionDetails","data":{"properties":{"location":{"anyOf":[{"$ref":"#/components/schemas/TransactionLocation"},{"type":"null"}]},"counterparty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty"},"terminal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Terminal Id"},"merchant_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Merchant Type"},"pre_authorization":{"type":"boolean","title":"Pre Authorization"},"issue_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issue Id"}},"type":"object","required":["pre_authorization"],"title":"CardTransactionDetails"}},"components/schemas/CardTransactionEvent":{"id":"components/schemas/CardTransactionEvent","kind":"json-schema","title":"CardTransactionEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/CardTransactionPayload"},"event_type":{"type":"string","enum":["card.transaction.approved","card.transaction.on_hold","card.transaction.reversed","card.transaction.rejected"],"title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"CardTransactionEvent"}},"components/schemas/CardTransactionPayload":{"id":"components/schemas/CardTransactionPayload","kind":"json-schema","title":"CardTransactionPayload","data":{"properties":{"card_id":{"type":"string","format":"uuid","title":"Card Id"},"amount":{"type":"integer","title":"Amount"},"account_id":{"type":"string","format":"uuid","title":"Account Id"}},"type":"object","required":["card_id","amount","account_id"],"title":"CardTransactionPayload"}},"components/schemas/CashBackTransactionDetails":{"id":"components/schemas/CashBackTransactionDetails","kind":"json-schema","title":"CashBackTransactionDetails","data":{"properties":{"period":{"type":"string","title":"Period","description":"Which period the cash back was calculated for, in YYYY-MM format."},"card_id":{"type":"string","format":"uuid","title":"Card Id"}},"type":"object","required":["period","card_id"],"title":"CashBackTransactionDetails"}},"components/schemas/ChangeCardStatusRequest":{"id":"components/schemas/ChangeCardStatusRequest","kind":"json-schema","title":"ChangeCardStatusRequest","data":{"properties":{"status":{"anyOf":[{"type":"string","enum":["OPEN","LOCKED"]},{"type":"null"}],"title":"Status"},"magstripe_status":{"anyOf":[{"type":"string","enum":["OFF","ON"]},{"type":"null"}],"title":"Magstripe Status"}},"type":"object","title":"ChangeCardStatusRequest"}},"components/schemas/CloseCardRequest":{"id":"components/schemas/CloseCardRequest","kind":"json-schema","title":"CloseCardRequest","data":{"properties":{"closure_reason":{"type":"string","enum":["LOST","STOLEN","DAMAGED","NEVER_RECEIVED","EXPIRED","CANCELED"],"title":"Closure Reason"},"lost_stolen_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Lost Stolen Date"}},"type":"object","required":["closure_reason"],"title":"CloseCardRequest"}},"components/schemas/CloseCustomerAccount":{"id":"components/schemas/CloseCustomerAccount","kind":"json-schema","title":"CloseCustomerAccount","data":{"properties":{"status":{"type":"string","const":"CLOSED","title":"Status"},"closure_reason":{"type":"string","enum":["SUSPICIOUS_ACTIVITY","USER_INSTIGATED","PARTNER_INITIATED_CLOSURE","INACTIVITY"],"title":"Closure Reason"},"closure_description":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Closure Description"}},"type":"object","required":["status","closure_reason"],"title":"CloseCustomerAccount"}},"components/schemas/Counterparty":{"id":"components/schemas/Counterparty","kind":"json-schema","title":"Counterparty","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"type":{"type":"string","enum":["ACH","WIRE"],"title":"Type"},"ach":{"anyOf":[{"$ref":"#/components/schemas/ACHCounterparty"},{"type":"null"}]},"wire":{"anyOf":[{"$ref":"#/components/schemas/WireCounterparty"},{"type":"null"}]},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","type","object_type"],"title":"Counterparty"}},"components/schemas/CounterpartyAddress":{"id":"components/schemas/CounterpartyAddress","kind":"json-schema","title":"CounterpartyAddress","data":{"properties":{"street_address":{"type":"string","maxLength":250,"title":"Street Address","description":"Street address"},"street_address2":{"anyOf":[{"type":"string","maxLength":250},{"type":"null"}],"title":"Street Address2","description":"Apartment, Suite, Box number, etc."},"city":{"type":"string","maxLength":250,"title":"City","description":"City / Town"},"postal_code":{"type":"string","maxLength":50,"title":"Postal Code","description":"Postal code / ZIP code"},"state":{"type":"string","title":"State","description":"State (Postal Abbreviations. Example: \"AL\", \"NJ\", \"OH\")"},"country":{"type":"string","title":"Country","description":"A ISO-3166 Alpha-2 country code (Abbreviated. Example: \"US\")"}},"type":"object","required":["street_address","city","postal_code","state","country"],"title":"CounterpartyAddress"}},"components/schemas/CounterpartyListResponseV2":{"id":"components/schemas/CounterpartyListResponseV2","kind":"json-schema","title":"CounterpartyListResponseV2","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"oneOf":[{"$ref":"#/components/schemas/ACHCounterpartyV2"},{"$ref":"#/components/schemas/WireCounterpartyV2"},{"$ref":"#/components/schemas/OnUsCounterpartyV2"},{"$ref":"#/components/schemas/InternationalWireCounterpartyV2"},{"$ref":"#/components/schemas/CryptoWalletAddressCounterpartyV2"}],"discriminator":{"propertyName":"type","mapping":{"ach":"#/components/schemas/ACHCounterpartyV2","crypto_wallet_address":"#/components/schemas/CryptoWalletAddressCounterpartyV2","international_wire":"#/components/schemas/InternationalWireCounterpartyV2","on_us":"#/components/schemas/OnUsCounterpartyV2","wire":"#/components/schemas/WireCounterpartyV2"}}},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"CounterpartyListResponseV2"}},"components/schemas/CounterpartyMicroDeposits":{"id":"components/schemas/CounterpartyMicroDeposits","kind":"json-schema","title":"CounterpartyMicroDeposits","data":{"properties":{"verification_failure_count":{"type":"integer","title":"Verification Failure Count"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["verification_failure_count","object_type"],"title":"CounterpartyMicroDeposits"}},"components/schemas/CounterpartyPlaid":{"id":"components/schemas/CounterpartyPlaid","kind":"json-schema","title":"CounterpartyPlaid","data":{"properties":{"mask":{"type":"string","title":"Mask"},"verification_status":{"anyOf":[{"type":"string","enum":["PENDING_AUTOMATIC_VERIFICATION","PENDING_MANUAL_VERIFICATION","AUTOMATICALLY_VERIFIED","MANUALLY_VERIFIED","VERIFICATION_EXPIRED","VERIFICATION_FAILED"]},{"type":"null"}],"title":"Verification Status"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["mask","verification_status","object_type"],"title":"CounterpartyPlaid"}},"components/schemas/CounterpartyStatusUpdateEvent":{"id":"components/schemas/CounterpartyStatusUpdateEvent","kind":"json-schema","title":"CounterpartyStatusUpdateEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/CounterpartyStatusUpdatePayload"},"event_type":{"type":"string","enum":["counterparty.status.linked","counterparty.status.unlinked","counterparty.status.failed"],"title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"CounterpartyStatusUpdateEvent"}},"components/schemas/CounterpartyStatusUpdatePayload":{"id":"components/schemas/CounterpartyStatusUpdatePayload","kind":"json-schema","title":"CounterpartyStatusUpdatePayload","data":{"properties":{"counterparty_id":{"type":"string","format":"uuid","title":"Counterparty Id"},"customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Customer Id"}},"type":"object","required":["counterparty_id"],"title":"CounterpartyStatusUpdatePayload"}},"components/schemas/Country":{"id":"components/schemas/Country","kind":"json-schema","title":"Country","data":{"type":"string","enum":["USA","US"],"title":"Country"}},"components/schemas/CreateACHCounterpartyRequest":{"id":"components/schemas/CreateACHCounterpartyRequest","kind":"json-schema","title":"CreateACHCounterpartyRequest","data":{"properties":{"routing_number":{"type":"string","title":"Routing Number"},"account_number":{"type":"string","title":"Account Number"},"account_type":{"type":"string","enum":["CHECKING","SAVINGS"],"title":"Account Type","description":"Account type"},"counterparty_name":{"type":"string","title":"Counterparty Name"},"verification":{"oneOf":[{"$ref":"#/components/schemas/CreatePreVerifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"pre_verified":"#/components/schemas/CreatePreVerifiedVerification"}}},"type":{"type":"string","const":"ach","title":"Type"},"display_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional client-chosen UUID to assign as the counterparty's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Supply one to know the counterparty's ID before it is created — useful for correlating a create that goes through an approval flow, or for making a retry safe. Omit it and Jiko generates the ID. Reusing an ID that already exists is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"type":"object","required":["routing_number","account_number","account_type","counterparty_name","verification","type"],"title":"CreateACHCounterpartyRequest"}},"components/schemas/CreateCryptoDepositAddressPortalRequest":{"id":"components/schemas/CreateCryptoDepositAddressPortalRequest","kind":"json-schema","title":"CreateCryptoDepositAddressPortalRequest","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","maxLength":50,"title":"Name"},"chain":{"type":"string","title":"Chain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ETH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported at this time."},"children":[]}]}]}]},"type":{"type":"string","const":"CRYPTO_DEPOSIT_ADDRESS_PORTAL","title":"Type"}},"type":"object","required":["id","name","chain","type"],"title":"CreateCryptoDepositAddressPortalRequest"}},"components/schemas/CreateCryptoWalletAddressCounterpartyRequest":{"id":"components/schemas/CreateCryptoWalletAddressCounterpartyRequest","kind":"json-schema","title":"CreateCryptoWalletAddressCounterpartyRequest","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"chain":{"type":"string","title":"Chain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ETH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported at this time."},"children":[]}]}]}]},"wallet_address":{"type":"string","title":"Wallet Address"},"counterparty_name":{"type":"string","title":"Counterparty Name"},"type":{"type":"string","const":"crypto_wallet_address","title":"Type"}},"type":"object","required":["id","chain","wallet_address","counterparty_name","type"],"title":"CreateCryptoWalletAddressCounterpartyRequest"}},"components/schemas/CreateIncomingWireVerification":{"id":"components/schemas/CreateIncomingWireVerification","kind":"json-schema","title":"CreateIncomingWireVerification","data":{"properties":{"type":{"type":"string","const":"incoming_wire","title":"Type"},"wire_id":{"type":"string","format":"uuid","title":"Wire Id"}},"type":"object","required":["type","wire_id"],"title":"CreateIncomingWireVerification"}},"components/schemas/CreateIndividualIdentificationNumber":{"id":"components/schemas/CreateIndividualIdentificationNumber","kind":"json-schema","title":"CreateIndividualIdentificationNumber","data":{"properties":{"identification_number":{"type":"string","title":"Identification Number"},"issuing_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuing Country","description":"A ISO-3166 Alpha-2 country code (Abbreviated. Example: \"US\")"},"identification_type":{"type":"string","enum":["SSN","PASSPORT","INTERNATIONAL_ID"],"title":"Identification Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identification_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. The options are"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SSN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Social security number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PASSPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A passport number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNATIONAL_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A government-issued national identity card. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNATIONAL_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type needs to be enabled. Please contact your Jiko representative. Selecting this value may prevent automatic onboarding and require manual review."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field will be made mandatory in a future release. Currently defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SSN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"type":"object","required":["identification_number","identification_type"],"title":"CreateIndividualIdentificationNumber"}},"components/schemas/CreateInternationalWireCounterpartyRequest":{"id":"components/schemas/CreateInternationalWireCounterpartyRequest","kind":"json-schema","title":"CreateInternationalWireCounterpartyRequest","data":{"properties":{"wire_instructions":{"anyOf":[{"type":"string","maxLength":140},{"type":"null"}],"title":"Wire Instructions","description":"Any additional wire instructions required for the wire to be processed correctly."},"counterparty_name":{"oneOf":[{"$ref":"#/components/schemas/IndividualName"},{"$ref":"#/components/schemas/BusinessName"}],"title":"Counterparty name","discriminator":{"propertyName":"type","mapping":{"business":"#/components/schemas/BusinessName","individual":"#/components/schemas/IndividualName"}}},"address":{"$ref":"#/components/schemas/CounterpartyAddress"},"identifier":{"type":"string","title":"Identifier","description":"Bank Account Number or IBAN Number"},"identifier_type":{"type":"string","enum":["iban","local"],"title":"Identifier Type","default":"local"},"swift_bic":{"type":"string","maxLength":11,"minLength":8,"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$","title":"Swift Bic","examples":["DEUTDEFF"]},"verification":{"oneOf":[{"$ref":"#/components/schemas/CreateSupportingDocumentsVerification"},{"$ref":"#/components/schemas/CreateUnverifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"supporting_documents":"#/components/schemas/CreateSupportingDocumentsVerification","unverified":"#/components/schemas/CreateUnverifiedVerification"}}},"type":{"type":"string","const":"international_wire","title":"Type"},"ownership_type":{"anyOf":[{"type":"string","enum":["FIRST_PARTY","THIRD_PARTY"]},{"type":"null"}],"title":"Ownership Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relationship of the counterparty to the account holder. FIRST_PARTY means the counterparty is owned by the account holder, THIRD_PARTY means it is owned by a different entity."},"children":[]}]}]}]},"display_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional client-chosen UUID to assign as the counterparty's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Supply one to know the counterparty's ID before it is created — useful for correlating a create that goes through an approval flow, or for making a retry safe. Omit it and Jiko generates the ID. Reusing an ID that already exists is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"type":"object","required":["counterparty_name","address","identifier","swift_bic","verification","type"],"title":"CreateInternationalWireCounterpartyRequest"}},"components/schemas/CreateNameMatchVerification":{"id":"components/schemas/CreateNameMatchVerification","kind":"json-schema","title":"CreateNameMatchVerification","data":{"properties":{"type":{"type":"string","const":"name_match","title":"Type"},"legal_name":{"type":"string","title":"Legal Name"}},"type":"object","required":["type","legal_name"],"title":"CreateNameMatchVerification"}},"components/schemas/CreateOnUsCounterpartyRequest":{"id":"components/schemas/CreateOnUsCounterpartyRequest","kind":"json-schema","title":"CreateOnUsCounterpartyRequest","data":{"properties":{"account_number":{"type":"string","title":"Account Number","description":"Represents the Jiko network address of the pocket."},"verification":{"oneOf":[{"$ref":"#/components/schemas/CreateNameMatchVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"name_match":"#/components/schemas/CreateNameMatchVerification"}}},"type":{"type":"string","const":"on_us","title":"Type"},"display_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional client-chosen UUID to assign as the counterparty's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Supply one to know the counterparty's ID before it is created — useful for correlating a create that goes through an approval flow, or for making a retry safe. Omit it and Jiko generates the ID. Reusing an ID that already exists is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"type":"object","required":["account_number","verification","type"],"title":"CreateOnUsCounterpartyRequest"}},"components/schemas/CreatePocketConfigurationId":{"id":"components/schemas/CreatePocketConfigurationId","kind":"json-schema","title":"CreatePocketConfigurationId","data":{"type":"string","enum":["UST-52W","UST-26W","UST-13W","UST-4W","UST-1W"],"title":"CreatePocketConfigurationId"}},"components/schemas/CreatePocketRequest":{"id":"components/schemas/CreatePocketRequest","kind":"json-schema","title":"CreatePocketRequest","data":{"properties":{"pocket_name":{"type":"string","maxLength":100,"title":"Pocket Name","description":"Pocket name"},"deposit_strategy_id":{"$ref":"#/components/schemas/CreatePocketConfigurationId","description":"Pocket deposit trading strategy ID (Example: UST-4W)"},"reinvestment_strategy_id":{"anyOf":[{"$ref":"#/components/schemas/CreatePocketConfigurationId"},{"type":"null"}],"description":"Pocket reinvestment trading strategy ID (Example: UST-4W)"},"type":{"anyOf":[{"type":"string","enum":["JIKO_PAY","JIKO_STORE"]},{"type":"null"}],"title":"Type","description":"Pocket type"}},"type":"object","required":["pocket_name","deposit_strategy_id"],"title":"CreatePocketRequest"}},"components/schemas/CreatePreVerifiedVerification":{"id":"components/schemas/CreatePreVerifiedVerification","kind":"json-schema","title":"CreatePreVerifiedVerification","data":{"properties":{"type":{"type":"string","const":"pre_verified","title":"Type"},"verification_method":{"type":"string","enum":["PLAID","MICRO_DEPOSIT"],"title":"Verification Method","description":"Underlying verification method"}},"type":"object","required":["type","verification_method"],"title":"CreatePreVerifiedVerification"}},"components/schemas/CreateReportRequest":{"id":"components/schemas/CreateReportRequest","kind":"json-schema","title":"CreateReportRequest","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"report":{"anyOf":[{"$ref":"#/components/schemas/BankStatementReport"},{"$ref":"#/components/schemas/TradeReport"},{"$ref":"#/components/schemas/SecurityPriceReport"},{"$ref":"#/components/schemas/BrokerageStatementReport"},{"$ref":"#/components/schemas/PositionSummaryReport"}],"title":"Report"},"output_formats":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":20,"minItems":1},{"type":"null"}],"title":"Output Formats","description":"If specified, renders only the specified formats. If not specified, renders all the available formats for the given report. The available formats differ depending on the report being requested. For a description of what formats are available per report, please refer to the Create Report Request endpoint description."}},"type":"object","required":["id","report"],"title":"CreateReportRequest"}},"components/schemas/CreateSubscriptionRequest":{"id":"components/schemas/CreateSubscriptionRequest","kind":"json-schema","title":"CreateSubscriptionRequest","data":{"properties":{"description":{"type":"string","title":"Description","description":"A description of the webhook's intended use.","default":""},"events":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Events","description":"Which types of events this webhook should be invoked for."},"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url","description":"The webhook URL to invoke."},"retry_policy":{"anyOf":[{"$ref":"#/components/schemas/RetryPolicy"},{"type":"null"}],"description":"The retry policy to use if Jiko encounters HTTP errors when calling subscription URLs."},"shared_secret":{"type":"string","minLength":16,"title":"Shared Secret","description":"The shared secret used by the Partner API to sign requests made to the webhook. The shared secret needs to be minimum 16 characters long."}},"type":"object","required":["events","url","shared_secret"],"title":"CreateSubscriptionRequest"}},"components/schemas/CreateSupportingDocumentsVerification":{"id":"components/schemas/CreateSupportingDocumentsVerification","kind":"json-schema","title":"CreateSupportingDocumentsVerification","data":{"properties":{"type":{"type":"string","const":"supporting_documents","title":"Type"},"document_ids":{"items":{"type":"string","format":"uuid"},"type":"array","minItems":1,"title":"Document Ids"}},"type":"object","required":["type","document_ids"],"title":"CreateSupportingDocumentsVerification"}},"components/schemas/CreateUnverifiedVerification":{"id":"components/schemas/CreateUnverifiedVerification","kind":"json-schema","title":"CreateUnverifiedVerification","data":{"properties":{"type":{"type":"string","const":"unverified","title":"Type"}},"type":"object","required":["type"],"title":"CreateUnverifiedVerification"}},"components/schemas/CreateVirtualBankAccountPortalRequest":{"id":"components/schemas/CreateVirtualBankAccountPortalRequest","kind":"json-schema","title":"CreateVirtualBankAccountPortalRequest","data":{"properties":{"name":{"type":"string","maxLength":50,"title":"Name"},"type":{"type":"string","const":"VIRTUAL_BANK_ACCOUNT_PORTAL","title":"Type"}},"type":"object","required":["name","type"],"title":"CreateVirtualBankAccountPortalRequest"}},"components/schemas/CreateWireCounterpartyRequest":{"id":"components/schemas/CreateWireCounterpartyRequest","kind":"json-schema","title":"CreateWireCounterpartyRequest","data":{"properties":{"routing_number":{"type":"string","title":"Routing Number"},"identifier":{"type":"string","title":"Identifier","description":"Bank Account Number or IBAN Number"},"identifier_code":{"anyOf":[{"type":"string","enum":["SWIFT_BIC","CHIPS_PARTICIPANT","DIRECT_DEPOSIT_ACCOUNT","FED_ROUTING_NUMBER","SWIFT_ID_AND_ACCOUNT_NUMBER","CHIPS_IDENTIFIER","PASSPORT_NUMBER","TAX_IDENTIFICATION_NUMBER","DRIVERS_LICENSE_NUMBER","ALIEN_REGISTRATION_NUMBER","CORPORATE_IDENTIFICATION","OTHER_IDENTIFICATION"]},{"type":"null"}],"title":"Identifier Code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[DEPRECATED] This field is ignored. The identifier code is always set to WireCounterpartyIdentifierCode_DDA_D (Demand Deposit Account)."},"children":[]}]}]}],"deprecated":true},"address":{"$ref":"#/components/schemas/CounterpartyAddress"},"wire_instructions":{"anyOf":[{"type":"string","maxLength":140},{"type":"null"}],"title":"Wire Instructions","description":"Any additional wire instructions required for the wire to be processed correctly."},"counterparty_name":{"oneOf":[{"$ref":"#/components/schemas/IndividualName"},{"$ref":"#/components/schemas/BusinessName"}],"title":"Counterparty name","discriminator":{"propertyName":"type","mapping":{"business":"#/components/schemas/BusinessName","individual":"#/components/schemas/IndividualName"}}},"verification":{"oneOf":[{"$ref":"#/components/schemas/CreateSupportingDocumentsVerification"},{"$ref":"#/components/schemas/CreateIncomingWireVerification"},{"$ref":"#/components/schemas/CreatePreVerifiedVerification"},{"$ref":"#/components/schemas/CreateUnverifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"incoming_wire":"#/components/schemas/CreateIncomingWireVerification","pre_verified":"#/components/schemas/CreatePreVerifiedVerification","supporting_documents":"#/components/schemas/CreateSupportingDocumentsVerification","unverified":"#/components/schemas/CreateUnverifiedVerification"}}},"type":{"type":"string","const":"wire","title":"Type"},"ownership_type":{"anyOf":[{"type":"string","enum":["FIRST_PARTY","THIRD_PARTY"]},{"type":"null"}],"title":"Ownership Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relationship of the counterparty to the account holder. FIRST_PARTY means the counterparty is owned by the account holder, THIRD_PARTY means it is owned by a different entity."},"children":[]}]}]}]},"display_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional client-chosen UUID to assign as the counterparty's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Supply one to know the counterparty's ID before it is created — useful for correlating a create that goes through an approval flow, or for making a retry safe. Omit it and Jiko generates the ID. Reusing an ID that already exists is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"type":"object","required":["routing_number","identifier","address","counterparty_name","verification","type"],"title":"CreateWireCounterpartyRequest"}},"components/schemas/CreditTransactionActivity":{"id":"components/schemas/CreditTransactionActivity","kind":"json-schema","title":"CreditTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"CREDIT","title":"Type"},"period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period","description":"Set if cash back for a certain card period."},"card_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Card Id","description":"The ID of the card related to the credit."}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type"],"title":"CreditTransactionActivity"}},"components/schemas/CryptoDepositAddressPortal":{"id":"components/schemas/CryptoDepositAddressPortal","kind":"json-schema","title":"CryptoDepositAddressPortal","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"name":{"type":"string","title":"Name","description":"Portal name"},"status":{"type":"string","enum":["OPEN","CLOSED","PENDING","REJECTED"],"title":"Status","description":"Portal status"},"type":{"type":"string","const":"CRYPTO_DEPOSIT_ADDRESS_PORTAL","title":"Type"},"chain":{"type":"string","title":"Chain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ETH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported at this time."},"children":[]}]}]}]},"wallet_address":{"type":"string","title":"Wallet Address"}},"type":"object","required":["id","pocket_id","time_created","name","status","type","chain","wallet_address"],"title":"CryptoDepositAddressPortal"}},"components/schemas/CryptoWalletAddressCounterpartyV2":{"id":"components/schemas/CryptoWalletAddressCounterpartyV2","kind":"json-schema","title":"Crypto wallet address Counterparty","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"status":{"type":"string","enum":["PENDING","FAILED","LINKED","UNLINKED","CLOSED"],"title":"Status"},"verification":{"oneOf":[{"$ref":"#/components/schemas/SupportingDocumentsVerification"},{"$ref":"#/components/schemas/IncomingWireVerification"},{"$ref":"#/components/schemas/PreVerifiedVerification"},{"$ref":"#/components/schemas/PlaidVerification"},{"$ref":"#/components/schemas/MicroDepositsVerification"},{"$ref":"#/components/schemas/NameMatchVerification"},{"$ref":"#/components/schemas/UnverifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"incoming_wire":"#/components/schemas/IncomingWireVerification","micro_deposits":"#/components/schemas/MicroDepositsVerification","name_match":"#/components/schemas/NameMatchVerification","plaid":"#/components/schemas/PlaidVerification","pre_verified":"#/components/schemas/PreVerifiedVerification","supporting_documents":"#/components/schemas/SupportingDocumentsVerification","unverified":"#/components/schemas/UnverifiedVerification"}}},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"counterparty_name":{"type":"string","title":"Counterparty Name"},"type":{"type":"string","const":"crypto_wallet_address","title":"Type"},"wallet_address":{"type":"string","title":"Wallet Address"},"chain":{"type":"string","title":"Chain"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","time_created","status","verification","counterparty_name","type","wallet_address","chain","object_type"],"title":"Crypto wallet address Counterparty"}},"components/schemas/CurrencyLeg":{"id":"components/schemas/CurrencyLeg","kind":"json-schema","title":"CurrencyLeg","data":{"properties":{"currency":{"type":"string","title":"Currency","description":"Currency code (e.g. 'USD')"},"description":{"type":"string","title":"Description","description":"A description of the currency leg"},"tradable_id":{"type":"string","title":"Tradable Id","description":"Internal identifier for the currency instrument"},"quantity":{"type":"integer","title":"Quantity","description":"Number of currency units in this leg"},"transaction_total":{"$ref":"#/components/schemas/Amount","description":"Total transaction value for this currency leg, in USD cents"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["currency","description","tradable_id","quantity","transaction_total","object_type"],"title":"CurrencyLeg"}},"components/schemas/CursorListResponse_ACHResponse_":{"id":"components/schemas/CursorListResponse_ACHResponse_","kind":"json-schema","title":"CursorListResponse[ACHResponse]","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/ACHResponse"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"CursorListResponse[ACHResponse]"}},"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____":{"id":"components/schemas/CursorListResponse_Annotated_Union_ACHTransactionActivity__WireTransactionActivity__CardTransactionActivity__OnUsTransactionActivity__FeeTransactionActivity__CreditTransactionActivity__GenericTransactionActivity__OnChainTransactionActivity___FieldInfo_annotation_NoneType__required_True__discriminator__type____","kind":"json-schema","title":"CursorListResponse[Annotated[Union[ACHTransactionActivity, WireTransactionActivity, CardTransactionActivity, OnUsTransactionActivity, FeeTransactionActivity, CreditTransactionActivity, GenericTransactionActivity, OnChainTransactionActivity], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"oneOf":[{"$ref":"#/components/schemas/ACHTransactionActivity"},{"$ref":"#/components/schemas/WireTransactionActivity"},{"$ref":"#/components/schemas/CardTransactionActivity"},{"$ref":"#/components/schemas/OnUsTransactionActivity"},{"$ref":"#/components/schemas/FeeTransactionActivity"},{"$ref":"#/components/schemas/CreditTransactionActivity"},{"$ref":"#/components/schemas/GenericTransactionActivity"},{"$ref":"#/components/schemas/OnChainTransactionActivity"}],"discriminator":{"propertyName":"type","mapping":{"ACH":"#/components/schemas/ACHTransactionActivity","CARD":"#/components/schemas/CardTransactionActivity","CREDIT":"#/components/schemas/CreditTransactionActivity","FEE":"#/components/schemas/FeeTransactionActivity","GENERIC":"#/components/schemas/GenericTransactionActivity","ON_CHAIN":"#/components/schemas/OnChainTransactionActivity","ON_US":"#/components/schemas/OnUsTransactionActivity","WIRE":"#/components/schemas/WireTransactionActivity"}}},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"CursorListResponse[Annotated[Union[ACHTransactionActivity, WireTransactionActivity, CardTransactionActivity, OnUsTransactionActivity, FeeTransactionActivity, CreditTransactionActivity, GenericTransactionActivity, OnChainTransactionActivity], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]"}},"components/schemas/CursorListResponse_Annotated_Union_IncomingWireResponse__OutgoingWireResponse___FieldInfo_annotation_NoneType__required_True__discriminator__direction____":{"id":"components/schemas/CursorListResponse_Annotated_Union_IncomingWireResponse__OutgoingWireResponse___FieldInfo_annotation_NoneType__required_True__discriminator__direction____","kind":"json-schema","title":"CursorListResponse[Annotated[Union[IncomingWireResponse, OutgoingWireResponse], FieldInfo(annotation=NoneType, required=True, discriminator='direction')]]","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"oneOf":[{"$ref":"#/components/schemas/IncomingWireResponse"},{"$ref":"#/components/schemas/OutgoingWireResponse"}],"discriminator":{"propertyName":"direction","mapping":{"INCOMING":"#/components/schemas/IncomingWireResponse","OUTGOING":"#/components/schemas/OutgoingWireResponse"}}},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"CursorListResponse[Annotated[Union[IncomingWireResponse, OutgoingWireResponse], FieldInfo(annotation=NoneType, required=True, discriminator='direction')]]"}},"components/schemas/CursorListResponse_PartnerEvent_":{"id":"components/schemas/CursorListResponse_PartnerEvent_","kind":"json-schema","title":"CursorListResponse[PartnerEvent]","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/PartnerEvent"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"CursorListResponse[PartnerEvent]"}},"components/schemas/CursorListResponse_ReportRequest_":{"id":"components/schemas/CursorListResponse_ReportRequest_","kind":"json-schema","title":"CursorListResponse[ReportRequest]","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/ReportRequest"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"CursorListResponse[ReportRequest]"}},"components/schemas/CursorListResponse_Subscription_":{"id":"components/schemas/CursorListResponse_Subscription_","kind":"json-schema","title":"CursorListResponse[Subscription]","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/Subscription"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"CursorListResponse[Subscription]"}},"components/schemas/CusipSecurity":{"id":"components/schemas/CusipSecurity","kind":"json-schema","title":"CusipSecurity","data":{"properties":{"cusip":{"type":"string","title":"Cusip","description":"CUSIP identifier of the security"},"description":{"type":"string","title":"Description","description":"A description of the security (e.g. '6 Month T Bill')"},"tradable_id":{"type":"string","title":"Tradable Id","description":"Internal identifier for the tradable instrument"},"maturity_date":{"type":"string","format":"date","title":"Maturity Date","description":"Maturity date of the fixed income instrument"},"quantity":{"type":"integer","title":"Quantity","description":"Number of securities in this leg"},"price":{"anyOf":[{"$ref":"#/components/schemas/Decimal"},{"type":"null"}],"description":"Unit price of the security at the time of the trade"},"transaction_total":{"$ref":"#/components/schemas/Amount","description":"Total transaction value for this security leg, in USD cents"},"original_purchase_price":{"anyOf":[{"$ref":"#/components/schemas/Decimal"},{"type":"null"}],"description":"Original purchase price from the source tax lot. Only populated for security transfer trades."},"original_settlement_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Original Settlement Date","description":"Original settlement date from the source tax lot. Only populated for security transfer trades."},"original_trade_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Original Trade Date","description":"Original trade date from the source tax lot. Only populated for security transfer trades."},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["cusip","description","tradable_id","maturity_date","quantity","transaction_total","object_type"],"title":"CusipSecurity"}},"components/schemas/Customer":{"id":"components/schemas/Customer","kind":"json-schema","title":"Customer","data":{"oneOf":[{"$ref":"#/components/schemas/Individual"},{"$ref":"#/components/schemas/Business"}],"title":"Customer","discriminator":{"propertyName":"type","mapping":{"BUSINESS":"#/components/schemas/Business","INDIVIDUAL":"#/components/schemas/Individual"}}}},"components/schemas/CustomerDefundingTransferRequest":{"id":"components/schemas/CustomerDefundingTransferRequest","kind":"json-schema","title":"Partner-Customer Defunding","data":{"properties":{"transfer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Transfer Id","description":"The ID for this transfer, auto-generated if not provided."},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description","description":"A description of the transfer, visible on statements."},"end_to_end_identification":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"End To End Identification","description":"Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain."},"from_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"to_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"type":{"type":"string","const":"PARTNER_CUSTOMER_DEFUNDING","title":"Type","description":"Withdraw funds from customer to partner."},"target":{"type":"string","maxLength":200,"title":"Target","description":"The funds destination belonging to the customer at the Partner institution."},"amount_usdc":{"anyOf":[{"type":"integer","exclusiveMinimum":0},{"type":"null"}],"title":"Amount USDC","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount, in USD cents. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"amount":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/RequestedAmount"},{"$ref":"#/components/schemas/FullWithdrawal"}],"discriminator":{"propertyName":"type","mapping":{"FULL_WITHDRAWAL":"#/components/schemas/FullWithdrawal","REQUESTED_AMOUNT":"#/components/schemas/RequestedAmount"}}},{"type":"null"}],"title":"Amount"},"async_mode":{"type":"boolean","title":"Async Mode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using asynchronous processing is strongly recommended."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Status updates will be delivered via Webhooks."},"children":[]}]}]}],"default":false}},"type":"object","required":["from_account","to_account","type","target"],"title":"Partner-Customer Defunding","example":{"amount":{"type":"FULL_WITHDRAWAL"},"description":"Withdrawing funds from customer to partner","from_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"target":"123456789","to_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"transfer_id":"d64e7b7e-7fd2-44a4-8bfd-68a31252afaa","type":"PARTNER_CUSTOMER_DEFUNDING"}}},"components/schemas/CustomerDefundingTransferResponse":{"id":"components/schemas/CustomerDefundingTransferResponse","kind":"json-schema","title":"Partner-Customer Defunding","data":{"properties":{"transfer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Transfer Id","description":"The ID for this transfer, auto-generated if not provided."},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description","description":"A description of the transfer, visible on statements."},"end_to_end_identification":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"End To End Identification","description":"Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain."},"from_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"to_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"type":{"type":"string","const":"PARTNER_CUSTOMER_DEFUNDING","title":"Type"},"target":{"type":"string","maxLength":200,"title":"Target","description":"The funds destination belonging to the customer at the Partner institution."},"amount":{"$ref":"#/components/schemas/Amount"}},"type":"object","required":["from_account","to_account","type","target","amount"],"title":"Partner-Customer Defunding","example":{"amount":{"type":"FULL_WITHDRAWAL"},"description":"Withdrawing funds from customer to partner","from_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"target":"123456789","to_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"transfer_id":"d64e7b7e-7fd2-44a4-8bfd-68a31252afaa","type":"PARTNER_CUSTOMER_DEFUNDING"}}},"components/schemas/CustomerEarningsResponse":{"id":"components/schemas/CustomerEarningsResponse","kind":"json-schema","title":"CustomerEarningsResponse","data":{"properties":{"aggregate":{"anyOf":[{"$ref":"#/components/schemas/EarningsResponse"},{"type":"null"}]},"pockets":{"items":{"$ref":"#/components/schemas/PocketEarnings"},"type":"array","title":"Pockets"}},"type":"object","required":["aggregate","pockets"],"title":"CustomerEarningsResponse"}},"components/schemas/CustomerFundingTransferRequest":{"id":"components/schemas/CustomerFundingTransferRequest","kind":"json-schema","title":"Partner-Customer Funding","data":{"properties":{"transfer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Transfer Id","description":"The ID for this transfer, auto-generated if not provided."},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description","description":"A description of the transfer, visible on statements."},"end_to_end_identification":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"End To End Identification","description":"Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain."},"from_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"to_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"type":{"type":"string","const":"PARTNER_CUSTOMER_FUNDING","title":"Type","description":"Disburse funds from partner to customer."},"source":{"type":"string","maxLength":200,"title":"Source","description":"The source of customer funds at the Partner institution."},"amount_usdc":{"anyOf":[{"type":"integer","exclusiveMinimum":0},{"type":"null"}],"title":"Amount USDC","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount, in USD cents. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"amount":{"anyOf":[{"$ref":"#/components/schemas/RequestedAmount"},{"type":"null"}]},"async_mode":{"type":"boolean","title":"Async Mode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using asynchronous processing is strongly recommended."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Status updates will be delivered via Webhooks."},"children":[]}]}]}],"default":false}},"type":"object","required":["from_account","to_account","type","source"],"title":"Partner-Customer Funding","example":{"amount":{"amount_usdc":100000,"type":"REQUESTED_AMOUNT"},"description":"Disbursing funds from partner to customer","from_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"source":"123456789","to_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"transfer_id":"d4a2d8dd-7def-4545-a062-761683b9aa05","type":"PARTNER_CUSTOMER_FUNDING"}}},"components/schemas/CustomerFundingTransferResponse":{"id":"components/schemas/CustomerFundingTransferResponse","kind":"json-schema","title":"Partner-Customer Funding","data":{"properties":{"transfer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Transfer Id","description":"The ID for this transfer, auto-generated if not provided."},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description","description":"A description of the transfer, visible on statements."},"end_to_end_identification":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"End To End Identification","description":"Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain."},"from_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"to_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"type":{"type":"string","const":"PARTNER_CUSTOMER_FUNDING","title":"Type"},"source":{"type":"string","maxLength":200,"title":"Source","description":"The source of customer funds at the Partner institution."},"amount":{"$ref":"#/components/schemas/Amount"}},"type":"object","required":["from_account","to_account","type","source","amount"],"title":"Partner-Customer Funding","example":{"amount":{"amount_usdc":100000,"type":"REQUESTED_AMOUNT"},"description":"Disbursing funds from partner to customer","from_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"source":"123456789","to_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"transfer_id":"d4a2d8dd-7def-4545-a062-761683b9aa05","type":"PARTNER_CUSTOMER_FUNDING"}}},"components/schemas/CustomerPocket":{"id":"components/schemas/CustomerPocket","kind":"json-schema","title":"CustomerPocket","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"ID of the pocket"},"pocket_name":{"type":"string","title":"Pocket Name","description":"Pocket name"},"portfolio":{"anyOf":[{"$ref":"#/components/schemas/partner_api__interface__models__v2__pockets__Portfolio"},{"type":"null"}],"description":"Total liquid cash and holdings"},"status":{"type":"string","enum":["PENDING","OPEN","FROZEN","CLOSED"],"title":"Status","description":"Pocket status"},"attributes":{"items":{"type":"string"},"type":"array","title":"Attributes"},"deposit_strategy_id":{"type":"string","title":"Deposit Strategy Id","description":"Pocket deposit trading strategy ID (Example: UST-4W)"},"reinvestment_strategy_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reinvestment Strategy Id","description":"Pocket reinvestment trading strategy ID (Example: UST-4W)"},"type":{"anyOf":[{"type":"string","enum":["JIKO_PAY","JIKO_STORE"]},{"type":"null"}],"title":"Type","description":"Pocket type"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The ID of the customer this pocket belongs to"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","pocket_name","status","deposit_strategy_id","reinvestment_strategy_id","customer_id","object_type"],"title":"CustomerPocket"}},"components/schemas/CustomerPocketsResponse":{"id":"components/schemas/CustomerPocketsResponse","kind":"json-schema","title":"CustomerPocketsResponse","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/CustomerPocket"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"CustomerPocketsResponse"}},"components/schemas/DateOfBirth":{"id":"components/schemas/DateOfBirth","kind":"json-schema","title":"DateOfBirth","data":{"properties":{"date_of_birth":{"type":"string","format":"date","title":"Date Of Birth"}},"type":"object","required":["date_of_birth"],"title":"DateOfBirth"}},"components/schemas/Decimal":{"id":"components/schemas/Decimal","kind":"json-schema","title":"Decimal","data":{"type":"string","title":"Decimal"}},"components/schemas/DeliveryAttemptDetails":{"id":"components/schemas/DeliveryAttemptDetails","kind":"json-schema","title":"DeliveryAttemptDetails","data":{"properties":{"delivery_attempt_id":{"type":"string","format":"uuid","title":"Delivery Attempt Id"},"subscription_id":{"type":"string","format":"uuid","title":"Subscription Id"},"success":{"type":"boolean","title":"Success"},"response_code":{"type":"integer","title":"Response Code"},"response_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Message"},"called_at":{"type":"string","format":"date-time","title":"Called At"}},"type":"object","required":["delivery_attempt_id","subscription_id","success","response_code","response_message","called_at"],"title":"DeliveryAttemptDetails"}},"components/schemas/Document":{"id":"components/schemas/Document","kind":"json-schema","title":"Document","data":{"properties":{"id":{"type":"string","title":"Id"},"type":{"type":"string","enum":["ID_FRONT","ID_BACK","ID_BARCODE","SELFIE","IDENTIFICATION_NUMBER_VERIFICATION","ADDRESS_VERIFICATION","PASSPORT","EIN_CONFIRMATION","OPERATING_AGREEMENT","PARTNERSHIP_AGREEMENT","ARTICLES_OF_INCORPORATION","BYLAWS","PROOF_OF_501_STATUS","ARTICLES_OF_ASSOCIATION","CORPORATE_CHARTER","TRUST_FORMATION_RECORDS","LIST_OF_TRUSTEES","TRUST_VERIFICATION_DOCUMENT","LEGAL_ANALYSIS_OF_BUSINESS_MODEL","COINS_AND_TOKENS_LISTED_AND_OFFERED","COIN_RATING_POLICY_AND_PROCEDURES","TYPE_OF_BLOCKCHAIN_ANALYTICS_USED","MARKET_MANIPULATION_POLICY","BSA_AML_OFAC_POLICIES","INDEPENDENT_AML_AUDIT_REPORT","BSA_AML_OFAC_INTERNAL_RISK_ASSESSMENT","ARTICLES_OF_ORGANIZATION","FLOW_OF_FUNDS","BANK_STATEMENTS_1","BANK_STATEMENTS_2","BANK_STATEMENTS_3","ORG_CHART","BUSINESS_DESCRIPTION","CERTIFICATE_OF_GOOD_STANDING","CERTIFICATE_OF_TRADE_NAME","COMPANY_RESOLUTION","SIGNATURE_AUTHORIZATION","BANK_STATEMENT","BUSINESS_LICENSE","CERTIFICATE_OF_EXISTENCE","CERTIFICATE_OF_ASSUMED_NAME","COMPANY_REGISTRATION_DOCUMENT","INTERNAL_KYC_AUDIT","EXTERNAL_KYC_AUDIT","KYC_POLICIES_AND_PROCEDURES","WIRE_COUNTERPARTY_VERIFICATION","CUSTOMER_RFI_REPLY","OTHER"],"title":"Type"},"status":{"type":"string","enum":["PENDING_UPLOAD","PENDING_REVIEW","APPROVED","INVALID"],"title":"Status"},"exception_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exception Reason"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","required":["id","type","status"],"title":"Document"}},"components/schemas/DomesticWireFundingInstruction":{"id":"components/schemas/DomesticWireFundingInstruction","kind":"json-schema","title":"DomesticWireFundingInstruction","data":{"properties":{"type":{"type":"string","const":"DOMESTIC_WIRE","title":"Type"},"receiver_bank":{"$ref":"#/components/schemas/ReceiverBank"},"beneficiary":{"$ref":"#/components/schemas/Beneficiary"}},"type":"object","required":["type","receiver_bank","beneficiary"],"title":"DomesticWireFundingInstruction"}},"components/schemas/EarningsResponse":{"id":"components/schemas/EarningsResponse","kind":"json-schema","title":"EarningsResponse","data":{"properties":{"earnings":{"$ref":"#/components/schemas/Amount"},"date_from":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"},"date_to":{"type":"string","format":"date","title":"Date To"},"pricing_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Pricing Timestamp"},"appreciation_per_second":{"anyOf":[{"$ref":"#/components/schemas/Decimal"},{"type":"null"}]}},"type":"object","required":["earnings","date_from","date_to"],"title":"EarningsResponse"}},"components/schemas/EmployedInvestmentProfile":{"id":"components/schemas/EmployedInvestmentProfile","kind":"json-schema","title":"EmployedInvestmentProfile","data":{"properties":{"income":{"type":"string","enum":["BELOW_50K","BETWEEN_50K_AND_100K","BETWEEN_100K_AND_250K","OVER_250K"],"title":"Income","description":"Applicant's estimated annual income in USD."},"net_worth":{"type":"string","enum":["BELOW_50K","BETWEEN_50K_AND_200K","BETWEEN_200K_AND_1M","BETWEEN_1M_AND_5M","OVER_5M"],"title":"Net Worth","description":"Applicant's estimated average personal net worth in USD."},"bd_association":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Bd Association","description":"Name of broker-dealer association or employment. Disclosure is required by law if applicable, else, leave empty"},"director_policy_maker_of_company":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Director Policy Maker Of Company","description":"Name of company where customer is director or policy maker. Disclosure is required by law if applicable, otherwise, leave empty"},"occupation":{"type":"string","maxLength":200,"minLength":2,"title":"Occupation","description":"Applicant's occupation. Needs to be filled out if employment status is Employed."},"employment_status":{"type":"string","const":"EMPLOYED","title":"Employment Status"}},"type":"object","required":["income","net_worth","occupation","employment_status"],"title":"EmployedInvestmentProfile"}},"components/schemas/EncryptionKeysResponse":{"id":"components/schemas/EncryptionKeysResponse","kind":"json-schema","title":"EncryptionKeysResponse","data":{"properties":{"set_pin":{"type":"string","title":"Set Pin","default":""}},"additionalProperties":false,"type":"object","title":"EncryptionKeysResponse","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encryption keys are currently stored as environment variables."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variables are declared in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"services/partner-api/secret-(dev|staging|sandbox|partners).yaml"},"children":[]}]}]}]}},"components/schemas/ErrorResponseModel":{"id":"components/schemas/ErrorResponseModel","kind":"json-schema","title":"ErrorResponseModel","data":{"properties":{"type":{"type":"string","title":"Type"},"instance":{"type":"string","title":"Instance"},"detail":{"type":"string","title":"Detail"},"trace_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trace Id"}},"type":"object","required":["type","instance","detail"],"title":"ErrorResponseModel"}},"components/schemas/EventDetails":{"id":"components/schemas/EventDetails","kind":"json-schema","title":"EventDetails","data":{"oneOf":[{"$ref":"#/components/schemas/ApplicationUpdateEvent"},{"$ref":"#/components/schemas/CardStatusUpdateEvent"},{"$ref":"#/components/schemas/ACHIncomingEvent"},{"$ref":"#/components/schemas/ACHOutgoingEvent"},{"$ref":"#/components/schemas/CardTransactionEvent"},{"$ref":"#/components/schemas/OutgoingWireEvent"},{"$ref":"#/components/schemas/OnUsTransferEvent"},{"$ref":"#/components/schemas/OnUsTransferReceivedEvent"},{"$ref":"#/components/schemas/TradableMaturityEvent"},{"$ref":"#/components/schemas/ReportEvent"},{"$ref":"#/components/schemas/CounterpartyStatusUpdateEvent"},{"$ref":"#/components/schemas/IncomingWireEvent"}],"title":"EventDetails","discriminator":{"propertyName":"event_type","mapping":{"application.approved":"#/components/schemas/ApplicationUpdateEvent","application.documents_needed":"#/components/schemas/ApplicationUpdateEvent","application.manual_review":"#/components/schemas/ApplicationUpdateEvent","application.rejected":"#/components/schemas/ApplicationUpdateEvent","card.status.closed":"#/components/schemas/CardStatusUpdateEvent","card.status.frozen":"#/components/schemas/CardStatusUpdateEvent","card.status.locked":"#/components/schemas/CardStatusUpdateEvent","card.status.open":"#/components/schemas/CardStatusUpdateEvent","card.transaction.approved":"#/components/schemas/CardTransactionEvent","card.transaction.on_hold":"#/components/schemas/CardTransactionEvent","card.transaction.rejected":"#/components/schemas/CardTransactionEvent","card.transaction.reversed":"#/components/schemas/CardTransactionEvent","counterparty.status.failed":"#/components/schemas/CounterpartyStatusUpdateEvent","counterparty.status.linked":"#/components/schemas/CounterpartyStatusUpdateEvent","counterparty.status.unlinked":"#/components/schemas/CounterpartyStatusUpdateEvent","report.status.available":"#/components/schemas/ReportEvent","report.status.failed":"#/components/schemas/ReportEvent","report.status.pending":"#/components/schemas/ReportEvent","tradable.maturity":"#/components/schemas/TradableMaturityEvent","transfers.ach.in.rejected":"#/components/schemas/ACHIncomingEvent","transfers.ach.in.success":"#/components/schemas/ACHIncomingEvent","transfers.ach.out.rejected":"#/components/schemas/ACHOutgoingEvent","transfers.ach.out.sent":"#/components/schemas/ACHOutgoingEvent","transfers.ach.out.success":"#/components/schemas/ACHOutgoingEvent","transfers.on-us.processing":"#/components/schemas/OnUsTransferEvent","transfers.on-us.received":"#/components/schemas/OnUsTransferReceivedEvent","transfers.on-us.rejected":"#/components/schemas/OnUsTransferEvent","transfers.on-us.success":"#/components/schemas/OnUsTransferEvent","transfers.wire.in.rejected":"#/components/schemas/IncomingWireEvent","transfers.wire.in.success":"#/components/schemas/IncomingWireEvent","transfers.wire.out.processing":"#/components/schemas/OutgoingWireEvent","transfers.wire.out.rejected":"#/components/schemas/OutgoingWireEvent","transfers.wire.out.success":"#/components/schemas/OutgoingWireEvent"}}}},"components/schemas/EventListResponse":{"id":"components/schemas/EventListResponse","kind":"json-schema","title":"EventListResponse","data":{"properties":{"offset":{"type":"integer","title":"Offset"},"count":{"type":"integer","title":"Count"},"items":{"items":{"$ref":"#/components/schemas/EventType"},"type":"array","title":"Items","description":"List of available events to subscribe to"},"object_type":{"type":"string","title":"Object Type","default":"List"}},"type":"object","required":["offset","count","items"],"title":"EventListResponse"}},"components/schemas/EventType":{"id":"components/schemas/EventType","kind":"json-schema","title":"EventType","data":{"properties":{"event":{"type":"string","title":"Event"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["event","object_type"],"title":"EventType"}},"components/schemas/Fee":{"id":"components/schemas/Fee","kind":"json-schema","title":"Fee","data":{"properties":{"type":{"type":"string","const":"AUM_FEE","title":"Type"},"amount":{"$ref":"#/components/schemas/Amount"}},"type":"object","required":["type","amount"],"title":"Fee"}},"components/schemas/FeeTransactionActivity":{"id":"components/schemas/FeeTransactionActivity","kind":"json-schema","title":"FeeTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"FEE","title":"Type"},"fee_type":{"type":"string","title":"Fee Type"}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type","fee_type"],"title":"FeeTransactionActivity"}},"components/schemas/FixedIncomeSecurity":{"id":"components/schemas/FixedIncomeSecurity","kind":"json-schema","title":"FixedIncomeSecurity","data":{"properties":{"quantity":{"type":"integer","title":"Quantity","description":"Number of securities"},"market_value":{"$ref":"#/components/schemas/Amount","description":"The current market value of the securities"},"cusip":{"type":"string","title":"Cusip","description":"CUSIP number of security"},"jiko_mark_price":{"$ref":"#/components/schemas/Decimal","description":"Current price of security"},"description":{"type":"string","title":"Description","description":"A description of the security"},"type":{"type":"string","const":"FIXED_INCOME","title":"Type"},"maturity_date":{"type":"string","format":"date","title":"Maturity Date","description":"Due date of the fixed income instrument"},"yield_to_maturity":{"$ref":"#/components/schemas/Decimal","description":"Rate of return if the security is held to the maturity date"}},"type":"object","required":["quantity","market_value","cusip","jiko_mark_price","description","type","maturity_date","yield_to_maturity"],"title":"FixedIncomeSecurity"}},"components/schemas/FullWithdrawal":{"id":"components/schemas/FullWithdrawal","kind":"json-schema","title":"Full withdrawal","data":{"properties":{"type":{"type":"string","const":"FULL_WITHDRAWAL","title":"Type"}},"type":"object","required":["type"],"title":"Full withdrawal","description":"Fully liquidates all T-Bills from the source account."}},"components/schemas/FundPortalRequest":{"id":"components/schemas/FundPortalRequest","kind":"json-schema","title":"FundPortalRequest","data":{"properties":{"account_id":{"type":"string","format":"uuid","title":"Account Id"},"amount_usdc":{"type":"integer","exclusiveMaximum":5000000,"exclusiveMinimum":0,"title":"Amount Usdc"},"company_name":{"type":"string","maxLength":16,"title":"Company Name","default":"FakeCompany"},"count":{"type":"integer","exclusiveMaximum":10,"exclusiveMinimum":0,"title":"Count","default":1}},"type":"object","required":["account_id","amount_usdc"],"title":"FundPortalRequest"}},"components/schemas/FundingInstructionsResponse":{"id":"components/schemas/FundingInstructionsResponse","kind":"json-schema","title":"FundingInstructionsResponse","data":{"properties":{"items":{"items":{"oneOf":[{"$ref":"#/components/schemas/ACHFundingInstruction"},{"$ref":"#/components/schemas/DomesticWireFundingInstruction"},{"$ref":"#/components/schemas/InternationalWireFundingInstruction"},{"$ref":"#/components/schemas/OnUsFundingInstruction"},{"$ref":"#/components/schemas/USDCFundingInstruction"}],"discriminator":{"propertyName":"type","mapping":{"ACH":"#/components/schemas/ACHFundingInstruction","DOMESTIC_WIRE":"#/components/schemas/DomesticWireFundingInstruction","INTERNATIONAL_WIRE":"#/components/schemas/InternationalWireFundingInstruction","ON_US":"#/components/schemas/OnUsFundingInstruction","USDC":"#/components/schemas/USDCFundingInstruction"}}},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"FundingInstructionsResponse"}},"components/schemas/GeneralAddress":{"id":"components/schemas/GeneralAddress","kind":"json-schema","title":"GeneralAddress","data":{"properties":{"street_address":{"type":"string","maxLength":250,"title":"Street Address","description":"Street address"},"street_address2":{"anyOf":[{"type":"string","maxLength":250},{"type":"null"}],"title":"Street Address2","description":"Apartment, Suite, Box number, etc."},"city":{"type":"string","maxLength":250,"title":"City","description":"City / Town"},"postal_code":{"type":"string","maxLength":50,"title":"Postal Code","description":"Postal code / ZIP code"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State (Postal Abbreviations. Example: \"AL\", \"NJ\", \"OH\")"},"country":{"type":"string","title":"Country","description":"A ISO-3166 Alpha-2 country code (Abbreviated. Example: \"US\")"}},"type":"object","required":["street_address","city","postal_code","country"],"title":"GeneralAddress"}},"components/schemas/GeneratePhysicalCardFromOrder":{"id":"components/schemas/GeneratePhysicalCardFromOrder","kind":"json-schema","title":"GeneratePhysicalCardFromOrder","data":{"properties":{"card_order_id":{"type":"string","format":"uuid","title":"Card Order Id"}},"type":"object","required":["card_order_id"],"title":"GeneratePhysicalCardFromOrder"}},"components/schemas/GenericTransactionActivity":{"id":"components/schemas/GenericTransactionActivity","kind":"json-schema","title":"GenericTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"GENERIC","title":"Type"},"reference_transaction_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Reference Transaction Id","description":"For reverse postings, the identity of the transaction being reversed. "}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type","reference_transaction_id"],"title":"GenericTransactionActivity"}},"components/schemas/HTTPValidationError":{"id":"components/schemas/HTTPValidationError","kind":"json-schema","title":"HTTPValidationError","data":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}},"components/schemas/ISOAddress":{"id":"components/schemas/ISOAddress","kind":"json-schema","title":"ISOAddress","data":{"properties":{"street_address":{"type":"string","maxLength":250,"title":"Street Address","description":"Street address"},"street_address2":{"anyOf":[{"type":"string","maxLength":250},{"type":"null"}],"title":"Street Address2","description":"Apartment, Suite, Box number, etc."},"city":{"type":"string","maxLength":250,"title":"City","description":"City / Town"},"postal_code":{"type":"string","maxLength":50,"title":"Postal Code","description":"Postal code / ZIP code"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State (Postal Abbreviations. Example: \"AL\", \"NJ\", \"OH\")"},"country":{"type":"string","title":"Country","description":"A ISO-3166 Alpha-2 country code (Abbreviated. Example: \"US\")"}},"type":"object","required":["street_address","city","postal_code","country"],"title":"ISOAddress"}},"components/schemas/ISOAddressRequest":{"id":"components/schemas/ISOAddressRequest","kind":"json-schema","title":"ISOAddressRequest","data":{"properties":{"street_address":{"type":"string","maxLength":250,"title":"Street Address","description":"Street address"},"street_address2":{"anyOf":[{"type":"string","maxLength":250},{"type":"null"}],"title":"Street Address2","description":"Apartment, Suite, Box number, etc."},"city":{"type":"string","maxLength":250,"title":"City","description":"City / Town"},"postal_code":{"type":"string","maxLength":50,"title":"Postal Code","description":"Postal code / ZIP code"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State (Postal Abbreviations. Example: \"AL\", \"NJ\", \"OH\")"},"country":{"type":"string","title":"Country","description":"A ISO-3166 Alpha-2 country code (Abbreviated. Example: \"US\")"}},"type":"object","required":["street_address","city","postal_code","country"],"title":"ISOAddressRequest"}},"components/schemas/IncomingWireEvent":{"id":"components/schemas/IncomingWireEvent","kind":"json-schema","title":"IncomingWireEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/WireIncomingPayload"},"event_type":{"type":"string","enum":["transfers.wire.in.success","transfers.wire.in.rejected"],"title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"IncomingWireEvent"}},"components/schemas/IncomingWireResponse":{"id":"components/schemas/IncomingWireResponse","kind":"json-schema","title":"IncomingWireResponse","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"status":{"type":"string","enum":["PENDING","SUCCESS","REJECTED"],"title":"Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the wire transfer: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"amount":{"$ref":"#/components/schemas/Amount"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also known as jiko_account_id"},"children":[]}]}]}]},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"wire_tracking_info":{"anyOf":[{"$ref":"#/components/schemas/WireTrackingInfo"},{"type":"null"}],"description":"Identifiers used to track the wire through the payment network. On outgoing wires these are assigned when the wire is sent; on incoming wires they are read from the received message. Null when not available."},"direction":{"type":"string","const":"INCOMING","title":"Direction","default":"INCOMING"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","status","amount","pocket_id","time_created","object_type"],"title":"IncomingWireResponse"}},"components/schemas/IncomingWireVerification":{"id":"components/schemas/IncomingWireVerification","kind":"json-schema","title":"IncomingWireVerification","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"type":"string","const":"incoming_wire","title":"Type"},"wire_id":{"type":"string","format":"uuid","title":"Wire Id"},"status":{"type":"string","enum":["PENDING_REVIEW","APPROVED","REJECTED"],"title":"Status"}},"type":"object","required":["id","description","type","wire_id","status"],"title":"IncomingWireVerification"}},"components/schemas/IndependentInvestmentProfile":{"id":"components/schemas/IndependentInvestmentProfile","kind":"json-schema","title":"IndependentInvestmentProfile","data":{"properties":{"income":{"type":"string","enum":["BELOW_50K","BETWEEN_50K_AND_100K","BETWEEN_100K_AND_250K","OVER_250K"],"title":"Income","description":"Applicant's estimated annual income in USD."},"net_worth":{"type":"string","enum":["BELOW_50K","BETWEEN_50K_AND_200K","BETWEEN_200K_AND_1M","BETWEEN_1M_AND_5M","OVER_5M"],"title":"Net Worth","description":"Applicant's estimated average personal net worth in USD."},"bd_association":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Bd Association","description":"Name of broker-dealer association or employment. Disclosure is required by law if applicable, else, leave empty"},"director_policy_maker_of_company":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Director Policy Maker Of Company","description":"Name of company where customer is director or policy maker. Disclosure is required by law if applicable, otherwise, leave empty"},"occupation":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Occupation","description":"Applicant's occupation. Needs to be filled out if employment status is Employed."},"employment_status":{"type":"string","const":"INDEPENDENT","title":"Employment Status"}},"type":"object","required":["income","net_worth","employment_status"],"title":"IndependentInvestmentProfile"}},"components/schemas/Individual":{"id":"components/schemas/Individual","kind":"json-schema","title":"Individual","data":{"properties":{"address":{"$ref":"#/components/schemas/GeneralAddress"},"email":{"type":"string","title":"Email"},"phone_number":{"type":"string","title":"Phone Number"},"account_status":{"type":"string","enum":["OPEN","CLOSED","FROZEN","PENDING"],"title":"Account Status"},"type":{"type":"string","const":"INDIVIDUAL","title":"Type"},"name":{"$ref":"#/components/schemas/Name"},"date_of_birth":{"type":"string","format":"date","title":"Date Of Birth"},"identification_number":{"$ref":"#/components/schemas/IndividualIdentificationNumberMasked"},"trusted_contact":{"anyOf":[{"$ref":"#/components/schemas/TrustedContact"},{"type":"null"}]}},"type":"object","required":["address","email","phone_number","account_status","type","name","date_of_birth","identification_number"],"title":"Individual"}},"components/schemas/IndividualIdentificationNumberMasked":{"id":"components/schemas/IndividualIdentificationNumberMasked","kind":"json-schema","title":"IndividualIdentificationNumberMasked","data":{"properties":{"identification_number":{"type":"string","title":"Identification Number"},"issuing_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuing Country","description":"A ISO-3166 Alpha-2 country code (Abbreviated. Example: \"US\")"},"identification_type":{"type":"string","enum":["SSN","PASSPORT","INTERNATIONAL_ID","DRIVERS_LICENSE"],"title":"Identification Type"}},"type":"object","required":["identification_number","identification_type"],"title":"IndividualIdentificationNumberMasked"}},"components/schemas/IndividualName":{"id":"components/schemas/IndividualName","kind":"json-schema","title":"Individual name","data":{"properties":{"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"type":{"type":"string","const":"individual","title":"Type"}},"type":"object","required":["first_name","last_name","type"],"title":"Individual name"}},"components/schemas/IndustryInfo":{"id":"components/schemas/IndustryInfo","kind":"json-schema","title":"IndustryInfo","data":{"properties":{"industry":{"anyOf":[{"type":"string","enum":["ACCOUNTING_AND_BOOKKEEPING","ADVERTISING","ART","ATM_OPERATOR","BEAUTY_AND_COSMETIC_SERVICES","BIOTECH","BUSINESS_MANAGEMENT","CLEANING_SERVICES","CONSTRUCTION","CONSULTING","CRYPTOCURRENCY","DESIGN","ECOMMERCE","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL_SERVICES","FITNESS","FOOD","GAMBLING","HARDWARE","HEALTHCARE","HOSPITALITY","INSURANCE","INVESTMENTS","LEGAL_SERVICES","MARKETING","MARKETPLACE","NONPROFIT","OTHER","PARKING_GARAGE","PROFESSIONAL_TECHNICAL_OR_MECHANICAL_SERVICES","REAL_ESTATE","RECRUITING","RESEARCH","RESTAURANT","RETAIL_STORES","SECURITY","SHIPPING_WAREHOUSING","SOFTWARE","SPORTS_TEAM","SUPPORT_SERVICES","TECHNOLOGY","TRANSPORTATION","TRAVEL","WHOLESALE","VENDING_MACHINE_OPERATOR","WASTE_MANAGEMENT"]},{"type":"null"}],"title":"Industry"},"other_industry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Other Industry"}},"type":"object","title":"IndustryInfo"}},"components/schemas/InternalReallocationTransferRequest":{"id":"components/schemas/InternalReallocationTransferRequest","kind":"json-schema","title":"Internal Reallocation","data":{"properties":{"transfer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Transfer Id","description":"The ID for this transfer, auto-generated if not provided."},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description","description":"A description of the transfer, visible on statements."},"end_to_end_identification":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"End To End Identification","description":"Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain."},"from_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"to_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"type":{"type":"string","const":"INTERNAL_REALLOCATION","title":"Type","description":"Move funds between accounts belonging to the same customer."},"transfer_type":{"anyOf":[{"type":"string","enum":["BANK_TRANSFER","SECURITY_TRANSFER"]},{"type":"null"}],"title":"Transfer Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of internal reallocation transfer. BANK_TRANSFER (default): sells the CUSIP from the origin pocket and buys new CSIP for the destination pocket. Settlement is T+1. SECURITY_TRANSFER: no bank transaction occurs; CUSIPs are moved directly between pockets. This is instant but currently only allowed for jiko_net pockets."},"children":[]}]}]}],"default":"BANK_TRANSFER"},"amount_usdc":{"anyOf":[{"type":"integer","exclusiveMinimum":0},{"type":"null"}],"title":"Amount USDC","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount, in USD cents. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"amount":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/RequestedAmount"},{"$ref":"#/components/schemas/FullWithdrawal"}],"discriminator":{"propertyName":"type","mapping":{"FULL_WITHDRAWAL":"#/components/schemas/FullWithdrawal","REQUESTED_AMOUNT":"#/components/schemas/RequestedAmount"}}},{"type":"null"}],"title":"Amount"},"async_mode":{"type":"boolean","title":"Async Mode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using asynchronous processing is strongly recommended."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Status updates will be delivered via Webhooks."},"children":[]}]}]}],"default":false}},"type":"object","required":["from_account","to_account","type"],"title":"Internal Reallocation","example":{"amount":{"amount_usdc":10000,"type":"REQUESTED_AMOUNT"},"description":"Moving funds between accounts belonging to the same customer","from_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"to_account":{"id":"991dd8b5-f103-4158-8c6b-84480cb43652","type":"JIKO_ACCOUNT"},"transfer_id":"cbb6cfce-f207-45e7-a6b3-1055ab43db51","type":"INTERNAL_REALLOCATION"}}},"components/schemas/InternalReallocationTransferResponse":{"id":"components/schemas/InternalReallocationTransferResponse","kind":"json-schema","title":"Internal Reallocation","data":{"properties":{"transfer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Transfer Id","description":"The ID for this transfer, auto-generated if not provided."},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description","description":"A description of the transfer, visible on statements."},"end_to_end_identification":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"End To End Identification","description":"Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain."},"from_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"to_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"type":{"type":"string","const":"INTERNAL_REALLOCATION","title":"Type"},"transfer_type":{"type":"string","enum":["BANK_TRANSFER","SECURITY_TRANSFER"],"title":"Transfer Type"},"amount":{"$ref":"#/components/schemas/Amount"}},"type":"object","required":["from_account","to_account","type","transfer_type","amount"],"title":"Internal Reallocation","example":{"amount":{"amount_usdc":10000,"type":"REQUESTED_AMOUNT"},"description":"Moving funds between accounts belonging to the same customer","from_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"to_account":{"id":"991dd8b5-f103-4158-8c6b-84480cb43652","type":"JIKO_ACCOUNT"},"transfer_id":"cbb6cfce-f207-45e7-a6b3-1055ab43db51","type":"INTERNAL_REALLOCATION"}}},"components/schemas/InternationalApplication":{"id":"components/schemas/InternationalApplication","kind":"json-schema","title":"InternationalApplication","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"phone_number":{"type":"string","title":"Phone Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicant's phone number. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": It will be required to include country codes in accordance to the E.164 spec in a future release, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"^\\+[1-9]\\d{1,14}$"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"agreement_consent":{"$ref":"#/components/schemas/AgreementConsent"},"exception_reasons":{"items":{"type":"string"},"type":"array","title":"Exception Reasons","default":[]},"email":{"type":"string","format":"email","title":"Email"},"status":{"type":"string","enum":["CREATED","PENDING","SUBMITTED","DOCUMENTS_NEEDED","APPROVED","REJECTED","MANUAL_REVIEW"],"title":"Status"},"name":{"anyOf":[{"$ref":"#/components/schemas/Name"},{"type":"null"}]},"date_of_birth":{"anyOf":[{"$ref":"#/components/schemas/DateOfBirth"},{"type":"null"}]},"investment_profile":{"anyOf":[{"$ref":"#/components/schemas/InvestmentProfile"},{"type":"null"}]},"customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Customer Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until application status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]}]}]}]},"documents":{"items":{"$ref":"#/components/schemas/Document"},"type":"array","title":"Documents"},"id_verification_documents_needed":{"type":"boolean","title":"Id Verification Documents Needed"},"identification_number_verification_document_needed":{"type":"boolean","title":"Identification Number Verification Document Needed"},"address_verification_document_needed":{"type":"boolean","title":"Address Verification Document Needed"},"address":{"$ref":"#/components/schemas/ISOAddress","description":"Address object"},"citizenship_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Citizenship Country","description":"The applicant's citizenship country in ISO-3166 Alpha-2 format.","default":"US"},"identification_number_issuing_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identification Number Issuing Country","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country that issued the applicant's identification number. Country in ISO-3166 Alpha-2 format. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field will be made mandatory in a future releases."},"children":[]}]}]}],"default":"US"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","time_created","updated_at","phone_number","agreement_consent","email","status","name","date_of_birth","investment_profile","id_verification_documents_needed","identification_number_verification_document_needed","address_verification_document_needed","address","object_type"],"title":"InternationalApplication"}},"components/schemas/InternationalApplicationRequest":{"id":"components/schemas/InternationalApplicationRequest","kind":"json-schema","title":"InternationalApplicationRequest","data":{"properties":{"identification_number":{"type":"string","title":"Identification Number","description":"Applicant's Identification number"},"name":{"$ref":"#/components/schemas/Name","description":"Applicant's full name"},"email":{"type":"string","format":"email","title":"Email","description":"Applicant's email address"},"date_of_birth":{"type":"string","format":"date","title":"Date Of Birth","description":"Applicant's date of birth"},"investment_profile":{"$ref":"#/components/schemas/InvestmentProfile"},"agreement_consent":{"$ref":"#/components/schemas/AgreementConsent","description":"Consent object for agreements"},"originally_onboarded_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Originally Onboarded At","description":"Original onboarding time of applicant"},"identification_type":{"type":"string","enum":["SSN","PASSPORT","TIN","DRIVERS_LICENSE","INTERNATIONAL_ID"],"title":"Identification Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identification_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. The options are"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SSN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Social security number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PASSPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A passport number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNATIONAL_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A government-issued national identity card. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNATIONAL_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type needs to be enabled. Please contact your Jiko representative. Selecting this value may prevent automatic onboarding and require manual review."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field will be made mandatory in a future release. Currently defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SSN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":"SSN"},"identification_number_issuing_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identification Number Issuing Country","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country that issued the applicant's identification number. Country in ISO-3166 Alpha-2 format. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field will be made mandatory in a future releases."},"children":[]}]}]}],"default":"US"},"address":{"$ref":"#/components/schemas/ISOAddressRequest","description":"Address object"},"phone_number":{"type":"string","title":"Phone Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicant's phone number. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": It will be required to include country codes in accordance to the E.164 spec in a future release, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"^\\+[1-9]\\d{1,14}$"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"citizenship_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Citizenship Country","description":"The applicant's citizenship country in ISO-3166 Alpha-2 format.","default":"US"}},"type":"object","required":["identification_number","name","email","date_of_birth","investment_profile","agreement_consent","address","phone_number"],"title":"InternationalApplicationRequest"}},"components/schemas/InternationalWireCounterpartyV2":{"id":"components/schemas/InternationalWireCounterpartyV2","kind":"json-schema","title":"International Wire Counterparty","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"status":{"type":"string","enum":["PENDING","FAILED","LINKED","UNLINKED","CLOSED"],"title":"Status"},"verification":{"oneOf":[{"$ref":"#/components/schemas/SupportingDocumentsVerification"},{"$ref":"#/components/schemas/IncomingWireVerification"},{"$ref":"#/components/schemas/PreVerifiedVerification"},{"$ref":"#/components/schemas/PlaidVerification"},{"$ref":"#/components/schemas/MicroDepositsVerification"},{"$ref":"#/components/schemas/NameMatchVerification"},{"$ref":"#/components/schemas/UnverifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"incoming_wire":"#/components/schemas/IncomingWireVerification","micro_deposits":"#/components/schemas/MicroDepositsVerification","name_match":"#/components/schemas/NameMatchVerification","plaid":"#/components/schemas/PlaidVerification","pre_verified":"#/components/schemas/PreVerifiedVerification","supporting_documents":"#/components/schemas/SupportingDocumentsVerification","unverified":"#/components/schemas/UnverifiedVerification"}}},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"type":{"type":"string","const":"international_wire","title":"Type"},"counterparty_name":{"oneOf":[{"$ref":"#/components/schemas/IndividualName"},{"$ref":"#/components/schemas/BusinessName"}],"title":"Counterparty name","discriminator":{"propertyName":"type","mapping":{"business":"#/components/schemas/BusinessName","individual":"#/components/schemas/IndividualName"}}},"address":{"$ref":"#/components/schemas/CounterpartyAddress"},"swift_bic":{"type":"string","title":"Swift Bic"},"identifier":{"type":"string","title":"Identifier"},"identifier_type":{"type":"string","enum":["iban","local"],"title":"Identifier Type","default":"local"},"bank_name":{"type":"string","title":"Bank Name"},"wire_instructions":{"anyOf":[{"type":"string","maxLength":140},{"type":"null"}],"title":"Wire Instructions","description":"Any additional wire instructions required for the wire to be processed correctly."},"ownership_type":{"anyOf":[{"type":"string","enum":["FIRST_PARTY","THIRD_PARTY"]},{"type":"null"}],"title":"Ownership Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relationship of the counterparty to the account holder. FIRST_PARTY means the counterparty is owned by the account holder, THIRD_PARTY means it is owned by a different entity."},"children":[]}]}]}]},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","time_created","status","verification","type","counterparty_name","address","swift_bic","identifier","bank_name","object_type"],"title":"International Wire Counterparty"}},"components/schemas/InternationalWireFundingInstruction":{"id":"components/schemas/InternationalWireFundingInstruction","kind":"json-schema","title":"InternationalWireFundingInstruction","data":{"properties":{"type":{"type":"string","const":"INTERNATIONAL_WIRE","title":"Type"},"receiver_bank":{"$ref":"#/components/schemas/ReceiverBank"},"beneficiary":{"$ref":"#/components/schemas/Beneficiary"},"remittance_info":{"$ref":"#/components/schemas/RemittanceInfo"}},"type":"object","required":["type","receiver_bank","beneficiary","remittance_info"],"title":"InternationalWireFundingInstruction"}},"components/schemas/InvestmentProfile":{"id":"components/schemas/InvestmentProfile","kind":"json-schema","title":"InvestmentProfile","data":{"oneOf":[{"$ref":"#/components/schemas/EmployedInvestmentProfile"},{"$ref":"#/components/schemas/IndependentInvestmentProfile"},{"$ref":"#/components/schemas/RetiredInvestmentProfile"},{"$ref":"#/components/schemas/StudentInvestmentProfile"},{"$ref":"#/components/schemas/UnemployedInvestmentProfile"}],"title":"InvestmentProfile","description":"Investment profile contains information required by FINRA Suitability Rule 2111","discriminator":{"propertyName":"employment_status","mapping":{"EMPLOYED":"#/components/schemas/EmployedInvestmentProfile","INDEPENDENT":"#/components/schemas/IndependentInvestmentProfile","RETIRED":"#/components/schemas/RetiredInvestmentProfile","STUDENT":"#/components/schemas/StudentInvestmentProfile","UNEMPLOYED":"#/components/schemas/UnemployedInvestmentProfile"}}}},"components/schemas/ListAccountsResponse":{"id":"components/schemas/ListAccountsResponse","kind":"json-schema","title":"ListAccountsResponse","data":{"properties":{"offset":{"type":"integer","title":"Offset"},"count":{"type":"integer","title":"Count"},"items":{"items":{"$ref":"#/components/schemas/Account"},"type":"array","title":"Items","description":"Customer accounts"},"object_type":{"type":"string","title":"Object Type","default":"List"}},"type":"object","required":["offset","count","items"],"title":"ListAccountsResponse"}},"components/schemas/ListBeneficialOwnersResponse":{"id":"components/schemas/ListBeneficialOwnersResponse","kind":"json-schema","title":"ListBeneficialOwnersResponse","data":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BusinessIndividual","description":"a list of beneficial owners for a given customer"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"ListBeneficialOwnersResponse"}},"components/schemas/ListCounterpartiesResponse":{"id":"components/schemas/ListCounterpartiesResponse","kind":"json-schema","title":"ListCounterpartiesResponse","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/Counterparty"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"ListCounterpartiesResponse"}},"components/schemas/ListPortalsResponse":{"id":"components/schemas/ListPortalsResponse","kind":"json-schema","title":"ListPortalsResponse","data":{"properties":{"count":{"type":"integer","title":"Count"},"portals":{"items":{"$ref":"#/components/schemas/Portal"},"type":"array","minItems":0,"title":"Portals"},"object_type":{"type":"string","title":"Object Type","default":"List"}},"type":"object","required":["count","portals"],"title":"ListPortalsResponse"}},"components/schemas/LoginInput":{"id":"components/schemas/LoginInput","kind":"json-schema","title":"LoginInput","data":{"properties":{"username":{"type":"string","maxLength":128,"title":"Username"},"password":{"type":"string","maxLength":128,"title":"Password"}},"type":"object","required":["username","password"],"title":"LoginInput"}},"components/schemas/LoginResponse":{"id":"components/schemas/LoginResponse","kind":"json-schema","title":"LoginResponse","data":{"properties":{"token":{"type":"string","title":"Token"},"expires":{"type":"string","format":"date-time","title":"Expires"}},"type":"object","required":["token","expires"],"title":"LoginResponse"}},"components/schemas/MicroDepositsVerification":{"id":"components/schemas/MicroDepositsVerification","kind":"json-schema","title":"MicroDepositsVerification","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"type":"string","const":"micro_deposits","title":"Type"},"status":{"anyOf":[{"type":"string","enum":["PENDING_REVIEW","APPROVED","REJECTED"]},{"type":"string","enum":["MICRO_DEPOSITS_SENT"]}],"title":"Status"},"verification_failure_count":{"type":"integer","title":"Verification Failure Count"}},"type":"object","required":["id","description","type","status","verification_failure_count"],"title":"MicroDepositsVerification"}},"components/schemas/MinimalPhysicalCardOrderResponse":{"id":"components/schemas/MinimalPhysicalCardOrderResponse","kind":"json-schema","title":"MinimalPhysicalCardOrderResponse","data":{"properties":{"card_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Card Id"},"card_order_id":{"type":"string","format":"uuid","title":"Card Order Id"},"status":{"type":"string","enum":["INITIAL","CARD_CREATED","ORDERED","RECEIVED"],"title":"Status"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["card_order_id","status","object_type"],"title":"MinimalPhysicalCardOrderResponse"}},"components/schemas/Name":{"id":"components/schemas/Name","kind":"json-schema","title":"Name","data":{"properties":{"first_name":{"type":"string","maxLength":50,"title":"First Name","description":"First Name"},"middle_name":{"anyOf":[{"type":"string","maxLength":50},{"type":"null"}],"title":"Middle Name","description":"Middle Name"},"last_name":{"type":"string","maxLength":50,"title":"Last Name","description":"Last Name"}},"type":"object","required":["first_name","last_name"],"title":"Name"}},"components/schemas/NameMatchVerification":{"id":"components/schemas/NameMatchVerification","kind":"json-schema","title":"NameMatchVerification","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"type":"string","const":"name_match","title":"Type"}},"type":"object","required":["id","description","type"],"title":"NameMatchVerification"}},"components/schemas/OnChainTransactionActivity":{"id":"components/schemas/OnChainTransactionActivity","kind":"json-schema","title":"OnChainTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"ON_CHAIN","title":"Type"},"blockchain_network":{"type":"string","title":"Blockchain Network"},"counterparty_wallet_address":{"type":"string","title":"Counterparty Wallet Address"},"counterparty_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Name"},"end_to_end_identification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End To End Identification"},"transaction_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Hash"}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type","blockchain_network","counterparty_wallet_address"],"title":"OnChainTransactionActivity"}},"components/schemas/OnUsCounterparty":{"id":"components/schemas/OnUsCounterparty","kind":"json-schema","title":"OnUsCounterparty","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"type":{"type":"string","const":"COUNTERPARTY","title":"Type"}},"type":"object","required":["id","type"],"title":"OnUsCounterparty"}},"components/schemas/OnUsCounterpartyV2":{"id":"components/schemas/OnUsCounterpartyV2","kind":"json-schema","title":"ON_US Counterparty","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"status":{"type":"string","enum":["PENDING","FAILED","LINKED","UNLINKED","CLOSED"],"title":"Status"},"verification":{"oneOf":[{"$ref":"#/components/schemas/SupportingDocumentsVerification"},{"$ref":"#/components/schemas/IncomingWireVerification"},{"$ref":"#/components/schemas/PreVerifiedVerification"},{"$ref":"#/components/schemas/PlaidVerification"},{"$ref":"#/components/schemas/MicroDepositsVerification"},{"$ref":"#/components/schemas/NameMatchVerification"},{"$ref":"#/components/schemas/UnverifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"incoming_wire":"#/components/schemas/IncomingWireVerification","micro_deposits":"#/components/schemas/MicroDepositsVerification","name_match":"#/components/schemas/NameMatchVerification","plaid":"#/components/schemas/PlaidVerification","pre_verified":"#/components/schemas/PreVerifiedVerification","supporting_documents":"#/components/schemas/SupportingDocumentsVerification","unverified":"#/components/schemas/UnverifiedVerification"}}},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"type":{"type":"string","const":"on_us","title":"Type"},"counterparty_name":{"type":"string","title":"Counterparty Name"},"account_number":{"type":"string","title":"Account Number","description":"Represents the Jiko network address of the pocket."},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","time_created","status","verification","type","counterparty_name","account_number","object_type"],"title":"ON_US Counterparty"}},"components/schemas/OnUsFundingInstruction":{"id":"components/schemas/OnUsFundingInstruction","kind":"json-schema","title":"OnUsFundingInstruction","data":{"properties":{"type":{"type":"string","const":"ON_US","title":"Type"},"account_number":{"type":"string","title":"Account Number","description":"Jiko network address of the portal"},"legal_name":{"type":"string","title":"Legal Name","description":"Customer legal name for counterparty creation"}},"type":"object","required":["type","account_number","legal_name"],"title":"OnUsFundingInstruction"}},"components/schemas/OnUsJikoAccountCounterparty":{"id":"components/schemas/OnUsJikoAccountCounterparty","kind":"json-schema","title":"OnUsJikoAccountCounterparty","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"type":{"type":"string","const":"JIKO_ACCOUNT","title":"Type"}},"type":"object","required":["id","type"],"title":"OnUsJikoAccountCounterparty"}},"components/schemas/OnUsTransactionActivity":{"id":"components/schemas/OnUsTransactionActivity","kind":"json-schema","title":"OnUsTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"ON_US","title":"Type"},"on_us_transfer_id":{"type":"string","title":"On Us Transfer Id"},"on_us_transfer_type":{"type":"string","title":"On Us Transfer Type"},"counterparty_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Name"},"associated_pocket_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Associated Pocket Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the pocket on the other half of INTERNAL_REALLOCATION ON_US transfer."},"children":[]}]}]}]},"end_to_end_identification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End To End Identification"}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type","on_us_transfer_id","on_us_transfer_type"],"title":"OnUsTransactionActivity"}},"components/schemas/OnUsTransactionDetails":{"id":"components/schemas/OnUsTransactionDetails","kind":"json-schema","title":"OnUsTransactionDetails","data":{"properties":{"on_us_transfer_id":{"type":"string","title":"On Us Transfer Id"},"on_us_transfer_type":{"type":"string","title":"On Us Transfer Type"},"counterparty":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/P2POnUsTransferCounterparty"}],"discriminator":{"propertyName":"type","mapping":{"P2POnUsTransferCounterparty":"#/components/schemas/P2POnUsTransferCounterparty"}}},{"type":"null"}],"title":"Counterparty"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"target":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target"}},"type":"object","required":["on_us_transfer_id","on_us_transfer_type"],"title":"OnUsTransactionDetails"}},"components/schemas/OnUsTransfer":{"id":"components/schemas/OnUsTransfer","kind":"json-schema","title":"OnUsTransfer","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"status":{"type":"string","enum":["PENDING","COMPLETED","REJECTED"],"title":"Status"},"reason":{"anyOf":[{"type":"string","enum":["ACCOUNT_UNAVAILABLE","CANCELED","INSUFFICIENT_FUNDS","INVALID_CURRENCY","INVALID_TRANSFER","SANCTION_SCREEN_FAILED"]},{"type":"null"}],"title":"Reason"},"transfer":{"$ref":"#/components/schemas/OnUsTransferDetails"},"fees":{"items":{"$ref":"#/components/schemas/Fee"},"type":"array","title":"Fees"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","status","reason","transfer","fees","object_type"],"title":"OnUsTransfer"}},"components/schemas/OnUsTransferDetails":{"id":"components/schemas/OnUsTransferDetails","kind":"json-schema","title":"OnUsTransferDetails","data":{"oneOf":[{"$ref":"#/components/schemas/CustomerFundingTransferResponse"},{"$ref":"#/components/schemas/CustomerDefundingTransferResponse"},{"$ref":"#/components/schemas/InternalReallocationTransferResponse"},{"$ref":"#/components/schemas/PeerToPeerTransferResponse"}],"title":"OnUsTransferDetails","discriminator":{"propertyName":"type","mapping":{"INTERNAL_REALLOCATION":"#/components/schemas/InternalReallocationTransferResponse","PARTNER_CUSTOMER_DEFUNDING":"#/components/schemas/CustomerDefundingTransferResponse","PARTNER_CUSTOMER_FUNDING":"#/components/schemas/CustomerFundingTransferResponse","PEER_TO_PEER":"#/components/schemas/PeerToPeerTransferResponse"}}}},"components/schemas/OnUsTransferDetailsRequest":{"id":"components/schemas/OnUsTransferDetailsRequest","kind":"json-schema","title":"OnUsTransferDetailsRequest","data":{"oneOf":[{"$ref":"#/components/schemas/CustomerFundingTransferRequest"},{"$ref":"#/components/schemas/CustomerDefundingTransferRequest"},{"$ref":"#/components/schemas/InternalReallocationTransferRequest"},{"$ref":"#/components/schemas/PeerToPeerTransferRequest"}],"title":"OnUsTransferDetailsRequest","discriminator":{"propertyName":"type","mapping":{"INTERNAL_REALLOCATION":"#/components/schemas/InternalReallocationTransferRequest","PARTNER_CUSTOMER_DEFUNDING":"#/components/schemas/CustomerDefundingTransferRequest","PARTNER_CUSTOMER_FUNDING":"#/components/schemas/CustomerFundingTransferRequest","PEER_TO_PEER":"#/components/schemas/PeerToPeerTransferRequest"}}}},"components/schemas/OnUsTransferEvent":{"id":"components/schemas/OnUsTransferEvent","kind":"json-schema","title":"OnUsTransferEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/OnUsTransferPayload"},"event_type":{"type":"string","enum":["transfers.on-us.success","transfers.on-us.processing","transfers.on-us.rejected"],"title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"OnUsTransferEvent"}},"components/schemas/OnUsTransferPayload":{"id":"components/schemas/OnUsTransferPayload","kind":"json-schema","title":"OnUsTransferPayload","data":{"properties":{"on_us_id":{"type":"string","format":"uuid","title":"On Us Id"},"origin_account_id":{"type":"string","format":"uuid","title":"Origin Account Id"},"destination_account_id":{"type":"string","format":"uuid","title":"Destination Account Id"}},"type":"object","required":["on_us_id","origin_account_id","destination_account_id"],"title":"OnUsTransferPayload"}},"components/schemas/OnUsTransferQuote":{"id":"components/schemas/OnUsTransferQuote","kind":"json-schema","title":"OnUsTransferQuote","data":{"properties":{"is_allowed":{"type":"boolean","title":"Is Allowed","description":"Whether the proposed transfer would be permitted at evaluation time."},"rejection_reason":{"anyOf":[{"type":"string","enum":["ACCOUNT_UNAVAILABLE","CANCELED","INSUFFICIENT_FUNDS","INVALID_CURRENCY","INVALID_TRANSFER","SANCTION_SCREEN_FAILED"]},{"type":"null"}],"title":"Rejection Reason","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner-facing rejection reason when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_allowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is false; null otherwise."},"children":[]}]}]}]},"rejection_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rejection Detail","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable explanation of the rejection; null when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_allowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true."},"children":[]}]}]}]},"settlement_type":{"type":"string","title":"Settlement Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement type the transfer would receive, e.g. \"T+0\" or \"T+1\"."},"children":[]}]}]}]},"eligible_transfer_amount":{"$ref":"#/components/schemas/Amount","description":"Maximum amount the customer is eligible to transfer given their short-maturity holdings. Zero when the request was rejected before holdings could be evaluated."},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["is_allowed","settlement_type","eligible_transfer_amount","object_type"],"title":"OnUsTransferQuote","description":"A dry-run quote for a same-entity on-us securities transfer. Indicative\nonly: a successful quote is not a guarantee that the transfer will book."}},"components/schemas/OnUsTransferQuoteRequest":{"id":"components/schemas/OnUsTransferQuoteRequest","kind":"json-schema","title":"On-Us Security Transfer Quote Request","data":{"properties":{"type":{"type":"string","const":"INTERNAL_REALLOCATION","title":"Type"},"transfer_type":{"type":"string","const":"SECURITY_TRANSFER","title":"Transfer Type"},"from_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"to_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"amount":{"$ref":"#/components/schemas/RequestedAmount"}},"type":"object","required":["type","transfer_type","from_account","to_account","amount"],"title":"On-Us Security Transfer Quote Request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests a dry-run quote for a same-entity on-us "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"security"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transfer (an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNAL_REALLOCATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SECURITY_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A quote runs the same validation and ruleset evaluation as creating the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transfer but books no trades and persists nothing. It is a subset of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create-on-us-transfer body for that single type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer_type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must be declared, and only the security-transfer values are accepted. Other"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on-us types (funding, defunding, peer-to-peer, bank-transfer reallocation)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are not quotable and are rejected with 422."},"children":[]}]}]}]}},"components/schemas/OnUsTransferReceivedEvent":{"id":"components/schemas/OnUsTransferReceivedEvent","kind":"json-schema","title":"OnUsTransferReceivedEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/OnUsTransferReceivedPayload"},"event_type":{"type":"string","const":"transfers.on-us.received","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"OnUsTransferReceivedEvent"}},"components/schemas/OnUsTransferReceivedPayload":{"id":"components/schemas/OnUsTransferReceivedPayload","kind":"json-schema","title":"OnUsTransferReceivedPayload","data":{"properties":{"on_us_id":{"type":"string","format":"uuid","title":"On Us Id"},"receiving_pocket_id":{"type":"string","format":"uuid","title":"Receiving Pocket Id"},"transaction_activity_id":{"type":"string","format":"uuid","title":"Transaction Activity Id"}},"type":"object","required":["on_us_id","receiving_pocket_id","transaction_activity_id"],"title":"OnUsTransferReceivedPayload"}},"components/schemas/OtherSecurity":{"id":"components/schemas/OtherSecurity","kind":"json-schema","title":"OtherSecurity","data":{"properties":{"quantity":{"type":"integer","title":"Quantity","description":"Number of securities"},"market_value":{"$ref":"#/components/schemas/Amount","description":"The current market value of the securities"},"cusip":{"type":"string","title":"Cusip","description":"CUSIP number of security"},"jiko_mark_price":{"$ref":"#/components/schemas/Decimal","description":"Current price of security"},"description":{"type":"string","title":"Description","description":"A description of the security"},"type":{"type":"string","const":"OTHER","title":"Type"}},"type":"object","required":["quantity","market_value","cusip","jiko_mark_price","description","type"],"title":"OtherSecurity"}},"components/schemas/OutgoingWireEvent":{"id":"components/schemas/OutgoingWireEvent","kind":"json-schema","title":"OutgoingWireEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/WireOutgoingPayload"},"event_type":{"type":"string","enum":["transfers.wire.out.success","transfers.wire.out.processing","transfers.wire.out.rejected"],"title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"OutgoingWireEvent"}},"components/schemas/OutgoingWireResponse":{"id":"components/schemas/OutgoingWireResponse","kind":"json-schema","title":"OutgoingWireResponse","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"status":{"type":"string","enum":["PENDING","SUCCESS","REJECTED"],"title":"Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the wire transfer: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"amount":{"$ref":"#/components/schemas/Amount"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also known as jiko_account_id"},"children":[]}]}]}]},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"wire_tracking_info":{"anyOf":[{"$ref":"#/components/schemas/WireTrackingInfo"},{"type":"null"}],"description":"Identifiers used to track the wire through the payment network. On outgoing wires these are assigned when the wire is sent; on incoming wires they are read from the received message. Null when not available."},"direction":{"type":"string","const":"OUTGOING","title":"Direction","default":"OUTGOING"},"counterparty_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Counterparty Id","description":"The ID of the counterparty for this wire transfer."},"client_verifiers":{"items":{"type":"string"},"type":"array","title":"Client Verifiers","description":"Identifiers (emails) of the verifiers/approvers of this wire."},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","status","amount","pocket_id","time_created","object_type"],"title":"OutgoingWireResponse"}},"components/schemas/P2POnUsTransferCounterparty":{"id":"components/schemas/P2POnUsTransferCounterparty","kind":"json-schema","title":"P2POnUsTransferCounterparty","data":{"properties":{"type":{"type":"string","const":"P2POnUsTransferCounterparty","title":"Type"},"counterparty_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Name"}},"type":"object","required":["type"],"title":"P2POnUsTransferCounterparty"}},"components/schemas/PartnerEvent":{"id":"components/schemas/PartnerEvent","kind":"json-schema","title":"PartnerEvent","data":{"properties":{"event":{"$ref":"#/components/schemas/EventDetails"},"delivery_attempts":{"items":{"$ref":"#/components/schemas/DeliveryAttemptDetails"},"type":"array","title":"Delivery Attempts"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["event","delivery_attempts","object_type"],"title":"PartnerEvent"}},"components/schemas/PeerToPeerTransferRequest":{"id":"components/schemas/PeerToPeerTransferRequest","kind":"json-schema","title":"Peer To Peer Transfer","data":{"properties":{"transfer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Transfer Id","description":"The ID for this transfer, auto-generated if not provided."},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description","description":"A description of the transfer, visible on statements."},"end_to_end_identification":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"End To End Identification","description":"Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain."},"from_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"to_account":{"$ref":"#/components/schemas/OnUsCounterparty"},"type":{"type":"string","const":"PEER_TO_PEER","title":"Type"},"amount_usdc":{"anyOf":[{"type":"integer","exclusiveMinimum":0},{"type":"null"}],"title":"Amount USDC","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount, in USD cents. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"deprecated":true},"amount":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/RequestedAmount"},{"$ref":"#/components/schemas/FullWithdrawal"}],"discriminator":{"propertyName":"type","mapping":{"FULL_WITHDRAWAL":"#/components/schemas/FullWithdrawal","REQUESTED_AMOUNT":"#/components/schemas/RequestedAmount"}}},{"type":"null"}],"title":"Amount"},"async_mode":{"type":"boolean","title":"Async Mode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using asynchronous processing is strongly recommended."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Status updates will be delivered via Webhooks."},"children":[]}]}]}],"default":false}},"type":"object","required":["from_account","to_account","type"],"title":"Peer To Peer Transfer","example":{"amount":{"amount_usdc":10000,"type":"REQUESTED_AMOUNT"},"description":"Moving funds between accounts belonging to different customers","from_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"to_account":{"id":"991dd8b5-f103-4158-8c6b-84480cb43652","type":"COUNTERPARTY"},"transfer_id":"cbb6cfce-f207-45e7-a6b3-1055ab43db51","type":"PEER_TO_PEER"}}},"components/schemas/PeerToPeerTransferResponse":{"id":"components/schemas/PeerToPeerTransferResponse","kind":"json-schema","title":"Peer To Peer Transfer","data":{"properties":{"transfer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Transfer Id","description":"The ID for this transfer, auto-generated if not provided."},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description","description":"A description of the transfer, visible on statements."},"end_to_end_identification":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"End To End Identification","description":"Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain."},"from_account":{"$ref":"#/components/schemas/OnUsJikoAccountCounterparty"},"to_account":{"$ref":"#/components/schemas/OnUsCounterparty"},"type":{"type":"string","const":"PEER_TO_PEER","title":"Type"},"amount":{"$ref":"#/components/schemas/Amount"}},"type":"object","required":["from_account","to_account","type","amount"],"title":"Peer To Peer Transfer","example":{"amount":{"amount_usdc":10000,"type":"REQUESTED_AMOUNT"},"description":"Moving funds between accounts belonging to different customers","from_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"to_account":{"id":"991dd8b5-f103-4158-8c6b-84480cb43652","type":"COUNTERPARTY"},"transfer_id":"cbb6cfce-f207-45e7-a6b3-1055ab43db51","type":"PEER_TO_PEER"}}},"components/schemas/PhysicalCardOrder":{"id":"components/schemas/PhysicalCardOrder","kind":"json-schema","title":"PhysicalCardOrder","data":{"properties":{"name_on_card":{"type":"string","maxLength":100,"title":"Name On Card","description":"Card holder's full name. Should be a maximum of 26 characters."},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"}},"type":"object","required":["name_on_card","shipping_address"],"title":"PhysicalCardOrder"}},"components/schemas/PhysicalCardOrderListResponse":{"id":"components/schemas/PhysicalCardOrderListResponse","kind":"json-schema","title":"PhysicalCardOrderListResponse","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/MinimalPhysicalCardOrderResponse"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"PhysicalCardOrderListResponse"}},"components/schemas/PhysicalCardOrderResponse":{"id":"components/schemas/PhysicalCardOrderResponse","kind":"json-schema","title":"PhysicalCardOrderResponse","data":{"properties":{"card_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Card Id"},"card_order_id":{"type":"string","format":"uuid","title":"Card Order Id"},"status":{"type":"string","enum":["INITIAL","CARD_CREATED","ORDERED","RECEIVED"],"title":"Status"},"name_on_card":{"type":"string","title":"Name On Card"},"shipping_address":{"$ref":"#/components/schemas/ShippingAddress"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["card_order_id","status","name_on_card","shipping_address","object_type"],"title":"PhysicalCardOrderResponse"}},"components/schemas/PhysicalCardResponse":{"id":"components/schemas/PhysicalCardResponse","kind":"json-schema","title":"PhysicalCardResponse","data":{"properties":{"card_id":{"type":"string","format":"uuid","title":"Card Id"},"encrypted_pan":{"type":"string","title":"Encrypted Pan"},"encrypted_cvv":{"type":"string","title":"Encrypted Cvv"},"encrypted_expiration":{"type":"string","title":"Encrypted Expiration"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["card_id","encrypted_pan","encrypted_cvv","encrypted_expiration","object_type"],"title":"PhysicalCardResponse"}},"components/schemas/PlaidVerification":{"id":"components/schemas/PlaidVerification","kind":"json-schema","title":"PlaidVerification","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"type":"string","const":"plaid","title":"Type"},"status":{"anyOf":[{"type":"string","enum":["PENDING_REVIEW","APPROVED","REJECTED"]},{"type":"string","enum":["VERIFICATION_EXPIRED","PENDING_AUTOMATIC_VERIFICATION","MICRO_DEPOSITS_SENT"]}],"title":"Status"},"account_number_masked":{"type":"string","title":"Account Number Masked"}},"type":"object","required":["id","description","type","status","account_number_masked"],"title":"PlaidVerification"}},"components/schemas/Pocket":{"id":"components/schemas/Pocket","kind":"json-schema","title":"Pocket","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"ID of the pocket"},"pocket_name":{"type":"string","title":"Pocket Name","description":"Pocket name"},"portfolio":{"anyOf":[{"$ref":"#/components/schemas/partner_api__interface__models__v2__pockets__Portfolio"},{"type":"null"}],"description":"Total liquid cash and holdings"},"status":{"type":"string","enum":["PENDING","OPEN","FROZEN","CLOSED"],"title":"Status","description":"Pocket status"},"attributes":{"items":{"type":"string"},"type":"array","title":"Attributes"},"deposit_strategy_id":{"type":"string","title":"Deposit Strategy Id","description":"Pocket deposit trading strategy ID (Example: UST-4W)"},"reinvestment_strategy_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reinvestment Strategy Id","description":"Pocket reinvestment trading strategy ID (Example: UST-4W)"},"type":{"anyOf":[{"type":"string","enum":["JIKO_PAY","JIKO_STORE"]},{"type":"null"}],"title":"Type","description":"Pocket type"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","pocket_name","status","deposit_strategy_id","reinvestment_strategy_id","object_type"],"title":"Pocket"}},"components/schemas/PocketEarnings":{"id":"components/schemas/PocketEarnings","kind":"json-schema","title":"PocketEarnings","data":{"properties":{"earnings":{"$ref":"#/components/schemas/Amount"},"date_from":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"},"date_to":{"type":"string","format":"date","title":"Date To"},"pricing_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Pricing Timestamp"},"appreciation_per_second":{"anyOf":[{"$ref":"#/components/schemas/Decimal"},{"type":"null"}]},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id"}},"type":"object","required":["earnings","date_from","date_to","pocket_id"],"title":"PocketEarnings"}},"components/schemas/Pockets":{"id":"components/schemas/Pockets","kind":"json-schema","title":"Pockets","data":{"properties":{"offset":{"type":"integer","title":"Offset"},"count":{"type":"integer","title":"Count"},"items":{"items":{"$ref":"#/components/schemas/Pocket"},"type":"array","title":"Items","description":"Customer pockets list"},"object_type":{"type":"string","title":"Object Type","default":"List"}},"type":"object","required":["offset","count","items"],"title":"Pockets"}},"components/schemas/Portal":{"id":"components/schemas/Portal","kind":"json-schema","title":"Portal","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"routing_number":{"type":"string","title":"Routing Number","description":"Routing number"},"account_number":{"type":"string","title":"Account Number","description":"Account number"},"status":{"type":"string","enum":["OPEN","CLOSED"],"title":"Status","description":"Portal status"},"name":{"type":"string","maxLength":50,"title":"Name","description":"Portal name"},"payment_rails":{"items":{"type":"string","enum":["ACH","WIRE","ON_US"]},"type":"array","title":"Payment Rails","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which payment rails (ACH, WIRE, ON_US) are accepted."},"children":[]}]}]}]},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","jiko_account_id","routing_number","account_number","status","name","payment_rails","object_type"],"title":"Portal"}},"components/schemas/PortalCreateRequest":{"id":"components/schemas/PortalCreateRequest","kind":"json-schema","title":"PortalCreateRequest","data":{"properties":{"name":{"type":"string","maxLength":128,"title":"Name"}},"type":"object","required":["name"],"title":"PortalCreateRequest"}},"components/schemas/PortalListResponse":{"id":"components/schemas/PortalListResponse","kind":"json-schema","title":"PortalListResponse","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"anyOf":[{"$ref":"#/components/schemas/VirtualBankAccountPortal"},{"$ref":"#/components/schemas/CryptoDepositAddressPortal"}]},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"PortalListResponse"}},"components/schemas/PositionSummaryReport":{"id":"components/schemas/PositionSummaryReport","kind":"json-schema","title":"PositionSummaryReport","data":{"properties":{"customer_id":{"type":"string","format":"uuid","title":"Customer Id"},"pocket_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Pocket Ids"},"date":{"type":"string","format":"date","title":"Date"},"type":{"type":"string","const":"POSITION_SUMMARY_REPORT","title":"Type"}},"type":"object","required":["customer_id","pocket_ids","date","type"],"title":"PositionSummaryReport"}},"components/schemas/PreVerifiedVerification":{"id":"components/schemas/PreVerifiedVerification","kind":"json-schema","title":"PreVerifiedVerification","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"type":"string","const":"pre_verified","title":"Type"},"status":{"type":"string","enum":["PENDING_REVIEW","APPROVED","REJECTED"],"title":"Status"}},"type":"object","required":["id","description","type","status"],"title":"PreVerifiedVerification"}},"components/schemas/PublicKeyRequest":{"id":"components/schemas/PublicKeyRequest","kind":"json-schema","title":"PublicKeyRequest","data":{"properties":{"public_key":{"type":"string","title":"Public Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single-use 4096-bit PEM-encoded RSA public-key in PKCS#1 or PKCS#1.5 format"},"children":[]}]}]}],"min_bytes":4096}},"type":"object","required":["public_key"],"title":"PublicKeyRequest"}},"components/schemas/ReceiverBank":{"id":"components/schemas/ReceiverBank","kind":"json-schema","title":"ReceiverBank","data":{"properties":{"routing_number":{"type":"string","title":"Routing Number","description":"ABA routing number"},"swift":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Swift","description":"SWIFT/BIC code"},"name":{"type":"string","title":"Name","description":"Bank name"},"address":{"type":"string","title":"Address","description":"Bank address"}},"type":"object","required":["routing_number","name","address"],"title":"ReceiverBank"}},"components/schemas/RelatedPartyApplicationRequest":{"id":"components/schemas/RelatedPartyApplicationRequest","kind":"json-schema","title":"RelatedPartyApplicationRequest","data":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/Name"},{"type":"null"}]},"address":{"anyOf":[{"$ref":"#/components/schemas/ISOAddressRequest"},{"type":"null"}]},"date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Of Birth"},"identification_number":{"anyOf":[{"$ref":"#/components/schemas/CreateIndividualIdentificationNumber"},{"type":"null"}]},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"roles":{"anyOf":[{"items":{"type":"string","enum":["CONTROL_PERSON","AUTHORIZED_REPRESENTATIVE"]},"type":"array"},{"type":"null"}],"title":"Roles"},"ownership_percentage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ownership Percentage","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The related party's ownership stake, as a string parseable to a number between 0 and 1 (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"0.51\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for 51%)."},"children":[]}]}]}]},"citizenship":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Citizenship"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},"type":"object","title":"RelatedPartyApplicationRequest"}},"components/schemas/RelatedPartyApplicationResponse":{"id":"components/schemas/RelatedPartyApplicationResponse","kind":"json-schema","title":"RelatedPartyApplicationResponse","data":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/Name"},{"type":"null"}]},"address":{"anyOf":[{"$ref":"#/components/schemas/ISOAddress"},{"type":"null"}]},"date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Of Birth"},"identification_number":{"anyOf":[{"$ref":"#/components/schemas/IndividualIdentificationNumberMasked"},{"type":"null"}]},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"roles":{"anyOf":[{"items":{"type":"string","enum":["CONTROL_PERSON","AUTHORIZED_REPRESENTATIVE"]},"type":"array"},{"type":"null"}],"title":"Roles"},"ownership_percentage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ownership Percentage","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The related party's ownership stake, as a string parseable to a number between 0 and 1 (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"0.51\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for 51%)."},"children":[]}]}]}]},"citizenship":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Citizenship"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["identification_number","id"],"title":"RelatedPartyApplicationResponse"}},"components/schemas/RemittanceInfo":{"id":"components/schemas/RemittanceInfo","kind":"json-schema","title":"RemittanceInfo","data":{"properties":{"purpose":{"type":"string","title":"Purpose","description":"Remittance purpose"}},"type":"object","required":["purpose"],"title":"RemittanceInfo"}},"components/schemas/RemittanceInformation":{"id":"components/schemas/RemittanceInformation","kind":"json-schema","title":"RemittanceInformation","data":{"properties":{"unstructured":{"type":"string","maxLength":200,"title":"Unstructured","description":"Unstructured information provided by the originator of the transaction.","default":""}},"type":"object","title":"RemittanceInformation"}},"components/schemas/RenderFormatsRequest":{"id":"components/schemas/RenderFormatsRequest","kind":"json-schema","title":"RenderFormatsRequest","data":{"properties":{"output_formats":{"items":{"type":"string"},"type":"array","maxItems":20,"minItems":1,"title":"Output Formats"},"customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Customer Id"}},"type":"object","required":["output_formats"],"title":"RenderFormatsRequest"}},"components/schemas/Report":{"id":"components/schemas/Report","kind":"json-schema","title":"Report","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"file_name":{"type":"string","title":"File Name"},"mime_type":{"type":"string","title":"Mime Type"},"status":{"type":"string","enum":["PENDING","AVAILABLE","FAILED"],"title":"Status"},"type":{"type":"string","title":"Type"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"format":{"anyOf":[{"$ref":"#/components/schemas/ReportFormat"},{"type":"null"}]}},"type":"object","required":["id","file_name","mime_type","status","type","metadata","created_at"],"title":"Report"}},"components/schemas/ReportDownload":{"id":"components/schemas/ReportDownload","kind":"json-schema","title":"ReportDownload","data":{"properties":{"download_url":{"type":"string","title":"Download Url"},"expires":{"type":"string","format":"date-time","title":"Expires"}},"type":"object","required":["download_url","expires"],"title":"ReportDownload"}},"components/schemas/ReportDownloadRequest":{"id":"components/schemas/ReportDownloadRequest","kind":"json-schema","title":"ReportDownloadRequest","data":{"properties":{"customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Customer Id"}},"type":"object","title":"ReportDownloadRequest"}},"components/schemas/ReportEvent":{"id":"components/schemas/ReportEvent","kind":"json-schema","title":"ReportEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ReportStatusPayload"},"event_type":{"type":"string","enum":["report.status.available","report.status.pending","report.status.failed"],"title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"ReportEvent"}},"components/schemas/ReportFormat":{"id":"components/schemas/ReportFormat","kind":"json-schema","title":"ReportFormat","data":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"}},"type":"object","required":["id","name","description"],"title":"ReportFormat"}},"components/schemas/ReportRequest":{"id":"components/schemas/ReportRequest","kind":"json-schema","title":"ReportRequest","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"type":{"type":"string","title":"Type"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"reports":{"items":{"$ref":"#/components/schemas/Report"},"type":"array","title":"Reports"}},"type":"object","required":["id","type","metadata","created_at","reports"],"title":"ReportRequest"}},"components/schemas/ReportStatusPayload":{"id":"components/schemas/ReportStatusPayload","kind":"json-schema","title":"ReportStatusPayload","data":{"properties":{"report_id":{"type":"string","format":"uuid","title":"Report Id"},"root_report_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Root Report Id"}},"type":"object","required":["report_id","root_report_id"],"title":"ReportStatusPayload"}},"components/schemas/RequestedAmount":{"id":"components/schemas/RequestedAmount","kind":"json-schema","title":"Requested amount","data":{"properties":{"amount_usdc":{"type":"integer","exclusiveMinimum":0,"title":"Amount USDC"},"type":{"type":"string","const":"REQUESTED_AMOUNT","title":"Type"}},"type":"object","required":["amount_usdc","type"],"title":"Requested amount","description":"Creates a transfer for a specific, requested amount."}},"components/schemas/RetiredInvestmentProfile":{"id":"components/schemas/RetiredInvestmentProfile","kind":"json-schema","title":"RetiredInvestmentProfile","data":{"properties":{"income":{"type":"string","enum":["BELOW_50K","BETWEEN_50K_AND_100K","BETWEEN_100K_AND_250K","OVER_250K"],"title":"Income","description":"Applicant's estimated annual income in USD."},"net_worth":{"type":"string","enum":["BELOW_50K","BETWEEN_50K_AND_200K","BETWEEN_200K_AND_1M","BETWEEN_1M_AND_5M","OVER_5M"],"title":"Net Worth","description":"Applicant's estimated average personal net worth in USD."},"bd_association":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Bd Association","description":"Name of broker-dealer association or employment. Disclosure is required by law if applicable, else, leave empty"},"director_policy_maker_of_company":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Director Policy Maker Of Company","description":"Name of company where customer is director or policy maker. Disclosure is required by law if applicable, otherwise, leave empty"},"occupation":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Occupation","description":"Applicant's occupation. Needs to be filled out if employment status is Employed."},"employment_status":{"type":"string","const":"RETIRED","title":"Employment Status"}},"type":"object","required":["income","net_worth","employment_status"],"title":"RetiredInvestmentProfile"}},"components/schemas/RetryPolicy":{"id":"components/schemas/RetryPolicy","kind":"json-schema","title":"RetryPolicy","data":{"properties":{"retry_on_status_codes":{"items":{"type":"integer"},"type":"array","title":"Retry On Status Codes","description":"Denotes on which status codes Jiko will retry the webhook call, e.g. 502 or 503."},"backoff_coefficient":{"type":"number","maximum":5,"minimum":1,"title":"Backoff Coefficient"},"maximum_attempts":{"type":"integer","maximum":5,"minimum":1,"title":"Maximum Attempts"},"initial_interval_seconds":{"type":"number","maximum":30,"minimum":0,"title":"Initial Interval Seconds"},"maximum_interval_seconds":{"type":"number","maximum":300,"minimum":0,"title":"Maximum Interval Seconds"}},"type":"object","required":["retry_on_status_codes","backoff_coefficient","maximum_attempts","initial_interval_seconds","maximum_interval_seconds"],"title":"RetryPolicy"}},"components/schemas/RiskInfo":{"id":"components/schemas/RiskInfo","kind":"json-schema","title":"RiskInfo","data":{"properties":{"risk_categories":{"anyOf":[{"items":{"type":"string","enum":["INTERNET_GAMBLING","CANNABIS","CRYPTOCURRENCY","CROWDFUNDING","FINANCIAL_OR_MONEY_MOVEMENT","NON_US_ENTITY","FINTECH_OR_BAAS"]},"type":"array"},{"type":"null"}],"title":"Risk Categories"},"company_mission":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Mission"},"has_current_enforcement_actions":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Current Enforcement Actions"},"primary_regulator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Primary Regulator"},"business_activity_location":{"anyOf":[{"type":"string","enum":["PRIMARILY_US","MIX_OF_US_AND_NON_US","PRIMARILY_NON_US"]},{"type":"null"}],"title":"Business Activity Location"},"source_of_funds":{"anyOf":[{"type":"string","enum":["INTERNAL_FUNDS","CLIENT_OR_EXTERNAL_FUNDS","CRYPTOCURRENCY_EXCESS_RESERVES","CRYPTOCURRENCY_STABLECOIN_RESERVES"]},{"type":"null"}],"title":"Source Of Funds"},"source_of_funds_explanation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Of Funds Explanation"},"account_usage":{"anyOf":[{"type":"string","enum":["MONEY_STORAGE","MONEY_STORAGE_US_BANKS","MONEY_STORAGE_NON_US_BANKS","3RD_PARTY_PAYMENTS","CRYPTOCURRENCY_EXCESS_RESERVES","CRYPTOCURRENCY_STABLECOIN_RESERVES"]},{"type":"null"}],"title":"Account Usage"},"annual_revenue":{"anyOf":[{"type":"string","enum":["PRE_REVENUE","5M_OR_LESS","BETWEEN_5M_100M","100M_OR_MORE"]},{"type":"null"}],"title":"Annual Revenue"},"monthly_transactions":{"anyOf":[{"type":"string","enum":["5_OR_LESS","BETWEEN_5_AND_15","15_OR_MORE"]},{"type":"null"}],"title":"Monthly Transactions"},"first_month_deposit":{"anyOf":[{"type":"string","enum":["1M_OR_LESS","BETWEEN_1M_AND_5M","BETWEEN_5M_AND_20M","BETWEEN_20M_AND_50M","50M_OR_MORE"]},{"type":"null"}],"title":"First Month Deposit"}},"type":"object","title":"RiskInfo"}},"components/schemas/SameEntityTransferTrade":{"id":"components/schemas/SameEntityTransferTrade","kind":"json-schema","title":"SameEntityTransferTrade","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for this trade"},"trade_datetime":{"type":"string","format":"date-time","title":"Trade Datetime","description":"The date and time at which the trade was executed"},"book_date":{"type":"string","format":"date","title":"Book Date","description":"The date on which the trade was booked into the ledger"},"settled_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Settled Date","description":"The date on which the trade was settled, or null if not yet settled"},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current status of the trade: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BOOKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]}]}]}]},"activity":{"type":"string","const":"SAME_ENTITY_SECURITY_TRANSFER","title":"Activity","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of trade activity: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MATURITY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXTERNAL_SECURITY_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAME_ENTITY_SECURITY_TRANSFER"},"children":[]}]}]}]},"origin_pocket_id":{"type":"string","format":"uuid","title":"Origin Pocket Id","description":"The pocket from which securities are being transferred"},"destination_pocket_id":{"type":"string","format":"uuid","title":"Destination Pocket Id","description":"The pocket to which securities are being transferred"},"securities":{"items":{"$ref":"#/components/schemas/CusipSecurity"},"type":"array","title":"Securities","description":"The securities being transferred"},"currency_legs":{"items":{"$ref":"#/components/schemas/CurrencyLeg"},"type":"array","title":"Currency Legs","description":"Currency movements associated with this transfer"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","trade_datetime","book_date","settled_date","status","activity","origin_pocket_id","destination_pocket_id","securities","currency_legs","object_type"],"title":"SameEntityTransferTrade","description":"A same-entity transfer trade representing a direct movement of securities between two pockets belonging to the same customer."}},"components/schemas/Security":{"id":"components/schemas/Security","kind":"json-schema","title":"Security","data":{"properties":{"tradable_id":{"type":"string","format":"uuid","title":"Tradable Id"},"security_type":{"type":"string","enum":["FIXED_INCOME","OTHER"],"title":"Security Type"},"quantity":{"type":"integer","exclusiveMinimum":0,"title":"Quantity","description":"Number of securities"},"market_value":{"$ref":"#/components/schemas/Amount","description":"The current market value of the securities"},"external_id":{"type":"string","title":"External Id"},"maturity_date":{"type":"string","format":"date","title":"Maturity Date","description":"Due date of the fixed income instrument"},"yield_to_maturity":{"$ref":"#/components/schemas/Decimal","description":"Rate of return if the security is held to the maturity date"},"ask":{"$ref":"#/components/schemas/Decimal","description":"The current price the account is willing to sell the security at"},"bid":{"$ref":"#/components/schemas/Decimal","description":"The current price the market is willing to pay for the security"},"description":{"type":"string","title":"Description","description":"A description of the security"}},"type":"object","required":["tradable_id","security_type","quantity","market_value","external_id","maturity_date","yield_to_maturity","ask","bid","description"],"title":"Security"}},"components/schemas/SecurityPriceReport":{"id":"components/schemas/SecurityPriceReport","kind":"json-schema","title":"SecurityPriceReport","data":{"properties":{"securities":{"items":{"type":"string"},"type":"array","title":"Securities","default":[]},"start_date":{"type":"string","format":"date","title":"Start Date"},"end_date":{"type":"string","format":"date","title":"End Date"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id"},"type":{"type":"string","const":"SECURITY_PRICE_REPORT","title":"Type"}},"type":"object","required":["start_date","end_date","customer_id","type"],"title":"SecurityPriceReport"}},"components/schemas/SecurityTransferTrade":{"id":"components/schemas/SecurityTransferTrade","kind":"json-schema","title":"SecurityTransferTrade","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for this trade"},"trade_datetime":{"type":"string","format":"date-time","title":"Trade Datetime","description":"The date and time at which the trade was executed"},"book_date":{"type":"string","format":"date","title":"Book Date","description":"The date on which the trade was booked into the ledger"},"settled_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Settled Date","description":"The date on which the trade was settled, or null if not yet settled"},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current status of the trade: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BOOKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]}]}]}]},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket this trade is listed under"},"activity":{"type":"string","const":"EXTERNAL_SECURITY_TRANSFER","title":"Activity","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of trade activity: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MATURITY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXTERNAL_SECURITY_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAME_ENTITY_SECURITY_TRANSFER"},"children":[]}]}]}]},"securities":{"items":{"$ref":"#/components/schemas/CusipSecurity"},"type":"array","title":"Securities","description":"The securities being transferred"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","trade_datetime","book_date","settled_date","status","pocket_id","activity","securities","object_type"],"title":"SecurityTransferTrade","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A security transfer trade representing securities moving in or out of a pocket."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yield_to_maturity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" because a transfer is not priced like a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"trade — it just moves existing securities between accounts."},"children":[]}]}]}]}},"components/schemas/ShippingAddress":{"id":"components/schemas/ShippingAddress","kind":"json-schema","title":"ShippingAddress","data":{"properties":{"street_address":{"type":"string","maxLength":100,"title":"Street Address","description":"Street address"},"street_address2":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Street Address2","description":"Apartment, Suite, Box number, etc."},"city":{"type":"string","maxLength":100,"title":"City","description":"City / Town"},"postal_code":{"type":"string","maxLength":10,"title":"Postal Code","description":"Postal code / ZIP code"},"state":{"$ref":"#/components/schemas/State","description":"State (Postal Abbreviations. Example: \"AL\", \"NJ\", \"OH\")"},"country":{"$ref":"#/components/schemas/Country","description":"A ISO-3166 Alpha-2 country code (Abbreviated. Example: \"US\")"}},"type":"object","required":["street_address","city","postal_code","state","country"],"title":"ShippingAddress"}},"components/schemas/StandardTrade":{"id":"components/schemas/StandardTrade","kind":"json-schema","title":"StandardTrade","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier for this trade"},"trade_datetime":{"type":"string","format":"date-time","title":"Trade Datetime","description":"The date and time at which the trade was executed"},"book_date":{"type":"string","format":"date","title":"Book Date","description":"The date on which the trade was booked into the ledger"},"settled_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Settled Date","description":"The date on which the trade was settled, or null if not yet settled"},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current status of the trade: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BOOKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]}]}]}]},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket this trade is listed under"},"activity":{"type":"string","enum":["BUY","SELL","MATURITY"],"title":"Activity","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of trade activity: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MATURITY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXTERNAL_SECURITY_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAME_ENTITY_SECURITY_TRANSFER"},"children":[]}]}]}]},"securities":{"items":{"$ref":"#/components/schemas/CusipSecurity"},"type":"array","title":"Securities","description":"The securities involved in this trade"},"yield_to_maturity":{"$ref":"#/components/schemas/Decimal","description":"Rate of return if the security is held to the maturity date"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","trade_datetime","book_date","settled_date","status","pocket_id","activity","securities","yield_to_maturity","object_type"],"title":"StandardTrade","description":"A standard trade representing a BUY, SELL, or MATURITY event for a single pocket."}},"components/schemas/State":{"id":"components/schemas/State","kind":"json-schema","title":"State","data":{"type":"string","enum":["AA","AE","AP","AK","AL","AR","AZ","CA","CO","CT","DC","DE","FL","GA","GU","HI","IA","ID","IL","IN","KS","KY","LA","MA","MD","ME","MI","MN","MO","MS","MT","NC","ND","NE","NH","NJ","NM","NV","NY","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VA","VI","VT","WA","WI","WV","WY"],"title":"State"}},"components/schemas/Statement":{"id":"components/schemas/Statement","kind":"json-schema","title":"Statement","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"jiko_account_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Jiko Account Id"},"type":{"type":"string","enum":["1099B","1099INT","BANK","BROKERAGE","CONSOLIDATED_BANK","CONSOLIDATED_BROKERAGE"],"title":"Type"},"key":{"type":"string","title":"Key"},"pdf_download_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Pdf Download Url"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"csv_zip_download_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Csv Zip Download Url"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","jiko_account_id","type","key","pdf_download_url","time_created","csv_zip_download_url","object_type"],"title":"Statement"}},"components/schemas/StatementListResponse":{"id":"components/schemas/StatementListResponse","kind":"json-schema","title":"StatementListResponse","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/Statement"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"StatementListResponse"}},"components/schemas/StudentInvestmentProfile":{"id":"components/schemas/StudentInvestmentProfile","kind":"json-schema","title":"StudentInvestmentProfile","data":{"properties":{"income":{"type":"string","enum":["BELOW_50K","BETWEEN_50K_AND_100K","BETWEEN_100K_AND_250K","OVER_250K"],"title":"Income","description":"Applicant's estimated annual income in USD."},"net_worth":{"type":"string","enum":["BELOW_50K","BETWEEN_50K_AND_200K","BETWEEN_200K_AND_1M","BETWEEN_1M_AND_5M","OVER_5M"],"title":"Net Worth","description":"Applicant's estimated average personal net worth in USD."},"bd_association":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Bd Association","description":"Name of broker-dealer association or employment. Disclosure is required by law if applicable, else, leave empty"},"director_policy_maker_of_company":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Director Policy Maker Of Company","description":"Name of company where customer is director or policy maker. Disclosure is required by law if applicable, otherwise, leave empty"},"occupation":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Occupation","description":"Applicant's occupation. Needs to be filled out if employment status is Employed."},"employment_status":{"type":"string","const":"STUDENT","title":"Employment Status"}},"type":"object","required":["income","net_worth","employment_status"],"title":"StudentInvestmentProfile"}},"components/schemas/Subscription":{"id":"components/schemas/Subscription","kind":"json-schema","title":"Subscription","data":{"properties":{"description":{"type":"string","title":"Description","description":"A description of the webhook's intended use.","default":""},"events":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Events","description":"Which types of events this webhook should be invoked for."},"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url","description":"The webhook URL to invoke."},"retry_policy":{"anyOf":[{"$ref":"#/components/schemas/RetryPolicy"},{"type":"null"}],"description":"The retry policy to use if Jiko encounters HTTP errors when calling subscription URLs."},"id":{"type":"string","format":"uuid","title":"Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"status":{"type":"string","enum":["enabled","disabled"],"title":"Status"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["events","url","id","time_created","updated_at","status","object_type"],"title":"Subscription"}},"components/schemas/SupportingDocument":{"id":"components/schemas/SupportingDocument","kind":"json-schema","title":"SupportingDocument","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"document_id":{"type":"string","format":"uuid","title":"Document Id"},"status":{"type":"string","enum":["PENDING_REVIEW","APPROVED","REJECTED"],"title":"Status"}},"type":"object","required":["id","document_id","status"],"title":"SupportingDocument"}},"components/schemas/SupportingDocumentsVerification":{"id":"components/schemas/SupportingDocumentsVerification","kind":"json-schema","title":"SupportingDocumentsVerification","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"type":"string","const":"supporting_documents","title":"Type"},"supporting_documents":{"items":{"$ref":"#/components/schemas/SupportingDocument"},"type":"array","title":"Supporting Documents"},"status":{"type":"string","enum":["PENDING_REVIEW","APPROVED","REJECTED"],"title":"Status"}},"type":"object","required":["id","description","type","supporting_documents","status"],"title":"SupportingDocumentsVerification"}},"components/schemas/TradableMaturityEvent":{"id":"components/schemas/TradableMaturityEvent","kind":"json-schema","title":"TradableMaturityEvent","data":{"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/TradableMaturityPayload"},"event_type":{"type":"string","const":"tradable.maturity","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TradableMaturityEvent"}},"components/schemas/TradableMaturityPayload":{"id":"components/schemas/TradableMaturityPayload","kind":"json-schema","title":"TradableMaturityPayload","data":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"cusip":{"type":"string","title":"Cusip"},"cusip_maturity_date":{"type":"string","format":"date-time","title":"Cusip Maturity Date"},"trading_strategy":{"type":"string","title":"Trading Strategy"}},"type":"object","required":["jiko_account_id","cusip","cusip_maturity_date","trading_strategy"],"title":"TradableMaturityPayload"}},"components/schemas/Trade":{"id":"components/schemas/Trade","kind":"json-schema","title":"Trade","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"trade_datetime":{"type":"string","format":"date-time","title":"Trade Datetime"},"settled_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Settled Date"},"is_settled":{"type":"boolean","title":"Is Settled"},"activity":{"type":"string","enum":["BUY","SELL","MATURITY"],"title":"Activity"},"cusip":{"type":"string","title":"Cusip"},"description":{"type":"string","title":"Description"},"notional":{"$ref":"#/components/schemas/Amount"},"quantity":{"type":"integer","title":"Quantity"},"price":{"$ref":"#/components/schemas/Decimal"},"maturity_date":{"type":"string","format":"date","title":"Maturity Date"},"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"yield_to_maturity":{"$ref":"#/components/schemas/Decimal"},"tradable_id":{"type":"string","title":"Tradable Id"},"book_date":{"type":"string","format":"date","title":"Book Date"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","trade_datetime","settled_date","is_settled","activity","cusip","description","notional","quantity","price","maturity_date","jiko_account_id","yield_to_maturity","tradable_id","book_date","object_type"],"title":"Trade"}},"components/schemas/TradeConfirmation":{"id":"components/schemas/TradeConfirmation","kind":"json-schema","title":"TradeConfirmation","data":{"properties":{"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["url","object_type"],"title":"TradeConfirmation","example":{"url":"https://example.com/path-to-trade-confirmation-pdf"}}},"components/schemas/TradeListResponse":{"id":"components/schemas/TradeListResponse","kind":"json-schema","title":"TradeListResponse","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/Trade"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"TradeListResponse"}},"components/schemas/TradeListResponseV2":{"id":"components/schemas/TradeListResponseV2","kind":"json-schema","title":"TradeListResponseV2","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"oneOf":[{"$ref":"#/components/schemas/StandardTrade"},{"$ref":"#/components/schemas/SecurityTransferTrade"},{"$ref":"#/components/schemas/SameEntityTransferTrade"}],"discriminator":{"propertyName":"activity","mapping":{"BUY":"#/components/schemas/StandardTrade","EXTERNAL_SECURITY_TRANSFER":"#/components/schemas/SecurityTransferTrade","MATURITY":"#/components/schemas/StandardTrade","SAME_ENTITY_SECURITY_TRANSFER":"#/components/schemas/SameEntityTransferTrade","SELL":"#/components/schemas/StandardTrade"}}},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"TradeListResponseV2"}},"components/schemas/TradeReport":{"id":"components/schemas/TradeReport","kind":"json-schema","title":"TradeReport","data":{"properties":{"customer_id":{"type":"string","format":"uuid","title":"Customer Id"},"pocket_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Pocket Ids"},"start_date":{"type":"string","format":"date","title":"Start Date"},"end_date":{"type":"string","format":"date","title":"End Date"},"filter_by_date_type":{"type":"string","enum":["trade_date","settlement_date","book_date"],"title":"Filter By Date Type","default":"trade_date"},"include_maturity_events":{"type":"boolean","title":"Include Maturity Events","default":false},"type":{"type":"string","const":"TRADE_REPORT","title":"Type"}},"type":"object","required":["customer_id","pocket_ids","start_date","end_date","type"],"title":"TradeReport"}},"components/schemas/TradingStrategies":{"id":"components/schemas/TradingStrategies","kind":"json-schema","title":"TradingStrategies","data":{"properties":{"offset":{"type":"integer","title":"Offset"},"count":{"type":"integer","title":"Count"},"items":{"items":{"$ref":"#/components/schemas/TradingStrategy"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"List"},"last_updated":{"type":"string","format":"date-time","title":"Last Updated","description":"Timestamp that reflects when the Jiko quote was fetched"}},"type":"object","required":["offset","count","items","last_updated"],"title":"TradingStrategies"}},"components/schemas/TradingStrategy":{"id":"components/schemas/TradingStrategy","kind":"json-schema","title":"TradingStrategy","data":{"properties":{"id":{"type":"string","title":"Id"},"description":{"type":"string","title":"Description"},"yield_to_maturity":{"anyOf":[{"$ref":"#/components/schemas/Decimal"},{"type":"null"}]},"discount_yield":{"anyOf":[{"$ref":"#/components/schemas/Decimal"},{"type":"null"}]},"applicable_to":{"items":{"type":"string","enum":["DEPOSIT","REINVESTMENT"]},"type":"array","title":"Applicable To"}},"type":"object","required":["id","description","yield_to_maturity","discount_yield","applicable_to"],"title":"TradingStrategy"}},"components/schemas/Transaction":{"id":"components/schemas/Transaction","kind":"json-schema","title":"Transaction","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"amount":{"$ref":"#/components/schemas/Amount"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"status":{"type":"string","enum":["PENDING","COMPLETED"],"title":"Status"},"details":{"$ref":"#/components/schemas/TransactionDetails"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","jiko_account_id","amount","timestamp","status","details","object_type"],"title":"Transaction"}},"components/schemas/TransactionDetails":{"id":"components/schemas/TransactionDetails","kind":"json-schema","title":"TransactionDetails","data":{"properties":{"transaction_type":{"type":"string","enum":["CARD","CASH_BACK","ACH","WIRE","WIRE_FEE","GENERIC","ON_US"],"title":"Transaction Type"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"sub_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sub Title"},"transaction_type_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Type Title"},"card_transaction":{"anyOf":[{"$ref":"#/components/schemas/CardTransactionDetails"},{"type":"null"}]},"ach_transaction":{"anyOf":[{"$ref":"#/components/schemas/ACHTransactionDetails"},{"type":"null"}]},"wire_transaction":{"anyOf":[{"$ref":"#/components/schemas/WireTransactionDetails"},{"type":"null"}]},"wire_fee_transaction":{"anyOf":[{"$ref":"#/components/schemas/WireTransactionDetails"},{"type":"null"}]},"cash_back_transaction":{"anyOf":[{"$ref":"#/components/schemas/CashBackTransactionDetails"},{"type":"null"}]},"on_us_transaction":{"anyOf":[{"$ref":"#/components/schemas/OnUsTransactionDetails"},{"type":"null"}]}},"type":"object","required":["transaction_type"],"title":"TransactionDetails"}},"components/schemas/TransactionListResponse":{"id":"components/schemas/TransactionListResponse","kind":"json-schema","title":"TransactionListResponse","data":{"properties":{"prev_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Page"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"},"items":{"items":{"$ref":"#/components/schemas/Transaction"},"type":"array","title":"Items"},"object_type":{"type":"string","title":"Object Type","default":"CursorList"}},"type":"object","required":["items"],"title":"TransactionListResponse"}},"components/schemas/TransactionLocation":{"id":"components/schemas/TransactionLocation","kind":"json-schema","title":"TransactionLocation","data":{"properties":{"street_address":{"type":"string","title":"Street Address"},"city":{"type":"string","title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"country":{"type":"string","title":"Country"}},"type":"object","required":["street_address","city","country"],"title":"TransactionLocation"}},"components/schemas/TrustedContact":{"id":"components/schemas/TrustedContact","kind":"json-schema","title":"TrustedContact","data":{"properties":{"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An E.164-formatted phone number, e.g. +12345678901"},"children":[]}]}]}]},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address of the trusted contact. You can use a format such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{street name}, {city}, {state}, {post code}, {country}"},"children":[]}]}]}]}},"type":"object","title":"TrustedContact"}},"components/schemas/USDCFundingInstruction":{"id":"components/schemas/USDCFundingInstruction","kind":"json-schema","title":"USDCFundingInstruction","data":{"properties":{"type":{"type":"string","const":"USDC","title":"Type"},"address":{"type":"string","title":"Address","description":"The wallet address of the portal"},"chain":{"type":"string","title":"Chain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chain associated with the wallet address. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ETH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported at this time."},"children":[]}]}]}]}},"type":"object","required":["type","address","chain"],"title":"USDCFundingInstruction"}},"components/schemas/UnemployedInvestmentProfile":{"id":"components/schemas/UnemployedInvestmentProfile","kind":"json-schema","title":"UnemployedInvestmentProfile","data":{"properties":{"income":{"type":"string","enum":["BELOW_50K","BETWEEN_50K_AND_100K","BETWEEN_100K_AND_250K","OVER_250K"],"title":"Income","description":"Applicant's estimated annual income in USD."},"net_worth":{"type":"string","enum":["BELOW_50K","BETWEEN_50K_AND_200K","BETWEEN_200K_AND_1M","BETWEEN_1M_AND_5M","OVER_5M"],"title":"Net Worth","description":"Applicant's estimated average personal net worth in USD."},"bd_association":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Bd Association","description":"Name of broker-dealer association or employment. Disclosure is required by law if applicable, else, leave empty"},"director_policy_maker_of_company":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Director Policy Maker Of Company","description":"Name of company where customer is director or policy maker. Disclosure is required by law if applicable, otherwise, leave empty"},"occupation":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Occupation","description":"Applicant's occupation. Needs to be filled out if employment status is Employed."},"employment_status":{"type":"string","const":"UNEMPLOYED","title":"Employment Status"}},"type":"object","required":["income","net_worth","employment_status"],"title":"UnemployedInvestmentProfile"}},"components/schemas/UnverifiedVerification":{"id":"components/schemas/UnverifiedVerification","kind":"json-schema","title":"UnverifiedVerification","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"type":"string","const":"unverified","title":"Type"}},"type":"object","required":["id","description","type"],"title":"UnverifiedVerification"}},"components/schemas/UpdateCounterpartyRequest":{"id":"components/schemas/UpdateCounterpartyRequest","kind":"json-schema","title":"UpdateCounterpartyRequest","data":{"properties":{"status":{"anyOf":[{"type":"string","const":"UNLINKED"},{"type":"null"}],"title":"Status"},"display_name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."}},"type":"object","title":"UpdateCounterpartyRequest"}},"components/schemas/UpdateCustomerData":{"id":"components/schemas/UpdateCustomerData","kind":"json-schema","title":"UpdateCustomerData","data":{"properties":{"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicant's phone number. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": It will be required to include country codes in accordance to the E.164 spec in a future release, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"^\\+[1-9]\\d{1,14}$"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"address":{"anyOf":[{"$ref":"#/components/schemas/ISOAddressRequest"},{"type":"null"}]},"trusted_contact":{"anyOf":[{"$ref":"#/components/schemas/TrustedContact"},{"type":"null"}],"description":"Set the trusted contact as null to remove the current trusted contact information."}},"type":"object","title":"UpdateCustomerData"}},"components/schemas/UpdatePocketRequest":{"id":"components/schemas/UpdatePocketRequest","kind":"json-schema","title":"UpdatePocketRequest","data":{"properties":{"pocket_name":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Pocket Name","description":"Pocket name"},"status":{"anyOf":[{"type":"string","const":"CLOSED"},{"type":"null"}],"title":"Status","description":"Pocket status"},"closure_reason":{"anyOf":[{"type":"string","enum":["PARTNER_INSTIGATED","USER_INSTIGATED","INACTIVITY","SUSPICIOUS_ACTIVITY"]},{"type":"null"}],"title":"Closure Reason"},"deposit_strategy_id":{"anyOf":[{"$ref":"#/components/schemas/CreatePocketConfigurationId"},{"type":"null"}],"description":"Pocket deposit trading strategy ID (Example: UST-4W)"},"reinvestment_strategy_id":{"anyOf":[{"$ref":"#/components/schemas/CreatePocketConfigurationId"},{"type":"null"}],"description":"Pocket reinvestment trading strategy ID (Example: UST-4W)"}},"type":"object","title":"UpdatePocketRequest"}},"components/schemas/UpdateRetryPolicy":{"id":"components/schemas/UpdateRetryPolicy","kind":"json-schema","title":"UpdateRetryPolicy","data":{"properties":{"retry_policy":{"anyOf":[{"$ref":"#/components/schemas/RetryPolicy"},{"type":"null"}]}},"type":"object","title":"UpdateRetryPolicy"}},"components/schemas/UpdateSubscriptionRequest":{"id":"components/schemas/UpdateSubscriptionRequest","kind":"json-schema","title":"UpdateSubscriptionRequest","data":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A description of the webhook's intended use."},"events":{"anyOf":[{"items":{"type":"string"},"type":"array","minItems":1,"description":"Which types of events this webhook should be invoked for."},{"type":"null"}],"title":"Events"},"url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Url","description":"The webhook URL to invoke."},"shared_secret":{"anyOf":[{"type":"string","minLength":16},{"type":"null"}],"title":"Shared Secret","description":"The shared secret used by the Partner API to sign requests made to the webhook. The shared secret needs to be minimum 16 characters long."},"retry_policy":{"anyOf":[{"$ref":"#/components/schemas/RetryPolicy"},{"type":"null"}]}},"type":"object","title":"UpdateSubscriptionRequest"}},"components/schemas/UploadDocumentResponse":{"id":"components/schemas/UploadDocumentResponse","kind":"json-schema","title":"UploadDocumentResponse","data":{"properties":{"success":{"type":"boolean","title":"Success"},"document_id":{"type":"string","format":"uuid","title":"Document Id"}},"type":"object","required":["success","document_id"],"title":"UploadDocumentResponse"}},"components/schemas/ValidationError":{"id":"components/schemas/ValidationError","kind":"json-schema","title":"ValidationError","data":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"components/schemas/ValuationType":{"id":"components/schemas/ValuationType","kind":"json-schema","title":"ValuationType","data":{"type":"string","enum":["rfq","jikonet"],"title":"ValuationType"}},"components/schemas/VirtualBankAccountPortal":{"id":"components/schemas/VirtualBankAccountPortal","kind":"json-schema","title":"VirtualBankAccountPortal","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"name":{"type":"string","title":"Name","description":"Portal name"},"status":{"type":"string","enum":["OPEN","CLOSED","PENDING","REJECTED"],"title":"Status","description":"Portal status"},"type":{"type":"string","const":"VIRTUAL_BANK_ACCOUNT_PORTAL","title":"Type"},"routing_number":{"type":"string","title":"Routing Number","description":"Routing number"},"account_number":{"type":"string","title":"Account Number","description":"Account number"},"payment_rails":{"items":{"type":"string","enum":["ACH","WIRE","ON_US"]},"type":"array","title":"Payment Rails","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which payment rails (ACH, WIRE, ON_US) are accepted."},"children":[]}]}]}]}},"type":"object","required":["id","pocket_id","time_created","name","status","type","routing_number","account_number","payment_rails"],"title":"VirtualBankAccountPortal"}},"components/schemas/VirtualCardResponse":{"id":"components/schemas/VirtualCardResponse","kind":"json-schema","title":"VirtualCardResponse","data":{"properties":{"card_id":{"type":"string","format":"uuid","title":"Card Id"},"encrypted_pan":{"type":"string","title":"Encrypted Pan"},"encrypted_cvv":{"type":"string","title":"Encrypted Cvv"},"encrypted_expiration":{"type":"string","title":"Encrypted Expiration"},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["card_id","encrypted_pan","encrypted_cvv","encrypted_expiration","object_type"],"title":"VirtualCardResponse"}},"components/schemas/WireCounterparty":{"id":"components/schemas/WireCounterparty","kind":"json-schema","title":"WireCounterparty","data":{"properties":{"time_created":{"type":"string","format":"date-time","title":"Time Created"},"verification_type":{"type":"string","enum":["MICRO_DEPOSITS","PLAID","PRE_VERIFIED","INCOMING_WIRE","SUPPORTING_DOCUMENTS"],"title":"Verification Type"},"status":{"type":"string","enum":["IN_PROGRESS","FAILED","VERIFIED"],"title":"Status"},"account_number":{"type":"string","title":"Account Number"},"routing_number":{"type":"string","title":"Routing Number"},"name_on_account":{"type":"string","title":"Name On Account"},"account_type":{"type":"string","enum":["SAVINGS","CHECKING"],"title":"Account Type"},"institution_name":{"type":"string","title":"Institution Name"}},"type":"object","required":["time_created","verification_type","status","account_number","routing_number","name_on_account","account_type","institution_name"],"title":"WireCounterparty"}},"components/schemas/WireCounterpartyV2":{"id":"components/schemas/WireCounterpartyV2","kind":"json-schema","title":"Wire Counterparty","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"time_created":{"type":"string","format":"date-time","title":"Time Created"},"status":{"type":"string","enum":["PENDING","FAILED","LINKED","UNLINKED","CLOSED"],"title":"Status"},"verification":{"oneOf":[{"$ref":"#/components/schemas/SupportingDocumentsVerification"},{"$ref":"#/components/schemas/IncomingWireVerification"},{"$ref":"#/components/schemas/PreVerifiedVerification"},{"$ref":"#/components/schemas/PlaidVerification"},{"$ref":"#/components/schemas/MicroDepositsVerification"},{"$ref":"#/components/schemas/NameMatchVerification"},{"$ref":"#/components/schemas/UnverifiedVerification"}],"title":"Verification","discriminator":{"propertyName":"type","mapping":{"incoming_wire":"#/components/schemas/IncomingWireVerification","micro_deposits":"#/components/schemas/MicroDepositsVerification","name_match":"#/components/schemas/NameMatchVerification","plaid":"#/components/schemas/PlaidVerification","pre_verified":"#/components/schemas/PreVerifiedVerification","supporting_documents":"#/components/schemas/SupportingDocumentsVerification","unverified":"#/components/schemas/UnverifiedVerification"}}},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"An optional custom display name for the counterparty, useful for distinguishing multiple counterparties that share the same legal name."},"type":{"type":"string","const":"wire","title":"Type"},"counterparty_name":{"oneOf":[{"$ref":"#/components/schemas/IndividualName"},{"$ref":"#/components/schemas/BusinessName"}],"title":"Counterparty name","discriminator":{"propertyName":"type","mapping":{"business":"#/components/schemas/BusinessName","individual":"#/components/schemas/IndividualName"}}},"address":{"$ref":"#/components/schemas/CounterpartyAddress"},"institution_name":{"type":"string","title":"Institution Name"},"routing_number":{"type":"string","title":"Routing Number"},"identifier":{"type":"string","title":"Identifier"},"identifier_code":{"type":"string","enum":["SWIFT_BIC","CHIPS_PARTICIPANT","DIRECT_DEPOSIT_ACCOUNT","FED_ROUTING_NUMBER","SWIFT_ID_AND_ACCOUNT_NUMBER","CHIPS_IDENTIFIER","PASSPORT_NUMBER","TAX_IDENTIFICATION_NUMBER","DRIVERS_LICENSE_NUMBER","ALIEN_REGISTRATION_NUMBER","CORPORATE_IDENTIFICATION","OTHER_IDENTIFICATION"],"title":"Identifier Code"},"wire_instructions":{"anyOf":[{"type":"string","maxLength":140},{"type":"null"}],"title":"Wire Instructions","description":"Any additional wire instructions required for the wire to be processed correctly."},"ownership_type":{"anyOf":[{"type":"string","enum":["FIRST_PARTY","THIRD_PARTY"]},{"type":"null"}],"title":"Ownership Type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relationship of the counterparty to the account holder. FIRST_PARTY means the counterparty is owned by the account holder, THIRD_PARTY means it is owned by a different entity."},"children":[]}]}]}]},"object_type":{"type":"string","title":"Object Type","readOnly":true}},"type":"object","required":["id","time_created","status","verification","type","counterparty_name","address","institution_name","routing_number","identifier","identifier_code","object_type"],"title":"Wire Counterparty"}},"components/schemas/WireIncomingPayload":{"id":"components/schemas/WireIncomingPayload","kind":"json-schema","title":"WireIncomingPayload","data":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"wire_id":{"type":"string","format":"uuid","title":"Wire Id"}},"type":"object","required":["jiko_account_id","wire_id"],"title":"WireIncomingPayload"}},"components/schemas/WireOutgoingPayload":{"id":"components/schemas/WireOutgoingPayload","kind":"json-schema","title":"WireOutgoingPayload","data":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"wire_id":{"type":"string","format":"uuid","title":"Wire Id"}},"type":"object","required":["jiko_account_id","wire_id"],"title":"WireOutgoingPayload"}},"components/schemas/WireRequest":{"id":"components/schemas/WireRequest","kind":"json-schema","title":"WireRequest","data":{"properties":{"counterparty_id":{"type":"string","format":"uuid","title":"Counterparty Id"},"amount_usdc":{"type":"integer","title":"Amount Usdc","description":"The amount, in USD cents."},"created_by":{"type":"string","title":"Created By","description":"A string identifying the wire transfer originator."},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description","description":"A description of the transfer, visible on statements."},"wire_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Wire Id","description":"The ID for this wire transfer, auto-generated if not provided."}},"type":"object","required":["counterparty_id","amount_usdc","created_by"],"title":"WireRequest"}},"components/schemas/WireTrackingInfo":{"id":"components/schemas/WireTrackingInfo","kind":"json-schema","title":"WireTrackingInfo","data":{"properties":{"uetr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uetr","description":"Unique End-to-end Transaction Reference (UETR), a UUID identifying the wire across the payment network."},"imad":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Imad","description":"Input Message Accountability Data (IMAD), the Fedwire identifier for the wire. Also known as the Fed reference number; domestic (Fedwire) wires only. Null when not available."},"instruction_identification":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"Instruction Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identification assigned by the instructing party to unambiguously identify the instruction (ISO 20022 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InstrId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"end_to_end_identification":{"anyOf":[{"type":"string","maxLength":35},{"type":"null"}],"title":"End To End Identification","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identification assigned by the initiating party to unambiguously identify the transaction (ISO 20022 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EndToEndId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This identification is passed on, unchanged, throughout the entire end-to-end chain."},"children":[]}]}]}]}},"type":"object","title":"WireTrackingInfo","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifiers carried on the wire's ISO 20022 message."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uetr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"imad"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are network identifiers, assigned as the payment moves"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"through the clearing network. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instruction_identification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_to_end_identification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are party-assigned references from the message's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment identification ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PmtId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"components/schemas/WireTransactionActivity":{"id":"components/schemas/WireTransactionActivity","kind":"json-schema","title":"WireTransactionActivity","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID of the transaction from the perspective of the respective pocket"},"transaction_id":{"type":"string","format":"uuid","title":"Transaction Id","description":"The ID of the transaction this activity is representing"},"description":{"type":"string","title":"Description","description":"A description of the transaction type, e.g. \"ACH Electronic Debit\"."},"amount":{"$ref":"#/components/schemas/Amount"},"time_booked":{"type":"string","format":"date-time","title":"Time Booked","description":"The time at which the transaction was originally booked into the ledger."},"time_settled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled","description":"The time at which transaction was settled."},"status":{"type":"string","enum":["BOOKED","SETTLED"],"title":"Status","description":"Status of the transactions. Has the transactions been settled"},"title":{"type":"string","title":"Title"},"direction":{"type":"string","enum":["DEBIT","CREDIT"],"title":"Direction"},"pocket_id":{"type":"string","format":"uuid","title":"Pocket Id","description":"The pocket associated with the transaction"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id","description":"The customer associated with the transaction"},"remittance_information":{"anyOf":[{"$ref":"#/components/schemas/RemittanceInformation"},{"type":"null"}]},"type":{"type":"string","const":"WIRE","title":"Type"},"reference_number":{"type":"string","title":"Reference Number"},"counterparty_name":{"type":"string","title":"Counterparty Name"},"wire_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Wire Id"}},"type":"object","required":["id","transaction_id","description","amount","time_booked","time_settled","status","title","direction","pocket_id","customer_id","type","reference_number","counterparty_name","wire_id"],"title":"WireTransactionActivity"}},"components/schemas/WireTransactionDetails":{"id":"components/schemas/WireTransactionDetails","kind":"json-schema","title":"WireTransactionDetails","data":{"properties":{"reference_number":{"type":"string","title":"Reference Number"},"counterparty_name":{"type":"string","title":"Counterparty Name"},"wire_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Wire Id"}},"type":"object","required":["reference_number","counterparty_name"],"title":"WireTransactionDetails"}},"components/schemas/partner_api__interface__models__accounts__Portfolio":{"id":"components/schemas/partner_api__interface__models__accounts__Portfolio","kind":"json-schema","title":"Portfolio","data":{"properties":{"securities":{"items":{"$ref":"#/components/schemas/Security"},"type":"array","title":"Securities","description":"Securities currently held by the brokerage account"},"cash":{"$ref":"#/components/schemas/Amount","description":"Cash currently held in the brokerage account."},"all_time_earnings":{"anyOf":[{"$ref":"#/components/schemas/Amount"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All time portfolio earnings. Use of this field is discouraged, as it will be removed in a future release. Please use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/pockets/get-earnings-v2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Earnings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint instead."},"children":[]}]}]}]}},"type":"object","required":["securities","cash","all_time_earnings"],"title":"Portfolio"}},"components/schemas/partner_api__interface__models__portals__PortalUpdateRequest":{"id":"components/schemas/partner_api__interface__models__portals__PortalUpdateRequest","kind":"json-schema","title":"PortalUpdateRequest","data":{"properties":{"name":{"type":"string","maxLength":50,"title":"Name","description":"Portal name"}},"type":"object","required":["name"],"title":"PortalUpdateRequest"}},"components/schemas/partner_api__interface__models__v2__pockets__Portfolio":{"id":"components/schemas/partner_api__interface__models__v2__pockets__Portfolio","kind":"json-schema","title":"Portfolio","data":{"properties":{"securities":{"items":{"oneOf":[{"$ref":"#/components/schemas/FixedIncomeSecurity"},{"$ref":"#/components/schemas/OtherSecurity"}],"title":"Securities currently held by the brokerage account","discriminator":{"propertyName":"type","mapping":{"FIXED_INCOME":"#/components/schemas/FixedIncomeSecurity","OTHER":"#/components/schemas/OtherSecurity"}}},"type":"array","title":"Securities"},"cash":{"$ref":"#/components/schemas/Amount","description":"Cash currently held in the brokerage account."},"all_time_earnings":{"anyOf":[{"$ref":"#/components/schemas/Amount"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All time portfolio earnings. Use of this field is discouraged, as it will be removed in a future release. Please use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/partner-api/reference/pockets/get-earnings-v2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Earnings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint instead."},"children":[]}]}]}]},"total_value":{"$ref":"#/components/schemas/Amount","description":"Total value, in USD cents"},"fees":{"items":{"oneOf":[{"$ref":"#/components/schemas/AUMFee"}],"title":"Outstanding fees for the account","discriminator":{"propertyName":"type","mapping":{"AUM_FEE":"#/components/schemas/AUMFee"}}},"type":"array","title":"Fees","description":"Any outstanding fees"},"liquidation_value_t0":{"$ref":"#/components/schemas/Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available liquid amount at T+0"},"children":[]}]}]}]},"liquidation_value_t1":{"anyOf":[{"$ref":"#/components/schemas/Amount"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available liquid amount at T+1"},"children":[]}]}]}]},"pricing_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Pricing Timestamp","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was priced. Populated for pockets backed by accounts with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"real_time_yield"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute when at least one underlying CUSIP holding has real-time pricing; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise."},"children":[]}]}]}]},"appreciation_per_second":{"anyOf":[{"$ref":"#/components/schemas/Decimal"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate at which "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accrues per second, in USD cents. Combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing_timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", allows interpolating the displayed total value forward as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_value + appreciation_per_second × (now - pricing_timestamp)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Populated for pockets backed by accounts with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"real_time_yield"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute when at least one underlying CUSIP holding has real-time pricing; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise."},"children":[]}]}]}]}},"type":"object","required":["securities","cash","total_value","fees","liquidation_value_t0"],"title":"Portfolio"}},"components/schemas/partner_api__interface__models__v2__portals__PortalUpdateRequest":{"id":"components/schemas/partner_api__interface__models__v2__portals__PortalUpdateRequest","kind":"json-schema","title":"PortalUpdateRequest","data":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":50},{"type":"null"}],"title":"Name","description":"Portal name"},"status":{"anyOf":[{"type":"string","const":"CLOSED"},{"type":"null"}],"title":"Status","description":"Portal status"}},"type":"object","title":"PortalUpdateRequest"}},"schema_305":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Customer Id"},"id":"schema_305"},"schema_306":{"kind":"json-schema","data":{"type":"integer","minimum":0,"default":0,"title":"Offset"},"id":"schema_306"},"schema_307":{"kind":"json-schema","data":{"type":"integer","maximum":100,"minimum":1,"default":100,"title":"Limit"},"id":"schema_307"},"schema_308":{"kind":"json-schema","data":{"anyOf":[{"type":"array","uniqueItems":true,"items":{"enum":["ALL_TIME_EARNINGS"],"type":"string"}},{"type":"null"}],"title":"Omit[]"},"id":"schema_308"},"schema_309":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"X-Jiko-Idempotency"},"id":"schema_309"},"schema_310":{"kind":"json-schema","data":{"type":"string","title":"X-Jiko-Signature"},"id":"schema_310"},"schema_311":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Account Id"},"id":"schema_311"},"schema_312":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/CloseCustomerAccount"},{"$ref":"#/components/schemas/UpdateCustomerData"}],"title":"Request"},"id":"schema_312"},"schema_313":{"kind":"json-schema","data":{"enum":["ID_FRONT","ID_BACK","ID_BARCODE","SELFIE","IDENTIFICATION_NUMBER_VERIFICATION","ADDRESS_VERIFICATION","PASSPORT","EIN_CONFIRMATION","OPERATING_AGREEMENT","PARTNERSHIP_AGREEMENT","ARTICLES_OF_INCORPORATION","BYLAWS","PROOF_OF_501_STATUS","ARTICLES_OF_ASSOCIATION","CORPORATE_CHARTER","TRUST_FORMATION_RECORDS","LIST_OF_TRUSTEES","TRUST_VERIFICATION_DOCUMENT","LEGAL_ANALYSIS_OF_BUSINESS_MODEL","COINS_AND_TOKENS_LISTED_AND_OFFERED","COIN_RATING_POLICY_AND_PROCEDURES","TYPE_OF_BLOCKCHAIN_ANALYTICS_USED","MARKET_MANIPULATION_POLICY","BSA_AML_OFAC_POLICIES","INDEPENDENT_AML_AUDIT_REPORT","BSA_AML_OFAC_INTERNAL_RISK_ASSESSMENT","ARTICLES_OF_ORGANIZATION","FLOW_OF_FUNDS","BANK_STATEMENTS_1","BANK_STATEMENTS_2","BANK_STATEMENTS_3","ORG_CHART","BUSINESS_DESCRIPTION","CERTIFICATE_OF_GOOD_STANDING","CERTIFICATE_OF_TRADE_NAME","COMPANY_RESOLUTION","SIGNATURE_AUTHORIZATION","BANK_STATEMENT","BUSINESS_LICENSE","CERTIFICATE_OF_EXISTENCE","CERTIFICATE_OF_ASSUMED_NAME","COMPANY_REGISTRATION_DOCUMENT","INTERNAL_KYC_AUDIT","EXTERNAL_KYC_AUDIT","KYC_POLICIES_AND_PROCEDURES","WIRE_COUNTERPARTY_VERIFICATION","CUSTOMER_RFI_REPLY","OTHER"],"type":"string","title":"Document Type"},"id":"schema_313"},"schema_314":{"kind":"json-schema","data":{"type":"string","pattern":"image/png","title":"Content-Type"},"id":"schema_314"},"schema_315":{"kind":"json-schema","data":{"type":"integer","exclusiveMaximum":52428800,"exclusiveMinimum":0,"title":"Content-Length"},"id":"schema_315"},"schema_316":{"kind":"json-schema","data":{"enum":["desc","asc"],"type":"string","default":"desc","title":"Order"},"id":"schema_316"},"schema_317":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Account[]"},"id":"schema_317"},"schema_318":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Filter[Card]"},"id":"schema_318"},"schema_319":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Filter[Portal]"},"id":"schema_319"},"schema_320":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"enum":["CARD","CASH_BACK","ACH","WIRE","WIRE_FEE","GENERIC","ON_US"],"type":"string"}},{"type":"null"}],"title":"Filter[Types]"},"id":"schema_320"},"schema_321":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Filter[On Us Transfer]"},"id":"schema_321"},"schema_322":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Filter[Wire]"},"id":"schema_322"},"schema_323":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp From"},"id":"schema_323"},"schema_324":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp To"},"id":"schema_324"},"schema_325":{"kind":"json-schema","data":{"type":"string","default":"","title":"Cursor"},"id":"schema_325"},"schema_326":{"kind":"json-schema","data":{"type":"integer","exclusiveMinimum":0,"lte":100,"default":30,"title":"Limit"},"id":"schema_326"},"schema_327":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Transaction Id"},"id":"schema_327"},"schema_328":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Trade Datetime From"},"id":"schema_328"},"schema_329":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Trade Datetime To"},"id":"schema_329"},"schema_330":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Filters the resulting trade list by book date from the provided ISO8601 date, inclusively","title":"Book Date From"},"id":"schema_330"},"schema_331":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Filters the resulting trade list by book date to the provided ISO8601 date, inclusively","title":"Book Date To"},"id":"schema_331"},"schema_332":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Filters the resulting trade list by settlement date from the provided ISO8601 date, inclusively","title":"Settlement Date From"},"id":"schema_332"},"schema_333":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Filters the resulting trade list by settlement date to the provided ISO8601 date, inclusively","title":"Settlement Date To"},"id":"schema_333"},"schema_334":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Trade Id"},"id":"schema_334"},"schema_335":{"kind":"json-schema","data":{"type":"array","items":{"enum":["1099B","1099INT","BANK","BROKERAGE","CONSOLIDATED_BANK","CONSOLIDATED_BROKERAGE"],"type":"string"},"default":[],"title":"Type[]"},"id":"schema_335"},"schema_336":{"kind":"json-schema","data":{"anyOf":[{"type":"string","pattern":"^\\d{4}(-\\d{2})?$"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date formatted either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM"},"children":[]}]}]}],"title":"Key"},"id":"schema_336"},"schema_337":{"kind":"json-schema","data":{"type":"integer","exclusiveMinimum":0,"lte":150,"default":30,"title":"Limit"},"id":"schema_337"},"schema_338":{"kind":"json-schema","data":{"type":"integer","default":100,"title":"Limit"},"id":"schema_338"},"schema_339":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"},"id":"schema_339"},"schema_340":{"kind":"json-schema","data":{"anyOf":[{"type":"array","uniqueItems":true,"items":{"enum":["OPEN","LOCKED","CLOSED","NOT_ACTIVATED","FROZEN"],"type":"string"}},{"type":"null"}],"title":"Filter[Status]"},"id":"schema_340"},"schema_341":{"kind":"json-schema","data":{"anyOf":[{"enum":["VIRTUAL","PHYSICAL"],"type":"string"},{"type":"null"}],"title":"Type"},"id":"schema_341"},"schema_342":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created From"},"id":"schema_342"},"schema_343":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created To"},"id":"schema_343"},"schema_344":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Card Id"},"id":"schema_344"},"schema_345":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Card Order Id"},"id":"schema_345"},"schema_346":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Application Id"},"id":"schema_346"},"schema_347":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/RelatedPartyApplicationResponse"},"title":"Response List-Related-Party-Application"},"id":"schema_347"},"schema_348":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Related Party Application Id"},"id":"schema_348"},"schema_349":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"title":"Response List-Related-Party-Document-Requests-Businesses"},"id":"schema_349"},"schema_350":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"title":"Response List-Document-Requests-Businesses"},"id":"schema_350"},"schema_351":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Document Id"},"id":"schema_351"},"schema_352":{"kind":"json-schema","data":{"type":"string","title":"Content-Disposition"},"id":"schema_352"},"schema_353":{"kind":"json-schema","data":{"anyOf":[{"enum":["INDIVIDUAL","BUSINESS"],"type":"string"},{"type":"null"}],"description":"Selects the bundle published for this customer type. Omit it only when a single bundle applies to every customer type.","title":"Customer Type"},"id":"schema_353"},"schema_354":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Subscription Id"},"id":"schema_354"},"schema_355":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After"},"id":"schema_355"},"schema_356":{"kind":"json-schema","data":{"type":"string","const":"OK","title":"Response Get-Health-Check"},"id":"schema_356"},"schema_357":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Subscription Id"},"id":"schema_357"},"schema_358":{"kind":"json-schema","data":{"$defs":{"ApplicationUpdatePayload":{"properties":{"application_id":{"type":"string","format":"uuid","title":"Application Id"}},"type":"object","required":["application_id"],"title":"ApplicationUpdatePayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ApplicationUpdatePayload"},"event_type":{"type":"string","const":"application.approved","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"ApplicationApproved"},"id":"schema_358"},"schema_359":{"kind":"json-schema","data":{},"id":"schema_359"},"schema_360":{"kind":"json-schema","data":{"$defs":{"ApplicationUpdatePayload":{"properties":{"application_id":{"type":"string","format":"uuid","title":"Application Id"}},"type":"object","required":["application_id"],"title":"ApplicationUpdatePayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ApplicationUpdatePayload"},"event_type":{"type":"string","const":"application.manual_review","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"ApplicationManual_Review"},"id":"schema_360"},"schema_361":{"kind":"json-schema","data":{"$defs":{"ApplicationUpdatePayload":{"properties":{"application_id":{"type":"string","format":"uuid","title":"Application Id"}},"type":"object","required":["application_id"],"title":"ApplicationUpdatePayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ApplicationUpdatePayload"},"event_type":{"type":"string","const":"application.documents_needed","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"ApplicationDocuments_Needed"},"id":"schema_361"},"schema_362":{"kind":"json-schema","data":{"$defs":{"ApplicationUpdatePayload":{"properties":{"application_id":{"type":"string","format":"uuid","title":"Application Id"}},"type":"object","required":["application_id"],"title":"ApplicationUpdatePayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ApplicationUpdatePayload"},"event_type":{"type":"string","const":"application.rejected","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"ApplicationRejected"},"id":"schema_362"},"schema_363":{"kind":"json-schema","data":{"$defs":{"ACHIncomingPayload":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"}},"type":"object","required":["jiko_account_id"],"title":"ACHIncomingPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ACHIncomingPayload"},"event_type":{"type":"string","const":"transfers.ach.in.success","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TransfersAchInSuccess"},"id":"schema_363"},"schema_364":{"kind":"json-schema","data":{"$defs":{"ACHIncomingPayload":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"}},"type":"object","required":["jiko_account_id"],"title":"ACHIncomingPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ACHIncomingPayload"},"event_type":{"type":"string","const":"transfers.ach.in.rejected","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TransfersAchInRejected"},"id":"schema_364"},"schema_365":{"kind":"json-schema","data":{"$defs":{"ACHOutgoingPayload":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"ach_origination_id":{"type":"string","format":"uuid","title":"Ach Origination Id"}},"type":"object","required":["jiko_account_id","ach_origination_id"],"title":"ACHOutgoingPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ACHOutgoingPayload"},"event_type":{"type":"string","const":"transfers.ach.out.success","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TransfersAchOutSuccess"},"id":"schema_365"},"schema_366":{"kind":"json-schema","data":{"$defs":{"ACHOutgoingPayload":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"ach_origination_id":{"type":"string","format":"uuid","title":"Ach Origination Id"}},"type":"object","required":["jiko_account_id","ach_origination_id"],"title":"ACHOutgoingPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ACHOutgoingPayload"},"event_type":{"type":"string","const":"transfers.ach.out.rejected","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TransfersAchOutRejected"},"id":"schema_366"},"schema_367":{"kind":"json-schema","data":{"$defs":{"ACHOutgoingPayload":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"ach_origination_id":{"type":"string","format":"uuid","title":"Ach Origination Id"}},"type":"object","required":["jiko_account_id","ach_origination_id"],"title":"ACHOutgoingPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ACHOutgoingPayload"},"event_type":{"type":"string","const":"transfers.ach.out.sent","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TransfersAchOutSent"},"id":"schema_367"},"schema_368":{"kind":"json-schema","data":{"$defs":{"CardStatusUpdatePayload":{"properties":{"card_id":{"type":"string","format":"uuid","title":"Card Id"},"status":{"type":"string","enum":["OPEN","LOCKED","CLOSED","NOT_ACTIVATED","FROZEN"],"title":"Status"}},"type":"object","required":["card_id","status"],"title":"CardStatusUpdatePayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/CardStatusUpdatePayload"},"event_type":{"type":"string","const":"card.status.closed","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"CardStatusClosed","example":{"event_id":"18816918-fa50-4bb0-a9d9-4b5b6a0836e0","event_type":"card.status.closed","payload":{"card_id":"e9ff3b2b-2cf0-4e81-83d2-0031eccfb6e0","status":"CLOSED"},"timestamp":"2026-08-22T14:34:30.250816"}},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"$defs":{"CardStatusUpdatePayload":{"properties":{"card_id":{"type":"string","format":"uuid","title":"Card Id"},"status":{"type":"string","enum":["OPEN","LOCKED","CLOSED","NOT_ACTIVATED","FROZEN"],"title":"Status"}},"type":"object","required":["card_id","status"],"title":"CardStatusUpdatePayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/CardStatusUpdatePayload"},"event_type":{"type":"string","const":"card.status.open","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"CardStatusOpen","example":{"event_id":"e8d06cb7-6f9c-46e8-8fed-ed9c68a65ce0","event_type":"card.status.open","payload":{"card_id":"8f867de4-bc60-4ff3-80f2-1402e3b497ea","status":"OPEN"},"timestamp":"2026-08-22T14:34:30.252320"}},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"$defs":{"CardStatusUpdatePayload":{"properties":{"card_id":{"type":"string","format":"uuid","title":"Card Id"},"status":{"type":"string","enum":["OPEN","LOCKED","CLOSED","NOT_ACTIVATED","FROZEN"],"title":"Status"}},"type":"object","required":["card_id","status"],"title":"CardStatusUpdatePayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/CardStatusUpdatePayload"},"event_type":{"type":"string","const":"card.status.frozen","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"CardStatusFrozen","example":{"event_id":"3bfb9182-05f9-4ed0-af20-0ef82cb03f8c","event_type":"card.status.frozen","payload":{"card_id":"94040955-a1ba-4399-b8ab-42bac39fcf25","status":"FROZEN"},"timestamp":"2026-08-22T14:34:30.253814"}},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"$defs":{"CardStatusUpdatePayload":{"properties":{"card_id":{"type":"string","format":"uuid","title":"Card Id"},"status":{"type":"string","enum":["OPEN","LOCKED","CLOSED","NOT_ACTIVATED","FROZEN"],"title":"Status"}},"type":"object","required":["card_id","status"],"title":"CardStatusUpdatePayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/CardStatusUpdatePayload"},"event_type":{"type":"string","const":"card.status.locked","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"CardStatusLocked","example":{"event_id":"ca9785f9-29f0-43d2-9f54-b7e77bf13f6b","event_type":"card.status.locked","payload":{"card_id":"cd1f9950-bed4-4692-aca6-ac101b0904e1","status":"LOCKED"},"timestamp":"2026-08-22T14:34:30.255284"}},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"$defs":{"CardTransactionPayload":{"properties":{"card_id":{"type":"string","format":"uuid","title":"Card Id"},"amount":{"type":"integer","title":"Amount"},"account_id":{"type":"string","format":"uuid","title":"Account Id"}},"type":"object","required":["card_id","amount","account_id"],"title":"CardTransactionPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/CardTransactionPayload"},"event_type":{"type":"string","const":"card.transaction.approved","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"CardTransactionApproved"},"id":"schema_372"},"schema_373":{"kind":"json-schema","data":{"$defs":{"CardTransactionPayload":{"properties":{"card_id":{"type":"string","format":"uuid","title":"Card Id"},"amount":{"type":"integer","title":"Amount"},"account_id":{"type":"string","format":"uuid","title":"Account Id"}},"type":"object","required":["card_id","amount","account_id"],"title":"CardTransactionPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/CardTransactionPayload"},"event_type":{"type":"string","const":"card.transaction.on_hold","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"CardTransactionOn_Hold"},"id":"schema_373"},"schema_374":{"kind":"json-schema","data":{"$defs":{"CardTransactionPayload":{"properties":{"card_id":{"type":"string","format":"uuid","title":"Card Id"},"amount":{"type":"integer","title":"Amount"},"account_id":{"type":"string","format":"uuid","title":"Account Id"}},"type":"object","required":["card_id","amount","account_id"],"title":"CardTransactionPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/CardTransactionPayload"},"event_type":{"type":"string","const":"card.transaction.reversed","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"CardTransactionReversed"},"id":"schema_374"},"schema_375":{"kind":"json-schema","data":{"$defs":{"CardTransactionPayload":{"properties":{"card_id":{"type":"string","format":"uuid","title":"Card Id"},"amount":{"type":"integer","title":"Amount"},"account_id":{"type":"string","format":"uuid","title":"Account Id"}},"type":"object","required":["card_id","amount","account_id"],"title":"CardTransactionPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/CardTransactionPayload"},"event_type":{"type":"string","const":"card.transaction.rejected","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"CardTransactionRejected"},"id":"schema_375"},"schema_376":{"kind":"json-schema","data":{"$defs":{"WireOutgoingPayload":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"wire_id":{"type":"string","format":"uuid","title":"Wire Id"}},"type":"object","required":["jiko_account_id","wire_id"],"title":"WireOutgoingPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/WireOutgoingPayload"},"event_type":{"type":"string","const":"transfers.wire.out.success","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TransfersWireOutSuccess"},"id":"schema_376"},"schema_377":{"kind":"json-schema","data":{"$defs":{"WireOutgoingPayload":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"wire_id":{"type":"string","format":"uuid","title":"Wire Id"}},"type":"object","required":["jiko_account_id","wire_id"],"title":"WireOutgoingPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/WireOutgoingPayload"},"event_type":{"type":"string","const":"transfers.wire.out.processing","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TransfersWireOutProcessing"},"id":"schema_377"},"schema_378":{"kind":"json-schema","data":{"$defs":{"WireOutgoingPayload":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"wire_id":{"type":"string","format":"uuid","title":"Wire Id"}},"type":"object","required":["jiko_account_id","wire_id"],"title":"WireOutgoingPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/WireOutgoingPayload"},"event_type":{"type":"string","const":"transfers.wire.out.rejected","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TransfersWireOutRejected"},"id":"schema_378"},"schema_379":{"kind":"json-schema","data":{"$defs":{"WireIncomingPayload":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"wire_id":{"type":"string","format":"uuid","title":"Wire Id"}},"type":"object","required":["jiko_account_id","wire_id"],"title":"WireIncomingPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/WireIncomingPayload"},"event_type":{"type":"string","const":"transfers.wire.in.success","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TransfersWireInSuccess"},"id":"schema_379"},"schema_380":{"kind":"json-schema","data":{"$defs":{"WireIncomingPayload":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"wire_id":{"type":"string","format":"uuid","title":"Wire Id"}},"type":"object","required":["jiko_account_id","wire_id"],"title":"WireIncomingPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/WireIncomingPayload"},"event_type":{"type":"string","const":"transfers.wire.in.rejected","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TransfersWireInRejected"},"id":"schema_380"},"schema_381":{"kind":"json-schema","data":{"$defs":{"OnUsTransferPayload":{"properties":{"on_us_id":{"type":"string","format":"uuid","title":"On Us Id"},"origin_account_id":{"type":"string","format":"uuid","title":"Origin Account Id"},"destination_account_id":{"type":"string","format":"uuid","title":"Destination Account Id"}},"type":"object","required":["on_us_id","origin_account_id","destination_account_id"],"title":"OnUsTransferPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/OnUsTransferPayload"},"event_type":{"type":"string","const":"transfers.on-us.success","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TransfersOn-UsSuccess"},"id":"schema_381"},"schema_382":{"kind":"json-schema","data":{"$defs":{"OnUsTransferPayload":{"properties":{"on_us_id":{"type":"string","format":"uuid","title":"On Us Id"},"origin_account_id":{"type":"string","format":"uuid","title":"Origin Account Id"},"destination_account_id":{"type":"string","format":"uuid","title":"Destination Account Id"}},"type":"object","required":["on_us_id","origin_account_id","destination_account_id"],"title":"OnUsTransferPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/OnUsTransferPayload"},"event_type":{"type":"string","const":"transfers.on-us.processing","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TransfersOn-UsProcessing"},"id":"schema_382"},"schema_383":{"kind":"json-schema","data":{"$defs":{"OnUsTransferPayload":{"properties":{"on_us_id":{"type":"string","format":"uuid","title":"On Us Id"},"origin_account_id":{"type":"string","format":"uuid","title":"Origin Account Id"},"destination_account_id":{"type":"string","format":"uuid","title":"Destination Account Id"}},"type":"object","required":["on_us_id","origin_account_id","destination_account_id"],"title":"OnUsTransferPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/OnUsTransferPayload"},"event_type":{"type":"string","const":"transfers.on-us.rejected","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TransfersOn-UsRejected"},"id":"schema_383"},"schema_384":{"kind":"json-schema","data":{"$defs":{"OnUsTransferReceivedPayload":{"properties":{"on_us_id":{"type":"string","format":"uuid","title":"On Us Id"},"receiving_pocket_id":{"type":"string","format":"uuid","title":"Receiving Pocket Id"},"transaction_activity_id":{"type":"string","format":"uuid","title":"Transaction Activity Id"}},"type":"object","required":["on_us_id","receiving_pocket_id","transaction_activity_id"],"title":"OnUsTransferReceivedPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/OnUsTransferReceivedPayload"},"event_type":{"type":"string","const":"transfers.on-us.received","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TransfersOn-UsReceived"},"id":"schema_384"},"schema_385":{"kind":"json-schema","data":{"$defs":{"TradableMaturityPayload":{"properties":{"jiko_account_id":{"type":"string","format":"uuid","title":"Jiko Account Id"},"cusip":{"type":"string","title":"Cusip"},"cusip_maturity_date":{"type":"string","format":"date-time","title":"Cusip Maturity Date"},"trading_strategy":{"type":"string","title":"Trading Strategy"}},"type":"object","required":["jiko_account_id","cusip","cusip_maturity_date","trading_strategy"],"title":"TradableMaturityPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/TradableMaturityPayload"},"event_type":{"type":"string","const":"tradable.maturity","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"TradableMaturity"},"id":"schema_385"},"schema_386":{"kind":"json-schema","data":{"$defs":{"ReportStatusPayload":{"properties":{"report_id":{"type":"string","format":"uuid","title":"Report Id"},"root_report_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Root Report Id"}},"type":"object","required":["report_id","root_report_id"],"title":"ReportStatusPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ReportStatusPayload"},"event_type":{"type":"string","const":"report.status.available","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"ReportStatusAvailable"},"id":"schema_386"},"schema_387":{"kind":"json-schema","data":{"$defs":{"ReportStatusPayload":{"properties":{"report_id":{"type":"string","format":"uuid","title":"Report Id"},"root_report_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Root Report Id"}},"type":"object","required":["report_id","root_report_id"],"title":"ReportStatusPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ReportStatusPayload"},"event_type":{"type":"string","const":"report.status.pending","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"ReportStatusPending"},"id":"schema_387"},"schema_388":{"kind":"json-schema","data":{"$defs":{"ReportStatusPayload":{"properties":{"report_id":{"type":"string","format":"uuid","title":"Report Id"},"root_report_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Root Report Id"}},"type":"object","required":["report_id","root_report_id"],"title":"ReportStatusPayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/ReportStatusPayload"},"event_type":{"type":"string","const":"report.status.failed","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"ReportStatusFailed"},"id":"schema_388"},"schema_389":{"kind":"json-schema","data":{"$defs":{"CounterpartyStatusUpdatePayload":{"properties":{"counterparty_id":{"type":"string","format":"uuid","title":"Counterparty Id"},"customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Customer Id"}},"type":"object","required":["counterparty_id"],"title":"CounterpartyStatusUpdatePayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/CounterpartyStatusUpdatePayload"},"event_type":{"type":"string","const":"counterparty.status.linked","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"CounterpartyStatusLinked"},"id":"schema_389"},"schema_390":{"kind":"json-schema","data":{"$defs":{"CounterpartyStatusUpdatePayload":{"properties":{"counterparty_id":{"type":"string","format":"uuid","title":"Counterparty Id"},"customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Customer Id"}},"type":"object","required":["counterparty_id"],"title":"CounterpartyStatusUpdatePayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/CounterpartyStatusUpdatePayload"},"event_type":{"type":"string","const":"counterparty.status.unlinked","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"CounterpartyStatusUnlinked"},"id":"schema_390"},"schema_391":{"kind":"json-schema","data":{"$defs":{"CounterpartyStatusUpdatePayload":{"properties":{"counterparty_id":{"type":"string","format":"uuid","title":"Counterparty Id"},"customer_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Customer Id"}},"type":"object","required":["counterparty_id"],"title":"CounterpartyStatusUpdatePayload"}},"properties":{"event_id":{"type":"string","format":"uuid","title":"Event Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/CounterpartyStatusUpdatePayload"},"event_type":{"type":"string","const":"counterparty.status.failed","title":"Event Type"}},"type":"object","required":["event_id","timestamp","payload","event_type"],"title":"CounterpartyStatusFailed"},"id":"schema_391"},"schema_392":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Customer Id"},"id":"schema_392"},"schema_393":{"kind":"json-schema","data":{"type":"integer","maximum":30,"minimum":0,"default":30,"title":"Limit"},"id":"schema_393"},"schema_394":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"id":"schema_394"},"schema_395":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date From"},"id":"schema_395"},"schema_396":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date To"},"id":"schema_396"},"schema_397":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Report Request Id"},"id":"schema_397"},"schema_398":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Report Id"},"id":"schema_398"},"schema_399":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"enum":["PENDING","FAILED","REJECTED","PROCESSED","APPROVED","IN_TRANSIT","CANCELLED"],"type":"string"}},{"type":"null"}],"title":"Filter[Status]"},"id":"schema_399"},"schema_400":{"kind":"json-schema","data":{"anyOf":[{"enum":["DEBIT","CREDIT"],"type":"string"},{"type":"null"}],"title":"Direction"},"id":"schema_400"},"schema_401":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Transfer Id"},"id":"schema_401"},"schema_402":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"Cursor"},"id":"schema_402"},"schema_403":{"kind":"json-schema","data":{"anyOf":[{"type":"integer","exclusiveMinimum":0},{"type":"null"}],"lte":100,"default":30,"title":"Limit"},"id":"schema_403"},"schema_404":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Counterparty Id"},"id":"schema_404"},"schema_405":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Portal Id"},"id":"schema_405"},"schema_406":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Pocket Id"},"id":"schema_406"},"schema_407":{"kind":"json-schema","data":{"anyOf":[{"enum":["INCOMING","OUTGOING"],"type":"string"},{"type":"null"}],"title":"Direction"},"id":"schema_407"},"schema_408":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Wire Id"},"id":"schema_408"},"schema_409":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/IncomingWireResponse"},{"$ref":"#/components/schemas/OutgoingWireResponse"}],"discriminator":{"propertyName":"direction","mapping":{"INCOMING":"#/components/schemas/IncomingWireResponse","OUTGOING":"#/components/schemas/OutgoingWireResponse"}},"title":"Response Get-Wire-V1"},"id":"schema_409"},"schema_410":{"kind":"json-schema","data":{"anyOf":[{"type":"array","uniqueItems":true,"items":{"enum":["portfolio","all_time_earnings"],"type":"string"}},{"type":"null"}],"title":"Omit[]"},"id":"schema_410"},"schema_411":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ValuationType"},{"type":"null"}],"title":"Valuation Type"},"id":"schema_411"},"schema_412":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"enum":["PENDING","OPEN","FROZEN","CLOSED"],"type":"string"},"default":["PENDING","OPEN","FROZEN"],"title":"Filter[Status]"},"id":"schema_412"},"schema_413":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Pocket Id"},"id":"schema_413"},"schema_414":{"kind":"json-schema","data":{"enum":["ytd","mtd","wtd","all-time","range"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period to fetch earnings for. Can be one of"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ytd (Year-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mtd (Month-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wtd (Week-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all-time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"range"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When 'range' is chosen, you need to specify 'date_from' and 'date_to' (inclusive)."},"children":[]}]}]}],"default":"all-time","title":"Period"},"id":"schema_414"},"schema_415":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"},"id":"schema_415"},"schema_416":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"},"id":"schema_416"},"schema_417":{"kind":"json-schema","data":{"enum":["ytd","mtd","wtd","all-time"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The period to fetch earnings for. Can be one of"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ytd (Year-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mtd (Month-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wtd (Week-to-date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all-time"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom date ranges are not supported at the customer level; use the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single-pocket earnings endpoint with 'range' instead."},"children":[]}]}]}],"default":"all-time","title":"Period"},"id":"schema_417"},"schema_418":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":30},{"type":"null"}],"description":"Restricts the earnings to the given pockets. Defaults to all of the customer's pockets except closed ones; a closed pocket's earnings are included only when it is listed here explicitly.","title":"Pocket Id[]"},"id":"schema_418"},"schema_419":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"enum":["VIRTUAL_BANK_ACCOUNT_PORTAL","CRYPTO_DEPOSIT_ADDRESS_PORTAL"],"type":"string"}},{"type":"null"}],"title":"Type[]"},"id":"schema_419"},"schema_420":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"enum":["OPEN","CLOSED","PENDING","REJECTED"],"type":"string"}},{"type":"null"}],"title":"Status[]"},"id":"schema_420"},"schema_421":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/CreateVirtualBankAccountPortalRequest"},{"$ref":"#/components/schemas/CreateCryptoDepositAddressPortalRequest"}],"title":"Model"},"id":"schema_421"},"schema_422":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/VirtualBankAccountPortal"},{"$ref":"#/components/schemas/CryptoDepositAddressPortal"}],"discriminator":{"propertyName":"type","mapping":{"VIRTUAL_BANK_ACCOUNT_PORTAL":"#/components/schemas/VirtualBankAccountPortal","CRYPTO_DEPOSIT_ADDRESS_PORTAL":"#/components/schemas/CryptoDepositAddressPortal"}},"title":"Response Create Portal Api V2 Pockets  Pocket Id  Portals  Post"},"id":"schema_422"},"schema_423":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/VirtualBankAccountPortal"},{"$ref":"#/components/schemas/CryptoDepositAddressPortal"}],"discriminator":{"propertyName":"type","mapping":{"VIRTUAL_BANK_ACCOUNT_PORTAL":"#/components/schemas/VirtualBankAccountPortal","CRYPTO_DEPOSIT_ADDRESS_PORTAL":"#/components/schemas/CryptoDepositAddressPortal"}},"title":"Response Get-Pocket-Portal"},"id":"schema_423"},"schema_424":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/VirtualBankAccountPortal"},{"$ref":"#/components/schemas/CryptoDepositAddressPortal"}],"discriminator":{"propertyName":"type","mapping":{"VIRTUAL_BANK_ACCOUNT_PORTAL":"#/components/schemas/VirtualBankAccountPortal","CRYPTO_DEPOSIT_ADDRESS_PORTAL":"#/components/schemas/CryptoDepositAddressPortal"}},"title":"Response Update Portal Api V2 Pockets  Pocket Id  Portals  Portal Id   Patch"},"id":"schema_424"},"schema_425":{"kind":"json-schema","data":{"anyOf":[{"enum":["DEPOSIT","REINVESTMENT"],"type":"string"},{"type":"null"}],"title":"Applicable To"},"id":"schema_425"},"schema_426":{"kind":"json-schema","data":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount From"},"id":"schema_426"},"schema_427":{"kind":"json-schema","data":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount To"},"id":"schema_427"},"schema_428":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"enum":["ACH","WIRE","ON_US","CARD","FEE","CREDIT","GENERIC","ON_CHAIN"],"type":"string"}},{"type":"null"}],"title":"Filter[Type]"},"id":"schema_428"},"schema_429":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Booked From"},"id":"schema_429"},"schema_430":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Booked To"},"id":"schema_430"},"schema_431":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled From"},"id":"schema_431"},"schema_432":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Time Settled To"},"id":"schema_432"},"schema_433":{"kind":"json-schema","data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include Sweeps"},"id":"schema_433"},"schema_434":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Filter[Pocket]"},"id":"schema_434"},"schema_435":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Transaction Activity Id"},"id":"schema_435"},"schema_436":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ACHTransactionActivity"},{"$ref":"#/components/schemas/WireTransactionActivity"},{"$ref":"#/components/schemas/CardTransactionActivity"},{"$ref":"#/components/schemas/OnUsTransactionActivity"},{"$ref":"#/components/schemas/FeeTransactionActivity"},{"$ref":"#/components/schemas/CreditTransactionActivity"},{"$ref":"#/components/schemas/GenericTransactionActivity"},{"$ref":"#/components/schemas/OnChainTransactionActivity"}],"discriminator":{"propertyName":"type","mapping":{"ACH":"#/components/schemas/ACHTransactionActivity","WIRE":"#/components/schemas/WireTransactionActivity","CARD":"#/components/schemas/CardTransactionActivity","ON_US":"#/components/schemas/OnUsTransactionActivity","FEE":"#/components/schemas/FeeTransactionActivity","CREDIT":"#/components/schemas/CreditTransactionActivity","GENERIC":"#/components/schemas/GenericTransactionActivity","ON_CHAIN":"#/components/schemas/OnChainTransactionActivity"}},"title":"Response Get-Transaction-V2"},"id":"schema_436"},"schema_437":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Pocket Id[]"},"id":"schema_437"},"schema_438":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"anyOf":[{"const":"ach","type":"string"},{"const":"wire","type":"string"},{"const":"on_us","type":"string"},{"const":"international_wire","type":"string"},{"const":"crypto_wallet_address","type":"string"}]}},{"type":"null"}],"title":"Type"},"id":"schema_438"},"schema_439":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"enum":["PENDING","FAILED","LINKED","UNLINKED","CLOSED"],"type":"string"}},{"type":"null"}],"title":"Status"},"id":"schema_439"},"schema_440":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/CreateWireCounterpartyRequest"},{"$ref":"#/components/schemas/CreateACHCounterpartyRequest"},{"$ref":"#/components/schemas/CreateOnUsCounterpartyRequest"},{"$ref":"#/components/schemas/CreateInternationalWireCounterpartyRequest"},{"$ref":"#/components/schemas/CreateCryptoWalletAddressCounterpartyRequest"}],"title":"Request"},"id":"schema_440"},"schema_441":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ACHCounterpartyV2"},{"$ref":"#/components/schemas/WireCounterpartyV2"},{"$ref":"#/components/schemas/OnUsCounterpartyV2"},{"$ref":"#/components/schemas/InternationalWireCounterpartyV2"},{"$ref":"#/components/schemas/CryptoWalletAddressCounterpartyV2"}],"discriminator":{"propertyName":"type","mapping":{"ach":"#/components/schemas/ACHCounterpartyV2","wire":"#/components/schemas/WireCounterpartyV2","on_us":"#/components/schemas/OnUsCounterpartyV2","international_wire":"#/components/schemas/InternationalWireCounterpartyV2","crypto_wallet_address":"#/components/schemas/CryptoWalletAddressCounterpartyV2"}},"title":"Response Create Counterparty Api V2 Customers  Customer Id  Counterparties  Post"},"id":"schema_441"},"schema_442":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ACHCounterpartyV2"},{"$ref":"#/components/schemas/WireCounterpartyV2"},{"$ref":"#/components/schemas/OnUsCounterpartyV2"},{"$ref":"#/components/schemas/InternationalWireCounterpartyV2"},{"$ref":"#/components/schemas/CryptoWalletAddressCounterpartyV2"}],"discriminator":{"propertyName":"type","mapping":{"ach":"#/components/schemas/ACHCounterpartyV2","wire":"#/components/schemas/WireCounterpartyV2","on_us":"#/components/schemas/OnUsCounterpartyV2","international_wire":"#/components/schemas/InternationalWireCounterpartyV2","crypto_wallet_address":"#/components/schemas/CryptoWalletAddressCounterpartyV2"}},"title":"Response Get Counterparty Api V2 Customers  Customer Id  Counterparties  Counterparty Id   Get"},"id":"schema_442"},"schema_443":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ACHCounterpartyV2"},{"$ref":"#/components/schemas/WireCounterpartyV2"},{"$ref":"#/components/schemas/OnUsCounterpartyV2"},{"$ref":"#/components/schemas/InternationalWireCounterpartyV2"},{"$ref":"#/components/schemas/CryptoWalletAddressCounterpartyV2"}],"discriminator":{"propertyName":"type","mapping":{"ach":"#/components/schemas/ACHCounterpartyV2","wire":"#/components/schemas/WireCounterpartyV2","on_us":"#/components/schemas/OnUsCounterpartyV2","international_wire":"#/components/schemas/InternationalWireCounterpartyV2","crypto_wallet_address":"#/components/schemas/CryptoWalletAddressCounterpartyV2"}},"title":"Response Update Counterparty Api V2 Customers  Customer Id  Counterparties  Counterparty Id   Patch"},"id":"schema_443"}},"exampleStore":{"paths/~1api~1v1~1customers~1{customer_id}~1jiko-accounts~1/get/responses/200/content/application~1json/example":{"value":{"offset":0,"count":1,"items":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"J1 (4-week)","total_value":{"value":20708596,"currency":"USD","formatted":"$207,085.96"},"status":"OPEN","portfolio":{"securities":[{"tradable_id":"4b955c69-dd95-4f6a-a0ff-325ee029f240","security_type":"FIXED_INCOME","quantity":210000,"market_value":{"value":20708596,"currency":"USD","formatted":"$207,085.96"},"external_id":"912796RF6","maturity_date":"2023-01-30","yield_to_maturity":"0.0468","ask":"98.628528","bid":"98.612361","description":"US T-Bill"}],"cash":{"value":0,"currency":"USD","formatted":"$0.00"},"all_time_earnings":{"value":935404,"currency":"USD","formatted":"$9,354.04"}},"object_type":"Account"}],"object_type":"List"},"id":"paths/~1api~1v1~1customers~1{customer_id}~1jiko-accounts~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1/get/responses/200/content/application~1json/example":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"J1 (4-week)","total_value":{"value":20708596,"currency":"USD","formatted":"$207,085.96"},"status":"OPEN","portfolio":{"securities":[{"tradable_id":"4b955c69-dd95-4f6a-a0ff-325ee029f240","security_type":"FIXED_INCOME","quantity":210000,"market_value":{"value":20708596,"currency":"USD","formatted":"$207,085.96"},"external_id":"912796RF6","maturity_date":"2023-01-30","yield_to_maturity":"0.0468","ask":"98.628528","bid":"98.612361","description":"US T-Bill"}],"cash":{"value":0,"currency":"USD","formatted":"$0.00"},"all_time_earnings":{"value":935404,"currency":"USD","formatted":"$9,354.04"}},"object_type":"Account"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customers~1{customer_id}~1/get/responses/200/content/application~1json/example":{"value":{"address":{"street_address":"2000 Allston Way","city":"Berkeley","postal_code":"94701","state":"CA","country":"USA"},"email":"jiko@example.com","phone_number":"15551234567","account_status":"OPEN","type":"INDIVIDUAL","name":{"first_name":"Jiko","last_name":"Customer"},"date_of_birth":"1970-01-01","identification_number":{"identification_number":"*****1234","identification_type":"SSN"},"trusted_contact":{"first_name":"Jiko Customer","last_name":"Trusted Contact","email":"jiko-trusted-contact@example.com","phone_number":"+15551234500","address":"2000 Allston Way, Berkeley CA 94701 USA"}},"id":"paths/~1api~1v1~1customers~1{customer_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customers~1{customer_id}~1/patch/requestBody/content/application~1json/examples/update_customer_data":{"value":{"email":"jiko@example.com","phone_number":"15551234567","address":{"street_address":"2000 Allston Way","city":"Berkeley","postal_code":"94701","state":"CA","country":"US"},"trusted_contact":{"first_name":"Jiko Customer","last_name":"Trusted Contact","email":"jiko-trusted-contact@example.com","phone_number":"+15551234500","address":"2000 Allston Way, Berkeley CA 94701 USA"}},"key":"update_customer_data","summary":"Customer data update request","id":"paths/~1api~1v1~1customers~1{customer_id}~1/patch/requestBody/content/application~1json/examples/update_customer_data"},"paths/~1api~1v1~1customers~1{customer_id}~1/patch/requestBody/content/application~1json/examples/close_customer_account":{"value":{"status":"CLOSED","closure_reason":"PARTNER_INITIATED_CLOSURE","closure_description":"Customer was closed due to full withdrawal."},"key":"close_customer_account","summary":"Customer account closure request","description":"The customer must not have funded pockets. All open and empty pockets will be closed. If the customer is already closed, or has funded pockets, an error will be returned.","id":"paths/~1api~1v1~1customers~1{customer_id}~1/patch/requestBody/content/application~1json/examples/close_customer_account"},"paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/200/content/application~1json/examples/updated_customer":{"value":{"address":{"street_address":"2000 Allston Way","city":"Berkeley","postal_code":"94701","state":"CA","country":"USA"},"email":"jiko@example.com","phone_number":"15551234567","account_status":"OPEN","type":"INDIVIDUAL","name":{"first_name":"Jiko","last_name":"Customer"},"date_of_birth":"1970-01-01","identification_number":{"identification_number":"*****1234","identification_type":"SSN"},"trusted_contact":{"first_name":"Jiko Customer","last_name":"Trusted Contact","email":"jiko-trusted-contact@example.com","phone_number":"+15551234500","address":"2000 Allston Way, Berkeley CA 94701 USA"}},"key":"updated_customer","summary":"Updated customer response","id":"paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/200/content/application~1json/examples/updated_customer"},"paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/200/content/application~1json/examples/customer_closed":{"value":{"address":{"street_address":"2000 Allston Way","city":"Berkeley","postal_code":"94701","state":"CA","country":"USA"},"email":"jiko@example.com","phone_number":"15551234567","account_status":"CLOSED","type":"INDIVIDUAL","name":{"first_name":"Jiko","last_name":"Customer"},"date_of_birth":"1970-01-01","identification_number":{"identification_number":"*****1234","identification_type":"SSN"},"trusted_contact":{"first_name":"Jiko Customer","last_name":"Trusted Contact","email":"jiko-trusted-contact@example.com","phone_number":"+15551234500","address":"2000 Allston Way, Berkeley CA 94701 USA"}},"key":"customer_closed","summary":"Closed customer response","id":"paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/200/content/application~1json/examples/customer_closed"},"paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/409/content/application~1json/example":{"value":{"customer_already_closed":{"instance":"/api/v1/customers/7424db43-b3f0-48ab-b519-1e22b966edff/","trace_id":"8900cfb5-bd62-41de-a889-8e17220320cd","type":"jiko.errors.customers.CustomerAlreadyClosedError","detail":"The Customer has already been closed"}},"id":"paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/409/content/application~1json/example"},"paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/422/content/application~1json/example":{"value":{"customer_still_funded":{"instance":"/api/v1/customers/c20ed8a1-ce9b-4a07-8fc7-393ca224bd7e/","trace_id":"8421f93b-e30a-407d-99eb-f3e79a047853","type":"jiko.errors.customers.CustomerClosureError","detail":"The Customer cannot be closed because they have one or more open Pockets with funds in them."}},"id":"paths/~1api~1v1~1customers~1{customer_id}~1/patch/responses/422/content/application~1json/example"},"paths/~1api~1v1~1customers~1{customer_id}~1beneficial-owners~1/get/responses/200/content/application~1json/example":{"value":{"items":[{"id":"62a9f07e-2173-44ef-8262-34a0baef516c","name":{"first_name":"Benedict","last_name":"O'Naire"},"title":"CFO"}]},"id":"paths/~1api~1v1~1customers~1{customer_id}~1beneficial-owners~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customers~1{customer_id}~1transactions~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"timestamp":"2023-01-01T12:00:00Z","status":"COMPLETED","details":{"transaction_type":"CARD","title":"ATM ABCD ID: TERM99 at 26 HOUSTON TEXAS CIR, HOUSTON TX","transaction_type_title":"ATM Withdrawal","card_transaction":{"location":{"street_address":"26 HOUSTON TEXAS CIR","city":"HOUSTON","state":"TX","country":"US"},"counterparty":"ABCD","terminal_id":"TERM99","merchant_type":"ATM","pre_authorization":true}},"object_type":"Transaction"},{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"timestamp":"2023-01-01T12:00:00Z","status":"COMPLETED","details":{"transaction_type":"ACH","title":"From VENMO (PAYMENT)","sub_title":"IIN: 596425331 REF: 91000010211227","transaction_type_title":"ACH Electronic Debit","ach_transaction":{"company_name":"VENMO","company_entry_description":"PAYMENT","individual_identification_number":"596425331","trace_number":"091000010211227","ach_direction":"RECEIVING","portal_id":"cc093946-a894-415e-bb69-eff95f5ece78"}},"object_type":"Transaction"},{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"timestamp":"2023-01-01T12:00:00Z","status":"COMPLETED","details":{"transaction_type":"WIRE","title":"From External Account","sub_title":"9999XXXX","transaction_type_title":"Wire Transfer In","wire_transaction":{"reference_number":"9999XXXX","counterparty_name":"John Smith","wire_id":"4854014d-5540-4f0c-9efe-a0137f01e1da"}},"object_type":"Transaction"},{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"timestamp":"2023-01-01T12:00:00Z","status":"COMPLETED","details":{"transaction_type":"CASH_BACK","title":"2022-06 Card Cash Back","transaction_type_title":"Card Cash Back","cash_back_transaction":{"period":"2022-06","card_id":"66f6e46c-f6a1-4af8-a1bd-49666bc01301"}},"object_type":"Transaction"}],"object_type":"CursorList"},"id":"paths/~1api~1v1~1customers~1{customer_id}~1transactions~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"timestamp":"2023-01-01T12:00:00Z","status":"COMPLETED","details":{"transaction_type":"CARD","title":"ATM ABCD ID: TERM99 at 26 HOUSTON TEXAS CIR, HOUSTON TX","transaction_type_title":"ATM Withdrawal","card_transaction":{"location":{"street_address":"26 HOUSTON TEXAS CIR","city":"HOUSTON","state":"TX","country":"US"},"counterparty":"ABCD","terminal_id":"TERM99","merchant_type":"ATM","pre_authorization":true}},"object_type":"Transaction"},{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"timestamp":"2023-01-01T12:00:00Z","status":"COMPLETED","details":{"transaction_type":"ACH","title":"From VENMO (PAYMENT)","sub_title":"IIN: 596425331 REF: 91000010211227","transaction_type_title":"ACH Electronic Debit","ach_transaction":{"company_name":"VENMO","company_entry_description":"PAYMENT","individual_identification_number":"596425331","trace_number":"091000010211227","ach_direction":"RECEIVING","portal_id":"cc093946-a894-415e-bb69-eff95f5ece78"}},"object_type":"Transaction"},{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"timestamp":"2023-01-01T12:00:00Z","status":"COMPLETED","details":{"transaction_type":"WIRE","title":"From External Account","sub_title":"9999XXXX","transaction_type_title":"Wire Transfer In","wire_transaction":{"reference_number":"9999XXXX","counterparty_name":"John Smith","wire_id":"4854014d-5540-4f0c-9efe-a0137f01e1da"}},"object_type":"Transaction"},{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"timestamp":"2023-01-01T12:00:00Z","status":"COMPLETED","details":{"transaction_type":"CASH_BACK","title":"2022-06 Card Cash Back","transaction_type_title":"Card Cash Back","cash_back_transaction":{"period":"2022-06","card_id":"66f6e46c-f6a1-4af8-a1bd-49666bc01301"}},"object_type":"Transaction"}],"object_type":"CursorList"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1{transaction_id}~1/get/responses/200/content/application~1json/example":{"value":{"id":"05964326-49b7-4e74-9783-81137ee3cf3b","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"timestamp":"2023-01-01T12:00:00Z","status":"COMPLETED","details":{"transaction_type":"WIRE","title":"From External Account","sub_title":"9999XXXX","transaction_type_title":"Wire Transfer In","wire_transaction":{"reference_number":"9999XXXX","counterparty_name":"John Smith","wire_id":"4854014d-5540-4f0c-9efe-a0137f01e1da"}},"object_type":"Transaction"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1transactions~1{transaction_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customers~1{customer_id}~1trades~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","trade_datetime":"2023-01-01T12:00:00+00:00","settled_date":"2023-01-01","is_settled":true,"activity":"BUY","cusip":"912796RF6","description":"US T-Bill","notional":{"value":20935404,"currency":"USD","formatted":"$209,354.04"},"quantity":2123,"price":"98.612361","maturity_date":"2023-01-30","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","yield_to_maturity":"0.0468","tradable_id":"912797HF7","book_date":"2023-01-01","object_type":"Trade"}],"object_type":"CursorList"},"id":"paths/~1api~1v1~1customers~1{customer_id}~1trades~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1trades~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","trade_datetime":"2023-01-01T12:00:00+00:00","settled_date":"2023-01-01","is_settled":true,"activity":"BUY","cusip":"912796RF6","description":"US T-Bill","notional":{"value":20935404,"currency":"USD","formatted":"$209,354.04"},"quantity":2123,"price":"98.612361","maturity_date":"2023-01-30","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","yield_to_maturity":"0.0468","tradable_id":"912797HF7","book_date":"2023-01-01","object_type":"Trade"}],"object_type":"CursorList"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1trades~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customers~1{customer_id}~1statements~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","type":"BANK","key":"2023-01-01","pdf_download_url":"https://example.com/path-to-statement-pdf","time_created":"2023-01-15T14:00:00Z","csv_zip_download_url":"https://example.com/path-to-csv-download","object_type":"Statement"}],"object_type":"CursorList"},"id":"paths/~1api~1v1~1customers~1{customer_id}~1statements~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1statements~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","type":"BANK","key":"2023-01-01","pdf_download_url":"https://example.com/path-to-statement-pdf","time_created":"2023-01-15T14:00:00Z","csv_zip_download_url":"https://example.com/path-to-csv-download","object_type":"Statement"}],"object_type":"CursorList"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1statements~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1/get/responses/200/content/application~1json/example":{"value":{"offset":0,"count":1,"items":[{"card_id":"66f6e46c-f6a1-4af8-a1bd-49666bc01304","name":"Jiko Virtual Debit Card","status":"OPEN","type":"VIRTUAL","creation_time":"2024-06-19T14:00:00Z","jiko_account_id":"a1b2c3d4-5e6f-7890-abcd-ef1234567890"}],"object_type":"List"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1cards~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customers~1{customer_id}~1cards~1/get/responses/200/content/application~1json/example":{"value":{"offset":0,"count":1,"items":[{"card_id":"66f6e46c-f6a1-4af8-a1bd-49666bc01304","name":"Jiko Virtual Debit Card","status":"OPEN","type":"VIRTUAL","creation_time":"2024-06-19T14:00:00Z","jiko_account_id":"a1b2c3d4-5e6f-7890-abcd-ef1234567890"}],"object_type":"List"},"id":"paths/~1api~1v1~1customers~1{customer_id}~1cards~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"card_id":"66f6e46c-f6a1-4af8-a1bd-49666bc01304","card_order_id":"d66e74c4-66f9-4937-8518-1a94f39ba0f9","status":"INITIAL","object_type":"MinimalPhysicalCardOrderResponse"}],"object_type":"CursorList"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/post/responses/201/content/application~1json/example":{"value":{"card_id":"66f6e46c-f6a1-4af8-a1bd-49666bc01304","card_order_id":"d66e74c4-66f9-4937-8518-1a94f39ba0f9","status":"INITIAL","name_on_card":"Jiko Customer","shipping_address":{"street_address":"2000 Allston Way","city":"Berkeley","postal_code":"94701","state":"CA","country":"USA"},"object_type":"PhysicalCardOrderResponse"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1customers~1{customer_id}~1card-orders~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"card_id":"66f6e46c-f6a1-4af8-a1bd-49666bc01304","card_order_id":"d66e74c4-66f9-4937-8518-1a94f39ba0f9","status":"INITIAL","object_type":"MinimalPhysicalCardOrderResponse"}],"object_type":"CursorList"},"id":"paths/~1api~1v1~1customers~1{customer_id}~1card-orders~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1{card_order_id}~1/get/responses/200/content/application~1json/example":{"value":{"card_id":"66f6e46c-f6a1-4af8-a1bd-49666bc01304","card_order_id":"d66e74c4-66f9-4937-8518-1a94f39ba0f9","status":"INITIAL","name_on_card":"Jiko Customer","shipping_address":{"street_address":"2000 Allston Way","city":"Berkeley","postal_code":"94701","state":"CA","country":"USA"},"object_type":"PhysicalCardOrderResponse"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1card-orders~1{card_order_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1physical-cards~1{card_id}~1/post/responses/200/content/application~1json/example":{"value":{"card_id":"66f6e46c-f6a1-4af8-a1bd-49666bc01304","encrypted_pan":"LBHyVQggqNZvbYriaL8omZSFnQfS4yMFEO8hpVmgrtn70uYz56...","encrypted_cvv":"GLuGA7uI2iYrzE03XkKMH1IJZD6cxR+WJmgw9Z0VuervNqnkUq...","encrypted_expiration":"amAxcZuURFfOi38kbM1LXfa6gBmuaSCt10Kic8243kM1V+Llsb...","object_type":"PhysicalCardResponse"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1physical-cards~1{card_id}~1/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1{card_id}~1/post/responses/200/content/application~1json/example":{"value":{"card_id":"66f6e46c-f6a1-4af8-a1bd-49666bc01304","encrypted_pan":"LBHyVQggqNZvbYriaL8omZSFnQfS4yMFEO8hpVmgrtn70uYz56...","encrypted_cvv":"GLuGA7uI2iYrzE03XkKMH1IJZD6cxR+WJmgw9Z0VuervNqnkUq...","encrypted_expiration":"amAxcZuURFfOi38kbM1LXfa6gBmuaSCt10Kic8243kM1V+Llsb...","object_type":"VirtualCardResponse"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1{card_id}~1/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1/post/responses/201/content/application~1json/example":{"value":{"card_id":"66f6e46c-f6a1-4af8-a1bd-49666bc01304","encrypted_pan":"LBHyVQggqNZvbYriaL8omZSFnQfS4yMFEO8hpVmgrtn70uYz56...","encrypted_cvv":"GLuGA7uI2iYrzE03XkKMH1IJZD6cxR+WJmgw9Z0VuervNqnkUq...","encrypted_expiration":"amAxcZuURFfOi38kbM1LXfa6gBmuaSCt10Kic8243kM1V+Llsb...","object_type":"VirtualCardResponse"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1virtual-cards~1/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1business-applications~1/post/responses/201/content/application~1json/example":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time_created":"2023-01-01T12:00:00Z","updated_at":"2023-01-01T12:00:00Z","status":"CREATED","exception_reasons":[],"name":"Jiko Group, Inc.","entity_type":"CORPORATE","doing_business_as":"Jiko","identification_number":{"identification_number":"987654321","issuing_country":"US","type":"EIN"},"address":{"street_address":"101 Mission Street","street_address2":"7th Floor","city":"San Francisco","postal_code":"94105","state":"CA","country":"US"},"website":"https://www.jiko.com","contact":{"name":{"first_name":"Jiko","middle_name":"","last_name":"Contact"},"phone_number":"+15551234567","email":"contact@jiko.com"},"formation_date":"2017-01-04","risk_info":{"risk_categories":[],"has_current_enforcement_actions":false,"business_activity_location":"PRIMARILY_US","source_of_funds":"INTERNAL_FUNDS","account_usage":"MONEY_STORAGE","annual_revenue":"PRE_REVENUE","monthly_transactions":"5_OR_LESS","first_month_deposit":"1M_OR_LESS"},"industry":{"industry":"ACCOUNTING_AND_BOOKKEEPING"},"agreement_consent":{"version":"1","timestamp":"2023-01-01T12:00:00Z"}},"id":"paths/~1api~1v1~1business-applications~1/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1business-applications~1{application_id}~1/get/responses/200/content/application~1json/example":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time_created":"2023-01-01T12:00:00Z","updated_at":"2023-01-01T12:00:00Z","status":"APPROVED","exception_reasons":[],"customer_id":"160c0c4b-9966-4dc1-a916-8407eb10d74e","name":"Jiko Group, Inc.","entity_type":"CORPORATE","doing_business_as":"Jiko","identification_number":{"identification_number":"987654321","issuing_country":"US","type":"EIN"},"address":{"street_address":"101 Mission Street","street_address2":"7th Floor","city":"San Francisco","postal_code":"94105","state":"CA","country":"US"},"website":"https://www.jiko.com","contact":{"name":{"first_name":"Jiko","middle_name":"","last_name":"Contact"},"phone_number":"+15551234567","email":"contact@jiko.com"},"formation_date":"2017-01-04","risk_info":{"risk_categories":[],"has_current_enforcement_actions":false,"business_activity_location":"PRIMARILY_US","source_of_funds":"INTERNAL_FUNDS","account_usage":"MONEY_STORAGE","annual_revenue":"PRE_REVENUE","monthly_transactions":"5_OR_LESS","first_month_deposit":"1M_OR_LESS"},"industry":{"industry":"ACCOUNTING_AND_BOOKKEEPING"},"agreement_consent":{"version":"1","timestamp":"2023-01-01T12:00:00Z"}},"id":"paths/~1api~1v1~1business-applications~1{application_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1business-applications~1{application_id}~1/patch/responses/200/content/application~1json/example":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time_created":"2023-01-01T12:00:00Z","updated_at":"2023-01-01T12:00:00Z","status":"SUBMITTED","exception_reasons":[],"name":"Jiko Group, Inc.","entity_type":"CORPORATE","doing_business_as":"Jiko","identification_number":{"identification_number":"987654321","issuing_country":"US","type":"EIN"},"address":{"street_address":"101 Mission Street","street_address2":"7th Floor","city":"San Francisco","postal_code":"94105","state":"CA","country":"US"},"website":"https://www.jiko.com","contact":{"name":{"first_name":"Jiko","middle_name":"","last_name":"Contact"},"phone_number":"+15551234567","email":"contact@jiko.com"},"formation_date":"2017-01-04","risk_info":{"risk_categories":[],"has_current_enforcement_actions":false,"business_activity_location":"PRIMARILY_US","source_of_funds":"INTERNAL_FUNDS","account_usage":"MONEY_STORAGE","annual_revenue":"PRE_REVENUE","monthly_transactions":"5_OR_LESS","first_month_deposit":"1M_OR_LESS"},"industry":{"industry":"ACCOUNTING_AND_BOOKKEEPING"},"agreement_consent":{"version":"1","timestamp":"2023-01-01T12:00:00Z"}},"id":"paths/~1api~1v1~1business-applications~1{application_id}~1/patch/responses/200/content/application~1json/example"},"paths/~1api~1v1~1business-applications~1{application_id}~1apply~1/post/responses/200/content/application~1json/example":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time_created":"2023-01-01T12:00:00Z","updated_at":"2023-01-01T12:00:00Z","status":"SUBMITTED","exception_reasons":[],"name":"Jiko Group, Inc.","entity_type":"CORPORATE","doing_business_as":"Jiko","identification_number":{"identification_number":"987654321","issuing_country":"US","type":"EIN"},"address":{"street_address":"101 Mission Street","street_address2":"7th Floor","city":"San Francisco","postal_code":"94105","state":"CA","country":"US"},"website":"https://www.jiko.com","contact":{"name":{"first_name":"Jiko","middle_name":"","last_name":"Contact"},"phone_number":"+15551234567","email":"contact@jiko.com"},"formation_date":"2017-01-04","risk_info":{"risk_categories":[],"has_current_enforcement_actions":false,"business_activity_location":"PRIMARILY_US","source_of_funds":"INTERNAL_FUNDS","account_usage":"MONEY_STORAGE","annual_revenue":"PRE_REVENUE","monthly_transactions":"5_OR_LESS","first_month_deposit":"1M_OR_LESS"},"industry":{"industry":"ACCOUNTING_AND_BOOKKEEPING"},"agreement_consent":{"version":"1","timestamp":"2023-01-01T12:00:00Z"}},"id":"paths/~1api~1v1~1business-applications~1{application_id}~1apply~1/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/post/responses/201/content/application~1json/example":{"value":{"name":{"first_name":"Related","middle_name":"","last_name":"Party"},"address":{"street_address":"101 Mission Street","street_address2":"7th Floor","city":"San Francisco","postal_code":"94105","state":"CA","country":"US"},"date_of_birth":"1970-01-01","identification_number":{"identification_number":"987654321","issuing_country":"US","identification_type":"SSN"},"phone_number":"+15551234567","title":"CEO","roles":["CONTROL_PERSON"],"ownership_percentage":"0.51","citizenship":"US","email":"relatedparty@jiko.com","id":"497f6eca-6276-4993-bfeb-53cbbbba6f08"},"id":"paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/get/responses/200/content/application~1json/example":{"value":[{"name":{"first_name":"Related","middle_name":"","last_name":"Party"},"address":{"street_address":"101 Mission Street","street_address2":"7th Floor","city":"San Francisco","postal_code":"94105","state":"CA","country":"US"},"date_of_birth":"1970-01-01","identification_number":{"identification_number":"987654321","issuing_country":"US","identification_type":"SSN"},"phone_number":"+15551234567","title":"CEO","roles":["CONTROL_PERSON"],"ownership_percentage":"0.51","citizenship":"US","email":"relatedparty@jiko.com","id":"497f6eca-6276-4993-bfeb-53cbbbba6f08"}],"id":"paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/patch/responses/200/content/application~1json/example":{"value":{"name":{"first_name":"Related","middle_name":"","last_name":"Party"},"address":{"street_address":"101 Mission Street","street_address2":"7th Floor","city":"San Francisco","postal_code":"94105","state":"CA","country":"US"},"date_of_birth":"1970-01-01","identification_number":{"identification_number":"987654321","issuing_country":"US","identification_type":"SSN"},"phone_number":"+15551234567","title":"CEO","roles":["CONTROL_PERSON"],"ownership_percentage":"0.51","citizenship":"US","email":"relatedparty@jiko.com","id":"497f6eca-6276-4993-bfeb-53cbbbba6f08"},"id":"paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/patch/responses/200/content/application~1json/example"},"paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/get/responses/200/content/application~1json/example":{"value":[{"id":"61c23eb1-002a-4459-aa9a-624428281e14","type":"OPERATING_AGREEMENT","status":"PENDING_UPLOAD","exception_reason":"","name":""},{"id":"96e70040-eb4e-48d1-98af-0c793a6ee137","type":"ARTICLES_OF_INCORPORATION","status":"INVALID","exception_reason":"IMAGE_QUALITY_ERROR_CUTOFF","name":"articles_of_incorporation.png"}],"id":"paths/~1api~1v1~1business-applications~1{application_id}~1related-party-applications~1{related_party_application_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1business-applications~1{application_id}~1documents~1/get/responses/200/content/application~1json/example":{"value":[{"id":"61c23eb1-002a-4459-aa9a-624428281e14","type":"OPERATING_AGREEMENT","status":"PENDING_UPLOAD","exception_reason":"","name":""},{"id":"96e70040-eb4e-48d1-98af-0c793a6ee137","type":"ARTICLES_OF_INCORPORATION","status":"INVALID","exception_reason":"IMAGE_QUALITY_ERROR_CUTOFF","name":"articles_of_incorporation.png"}],"id":"paths/~1api~1v1~1business-applications~1{application_id}~1documents~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1documents~1{document_id}~1/post/responses/200/content/application~1json/example":{"value":{"id":"96e70040-eb4e-48d1-98af-0c793a6ee137","type":"ARTICLES_OF_INCORPORATION","status":"APPROVED","exception_reason":"","name":"articles_of_incorporation.png"},"id":"paths/~1api~1v1~1documents~1{document_id}~1/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1applications~1/post/responses/201/content/application~1json/example":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time_created":"2023-01-01T12:00:00Z","updated_at":"2023-01-01T13:00:00Z","status":"CREATED","exception_reasons":[],"phone_number":"+14155550100","agreement_consent":{"version":"1","timestamp":"2023-01-01T12:00:00Z"},"email":"jiko@example.com","name":{"first_name":"Jiko","last_name":"Customer"},"date_of_birth":{"date_of_birth":"1970-01-01"},"investment_profile":{"income":"BETWEEN_100K_AND_250K","net_worth":"BETWEEN_1M_AND_5M","occupation":"Investor","employment_status":"EMPLOYED"},"documents":[],"id_verification_documents_needed":false,"identification_number_verification_document_needed":false,"address_verification_document_needed":false,"address":{"street_address":"2000 Allston Way","city":"Berkeley","postal_code":"94701","state":"CA","country":"US"},"citizenship_country":"US","identification_number_issuing_country":"US","object_type":"InternationalApplication"},"id":"paths/~1api~1v1~1applications~1/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1applications~1{application_id}~1/get/responses/200/content/application~1json/example":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time_created":"2023-01-01T12:00:00Z","updated_at":"2023-01-01T13:00:00Z","status":"CREATED","exception_reasons":[],"phone_number":"+14155550100","agreement_consent":{"version":"1","timestamp":"2023-01-01T12:00:00Z"},"email":"jiko@example.com","name":{"first_name":"Jiko","last_name":"Customer"},"date_of_birth":{"date_of_birth":"1970-01-01"},"investment_profile":{"income":"BETWEEN_100K_AND_250K","net_worth":"BETWEEN_1M_AND_5M","occupation":"Investor","employment_status":"EMPLOYED"},"documents":[],"id_verification_documents_needed":false,"identification_number_verification_document_needed":false,"address_verification_document_needed":false,"address":{"street_address":"2000 Allston Way","city":"Berkeley","postal_code":"94701","state":"CA","country":"US"},"citizenship_country":"US","identification_number_issuing_country":"US","object_type":"InternationalApplication"},"id":"paths/~1api~1v1~1applications~1{application_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1applications~1{application_id}~1apply~1/post/responses/200/content/application~1json/example":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time_created":"2023-01-01T12:00:00Z","updated_at":"2023-01-01T13:00:00Z","status":"DOCUMENTS_NEEDED","exception_reasons":[],"phone_number":"+14155550100","agreement_consent":{"version":"1","timestamp":"2023-01-01T12:00:00Z"},"email":"jiko@example.com","name":{"first_name":"Jiko","last_name":"Customer"},"date_of_birth":{"date_of_birth":"1970-01-01"},"investment_profile":{"income":"BETWEEN_100K_AND_250K","net_worth":"BETWEEN_1M_AND_5M","occupation":"Investor","employment_status":"EMPLOYED"},"customer_id":"160c0c4b-9966-4dc1-a916-8407eb10d74e","documents":[{"id":"dcd70de2-9f18-4918-bd96-c3972c85dc4e","type":"ID_FRONT","status":"PENDING_UPLOAD"},{"id":"62cd7ac9-d882-43f5-ac19-ad85c0c5c533","type":"ID_BACK","status":"PENDING_UPLOAD"},{"id":"1bd78e61-c86f-45b8-8848-34a51c863166","type":"PASSPORT","status":"PENDING_UPLOAD"},{"id":"0ceee47c-946e-4a6d-8951-96e1f630a59c","type":"SELFIE","status":"PENDING_UPLOAD"}],"id_verification_documents_needed":true,"identification_number_verification_document_needed":false,"address_verification_document_needed":false,"address":{"street_address":"2000 Allston Way","city":"Berkeley","postal_code":"94701","state":"CA","country":"US"},"citizenship_country":"US","identification_number_issuing_country":"US","object_type":"InternationalApplication"},"id":"paths/~1api~1v1~1applications~1{application_id}~1apply~1/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1agreements~1/get/responses/200/content/application~1json/example":{"value":{"version":"1.0.0","release_date":"2023-01-01","documents":[{"pdf_download_url":"https://example.com/path-to-agreement-pdf","title":"Jiko Privacy Policy","type":"PRIVACY_POLICY","category":"GENERAL"}]},"id":"paths/~1api~1v1~1agreements~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1events~1types~1/get/responses/200/content/application~1json/example":{"value":{"offset":0,"count":14,"items":[{"event":"application.approved","object_type":"EventType"},{"event":"application.documents_needed","object_type":"EventType"},{"event":"application.manual_review","object_type":"EventType"},{"event":"application.rejected","object_type":"EventType"},{"event":"card.status.closed","object_type":"EventType"},{"event":"card.status.frozen","object_type":"EventType"},{"event":"card.status.locked","object_type":"EventType"},{"event":"card.status.open","object_type":"EventType"},{"event":"card.transaction.approved","object_type":"EventType"},{"event":"card.transaction.rejected","object_type":"EventType"},{"event":"transfers.ach.in.success","object_type":"EventType"},{"event":"transfers.ach.in.rejected","object_type":"EventType"},{"event":"transfers.ach.out.success","object_type":"EventType"},{"event":"transfers.ach.out.rejected","object_type":"EventType"}],"object_type":"List"},"id":"paths/~1api~1v1~1events~1types~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1events~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"event":{"event_id":"a7a26ff2-e851-45b6-9634-d595f45458b7","timestamp":"2023-01-01T14:00:00Z","payload":{"application_id":"48ac72d0-a829-4896-a067-dcb1c2b0f30c"},"event_type":"application.approved"},"delivery_attempts":[{"delivery_attempt_id":"5326238f-7f19-4e5f-b374-402eed7b1c7b","subscription_id":"aa11a4c2-a467-43db-b413-c4ab0f5cf627","success":true,"response_code":200,"response_message":"OK","called_at":"2023-01-01T14:00:00Z"}],"object_type":"PartnerEvent"}],"object_type":"CursorList"},"id":"paths/~1api~1v1~1events~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1login~1/post/responses/200/content/application~1json/examples/0":{"key":"0","summary":"0","id":"paths/~1api~1v1~1login~1/post/responses/200/content/application~1json/examples/0"},"paths/~1api~1v1~1public-keys~1/get/responses/200/content/application~1json/example":{"value":{"set_pin":"-----BEGIN PUBLIC KEY-----\r\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAzmZv8spzSU9z+/bhFzX0\r\ns4xVXE9ZOApQUMoM3Q1VDiJujyWJ61uoTsWT1uQlIXHdUQ3NcXw0WYDUEaM8fj1b\r\nB2k1zSXmRD4VmxAIRNVfs3Cp3GKqC/WjyvDw25+SYBFwiaYJblpyZPiunXvXRyK8\r\nvdDaPliwTN5p7pjHQvcfXOl20ZtWnZTGMulJ+smNCYKWckW1hEOMjJP8FLMJpSHa\r\n6yGOpAYAxoHxodiJCI4X6fG206gBtyFps1CyxCz8WDjALqJYfeArTFv7/2AyuVCF\r\n5zLE7tzPrJeVxfqa+CI+7mWFhEKZLAd/PEzEL7P2VZr9BRd0lyxBipEEG/DGMEvY\r\n1dcx+3J56ZxVURAqeXPGkqVfz/IdisQt/okp6vSVKQdImeyzpJvwvBc7T7tKyRZR\r\nvtL8XLYzZBujqWCezMxU97TAb7BlQ2nPJCQFMZD7y1KldgWuGnjXha1TFIYvfrYW\r\noDFK221Z6LYlKWeRFGXhoNOX1Qm/CX3wi9Tfo01LTxbCY2Y1mbv6e8Xt12MzhicD\r\nZsFvVrtRaVrjmqXXDq8X2r7puPTLOQf7Dow3944XnTZQURE4oPIwCfTBmfMow+TB\r\n+ZUYWRXwg0/hl9AOBSGLVNlaGZD8sAu98knish5LJv34lx5mIiLLpGpIt+mzZikU\r\nFt9siIkltvk49qcmTuI8GJUCAwEAAQ==\r\n-----END PUBLIC KEY-----"},"id":"paths/~1api~1v1~1public-keys~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1subscriptions~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"description":"Jiko API Webhook Subscriptions","events":["application.approved","application.documents_needed","application.manual_review","application.rejected","card.status.closed","card.status.frozen","card.status.locked","card.status.open","card.transaction.approved","card.transaction.rejected","transfers.ach.in.success","transfers.ach.in.rejected","transfers.ach.out.success","transfers.ach.out.rejected"],"url":"https://example.com/webhooks","id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time_created":"2023-01-01T14:00:00Z","updated_at":"2023-01-01T14:00:00Z","status":"enabled","object_type":"Subscription"}],"object_type":"CursorList"},"id":"paths/~1api~1v1~1subscriptions~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1subscriptions~1/post/responses/201/content/application~1json/example":{"value":{"description":"Incoming ACH Success Webhook","events":["transfers.ach.in.success"],"url":"https://example.com/webhooks/ach-incoming-success","retry_policy":{"retry_on_status_codes":[502,503,500],"backoff_coefficient":2.1,"maximum_attempts":3,"initial_interval_seconds":3,"maximum_interval_seconds":20},"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time_created":"2023-01-01T14:00:00Z","updated_at":"2023-01-01T14:00:00Z","status":"enabled","object_type":"Subscription"},"id":"paths/~1api~1v1~1subscriptions~1/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1subscriptions~1{subscription_id}~1/get/responses/200/content/application~1json/example":{"value":{"description":"Incoming ACH Success Webhook","events":["transfers.ach.in.success"],"url":"https://example.com/webhooks/ach-incoming-success","retry_policy":{"retry_on_status_codes":[502,503,500],"backoff_coefficient":2.1,"maximum_attempts":3,"initial_interval_seconds":3,"maximum_interval_seconds":20},"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time_created":"2023-01-01T14:00:00Z","updated_at":"2023-01-01T14:00:00Z","status":"enabled","object_type":"Subscription"},"id":"paths/~1api~1v1~1subscriptions~1{subscription_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1subscriptions~1{subscription_id}~1/patch/responses/200/content/application~1json/example":{"value":{"description":"Incoming ACH Success Webhook","events":["transfers.ach.in.success"],"url":"https://example.com/webhooks/ach-incoming-success-new","id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","time_created":"2023-01-01T14:00:00Z","updated_at":"2023-01-01T16:00:00Z","status":"enabled","object_type":"Subscription"},"id":"paths/~1api~1v1~1subscriptions~1{subscription_id}~1/patch/responses/200/content/application~1json/example"},"paths/~1api~1v1~1report-requests~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"BANK_STATEMENT_REPORT","metadata":{"date":"2023-02-06"},"created_at":"2023-01-01T12:00:00Z","reports":[{"id":"8a7ec6c0-2701-40a1-8954-68870964b50d","file_name":"bank_statement_report.xml","mime_type":"application/xml","status":"AVAILABLE","type":"BANK_STATEMENT_REPORT_CAMT053","metadata":{"date":"2023-02-06"},"created_at":"2023-01-01T12:00:00Z"},{"id":"cc093946-a894-415e-bb69-eff95f5ece78","file_name":"bank_statement_report.pdf","mime_type":"application/pdf","status":"AVAILABLE","type":"BANK_STATEMENT_REPORT_PDF","metadata":{"date":"2023-02-06"},"created_at":"2023-01-01T12:00:00Z"}]}],"object_type":"CursorList"},"id":"paths/~1api~1v1~1report-requests~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1report-requests~1{report_request_id}~1/get/responses/200/content/application~1json/example":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"BANK_STATEMENT_REPORT","metadata":{"date":"2023-02-06"},"created_at":"2023-01-01T12:00:00Z","reports":[{"id":"8a7ec6c0-2701-40a1-8954-68870964b50d","file_name":"campt053.xml","mime_type":"application/xml","status":"AVAILABLE","type":"BANK_STATEMENT_REPORT_CAMT053","metadata":{"date":"2023-02-06"},"created_at":"2023-01-01T12:00:00Z"},{"id":"cc093946-a894-415e-bb69-eff95f5ece78","file_name":"campt053.pdf","mime_type":"application/pdf","status":"AVAILABLE","type":"BANK_STATEMENT_REPORT_PDF","metadata":{"date":"2023-02-06"},"created_at":"2023-01-01T12:00:00Z"}]},"id":"paths/~1api~1v1~1report-requests~1{report_request_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1reports~1{report_id}~1/get/responses/200/content/application~1json/example":{"value":{"id":"8a7ec6c0-2701-40a1-8954-68870964b50d","file_name":"campt053.xml","mime_type":"application/xml","status":"AVAILABLE","type":"BANK_STATEMENT_REPORT_CAMT053","metadata":{"date":"2023-02-06"},"created_at":"2023-01-01T12:00:00Z"},"id":"paths/~1api~1v1~1reports~1{report_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1reports~1{report_id}~1download~1/post/responses/200/content/application~1json/example":{"value":{"download_url":"reportUrl.jiko.com","expires":"2023-01-01T12:00:00Z"},"id":"paths/~1api~1v1~1reports~1{report_id}~1download~1/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"counterparty_id":"fd38dae9-b300-4017-a630-101c42791afd","direction":"DEBIT","sec_code":"WEB","payment_related_information":["Transferring funds to Jiko from an external account"],"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","status":"PROCESSED","time_created":"2023-01-01T14:00:00Z","company_entry_description":"TXN INFO","object_type":"ACHResponse"}],"object_type":"CursorList"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/post/responses/200/content/application~1json/example":{"value":{"counterparty_id":"fd38dae9-b300-4017-a630-101c42791afd","direction":"CREDIT","sec_code":"WEB","payment_related_information":["Transferring funds from Jiko to an external account"],"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","status":"PROCESSED","time_created":"2023-01-01T14:00:00Z","company_entry_description":"ACH TXN","object_type":"ACHResponse"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1{transfer_id}~1/get/responses/200/content/application~1json/example":{"value":{"counterparty_id":"fd38dae9-b300-4017-a630-101c42791afd","direction":"CREDIT","sec_code":"WEB","payment_related_information":["Transferring funds from Jiko to an external account"],"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","status":"PROCESSED","time_created":"2023-01-01T14:00:00Z","company_entry_description":"ACH TXN","object_type":"ACHResponse"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1ach-originating~1{transfer_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customers~1{customer_id}~1ach-originating~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"counterparty_id":"fd38dae9-b300-4017-a630-101c42791afd","direction":"DEBIT","sec_code":"WEB","payment_related_information":["Transferring funds to Jiko from an external account"],"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","status":"PROCESSED","time_created":"2023-01-01T14:00:00Z","company_entry_description":"TXN INFO","object_type":"ACHResponse"}],"object_type":"CursorList"},"id":"paths/~1api~1v1~1customers~1{customer_id}~1ach-originating~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"ACH","ach":{"time_created":"2023-01-15T14:00:00Z","verification_type":"MICRO_DEPOSITS","status":"IN_PROGRESS","account_number":"123456789","routing_number":"9876456","name_on_account":"External Accountholder","account_type":"SAVINGS","institution_name":"External Bank NA","plaid":{"mask":"0000","verification_status":"PENDING_AUTOMATIC_VERIFICATION","object_type":"CounterpartyPlaid"}},"wire":{"time_created":"2023-01-15T14:00:00Z","verification_type":"INCOMING_WIRE","status":"IN_PROGRESS","account_number":"1213456789","routing_number":"9876456","name_on_account":"External Accountholder","account_type":"SAVINGS","institution_name":"External Bank NA"},"object_type":"Counterparty"}],"object_type":"CursorList"},"id":"paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/responses/200/content/application~1json/example":{"value":{"id":"b5a776db-8960-4157-afe5-519b6708bb79","type":"WIRE","wire":{"time_created":"2023-01-15T14:00:00Z","verification_type":"INCOMING_WIRE","status":"IN_PROGRESS","account_number":"1213456789","routing_number":"9876456","name_on_account":"External Accountholder","account_type":"SAVINGS","institution_name":"External Bank NA"},"object_type":"Counterparty"},"id":"paths/~1api~1v1~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1transfers~1on-us~1/post/responses/201/content/application~1json/example":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","status":"PENDING","transfer":{"transfer_id":"d4a2d8dd-7def-4545-a062-761683b9aa05","description":"Disbursing funds from partner to customer","from_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"to_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"type":"PARTNER_CUSTOMER_FUNDING","source":"123456789","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"}},"fees":[{"type":"AUM_FEE","amount":{"value":10,"currency":"USD","formatted":"$0.10"}}],"object_type":"OnUsTransfer"},"id":"paths/~1api~1v1~1transfers~1on-us~1/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1transfers~1on-us~1quotes~1/post/responses/200/content/application~1json/example":{"value":{"is_allowed":true,"settlement_type":"T+1","eligible_transfer_amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"object_type":"OnUsTransferQuote"},"id":"paths/~1api~1v1~1transfers~1on-us~1quotes~1/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1transfers~1on-us~1{transfer_id}~1/get/responses/200/content/application~1json/example":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","status":"PENDING","transfer":{"transfer_id":"d4a2d8dd-7def-4545-a062-761683b9aa05","description":"Disbursing funds from partner to customer","from_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"to_account":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","type":"JIKO_ACCOUNT"},"type":"PARTNER_CUSTOMER_FUNDING","source":"123456789","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"}},"fees":[{"type":"AUM_FEE","amount":{"value":10,"currency":"USD","formatted":"$0.10"}}],"object_type":"OnUsTransfer"},"id":"paths/~1api~1v1~1transfers~1on-us~1{transfer_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/get/responses/200/content/application~1json/example":{"value":{"count":1,"portals":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","routing_number":"123456789","account_number":"987654321","status":"OPEN","name":"Payroll","payment_rails":["WIRE"],"object_type":"Portal"}],"object_type":"List"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/post/responses/201/content/application~1json/example":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","routing_number":"123456789","account_number":"987654321","status":"OPEN","name":"Payroll","payment_rails":["WIRE"],"object_type":"Portal"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/get/responses/200/content/application~1json/example":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","routing_number":"123456789","account_number":"987654321","status":"OPEN","name":"Payroll","payment_rails":["WIRE"],"object_type":"Portal"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/patch/responses/200/content/application~1json/example":{"value":{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","routing_number":"123456789","account_number":"987654321","status":"OPEN","name":"Payroll","payment_rails":["WIRE"],"object_type":"Portal"},"id":"paths/~1api~1v1~1jiko-accounts~1{account_id}~1portals~1{portal_id}~1/patch/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customers~1{customer_id}~1portals~1/get/responses/200/content/application~1json/example":{"value":{"count":1,"portals":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","jiko_account_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","routing_number":"123456789","account_number":"987654321","status":"OPEN","name":"Payroll","payment_rails":["WIRE"],"object_type":"Portal"}],"object_type":"List"},"id":"paths/~1api~1v1~1customers~1{customer_id}~1portals~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/responses/201/content/application~1json/example":{"value":{"id":"d0e1dd1b-3e21-4cd4-9872-f71ea4967ffd","pocket_name":"4-week T-bills","portfolio":{"securities":[],"cash":{"value":0,"currency":"USD","formatted":"$0.00"},"all_time_earnings":{"value":0,"currency":"USD","formatted":"$0.00"},"total_value":{"value":0,"currency":"USD","formatted":"$0.00"},"fees":[],"liquidation_value_t0":{"value":0,"currency":"USD","formatted":"$0.00"},"liquidation_value_t1":{"value":0,"currency":"USD","formatted":"$0.00"}},"status":"PENDING","attributes":[],"deposit_strategy_id":"UST-4W","reinvestment_strategy_id":"UST-4W","object_type":"Pocket"},"id":"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/responses/201/content/application~1json/example"},"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/responses/422/content/application~1json/examples/pocket_limit":{"value":{"instance":"/api/v2/customers/{customer_id}/pockets/","trace_id":"febbcfca-c6f1-456d-9f54-289736b292f2","detail":"Unable to create pocket. Pocket limit reached.","type":"jiko.errors.pockets.PocketCreationError"},"key":"pocket_limit","summary":"Pocket limit reached","id":"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/post/responses/422/content/application~1json/examples/pocket_limit"},"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/get/responses/200/content/application~1json/example":{"value":{"offset":0,"count":1,"items":[{"id":"d0e1dd1b-3e21-4cd4-9872-f71ea4967ffd","pocket_name":"4-week T-bills","portfolio":{"securities":[{"quantity":210000,"market_value":{"value":20708596,"currency":"USD","formatted":"$207,085.96"},"cusip":"912797GA9","jiko_mark_price":"98.612361","description":"US T-Bill","type":"FIXED_INCOME","maturity_date":"2023-01-30","yield_to_maturity":"0.0468"},{"quantity":400,"market_value":{"value":3944494,"currency":"USD","formatted":"$39,444.94"},"cusip":"912796RF6","jiko_mark_price":"98.612361","description":"US T-Bill","type":"FIXED_INCOME","maturity_date":"2023-02-06","yield_to_maturity":"0.0468"}],"cash":{"value":0,"currency":"USD","formatted":"$0.00"},"all_time_earnings":{"value":935404,"currency":"USD","formatted":"$9,354.04"},"total_value":{"value":24653090,"currency":"USD","formatted":"$246,530.90"},"fees":[],"liquidation_value_t0":{"value":24653090,"currency":"USD","formatted":"$246,530.90"},"liquidation_value_t1":{"value":24653090,"currency":"USD","formatted":"$246,530.90"}},"status":"OPEN","attributes":[],"deposit_strategy_id":"UST-4W","reinvestment_strategy_id":"UST-26W","object_type":"Pocket"}],"object_type":"List"},"id":"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1pockets~1/get/responses/200/content/application~1json/example":{"value":{"next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"id":"d0e1dd1b-3e21-4cd4-9872-f71ea4967ffd","pocket_name":"4-week T-bills","portfolio":{"securities":[{"quantity":210000,"market_value":{"value":20708596,"currency":"USD","formatted":"$207,085.96"},"cusip":"912797GA9","jiko_mark_price":"98.612361","description":"US T-Bill","type":"FIXED_INCOME","maturity_date":"2023-01-30","yield_to_maturity":"0.0468"},{"quantity":400,"market_value":{"value":3944494,"currency":"USD","formatted":"$39,444.94"},"cusip":"912796RF6","jiko_mark_price":"98.612361","description":"US T-Bill","type":"FIXED_INCOME","maturity_date":"2023-02-06","yield_to_maturity":"0.0468"}],"cash":{"value":0,"currency":"USD","formatted":"$0.00"},"all_time_earnings":{"value":935404,"currency":"USD","formatted":"$9,354.04"},"total_value":{"value":24653090,"currency":"USD","formatted":"$246,530.90"},"fees":[{"amount":{"value":101,"currency":"USD","formatted":"$1.01"},"type":"AUM_FEE"}],"liquidation_value_t0":{"value":21876487,"currency":"USD","formatted":"$218,764.87"},"liquidation_value_t1":{"value":24653090,"currency":"USD","formatted":"$246,530.90"}},"status":"OPEN","attributes":[],"deposit_strategy_id":"UST-4W","reinvestment_strategy_id":"UST-26W","customer_id":"e0e2dd1a-2eee-4cd4-9872-e71eaf967afa","object_type":"CustomerPocket"}],"object_type":"CursorList"},"id":"paths/~1api~1v2~1pockets~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/get/responses/200/content/application~1json/example":{"value":{"id":"d0e1dd1b-3e21-4cd4-9872-f71ea4967ffd","pocket_name":"4-week T-bills","portfolio":{"securities":[{"quantity":210000,"market_value":{"value":20708596,"currency":"USD","formatted":"$207,085.96"},"cusip":"912796RF6","jiko_mark_price":"98.612361","description":"US T-Bill","type":"FIXED_INCOME","maturity_date":"2023-01-30","yield_to_maturity":"0.0468"}],"cash":{"value":0,"currency":"USD","formatted":"$0.00"},"all_time_earnings":{"value":935404,"currency":"USD","formatted":"$9,354.04"},"total_value":{"value":20708596,"currency":"USD","formatted":"$207,085.96"},"fees":[],"liquidation_value_t0":{"value":20708596,"currency":"USD","formatted":"$207,085.96"},"liquidation_value_t1":{"value":20708596,"currency":"USD","formatted":"$207,085.96"}},"status":"OPEN","attributes":[],"deposit_strategy_id":"UST-4W","reinvestment_strategy_id":"UST-26W","customer_id":"62c5272e-ef8c-4d8a-a49d-633432409fd4","object_type":"CustomerPocket"},"id":"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/requestBody/content/application~1json/examples/pocket_name":{"value":{"pocket_name":"Savings"},"key":"pocket_name","summary":"Updating a pocket name","id":"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/requestBody/content/application~1json/examples/pocket_name"},"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/requestBody/content/application~1json/examples/close":{"value":{"status":"CLOSED","closure_reason":"PARTNER_INSTIGATED"},"key":"close","summary":"Closing a pocket","description":"When closing a pocket, you need to specify a closure reason","id":"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/requestBody/content/application~1json/examples/close"},"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/200/content/application~1json/example":{"value":{"id":"d0e1dd1b-3e21-4cd4-9872-f71ea4967ffd","pocket_name":"4-week T-bills","status":"OPEN","attributes":[],"deposit_strategy_id":"UST-4W","reinvestment_strategy_id":"UST-26W","customer_id":"62c5272e-ef8c-4d8a-a49d-633432409fd4","object_type":"CustomerPocket"},"id":"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/200/content/application~1json/example"},"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/422/content/application~1json/examples/invalid_transition":{"value":{"instance":"/api/v2/customers/00000000-0000-0000-0000-000000000000/pockets/00000000-0000-0000-0000-000000000001/","trace_id":"cbde0417-a05f-4bcb-8010-b82c9e54483c","detail":"Only pockets that are currently open can be closed.","type":"jiko.errors.pockets.PocketCannotBeClosedError"},"key":"invalid_transition","summary":"Invalid transition when closing a pocket","id":"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/422/content/application~1json/examples/invalid_transition"},"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/422/content/application~1json/examples/pocket_has_balance":{"value":{"instance":"/api/v2/customers/00000000-0000-0000-0000-000000000000/pockets/00000000-0000-0000-0000-000000000001/","trace_id":"712adf0c-7f8a-4afd-8bd5-e8c86279681c","detail":"The pocket cannot be closed because it is not empty.","type":"jiko.errors.pockets.PocketNotEmptyError"},"key":"pocket_has_balance","summary":"Pocket not empty when closing","id":"paths/~1api~1v2~1customers~1{customer_id}~1pockets~1{pocket_id}~1/patch/responses/422/content/application~1json/examples/pocket_has_balance"},"paths/~1api~1v2~1pockets~1{pocket_id}~1/get/responses/200/content/application~1json/example":{"value":{"id":"d0e1dd1b-3e21-4cd4-9872-f71ea4967ffd","pocket_name":"4-week T-bills","portfolio":{"securities":[{"quantity":210000,"market_value":{"value":20708596,"currency":"USD","formatted":"$207,085.96"},"cusip":"912796RF6","jiko_mark_price":"98.612361","description":"US T-Bill","type":"FIXED_INCOME","maturity_date":"2023-01-30","yield_to_maturity":"0.0468"}],"cash":{"value":0,"currency":"USD","formatted":"$0.00"},"all_time_earnings":{"value":935404,"currency":"USD","formatted":"$9,354.04"},"total_value":{"value":20708596,"currency":"USD","formatted":"$207,085.96"},"fees":[],"liquidation_value_t0":{"value":20708596,"currency":"USD","formatted":"$207,085.96"},"liquidation_value_t1":{"value":20708596,"currency":"USD","formatted":"$207,085.96"}},"status":"OPEN","attributes":[],"deposit_strategy_id":"UST-4W","reinvestment_strategy_id":"UST-26W","customer_id":"62c5272e-ef8c-4d8a-a49d-633432409fd4","object_type":"CustomerPocket"},"id":"paths/~1api~1v2~1pockets~1{pocket_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1pockets~1{pocket_id}~1earnings~1/get/responses/200/content/application~1json/example":{"value":{"earnings":{"value":13000,"currency":"USD","formatted":"$130.00"},"date_from":"2025-04-01","date_to":"2025-05-01"},"id":"paths/~1api~1v2~1pockets~1{pocket_id}~1earnings~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/get/responses/200/content/application~1json/example":{"value":{"items":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","pocket_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","time_created":"2023-01-01T12:00:00Z","name":"Payroll","status":"OPEN","type":"VIRTUAL_BANK_ACCOUNT_PORTAL","routing_number":"123456789","account_number":"987654321","payment_rails":["WIRE"]}],"object_type":"CursorList"},"id":"paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/post/responses/201/content/application~1json/example":{"value":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","pocket_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","time_created":"2023-01-01T12:00:00Z","name":"Payroll","status":"OPEN","type":"VIRTUAL_BANK_ACCOUNT_PORTAL","routing_number":"123456789","account_number":"987654321","payment_rails":["WIRE"]}],"id":"paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1/post/responses/201/content/application~1json/example"},"paths/~1api~1v2~1customers~1{customer_id}~1portals~1/get/responses/200/content/application~1json/example":{"value":{"items":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","pocket_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","time_created":"2023-01-01T12:00:00Z","name":"Payroll","status":"OPEN","type":"VIRTUAL_BANK_ACCOUNT_PORTAL","routing_number":"123456789","account_number":"987654321","payment_rails":["WIRE"]}],"object_type":"CursorList"},"id":"paths/~1api~1v2~1customers~1{customer_id}~1portals~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/get/responses/200/content/application~1json/example":{"value":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","pocket_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","time_created":"2023-01-01T12:00:00Z","name":"Payroll","status":"OPEN","type":"VIRTUAL_BANK_ACCOUNT_PORTAL","routing_number":"123456789","account_number":"987654321","payment_rails":["WIRE"]}],"id":"paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/patch/responses/200/content/application~1json/example":{"value":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","pocket_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","time_created":"2023-01-01T12:00:00Z","name":"Payroll","status":"OPEN","type":"VIRTUAL_BANK_ACCOUNT_PORTAL","routing_number":"123456789","account_number":"987654321","payment_rails":["WIRE"]}],"id":"paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1/patch/responses/200/content/application~1json/example"},"paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1funding-instructions~1/get/responses/200/content/application~1json/example":{"value":{"items":[{"type":"ACH","routing_number":"091271660","account_number":"9876543210","account_type":"CHECKING"},{"type":"DOMESTIC_WIRE","receiver_bank":{"routing_number":"091271660","name":"Mid-Central National Bank-Jiko","address":"520 S. Jefferson Street, Wadena, MN 56482"},"beneficiary":{"account_number":"9876543210","name":"Jane Doe","address":"123 Main St, Anytown, US 12345"}},{"type":"INTERNATIONAL_WIRE","receiver_bank":{"routing_number":"091001322","swift":"UBBKUS44","name":"United Bankers' Bank","address":"1650 W 82nd St, #1500, Bloomington, MN 55431"},"beneficiary":{"account_number":"2508117","name":"Jane Doe","address":"123 Main St, Anytown, US 12345"},"remittance_info":{"purpose":"9876543210 - Jane Doe"}},{"type":"ON_US","account_number":"9876543210","legal_name":"Jane Doe"}]},"id":"paths/~1api~1v2~1pockets~1{pocket_id}~1portals~1{portal_id}~1funding-instructions~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1trading-strategies~1/get/responses/200/content/application~1json/example":{"value":{"offset":0,"count":5,"items":[{"id":"UST-4W","description":"US T-bills, 4-week, Buy-and-hold","yield_to_maturity":"0.0625","discount_yield":"0.0472","applicable_to":["DEPOSIT","REINVESTMENT"]},{"id":"UST-13W","description":"US T-bills, 13-week, Buy-and-hold","yield_to_maturity":"0.0598","discount_yield":"0.0484","applicable_to":["DEPOSIT","REINVESTMENT"]},{"id":"UST-26W","description":"US T-bills, 26-week, Buy-and-hold","yield_to_maturity":"0.0456","discount_yield":"0.0388","applicable_to":["DEPOSIT","REINVESTMENT"]},{"id":"UST-52W","description":"US T-bills, 52-week, Buy-and-hold","yield_to_maturity":"0.0523","discount_yield":"0.0411","applicable_to":["DEPOSIT","REINVESTMENT"]}],"object_type":"List","last_updated":"2026-08-22T14:34:30.979439Z"},"id":"paths/~1api~1v2~1trading-strategies~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1pockets~1{pocket_id}~1transactions~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"id":"05964326-49b7-4e74-9783-81137ee3cf3b","transaction_id":"4b955c69-dd95-4f6a-a0ff-325ee029f240","description":"Wire Transfer In","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"time_booked":"2023-01-01T12:00:00Z","time_settled":"2023-01-02T12:00:00Z","status":"SETTLED","title":"From External Account","direction":"DEBIT","pocket_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","customer_id":"66f6e46c-f6a1-4af8-a1bd-49666bc01301","type":"WIRE","reference_number":"9999XXXX","counterparty_name":"John Smith","wire_id":"4854014d-5540-4f0c-9efe-a0137f01e1da"}],"object_type":"CursorList"},"id":"paths/~1api~1v2~1pockets~1{pocket_id}~1transactions~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1customers~1{customer_id}~1transactions~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"id":"05964326-49b7-4e74-9783-81137ee3cf3b","transaction_id":"4b955c69-dd95-4f6a-a0ff-325ee029f240","description":"Wire Transfer In","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"time_booked":"2023-01-01T12:00:00Z","time_settled":"2023-01-02T12:00:00Z","status":"SETTLED","title":"From External Account","direction":"DEBIT","pocket_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","customer_id":"66f6e46c-f6a1-4af8-a1bd-49666bc01301","type":"WIRE","reference_number":"9999XXXX","counterparty_name":"John Smith","wire_id":"4854014d-5540-4f0c-9efe-a0137f01e1da"}],"object_type":"CursorList"},"id":"paths/~1api~1v2~1customers~1{customer_id}~1transactions~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1transactions~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"id":"05964326-49b7-4e74-9783-81137ee3cf3b","transaction_id":"4b955c69-dd95-4f6a-a0ff-325ee029f240","description":"Wire Transfer In","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"time_booked":"2023-01-01T12:00:00Z","time_settled":"2023-01-02T12:00:00Z","status":"SETTLED","title":"From External Account","direction":"DEBIT","pocket_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","customer_id":"66f6e46c-f6a1-4af8-a1bd-49666bc01301","type":"WIRE","reference_number":"9999XXXX","counterparty_name":"John Smith","wire_id":"4854014d-5540-4f0c-9efe-a0137f01e1da"}],"object_type":"CursorList"},"id":"paths/~1api~1v2~1transactions~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1transactions~1{transaction_activity_id}~1/get/responses/200/content/application~1json/example":{"value":{"id":"05964326-49b7-4e74-9783-81137ee3cf3b","transaction_id":"4b955c69-dd95-4f6a-a0ff-325ee029f240","description":"Wire Transfer In","amount":{"value":100000,"currency":"USD","formatted":"$1,000.00"},"time_booked":"2023-01-01T12:00:00Z","time_settled":"2023-01-02T12:00:00Z","status":"SETTLED","title":"From External Account","direction":"DEBIT","pocket_id":"8a7ec6c0-2701-40a1-8954-68870964b50d","customer_id":"66f6e46c-f6a1-4af8-a1bd-49666bc01301","type":"WIRE","reference_number":"9999XXXX","counterparty_name":"John Smith","wire_id":"4854014d-5540-4f0c-9efe-a0137f01e1da"},"id":"paths/~1api~1v2~1transactions~1{transaction_activity_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/get/responses/200/content/application~1json/example":{"value":{"prev_page":"cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==","next_page":"cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw","items":[{"id":"838db493-7ed3-4a46-877d-7b466b9deb3a","time_created":"2023-05-12T19:05:01.323248Z","status":"LINKED","verification":{"id":"779b5eb8-9b6a-4027-b253-3c374440143e","description":"Verified by customer support","type":"pre_verified","status":"APPROVED"},"type":"ach","counterparty_name":"External Accountholder","institution_name":"External Bank NA","routing_number":"123456789","account_number":"9876543","account_type":"CHECKING","object_type":"ACHCounterpartyV2"},{"id":"86bc2eb3-9b85-4f82-b8fa-91f8d0eea1ff","time_created":"2023-05-11T19:05:01.323339Z","status":"LINKED","verification":{"id":"6a620795-dc32-46b8-9464-d692d71b3075","description":"Incoming wire","type":"incoming_wire","wire_id":"e5449f18-2383-4772-8fec-9d90a8cb2542","status":"APPROVED"},"type":"wire","counterparty_name":{"first_name":"External","last_name":"Accountholder","type":"individual"},"address":{"street_address":"2000 Allston Way","street_address2":"","city":"Berkeley","postal_code":"94701","state":"CA","country":"US"},"institution_name":"External Bank NA","routing_number":"987654321","identifier":"1234567890","identifier_code":"DIRECT_DEPOSIT_ACCOUNT","object_type":"WireCounterpartyV2"},{"id":"838db493-7ed3-4a46-877d-7b466b9deb3a","time_created":"2023-05-12T19:05:01.323248Z","status":"LINKED","verification":{"id":"779b5eb8-9b6a-4027-b253-3c374440143e","description":"Verified by customer support","type":"pre_verified","status":"APPROVED"},"type":"on_us","counterparty_name":"Some Company","account_number":"9876543","object_type":"OnUsCounterpartyV2"}],"object_type":"CursorList"},"id":"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req":{"value":{"routing_number":"987654321","identifier":"1234567890","address":{"street_address":"2000 Allston Way","street_address2":"","city":"Berkeley","postal_code":"94701","state":"CA","country":"US"},"wire_instructions":"Example wire instructions","counterparty_name":{"first_name":"External","last_name":"Accountholder","type":"individual"},"verification":{"type":"incoming_wire","wire_id":"e5449f18-2383-4772-8fec-9d90a8cb2542"},"type":"wire"},"key":"dwc_req","summary":"Domestic wire counterparty request","id":"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/dwc_req"},"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz":{"value":[{"wire_instructions":"Example wire instructions","counterparty_name":{"business_name":"Deutsche Bank AG","type":"business"},"address":{"street_address":"Taunusanlage 12","street_address2":"","city":"Frankfurt am Main","postal_code":"60325","state":"","country":"DE"},"identifier":"DE89370400440532013000","identifier_type":"iban","swift_bic":"DEUTDEFF","verification":{"type":"unverified"},"type":"international_wire"}],"key":"iwc_req_iban_biz","summary":"Business international wire counterparty request with IBAN","id":"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz"},"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_ind":{"value":[{"wire_instructions":"Example wire instructions","counterparty_name":{"first_name":"Hans","last_name":"Mueller","type":"individual"},"address":{"street_address":"Unter den Linden 5","street_address2":"","city":"Berlin","postal_code":"10117","state":"","country":"DE"},"identifier":"DE89370400440532013000","identifier_type":"iban","swift_bic":"DEUTDEFF","verification":{"type":"unverified"},"type":"international_wire"}],"key":"iwc_req_iban_ind","summary":"Individual international wire counterparty request with IBAN","id":"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_ind"},"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_biz":{"value":[{"wire_instructions":"Example wire instructions","counterparty_name":{"business_name":"Deutsche Bank AG","type":"business"},"address":{"street_address":"Taunusanlage 12","street_address2":"","city":"Frankfurt am Main","postal_code":"60325","state":"","country":"DE"},"identifier":"1234567890","identifier_type":"local","swift_bic":"DEUTDEFF","verification":{"type":"unverified"},"type":"international_wire"}],"key":"iwc_req_local_biz","summary":"Business international wire counterparty request with Local Account Number","id":"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_biz"},"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_ind":{"value":[{"wire_instructions":"Example wire instructions","counterparty_name":{"first_name":"Hans","last_name":"Mueller","type":"individual"},"address":{"street_address":"Unter den Linden 5","street_address2":"","city":"Berlin","postal_code":"10117","state":"","country":"DE"},"identifier":"1234567890","identifier_type":"local","swift_bic":"DEUTDEFF","verification":{"type":"unverified"},"type":"international_wire"}],"key":"iwc_req_local_ind","summary":"Individual international wire counterparty request with Local Account Number","id":"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_local_ind"},"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz_supporting_documents":{"value":[{"wire_instructions":"Example wire instructions","counterparty_name":{"business_name":"Deutsche Bank AG","type":"business"},"address":{"street_address":"Taunusanlage 12","street_address2":"","city":"Frankfurt am Main","postal_code":"60325","state":"","country":"DE"},"identifier":"DE89370400440532013000","identifier_type":"iban","swift_bic":"DEUTDEFF","verification":{"type":"supporting_documents","document_ids":["497f6eca-6276-4993-bfeb-53cbbbba6f08"]},"type":"international_wire"}],"key":"iwc_req_iban_biz_supporting_documents","summary":"Business international wire counterparty request with IBAN and supporting documents","id":"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/requestBody/content/application~1json/examples/iwc_req_iban_biz_supporting_documents"},"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/wire":{"value":[{"id":"86bc2eb3-9b85-4f82-b8fa-91f8d0eea1ff","time_created":"2023-05-11T19:05:01.323339Z","status":"PENDING","verification":{"id":"6a620795-dc32-46b8-9464-d692d71b3075","description":"Incoming wire","type":"incoming_wire","wire_id":"e5449f18-2383-4772-8fec-9d90a8cb2542","status":"PENDING_REVIEW"},"type":"wire","counterparty_name":{"first_name":"External","last_name":"Accountholder","type":"individual"},"address":{"street_address":"2000 Allston Way","street_address2":"","city":"Berkeley","postal_code":"94701","state":"CA","country":"US"},"institution_name":"External Bank NA","routing_number":"987654321","identifier":"1234567890","identifier_code":"DIRECT_DEPOSIT_ACCOUNT","object_type":"WireCounterpartyV2"}],"key":"wire","summary":"Domestic wire counterparty","id":"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/wire"},"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_business_iban":{"value":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","time_created":"2026-03-15T10:30:00Z","status":"PENDING","verification":{"id":"b2c3d4e5-f6a7-8901-bcde-f12345678901","description":"","type":"unverified"},"type":"international_wire","counterparty_name":{"business_name":"Deutsche Bank AG","type":"business"},"address":{"street_address":"Taunusanlage 12","street_address2":"","city":"Frankfurt am Main","postal_code":"60325","state":"","country":"DE"},"swift_bic":"DEUTDEFF","identifier":"DE89370400440532013000","identifier_type":"iban","bank_name":"Deutsche Bank AG","wire_instructions":"Example wire instructions","object_type":"InternationalWireCounterpartyV2"}],"key":"international_wire_business_iban","summary":"Business international wire counterparty with IBAN","id":"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_business_iban"},"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_individual_iban":{"value":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","time_created":"2026-03-15T10:30:00Z","status":"PENDING","verification":{"id":"b2c3d4e5-f6a7-8901-bcde-f12345678901","description":"","type":"unverified"},"type":"international_wire","counterparty_name":{"first_name":"Hans","last_name":"Mueller","type":"individual"},"address":{"street_address":"Unter den Linden 5","street_address2":"","city":"Berlin","postal_code":"10117","state":"","country":"DE"},"swift_bic":"DEUTDEFF","identifier":"DE89370400440532013000","identifier_type":"iban","bank_name":"Deutsche Bank AG","wire_instructions":"Example wire instructions","object_type":"InternationalWireCounterpartyV2"}],"key":"international_wire_individual_iban","summary":"Individual international wire counterparty with IBAN","id":"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_individual_iban"},"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_business_local":{"value":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","time_created":"2026-03-15T10:30:00Z","status":"PENDING","verification":{"id":"b2c3d4e5-f6a7-8901-bcde-f12345678901","description":"","type":"unverified"},"type":"international_wire","counterparty_name":{"business_name":"Deutsche Bank AG","type":"business"},"address":{"street_address":"Taunusanlage 12","street_address2":"","city":"Frankfurt am Main","postal_code":"60325","state":"","country":"DE"},"swift_bic":"DEUTDEFF","identifier":"1234567890","identifier_type":"local","bank_name":"Deutsche Bank AG","wire_instructions":"Example wire instructions","object_type":"InternationalWireCounterpartyV2"}],"key":"international_wire_business_local","summary":"Business international wire counterparty with Local Account Number","id":"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_business_local"},"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_individual_local":{"value":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","time_created":"2026-03-15T10:30:00Z","status":"PENDING","verification":{"id":"b2c3d4e5-f6a7-8901-bcde-f12345678901","description":"","type":"unverified"},"type":"international_wire","counterparty_name":{"first_name":"Hans","last_name":"Mueller","type":"individual"},"address":{"street_address":"Unter den Linden 5","street_address2":"","city":"Berlin","postal_code":"10117","state":"","country":"DE"},"swift_bic":"DEUTDEFF","identifier":"1234567890","identifier_type":"local","bank_name":"Deutsche Bank AG","wire_instructions":"Example wire instructions","object_type":"InternationalWireCounterpartyV2"}],"key":"international_wire_individual_local","summary":"Individual international wire counterparty with Local Account Number","id":"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1/post/responses/201/content/application~1json/examples/international_wire_individual_local"},"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/responses/200/content/application~1json/example":{"value":[{"id":"86bc2eb3-9b85-4f82-b8fa-91f8d0eea1ff","time_created":"2023-05-11T19:05:01.323339Z","status":"LINKED","verification":{"id":"6a620795-dc32-46b8-9464-d692d71b3075","description":"Incoming wire","type":"incoming_wire","wire_id":"e5449f18-2383-4772-8fec-9d90a8cb2542","status":"APPROVED"},"type":"wire","counterparty_name":{"first_name":"External","last_name":"Accountholder","type":"individual"},"address":{"street_address":"2000 Allston Way","street_address2":"","city":"Berkeley","postal_code":"94701","state":"CA","country":"US"},"institution_name":"External Bank NA","routing_number":"987654321","identifier":"1234567890","identifier_code":"DIRECT_DEPOSIT_ACCOUNT","object_type":"WireCounterpartyV2"}],"id":"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/get/responses/200/content/application~1json/example"},"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/patch/responses/200/content/application~1json/example":{"value":[{"id":"86bc2eb3-9b85-4f82-b8fa-91f8d0eea1ff","time_created":"2023-05-11T19:05:01.323339Z","status":"UNLINKED","verification":{"id":"6a620795-dc32-46b8-9464-d692d71b3075","description":"Incoming wire","type":"incoming_wire","wire_id":"e5449f18-2383-4772-8fec-9d90a8cb2542","status":"APPROVED"},"type":"wire","counterparty_name":{"first_name":"External","last_name":"Accountholder","type":"individual"},"address":{"street_address":"2000 Allston Way","street_address2":"","city":"Berkeley","postal_code":"94701","state":"CA","country":"US"},"institution_name":"External Bank NA","routing_number":"987654321","identifier":"1234567890","identifier_code":"DIRECT_DEPOSIT_ACCOUNT","object_type":"WireCounterpartyV2"}],"id":"paths/~1api~1v2~1customers~1{customer_id}~1counterparties~1{counterparty_id}~1/patch/responses/200/content/application~1json/example"}},"securitySchemeStore":{"HTTPBearer":{"id":"HTTPBearer","type":"http","scheme":"bearer"}},"servers":[{"url":"https://{partner}.partner-api.jikoservices.com","description":"Production server","variables":{"partner":{"default":"your-partner-name","description":"Your organization's unique identifier"}}},{"url":"https://{partner}.sandbox-api.jikoservices.com","description":"Sandbox server","variables":{"partner":{"default":"your-partner-name","description":"Your organization's unique identifier"}}}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/partner-api/reference.json?download"},{"url":"/_bundle/products/partner-api/reference.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Jiko Partner API","description":"## Introduction\n\nWelcome to the Jiko API Reference! Jiko enables you to integrate money storage and movement, backed by the safety and security of US Treasury Bills. Use the Partner API if you are building an application that embeds Jiko’s services and offers Jiko products to your own customers. The Partner API will then enable your application to interact with Jiko on behalf of your customers.\n\n</br>\n\nAt the core of our platform is the Jiko Pocket: a pair consisting of a bank account and a brokerage account. When money is deposited into a Pocket, the funds are automatically invested in T-bills. When a payment or withdrawal is made, T-bills are immediately liquidated and used as cash. Customers can have multiple Pockets, and each Pocket is associated with a single T-bill maturity: 4-week, 13-week, 26-week or 52-week.\n\n</br>\n\nThe API Reference covers everything you need to build a full application leveraging the Jiko platform:\n\n</br>\n\n- Onboarding customers\n- Funding Pockets via ACH or Wire\n- Viewing and managing Pockets (including monthly statements and trade confirmations)\n- Making payments and transfers via ACH, Wire, On-Us (Book) Transfer or Debit Card\n\n</br>\n\nWhen you’re ready to start building, please contact us at [partner.support@jiko.io](mailto:partner.support@jiko.io) to request sandbox access.\n"}},"baseSlug":"/products/partner-api/reference","routesMapping":{}}