{"items":[{"type":"link","label":"Payments Direct API","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","content":{"contentType":"overview","meta":{"name":"Payments Direct API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"payments-direct-2-api.json","url":"/_bundle/products/payments-direct-2/@v2026.03/api-docs/payments-direct-api/payments-direct-2-api.json?download"},{"kind":"download","label":"payments-direct-2-api.yaml","url":"/_bundle/products/payments-direct-2/@v2026.03/api-docs/payments-direct-api/payments-direct-2-api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"http://apache.org"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Payments Direct API (2026.03)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Payments Direct API to get quotes, create and manage payments, and manage originator and beneficiary identities."},"children":[]}]}]}]}],"sectionId":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api"}],"sectionId":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/api-environments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API environments"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Payments Direct API offers the following environments:"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"div","attrs":{"style":{"width":"90px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"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":"UAT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.test.ripple.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UAT environment with simulated currency."},"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":"Production"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.ripple.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production environment"},"children":[]}]}]}]}]}]}]}],"sectionId":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/section/api-environments"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/api-authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":{"$$mdtype":"Variable","path":["env","PUBLIC_VAR_RPD"]}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API operations require a Bearer access token specific to the environment you're using. Ripple provides a secure model for authentication and authorization by providing access tokens scoped for a set of credentials."},"children":[]}]}]}]}],"sectionId":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/section/api-authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/generate-client-id-and-client-secret"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate client ID and client secret"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You will need your "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client secret"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to obtain an access token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do not already have your client ID and client secret, do the following:"},"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":"text","inline":true,"attributes":{"content":"Log into the Ripple Payments UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the left navigation menu, click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Under "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Administration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the dropdown list next to the page title, select the access environment. For example, to provision credentials for the test environment, select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UAT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the dropdown list."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the upper right corner of the page, click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New Credential"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Save and Generate Key"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Caution:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client secret"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is displayed only once when you are creating new credentials. You cannot retrieve the secret after exiting this page. Copy and store the client secret securely and share it with authorized individuals in accordance with your organization's security policy."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can now use the client ID and client secret to generate access tokens using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/authenticate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]}],"sectionId":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/section/generate-client-id-and-client-secret"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/request-an-access-token"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get an access token, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/authenticate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation with your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The response contains a token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend rotating your API credentials at regular intervals according to your organization's security policy."},"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":": Authentication tokens are not a fixed length and can vary, avoid validating tokens based on character length."},"children":[]}]}]}]}],"sectionId":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/section/request-an-access-token"}]}]}},{"type":"link","label":"API environments","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/section/api-environments","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/section/api-environments","content":null},{"type":"link","label":"API authentication","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/section/api-authentication","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/section/api-authentication","content":null},{"type":"link","label":"Generate client ID and client secret","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/section/generate-client-id-and-client-secret","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/section/generate-client-id-and-client-secret","content":null},{"type":"link","label":"Request an access token","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/section/request-an-access-token","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/section/request-an-access-token","content":null},{"type":"group","label":"Authentication","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/authentication","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/authentication","items":[{"label":"Request an access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/authentication/authenticate","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/authentication/authenticate","metadata":{"seo":{"title":"Request an access token","description":"Request an access token for authentication with Ripple APIs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticate","name":"Request an access token","isWebhook":false,"pointer":"/paths/~1v2~1oauth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request an access token","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":"Request an access token for authentication with Ripple APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to request a token for the environment you want to authenticate with."},"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":": The length of the access token isn't fixed, hence it can vary. Avoid validating tokens based on character length."},"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":"Developer guide"},"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":"Learn how to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-direct-2/v2026.03/api-docs/developer-guides/request-an-access-token"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"authentication/authenticate/request/environments","deepLinkHash":"/authentication/authenticate#authentication/authenticate/request/environments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"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":"Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"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":"Test"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api.test.ripple.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test environment with simulated currency."},"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":"Production"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api.ripple.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production environment for Ripple Payments Direct"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_0"}],"pointer":"/paths/~1v2~1oauth~1token/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuthenticationRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AuthenticationRequest"}},"schemaId":"components/schemas/AuthenticationRequest","pointer":"/paths/~1v2~1oauth~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/oauth/token","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":false,"example":"Basic ZGVtbzpwQDU1dzByZA==","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AuthenticationRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AuthenticationRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v2/oauth/token","href":"authentication/authenticate","openApiOperationId":"authenticate","summary":"Request an access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"schemaId":"components/schemas/AuthenticationRequest","mediaTypes":["application/json","application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AuthenticationRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/AuthenticationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns the authentication response object that includes the token, type, scopes, and expiry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthenticationResponse"}},"schemaId":"components/schemas/AuthenticationResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_denied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the domain is not enabled, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unauthorized_client"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the caller (client ID or audience) is not authorized to request a token."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/403/content/application~1json/example"]}],"pointer":"/paths/~1v2~1oauth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuthenticationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthenticationResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1v2~1oauth~1token/post/responses/403/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/authenticate"}],"panels":[]}]},"httpPath":"/v2/oauth/token"},{"label":"Test access token","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/authentication/testauthtoken","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/authentication/testauthtoken","metadata":{"seo":{"title":"Test access token","description":"Test if an access token can be used for authentication with Ripple APIs and how much time remains on it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"testAuthToken","name":"Test access token","isWebhook":false,"pointer":"/paths/~1v2~1oauth~1token~1test/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test access token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Test if an access token can be used for authentication with Ripple APIs and how much time remains on it."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/oauth/token/test","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v2/oauth/token/test","href":"authentication/testauthtoken","openApiOperationId":"testAuthToken","summary":"Test access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"If a valid bearer token is supplied, the time remaining before the token expires is returned.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1"}},"schemaId":"schema_1"},{"code":"400","description":"Bad Request","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_2","exampleIds":["paths/~1v2~1oauth~1token~1test/get/responses/400/content/text~1plain/example"]}},"schemaId":"schema_2","exampleIds":["paths/~1v2~1oauth~1token~1test/get/responses/400/content/text~1plain/example"]},{"code":"401","description":"Unauthorized"}],"pointer":"/paths/~1v2~1oauth~1token~1test/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1"}}},{"code":"400","schemaId":"schema_2","exampleIds":["paths/~1v2~1oauth~1token~1test/get/responses/400/content/text~1plain/example"],"mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_2","exampleIds":["paths/~1v2~1oauth~1token~1test/get/responses/400/content/text~1plain/example"]}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/testauthtoken"}],"panels":[]}]},"httpPath":"/v2/oauth/token/test"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","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 API operations to manage your authentication tokens."},"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":"Operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"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":"link","inline":true,"attributes":{"href":"#operation/authenticate"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token for authentication with Ripple APIs."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/testAuthToken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test access token"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test if an access token can be used for authentication."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/oauth/token","summary":"Request an access token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/authenticate","deprecated":false},{"title":"/v2/oauth/token/test","summary":"Test access token","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authentication/testauthtoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Identities","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3","items":[{"label":"Create an identity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/createidentity","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/createidentity","metadata":{"seo":{"title":"Create an identity","description":"Create a new payment identity as an ORIGINATOR or BENEFICIARY for either an INDIVIDUAL or BUSINESS."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createIdentity","name":"Create an identity","isWebhook":false,"pointer":"/paths/~1v3~1identities/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an identity","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 new payment identity as an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORIGINATOR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BENEFICIARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for either an "},"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":"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":"The request body must follow the v3 identity schema and will be validated against corridor rules where applicable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On success, the API returns the new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and its initial version."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create-identity-request-v3","exampleIds":["paths/~1v3~1identities/post/requestBody/content/application~1json/examples/create-individual-originator","paths/~1v3~1identities/post/requestBody/content/application~1json/examples/create-business-beneficiary"]}},"schemaId":"components/schemas/create-identity-request-v3","exampleIds":["paths/~1v3~1identities/post/requestBody/content/application~1json/examples/create-individual-originator","paths/~1v3~1identities/post/requestBody/content/application~1json/examples/create-business-beneficiary"],"pointer":"/paths/~1v3~1identities/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/identities","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/create-identity-request-v3","exampleIds":["paths/~1v3~1identities/post/requestBody/content/application~1json/examples/create-individual-originator","paths/~1v3~1identities/post/requestBody/content/application~1json/examples/create-business-beneficiary"]}},"responseCodes":["201","400","409","500"],"pointer":"/v3/identities","href":"identitiesv3/createidentity","openApiOperationId":"createIdentity","summary":"Create an identity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"schemaId":"components/schemas/create-identity-request-v3","exampleIds":["paths/~1v3~1identities/post/requestBody/content/application~1json/examples/create-individual-originator","paths/~1v3~1identities/post/requestBody/content/application~1json/examples/create-business-beneficiary"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create-identity-request-v3","exampleIds":["paths/~1v3~1identities/post/requestBody/content/application~1json/examples/create-individual-originator","paths/~1v3~1identities/post/requestBody/content/application~1json/examples/create-business-beneficiary"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Identity created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/create-identity-response-v3","exampleIds":["paths/~1v3~1identities/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/create-identity-response-v3","exampleIds":["paths/~1v3~1identities/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/post/responses/400/content/application~1json/examples/error-response-400"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/post/responses/400/content/application~1json/examples/error-response-400"]},{"code":"409","description":"Conflict - An identity with the provided internalId already exists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response"}},"schemaId":"components/schemas/error-response"},{"code":"500","description":"Internal processing error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/post/responses/500/content/application~1json/examples/error-response-500"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/post/responses/500/content/application~1json/examples/error-response-500"]}],"pointer":"/paths/~1v3~1identities/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/create-identity-response-v3","exampleIds":["paths/~1v3~1identities/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/create-identity-response-v3","exampleIds":["paths/~1v3~1identities/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/post/responses/400/content/application~1json/examples/error-response-400"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/post/responses/400/content/application~1json/examples/error-response-400"]}}},{"code":"409","schemaId":"components/schemas/error-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response"}}},{"code":"500","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/post/responses/500/content/application~1json/examples/error-response-500"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/post/responses/500/content/application~1json/examples/error-response-500"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identitiesv3/createidentity"}],"panels":[]}]},"httpPath":"/v3/identities"},{"label":"Get a list of identities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/getidentities","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/getidentities","metadata":{"seo":{"title":"Get a list of identities","description":"Retrieve identities for your organization with optional filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIdentities","name":"Get a list of identities","isWebhook":false,"pointer":"/paths/~1v3~1identities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of identities","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 identities for your organization with optional filters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pagination. The response includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array and an optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"payment-role","in":"query","schemaId":"schema_2","description":"Filter by payment role.","example":"BENEFICIARY"},{"name":"nick-name","in":"query","schemaId":"schema_3","description":"Filter by nickname.","example":"Alice"},{"name":"limit","in":"query","schemaId":"schema_4","description":"Maximum number of identities to return. Default value is 10, maximum is 100."},{"name":"next-token","in":"query","schemaId":"schema_2","description":"Opaque token to fetch the next page of results.","example":"eyJrZXkxIjoidmFsdWVfMSIsImtleTIiOiJ2YWx1ZTIifQ=="}],"pointer":"/paths/~1v3~1identities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/identities","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"payment-role","in":"query","required":false,"example":"BENEFICIARY","schemaId":"schema_2"},{"name":"nick-name","in":"query","required":false,"example":"Alice","schemaId":"schema_3"},{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_4"},{"name":"next-token","in":"query","required":false,"example":"eyJrZXkxIjoidmFsdWVfMSIsImtleTIiOiJ2YWx1ZTIifQ==","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v3/identities","href":"identitiesv3/getidentities","openApiOperationId":"getIdentities","summary":"Get a list of identities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A page of identities.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-identities-response-v3","exampleIds":["paths/~1v3~1identities/get/responses/200/content/application~1json/examples/list-identities-v3"]}},"schemaId":"components/schemas/list-identities-response-v3","exampleIds":["paths/~1v3~1identities/get/responses/200/content/application~1json/examples/list-identities-v3"]},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/get/responses/400/content/application~1json/examples/error-response-400"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/get/responses/400/content/application~1json/examples/error-response-400"]},{"code":"404","description":"No identities found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/get/responses/404/content/application~1json/examples/error-response-404"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/get/responses/404/content/application~1json/examples/error-response-404"]},{"code":"500","description":"Internal processing error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/get/responses/500/content/application~1json/examples/error-response-500"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/get/responses/500/content/application~1json/examples/error-response-500"]}],"pointer":"/paths/~1v3~1identities/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/list-identities-response-v3","exampleIds":["paths/~1v3~1identities/get/responses/200/content/application~1json/examples/list-identities-v3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-identities-response-v3","exampleIds":["paths/~1v3~1identities/get/responses/200/content/application~1json/examples/list-identities-v3"]}}},{"code":"400","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/get/responses/400/content/application~1json/examples/error-response-400"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/get/responses/400/content/application~1json/examples/error-response-400"]}}},{"code":"404","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/get/responses/404/content/application~1json/examples/error-response-404"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/get/responses/404/content/application~1json/examples/error-response-404"]}}},{"code":"500","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/get/responses/500/content/application~1json/examples/error-response-500"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities/get/responses/500/content/application~1json/examples/error-response-500"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identitiesv3/getidentities"}],"panels":[]}]},"httpPath":"/v3/identities"},{"label":"Get an identity by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/getidentitybyid","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/getidentitybyid","metadata":{"seo":{"title":"Get an identity by ID","description":"Retrieve a specific identity by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIdentityById","name":"Get an identity by ID","isWebhook":false,"pointer":"/paths/~1v3~1identities~1{identity-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an identity by ID","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 specific identity by ID."},"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":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided, the latest version is returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identity-id","in":"path","schemaId":"schema_2","description":"The ID of the identity to retrieve.","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b"}],"pointer":"/paths/~1v3~1identities~1{identity-id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_2","description":"Specific version to retrieve. If omitted, returns the latest version.","example":"2"}],"pointer":"/paths/~1v3~1identities~1{identity-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/identities/{identity-id}","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[{"name":"identity-id","in":"path","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b","schemaId":"schema_2"}],"query":[{"name":"version","in":"query","required":false,"example":"2","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v3/identities/{identity-id}","href":"identitiesv3/getidentitybyid","openApiOperationId":"getIdentityById","summary":"Get an identity by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Identity details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/get-identity-response-v3","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/200/content/application~1json/examples/get-identity-v3"]}},"schemaId":"components/schemas/get-identity-response-v3","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/200/content/application~1json/examples/get-identity-v3"]},{"code":"400","description":"Invalid identity ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/400/content/application~1json/examples/error-response-400"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/400/content/application~1json/examples/error-response-400"]},{"code":"404","description":"Identity not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/404/content/application~1json/examples/error-response-404"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/404/content/application~1json/examples/error-response-404"]},{"code":"500","description":"Internal processing error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/500/content/application~1json/examples/error-response-500"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/500/content/application~1json/examples/error-response-500"]}],"pointer":"/paths/~1v3~1identities~1{identity-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/get-identity-response-v3","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/200/content/application~1json/examples/get-identity-v3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/get-identity-response-v3","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/200/content/application~1json/examples/get-identity-v3"]}}},{"code":"400","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/400/content/application~1json/examples/error-response-400"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/400/content/application~1json/examples/error-response-400"]}}},{"code":"404","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/404/content/application~1json/examples/error-response-404"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/404/content/application~1json/examples/error-response-404"]}}},{"code":"500","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/500/content/application~1json/examples/error-response-500"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/get/responses/500/content/application~1json/examples/error-response-500"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identitiesv3/getidentitybyid"}],"panels":[]}]},"httpPath":"/v3/identities/{identity-id}"},{"label":"Update an identity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/putidentity","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/putidentity","metadata":{"seo":{"title":"Update an identity","description":"Update all fields of an existing identity. Supports updates to PII fields and metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putIdentity","name":"Update an identity","isWebhook":false,"pointer":"/paths/~1v3~1identities~1{identity-id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an identity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update all fields of an existing identity. Supports updates to PII fields and metadata.\n\nEach successful PUT creates a new version and preserves prior versions for audit.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identity-id","in":"path","schemaId":"schema_2","description":"The ID of the identity to update.","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b"}],"pointer":"/paths/~1v3~1identities~1{identity-id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/put-identity-request-v3","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-metadata","paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-individual-address","paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-business-contact"]}},"schemaId":"components/schemas/put-identity-request-v3","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-metadata","paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-individual-address","paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-business-contact"],"pointer":"/paths/~1v3~1identities~1{identity-id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/identities/{identity-id}","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[{"name":"identity-id","in":"path","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b","schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/put-identity-request-v3","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-metadata","paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-individual-address","paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-business-contact"]}},"responseCodes":["200","400","404","409","500"],"pointer":"/v3/identities/{identity-id}","href":"identitiesv3/putidentity","openApiOperationId":"putIdentity","summary":"Update an identity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"schemaId":"components/schemas/put-identity-request-v3","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-metadata","paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-individual-address","paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-business-contact"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/put-identity-request-v3","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-metadata","paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-individual-address","paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-business-contact"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Identity updated. Latest version returned.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/get-identity-response-v3"}},"schemaId":"components/schemas/get-identity-response-v3"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/responses/400/content/application~1json/examples/error-response-400"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/responses/400/content/application~1json/examples/error-response-400"]},{"code":"404","description":"Identity not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/responses/404/content/application~1json/examples/error-response-404"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/responses/404/content/application~1json/examples/error-response-404"]},{"code":"409","description":"Conflict - The provided internalId already exists on a different identity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response"}},"schemaId":"components/schemas/error-response"},{"code":"500","description":"Internal processing error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/responses/500/content/application~1json/examples/error-response-500"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/responses/500/content/application~1json/examples/error-response-500"]}],"pointer":"/paths/~1v3~1identities~1{identity-id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/get-identity-response-v3","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/get-identity-response-v3"}}},{"code":"400","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/responses/400/content/application~1json/examples/error-response-400"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/responses/400/content/application~1json/examples/error-response-400"]}}},{"code":"404","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/responses/404/content/application~1json/examples/error-response-404"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/responses/404/content/application~1json/examples/error-response-404"]}}},{"code":"409","schemaId":"components/schemas/error-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response"}}},{"code":"500","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/responses/500/content/application~1json/examples/error-response-500"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/put/responses/500/content/application~1json/examples/error-response-500"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identitiesv3/putidentity"}],"panels":[]}]},"httpPath":"/v3/identities/{identity-id}"},{"label":"Deactivate an identity","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/deactivateidentityv3","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/deactivateidentityv3","metadata":{"seo":{"title":"Deactivate an identity","description":"Deactivate an identity and its financial instruments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivateIdentityV3","name":"Deactivate an identity","isWebhook":false,"pointer":"/paths/~1v3~1identities~1{identity-id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate an identity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deactivate an identity and its financial instruments.\n\nDeactivation is permanent and prevents further use in payments.\n\nHistorical versions remain available for audit.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identity-id","in":"path","schemaId":"schema_2","description":"ID of the identity to deactivate.","required":true,"example":"146f3c51-c313-47ce-b6f2-691c5a238b3e"}],"pointer":"/paths/~1v3~1identities~1{identity-id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/identities/{identity-id}","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[{"name":"identity-id","in":"path","required":true,"example":"146f3c51-c313-47ce-b6f2-691c5a238b3e","schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","404","422","500"],"pointer":"/v3/identities/{identity-id}","href":"identitiesv3/deactivateidentityv3","openApiOperationId":"deactivateIdentityV3","summary":"Deactivate an identity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Identity deactivated."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/delete/responses/400/content/application~1json/examples/error-response-400"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/delete/responses/400/content/application~1json/examples/error-response-400"]},{"code":"404","description":"Identity not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/delete/responses/404/content/application~1json/examples/error-response-404"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/delete/responses/404/content/application~1json/examples/error-response-404"]},{"code":"422","description":"Identity already deactivated or cannot be deactivated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response"}},"schemaId":"components/schemas/error-response"},{"code":"500","description":"Internal processing error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/delete/responses/500/content/application~1json/examples/error-response-500"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/delete/responses/500/content/application~1json/examples/error-response-500"]}],"pointer":"/paths/~1v3~1identities~1{identity-id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/delete/responses/400/content/application~1json/examples/error-response-400"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/delete/responses/400/content/application~1json/examples/error-response-400"]}}},{"code":"404","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/delete/responses/404/content/application~1json/examples/error-response-404"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/delete/responses/404/content/application~1json/examples/error-response-404"]}}},{"code":"422","schemaId":"components/schemas/error-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response"}}},{"code":"500","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/delete/responses/500/content/application~1json/examples/error-response-500"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}/delete/responses/500/content/application~1json/examples/error-response-500"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identitiesv3/deactivateidentityv3"}],"panels":[]}]},"httpPath":"/v3/identities/{identity-id}"},{"label":"Get an identity by Internal ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/getidentitybyinternalid","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/getidentitybyinternalid","metadata":{"seo":{"title":"Get an identity by Internal ID","description":"Retrieve a specific identity by its internal ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIdentityByInternalId","name":"Get an identity by Internal ID","isWebhook":false,"pointer":"/paths/~1v3~1identities~1by-internal-id~1{internal-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an identity by Internal ID","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 specific identity by its internal ID."},"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":"Behavior:"},"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":"Only returns identities in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state. Deactivated identities will result in an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always returns the latest version of the identity. Historical versions are not accessible through this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no active identity exists for the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a 404 is returned."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"internal-id","in":"path","schemaId":"schema_2","description":"The Internal ID of the identity to retrieve.","required":true,"example":"customer-12345-uuid"}],"pointer":"/paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/identities/by-internal-id/{internal-id}","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[{"name":"internal-id","in":"path","required":true,"example":"customer-12345-uuid","schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v3/identities/by-internal-id/{internal-id}","href":"identitiesv3/getidentitybyinternalid","openApiOperationId":"getIdentityByInternalId","summary":"Get an identity by Internal ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Identity details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/get-identity-response-v3","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/200/content/application~1json/examples/get-identity-v3"]}},"schemaId":"components/schemas/get-identity-response-v3","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/200/content/application~1json/examples/get-identity-v3"]},{"code":"400","description":"Invalid internal ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/400/content/application~1json/examples/error-response-400"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/400/content/application~1json/examples/error-response-400"]},{"code":"404","description":"Active Identity not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/404/content/application~1json/examples/error-response-404"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/404/content/application~1json/examples/error-response-404"]},{"code":"500","description":"Internal processing error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/500/content/application~1json/examples/error-response-500"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/500/content/application~1json/examples/error-response-500"]}],"pointer":"/paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/get-identity-response-v3","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/200/content/application~1json/examples/get-identity-v3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/get-identity-response-v3","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/200/content/application~1json/examples/get-identity-v3"]}}},{"code":"400","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/400/content/application~1json/examples/error-response-400"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/400/content/application~1json/examples/error-response-400"]}}},{"code":"404","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/404/content/application~1json/examples/error-response-404"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/404/content/application~1json/examples/error-response-404"]}}},{"code":"500","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/500/content/application~1json/examples/error-response-500"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/500/content/application~1json/examples/error-response-500"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identitiesv3/getidentitybyinternalid"}],"panels":[]}]},"httpPath":"/v3/identities/by-internal-id/{internal-id}"},{"label":"Add a financial instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/createfinancialinstrument","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/createfinancialinstrument","metadata":{"seo":{"title":"Add a financial instrument","description":"Create a financial instrument for the specified identity. The request body must includethe payment rail (financialInstrumentType), currency or asset code, and the rail-specificdetails (for example, US ACH account numbers or a wallet address)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFinancialInstrument","name":"Add a financial instrument","isWebhook":false,"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a financial instrument","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 financial instrument for the specified identity. The request body must include"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the payment rail (financialInstrumentType), currency or asset code, and the rail-specific"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"details (for example, US ACH account numbers or a wallet address)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the current release, each identity can have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" financial instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Future releases will support multiple instruments per identity."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identity-id","in":"path","schemaId":"schema_2","description":"Unique identifier of the identity that will own the financial instrument.","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b"}],"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ripple-financial-instrument","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/requestBody/content/application~1json/examples/create-us-ach"]}},"schemaId":"components/schemas/ripple-financial-instrument","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/requestBody/content/application~1json/examples/create-us-ach"],"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/identities/{identity-id}/financial-instruments","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[{"name":"identity-id","in":"path","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b","schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ripple-financial-instrument","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/requestBody/content/application~1json/examples/create-us-ach"]}},"responseCodes":["201","400","404","500"],"pointer":"/v3/identities/{identity-id}/financial-instruments","href":"identitiesv3/createfinancialinstrument","openApiOperationId":"createFinancialInstrument","summary":"Add a financial instrument"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"schemaId":"components/schemas/ripple-financial-instrument","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/requestBody/content/application~1json/examples/create-us-ach"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ripple-financial-instrument","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/requestBody/content/application~1json/examples/create-us-ach"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Financial instrument created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/create-financial-instrument-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/create-financial-instrument-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/400/content/application~1json/examples/error-response-400"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/400/content/application~1json/examples/error-response-400"]},{"code":"404","description":"Identity not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/404/content/application~1json/examples/error-response-404"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/404/content/application~1json/examples/error-response-404"]},{"code":"500","description":"Internal processing error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/500/content/application~1json/examples/error-response-500"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/500/content/application~1json/examples/error-response-500"]}],"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/create-financial-instrument-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/create-financial-instrument-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/400/content/application~1json/examples/error-response-400"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/400/content/application~1json/examples/error-response-400"]}}},{"code":"404","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/404/content/application~1json/examples/error-response-404"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/404/content/application~1json/examples/error-response-404"]}}},{"code":"500","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/500/content/application~1json/examples/error-response-500"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/500/content/application~1json/examples/error-response-500"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identitiesv3/createfinancialinstrument"}],"panels":[]}]},"httpPath":"/v3/identities/{identity-id}/financial-instruments"},{"label":"Get a list of financial instruments of the identity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/getfinancialinstruments","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/getfinancialinstruments","metadata":{"seo":{"title":"Get a list of financial instruments of the identity","description":"List financial instruments for an identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFinancialInstruments","name":"Get a list of financial instruments of the identity","isWebhook":false,"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of financial instruments of the identity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List financial instruments for an identity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identity-id","in":"path","schemaId":"schema_2","description":"Unique UUID string that maps to an identity","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b"}],"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_2","description":"Version of the identity","example":"2"},{"name":"next-token","in":"query","schemaId":"schema_2","description":"The token to use for the next page of results. If provided, the API will return financial instruments after this token.","example":"eyJrZXkxIjoidmFsdWVfMSIsImtleTIiOiJ2YWx1ZTIifQ=="},{"name":"limit","in":"query","schemaId":"schema_5","description":"The maximum number of financial instruments to return. Default is 10, maximum is 100."}],"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/identities/{identity-id}/financial-instruments","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[{"name":"identity-id","in":"path","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b","schemaId":"schema_2"}],"query":[{"name":"version","in":"query","required":false,"example":"2","schemaId":"schema_2"},{"name":"next-token","in":"query","required":false,"example":"eyJrZXkxIjoidmFsdWVfMSIsImtleTIiOiJ2YWx1ZTIifQ==","schemaId":"schema_2"},{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v3/identities/{identity-id}/financial-instruments","href":"identitiesv3/getfinancialinstruments","openApiOperationId":"getFinancialInstruments","summary":"Get a list of financial instruments of the identity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Requested financial instruments of the identity in JSON format","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-financial-instruments-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/200/content/application~1json/examples/list-fi-v3"]}},"schemaId":"components/schemas/list-financial-instruments-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/200/content/application~1json/examples/list-fi-v3"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/400/content/application~1json/examples/error-response-400"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/400/content/application~1json/examples/error-response-400"]},{"code":"404","description":"No identity or financial instruments found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/404/content/application~1json/examples/error-response-404"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/404/content/application~1json/examples/error-response-404"]},{"code":"500","description":"Internal Processing Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/500/content/application~1json/examples/error-response-500"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/500/content/application~1json/examples/error-response-500"]}],"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/list-financial-instruments-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/200/content/application~1json/examples/list-fi-v3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-financial-instruments-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/200/content/application~1json/examples/list-fi-v3"]}}},{"code":"400","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/400/content/application~1json/examples/error-response-400"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/400/content/application~1json/examples/error-response-400"]}}},{"code":"404","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/404/content/application~1json/examples/error-response-404"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/404/content/application~1json/examples/error-response-404"]}}},{"code":"500","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/500/content/application~1json/examples/error-response-500"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/500/content/application~1json/examples/error-response-500"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identitiesv3/getfinancialinstruments"}],"panels":[]}]},"httpPath":"/v3/identities/{identity-id}/financial-instruments"},{"label":"Get a financial instrument by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/getfinancialinstrumentbyid","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/getfinancialinstrumentbyid","metadata":{"seo":{"title":"Get a financial instrument by ID","description":"Retrieves one financial instrument associated with the specified identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFinancialInstrumentById","name":"Get a financial instrument by ID","isWebhook":false,"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a financial instrument by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves one financial instrument associated with the specified identity.\n\nIn the current release, one instrument is retrieved at most because only a single instrument is allowed per identity.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identity-id","in":"path","schemaId":"schema_2","description":"Unique identifier of the identity whose instruments you want to list.","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b"},{"name":"financial-instrument-id","in":"path","schemaId":"schema_2","description":"The ID of the financial instrument of the identity.","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b"}],"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version","in":"query","schemaId":"schema_2","description":"Version of the identity","example":"2"},{"name":"expand-identity","in":"query","schemaId":"schema_6","description":"Optional parameter to expand the financial instrument details.\nIf set to true, the details about the identity will be included in the response.\n"}],"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/identities/{identity-id}/financial-instruments/{financial-instrument-id}","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[{"name":"identity-id","in":"path","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b","schemaId":"schema_2"},{"name":"financial-instrument-id","in":"path","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b","schemaId":"schema_2"}],"query":[{"name":"version","in":"query","required":false,"example":"2","schemaId":"schema_2"},{"name":"expand-identity","in":"query","required":false,"example":true,"schemaId":"schema_6"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v3/identities/{identity-id}/financial-instruments/{financial-instrument-id}","href":"identitiesv3/getfinancialinstrumentbyid","openApiOperationId":"getFinancialInstrumentById","summary":"Get a financial instrument by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Financial instrument for the identity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/get-financial-instrument-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/200/content/application~1json/examples/get-fi-v3"]}},"schemaId":"components/schemas/get-financial-instrument-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/200/content/application~1json/examples/get-fi-v3"]},{"code":"400","description":"Identity ID or financial instrument ID is not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/400/content/application~1json/examples/error-response-400"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/400/content/application~1json/examples/error-response-400"]},{"code":"404","description":"The specified identity-id does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/404/content/application~1json/examples/error-response-404"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/404/content/application~1json/examples/error-response-404"]},{"code":"500","description":"Internal processing error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/500/content/application~1json/examples/error-response-500"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/500/content/application~1json/examples/error-response-500"]}],"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/get-financial-instrument-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/200/content/application~1json/examples/get-fi-v3"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/get-financial-instrument-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/200/content/application~1json/examples/get-fi-v3"]}}},{"code":"400","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/400/content/application~1json/examples/error-response-400"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/400/content/application~1json/examples/error-response-400"]}}},{"code":"404","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/404/content/application~1json/examples/error-response-404"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/404/content/application~1json/examples/error-response-404"]}}},{"code":"500","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/500/content/application~1json/examples/error-response-500"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/500/content/application~1json/examples/error-response-500"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identitiesv3/getfinancialinstrumentbyid"}],"panels":[]}]},"httpPath":"/v3/identities/{identity-id}/financial-instruments/{financial-instrument-id}"},{"label":"Update a financial instrument","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/putfinancialinstrument","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/putfinancialinstrument","metadata":{"seo":{"title":"Update a financial instrument","description":"Update editable fields of a financial instrument including rail-specific details and labels."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putFinancialInstrument","name":"Update a financial instrument","isWebhook":false,"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a financial instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update editable fields of a financial instrument including rail-specific details and labels.\n\nThe financialInstrumentType is immutable after creation.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identity-id","in":"path","schemaId":"schema_2","description":"The unique ID of the identity.","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b"},{"name":"financial-instrument-id","in":"path","schemaId":"schema_2","description":"The ID of the financial instrument to update.","required":true,"example":"c7e2f5b4-d1a2-4c3a-9e1b-4d5c6f7e8a9d"}],"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/put-ripple-financial-instrument","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/requestBody/content/application~1json/examples/put-label-only","paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/requestBody/content/application~1json/examples/put-ach-details"]}},"schemaId":"components/schemas/put-ripple-financial-instrument","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/requestBody/content/application~1json/examples/put-label-only","paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/requestBody/content/application~1json/examples/put-ach-details"],"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/identities/{identity-id}/financial-instruments/{financial-instrument-id}","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[{"name":"identity-id","in":"path","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b","schemaId":"schema_2"},{"name":"financial-instrument-id","in":"path","required":true,"example":"c7e2f5b4-d1a2-4c3a-9e1b-4d5c6f7e8a9d","schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/put-ripple-financial-instrument","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/requestBody/content/application~1json/examples/put-label-only","paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/requestBody/content/application~1json/examples/put-ach-details"]}},"responseCodes":["200","400","404","409","500"],"pointer":"/v3/identities/{identity-id}/financial-instruments/{financial-instrument-id}","href":"identitiesv3/putfinancialinstrument","openApiOperationId":"putFinancialInstrument","summary":"Update a financial instrument"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"schemaId":"components/schemas/put-ripple-financial-instrument","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/requestBody/content/application~1json/examples/put-label-only","paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/requestBody/content/application~1json/examples/put-ach-details"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/put-ripple-financial-instrument","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/requestBody/content/application~1json/examples/put-label-only","paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/requestBody/content/application~1json/examples/put-ach-details"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Financial instrument updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/update-financial-instrument-response"}},"schemaId":"components/schemas/update-financial-instrument-response"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/400/content/application~1json/examples/error-response-400"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/400/content/application~1json/examples/error-response-400"]},{"code":"404","description":"Identity or financial instrument not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/404/content/application~1json/examples/error-response-404"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/404/content/application~1json/examples/error-response-404"]},{"code":"409","description":"Conflicting resource state.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/409/content/application~1json/examples/error-response-409"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/409/content/application~1json/examples/error-response-409"]},{"code":"500","description":"Internal processing error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/500/content/application~1json/examples/error-response-500"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/500/content/application~1json/examples/error-response-500"]}],"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/update-financial-instrument-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/update-financial-instrument-response"}}},{"code":"400","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/400/content/application~1json/examples/error-response-400"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/400/content/application~1json/examples/error-response-400"]}}},{"code":"404","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/404/content/application~1json/examples/error-response-404"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/404/content/application~1json/examples/error-response-404"]}}},{"code":"409","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/409/content/application~1json/examples/error-response-409"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/409/content/application~1json/examples/error-response-409"]}}},{"code":"500","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/500/content/application~1json/examples/error-response-500"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/500/content/application~1json/examples/error-response-500"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identitiesv3/putfinancialinstrument"}],"panels":[]}]},"httpPath":"/v3/identities/{identity-id}/financial-instruments/{financial-instrument-id}"},{"label":"Deactivate a Financial Instrument","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/deactivatefinancialinstrumentv3","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/identitiesv3/deactivatefinancialinstrumentv3","metadata":{"seo":{"title":"Deactivate a Financial Instrument","description":"Deactivate a financial instrument of an Identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivateFinancialInstrumentV3","name":"Deactivate a Financial Instrument","isWebhook":false,"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate a Financial Instrument","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deactivate a financial instrument of an Identity.\n\nDeactivation is permanent and prevents further use in payments.\n\nHistorical versions remain available for audit.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identity-id","in":"path","schemaId":"schema_2","description":"The unique ID of the identity.","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b"},{"name":"financial-instrument-id","in":"path","schemaId":"schema_2","description":"The ID of the financial instrument to deactivate.","required":true,"example":"c7e2f5b4-d1a2-4c3a-9e1b-4d5c6f7e8a9d"}],"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/identities/{identity-id}/financial-instruments/{financial-instrument-id}","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[{"name":"identity-id","in":"path","required":true,"example":"2f4ac57f-c5ba-4051-b51f-b3565778717b","schemaId":"schema_2"},{"name":"financial-instrument-id","in":"path","required":true,"example":"c7e2f5b4-d1a2-4c3a-9e1b-4d5c6f7e8a9d","schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","404","405","409","500"],"pointer":"/v3/identities/{identity-id}/financial-instruments/{financial-instrument-id}","href":"identitiesv3/deactivatefinancialinstrumentv3","openApiOperationId":"deactivateFinancialInstrumentV3","summary":"Deactivate a Financial Instrument"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Financial Instrument deactivated."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/400/content/application~1json/examples/error-response-400"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/400/content/application~1json/examples/error-response-400"]},{"code":"404","description":"Financial Instrument not found for the identity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/404/content/application~1json/examples/error-response-404"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/404/content/application~1json/examples/error-response-404"]},{"code":"405","description":"Method not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response"}},"schemaId":"components/schemas/error-response"},{"code":"409","description":"Conflicting resource state. Identity/Financial Instrument already deactivated or cannot be deactivated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/409/content/application~1json/examples/error-response-409"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/409/content/application~1json/examples/error-response-409"]},{"code":"500","description":"Internal processing error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/500/content/application~1json/examples/error-response-500"]}},"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/500/content/application~1json/examples/error-response-500"]}],"pointer":"/paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/400/content/application~1json/examples/error-response-400"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/400/content/application~1json/examples/error-response-400"]}}},{"code":"404","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/404/content/application~1json/examples/error-response-404"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/404/content/application~1json/examples/error-response-404"]}}},{"code":"405","schemaId":"components/schemas/error-response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response"}}},{"code":"409","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/409/content/application~1json/examples/error-response-409"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/409/content/application~1json/examples/error-response-409"]}}},{"code":"500","schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/500/content/application~1json/examples/error-response-500"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error-response","exampleIds":["paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/500/content/application~1json/examples/error-response-500"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identitiesv3/deactivatefinancialinstrumentv3"}],"panels":[]}]},"httpPath":"/v3/identities/{identity-id}/financial-instruments/{financial-instrument-id}"}],"content":{"contentType":"group","meta":{"name":"IdentitiesV3"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Identities","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 API operations to manage your identities with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity Management v3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (recommended for all new integrations). For more information about identity management, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-direct-2/introduction/concepts/payment-identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment identities"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-direct-2/introduction/concepts/financial-instruments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Financial instruments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"Operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"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":"link","inline":true,"attributes":{"href":"#operation/createIdentity"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an identity"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new identity (INDIVIDUAL/BUSINESS; ORIGINATOR/BENEFICIARY)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getIdentities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a list of identities"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a list of identities with optional filters (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentRole"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getIdentityById"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get an identity by ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a specific identity by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (latest version by default)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getIdentityByInternalId"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get an identity by internal ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an active identity by client-provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/putIdentity"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an identity"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update one or more fields; creates a new version."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/deactivateIdentityV3"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivate an identity"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELETE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the identity state to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEACTIVATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (cannot be used for new payments)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/createFinancialInstrument"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a financial instrument"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a financial instrument to an identity."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getFinancialInstruments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a list of financial instruments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a list of financial instruments for an identity."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getFinancialInstrumentById"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a financial instrument by ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a specific financial instrument by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"financialInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/putFinancialInstrument"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a financial instrument"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a financial instrument by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"financialInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/deactivateFinancialInstrumentV3"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivate a financial instrument"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELETE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivate a financial instrument by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"financialInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/identities","summary":"Create an identity","prefix":{"name":"post","color":"post"},"badges":[],"link":"/identitiesv3/createidentity","deprecated":false},{"title":"/v3/identities","summary":"Get a list of identities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identitiesv3/getidentities","deprecated":false},{"title":"/v3/identities/{identity-id}","summary":"Get an identity by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identitiesv3/getidentitybyid","deprecated":false},{"title":"/v3/identities/{identity-id}","summary":"Update an identity","prefix":{"name":"put","color":"put"},"badges":[],"link":"/identitiesv3/putidentity","deprecated":false},{"title":"/v3/identities/{identity-id}","summary":"Deactivate an identity","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/identitiesv3/deactivateidentityv3","deprecated":false},{"title":"/v3/identities/by-internal-id/{internal-id}","summary":"Get an identity by Internal ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identitiesv3/getidentitybyinternalid","deprecated":false},{"title":"/v3/identities/{identity-id}/financial-instruments","summary":"Add a financial instrument","prefix":{"name":"post","color":"post"},"badges":[],"link":"/identitiesv3/createfinancialinstrument","deprecated":false},{"title":"/v3/identities/{identity-id}/financial-instruments","summary":"Get a list of financial instruments of the identity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identitiesv3/getfinancialinstruments","deprecated":false},{"title":"/v3/identities/{identity-id}/financial-instruments/{financial-instrument-id}","summary":"Get a financial instrument by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identitiesv3/getfinancialinstrumentbyid","deprecated":false},{"title":"/v3/identities/{identity-id}/financial-instruments/{financial-instrument-id}","summary":"Update a financial instrument","prefix":{"name":"put","color":"put"},"badges":[],"link":"/identitiesv3/putfinancialinstrument","deprecated":false},{"title":"/v3/identities/{identity-id}/financial-instruments/{financial-instrument-id}","summary":"Deactivate a Financial Instrument","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/identitiesv3/deactivatefinancialinstrumentv3","deprecated":false}]}]}]}]}},{"type":"group","label":"Quotes","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/quote","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/quote","items":[{"label":"Create quote collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/quote/createquotecollection","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/quote/createquotecollection","metadata":{"seo":{"title":"Create quote collection","description":"Creates a collection of quotes for a proposed payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createQuoteCollection","name":"Create quote collection","isWebhook":false,"pointer":"/paths/~1v2~1quotes~1quote-collection/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create quote collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a collection of quotes for a proposed payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QuoteCollectionRequest"}},"schemaId":"components/schemas/QuoteCollectionRequest","pointer":"/paths/~1v2~1quotes~1quote-collection/post/requestBody","description":"Create quote collection request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/quotes/quote-collection","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/QuoteCollectionRequest"}},"responseCodes":["201","400","401","403","500","503"],"pointer":"/v2/quotes/quote-collection","href":"quote/createquotecollection","openApiOperationId":"createQuoteCollection","summary":"Create quote collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"schemaId":"components/schemas/QuoteCollectionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QuoteCollectionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Creates a collection of quotes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteCollection"}},"schemaId":"components/schemas/QuoteCollection"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}},"schemaId":"components/schemas/QuoteErrorResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}},"schemaId":"components/schemas/QuoteErrorResponse"},{"code":"403","description":"The principal identified by the authorization header doesn't have enough scopes to perform this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}},"schemaId":"components/schemas/QuoteErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}},"schemaId":"components/schemas/QuoteErrorResponse"},{"code":"503","description":"A maintenance window is in force for this corridor. The error description states when service is expected to resume.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}},"schemaId":"components/schemas/QuoteErrorResponse"}],"pointer":"/paths/~1v2~1quotes~1quote-collection/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/QuoteCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteCollection"}}},{"code":"400","schemaId":"components/schemas/QuoteErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}}},{"code":"401","schemaId":"components/schemas/QuoteErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}}},{"code":"403","schemaId":"components/schemas/QuoteErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}}},{"code":"500","schemaId":"components/schemas/QuoteErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}}},{"code":"503","schemaId":"components/schemas/QuoteErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quote/createquotecollection"}],"panels":[]}]},"httpPath":"/v2/quotes/quote-collection"},{"label":"Get quote collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/quote/getquotecollection","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/quote/getquotecollection","metadata":{"seo":{"title":"Get quote collection","description":"Get quote collection"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQuoteCollection","name":"Get quote collection","isWebhook":false,"pointer":"/paths/~1v2~1quotes~1quote-collection~1{quote-collection-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get quote collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"quote-collection-id","in":"path","schemaId":"schema_7","description":"The unique identifier of the quote collection you want to retrieve","required":true}],"pointer":"/paths/~1v2~1quotes~1quote-collection~1{quote-collection-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/quotes/quote-collection/{quote-collection-id}","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[{"name":"quote-collection-id","in":"path","required":true,"example":"11111111-aaaa-2222-bbbb-222222222222","schemaId":"schema_7"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/v2/quotes/quote-collection/{quote-collection-id}","href":"quote/getquotecollection","openApiOperationId":"getQuoteCollection","summary":"Get quote collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Valid quote collection found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteCollection"}},"schemaId":"components/schemas/QuoteCollection"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}},"schemaId":"components/schemas/QuoteErrorResponse"},{"code":"403","description":"The principal identified by the authorization header doesn't have enough scopes to perform this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}},"schemaId":"components/schemas/QuoteErrorResponse"},{"code":"404","description":"Quote collection not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}},"schemaId":"components/schemas/QuoteErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}},"schemaId":"components/schemas/QuoteErrorResponse"}],"pointer":"/paths/~1v2~1quotes~1quote-collection~1{quote-collection-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteCollection"}}},{"code":"401","schemaId":"components/schemas/QuoteErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}}},{"code":"403","schemaId":"components/schemas/QuoteErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}}},{"code":"404","schemaId":"components/schemas/QuoteErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}}},{"code":"500","schemaId":"components/schemas/QuoteErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quote/getquotecollection"}],"panels":[]}]},"httpPath":"/v2/quotes/quote-collection/{quote-collection-id}"},{"label":"Get quote","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/quote/getquote","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/quote/getquote","metadata":{"seo":{"title":"Get quote","description":"Get quote"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQuote","name":"Get quote","isWebhook":false,"pointer":"/paths/~1v2~1quotes~1{quote-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"quote-id","in":"path","schemaId":"schema_8","description":"The unique identifier of the quote to retrieve","required":true}],"pointer":"/paths/~1v2~1quotes~1{quote-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/quotes/{quote-id}","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[{"name":"quote-id","in":"path","required":true,"example":"22222222-aaaa-2222-bbbb-222222222222","schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/v2/quotes/{quote-id}","href":"quote/getquote","openApiOperationId":"getQuote","summary":"Get quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Valid quote found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}},"schemaId":"components/schemas/Quote"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}},"schemaId":"components/schemas/QuoteErrorResponse"},{"code":"403","description":"The principal identified by the authorization header doesn't have enough scopes to perform this operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}},"schemaId":"components/schemas/QuoteErrorResponse"},{"code":"404","description":"Quote not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}},"schemaId":"components/schemas/QuoteErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}},"schemaId":"components/schemas/QuoteErrorResponse"}],"pointer":"/paths/~1v2~1quotes~1{quote-id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}}},{"code":"401","schemaId":"components/schemas/QuoteErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}}},{"code":"403","schemaId":"components/schemas/QuoteErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}}},{"code":"404","schemaId":"components/schemas/QuoteErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}}},{"code":"500","schemaId":"components/schemas/QuoteErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quote/getquote"}],"panels":[]}]},"httpPath":"/v2/quotes/{quote-id}"}],"content":{"contentType":"group","meta":{"name":"Quote"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quotes","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 API operations to manage your quotes."},"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":"Operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"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":"link","inline":true,"attributes":{"href":"#operation/createQuoteCollection"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create quote collection"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a collection of quotes."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getQuoteCollection"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get quote collection"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a quote collection by ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getQuote"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a quote"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a specific quote by ID."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/quotes/quote-collection","summary":"Create quote collection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quote/createquotecollection","deprecated":false},{"title":"/v2/quotes/quote-collection/{quote-collection-id}","summary":"Get quote collection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/quote/getquotecollection","deprecated":false},{"title":"/v2/quotes/{quote-id}","summary":"Get quote","prefix":{"name":"get","color":"get"},"badges":[],"link":"/quote/getquote","deprecated":false}]}]}]}]}},{"type":"group","label":"Payments","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/paymentsv2","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/paymentsv2","items":[{"label":"Search payments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/paymentsv2/searchpaymentsv2","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/paymentsv2/searchpaymentsv2","metadata":{"seo":{"title":"Search payments","description":"Returns a paginated list of payments matching the specified filters. You can filter by status, date range, destination country, currency, or custom labels."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchPaymentsV2","name":"Search payments","isWebhook":false,"pointer":"/paths/~1v3~1payments~1filter/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search payments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of payments matching the specified filters. You can filter by status, date range, destination country, currency, or custom labels."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchPaymentsRequestV2"}},"schemaId":"components/schemas/SearchPaymentsRequestV2","pointer":"/paths/~1v3~1payments~1filter/post/requestBody","description":"Search payments request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/payments/filter","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchPaymentsRequestV2"}},"responseCodes":["200","400","415","500"],"pointer":"/v3/payments/filter","href":"paymentsv2/searchpaymentsv2","openApiOperationId":"searchPaymentsV2","summary":"Search payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"schemaId":"components/schemas/SearchPaymentsRequestV2","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchPaymentsRequestV2"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payments matching the specified filtering criteria.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentsResponseV2"}},"schemaId":"components/schemas/PaymentsResponseV2"},{"code":"400","description":"Invalid input variables for the request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1filter/post/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1filter/post/responses/400/content/application~1json/examples/invalidRequestBody"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1filter/post/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1filter/post/responses/400/content/application~1json/examples/invalidRequestBody"]},{"code":"415","description":"Missing or unsupported Content-Type header.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1filter/post/responses/415/content/application~1json/examples/unsupportedMediaType"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1filter/post/responses/415/content/application~1json/examples/unsupportedMediaType"]},{"code":"500","description":"Internal processing error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1filter/post/responses/500/content/application~1json/examples/internalServerError"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1filter/post/responses/500/content/application~1json/examples/internalServerError"]}],"pointer":"/paths/~1v3~1payments~1filter/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentsResponseV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentsResponseV2"}}},{"code":"400","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1filter/post/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1filter/post/responses/400/content/application~1json/examples/invalidRequestBody"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1filter/post/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1filter/post/responses/400/content/application~1json/examples/invalidRequestBody"]}}},{"code":"415","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1filter/post/responses/415/content/application~1json/examples/unsupportedMediaType"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1filter/post/responses/415/content/application~1json/examples/unsupportedMediaType"]}}},{"code":"500","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1filter/post/responses/500/content/application~1json/examples/internalServerError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1filter/post/responses/500/content/application~1json/examples/internalServerError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/paymentsv2/searchpaymentsv2"}],"panels":[]}]},"httpPath":"/v3/payments/filter"},{"label":"Create payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/paymentsv2/createpaymentv2","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/paymentsv2/createpaymentv2","metadata":{"seo":{"title":"Create payment","description":"Initiates a new cross-border payment. Payments are processed asynchronously. Use Get a payment by ID to poll for status updates, or Get state transitions to view the full status history."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPaymentV2","name":"Create payment","isWebhook":false,"pointer":"/paths/~1v3~1payments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create payment","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 new cross-border payment. Payments are processed asynchronously. Use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a payment by ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to poll for status updates, or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get state transitions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view the full status history."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentRequestV2"}},"schemaId":"components/schemas/PaymentRequestV2","pointer":"/paths/~1v3~1payments/post/requestBody","description":"create payment request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/payments","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentRequestV2"}},"responseCodes":["201","400","402","403","415","500"],"pointer":"/v3/payments","href":"paymentsv2/createpaymentv2","openApiOperationId":"createPaymentV2","summary":"Create payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"schemaId":"components/schemas/PaymentRequestV2","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentRequestV2"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Valid payment","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentV2"}},"schemaId":"components/schemas/PaymentV2"},{"code":"400","description":"Invalid input variables for the payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments/post/responses/400/content/application~1json/examples/invalidRequestBody"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments/post/responses/400/content/application~1json/examples/invalidRequestBody"]},{"code":"402","description":"Problems related to payment limits.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/402/content/application~1json/examples/insufficientBalance"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/402/content/application~1json/examples/insufficientBalance"]},{"code":"403","description":"The payment already exists and belongs to a different tenant.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/403/content/application~1json/examples/forbidden"]},{"code":"415","description":"Missing or unsupported Content-Type header.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/415/content/application~1json/examples/unsupportedMediaType"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/415/content/application~1json/examples/unsupportedMediaType"]},{"code":"500","description":"Internal processing error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/500/content/application~1json/examples/internalServerError"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/500/content/application~1json/examples/internalServerError"]}],"pointer":"/paths/~1v3~1payments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/PaymentV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentV2"}}},{"code":"400","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments/post/responses/400/content/application~1json/examples/invalidRequestBody"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments/post/responses/400/content/application~1json/examples/invalidRequestBody"]}}},{"code":"402","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/402/content/application~1json/examples/insufficientBalance"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/402/content/application~1json/examples/insufficientBalance"]}}},{"code":"403","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"415","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/415/content/application~1json/examples/unsupportedMediaType"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/415/content/application~1json/examples/unsupportedMediaType"]}}},{"code":"500","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/500/content/application~1json/examples/internalServerError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments/post/responses/500/content/application~1json/examples/internalServerError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/paymentsv2/createpaymentv2"}],"panels":[]}]},"httpPath":"/v3/payments"},{"label":"Get a payment by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/paymentsv2/getpaymentbyidv2","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/paymentsv2/getpaymentbyidv2","metadata":{"seo":{"title":"Get a payment by ID","description":"Returns the current status and full details of a payment, including amounts, beneficiary information, and the associated quote."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentByIdV2","name":"Get a payment by ID","isWebhook":false,"pointer":"/paths/~1v3~1payments~1{paymentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a payment by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the current status and full details of a payment, including amounts, beneficiary information, and the associated quote."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentId","in":"path","schemaId":"schema_9","description":"Unique identifier of the payment to get.","required":true,"example":"7ea3399c-1234-5678-8d8f-d320ea406630"}],"pointer":"/paths/~1v3~1payments~1{paymentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/payments/{paymentId}","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[{"name":"paymentId","in":"path","required":true,"example":"7ea3399c-1234-5678-8d8f-d320ea406630","schemaId":"schema_9"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v3/payments/{paymentId}","href":"paymentsv2/getpaymentbyidv2","openApiOperationId":"getPaymentByIdV2","summary":"Get a payment by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully fetched payment details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentWithDetailsV2"}},"schemaId":"components/schemas/PaymentWithDetailsV2"},{"code":"400","description":"Invalid input variables for the payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}/get/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1{paymentId}/get/responses/400/content/application~1json/examples/invalidRequestBody"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}/get/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1{paymentId}/get/responses/400/content/application~1json/examples/invalidRequestBody"]},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}/get/responses/404/content/application~1json/examples/resourceNotFound"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}/get/responses/404/content/application~1json/examples/resourceNotFound"]},{"code":"500","description":"Internal processing error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}/get/responses/500/content/application~1json/examples/internalServerError"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}/get/responses/500/content/application~1json/examples/internalServerError"]}],"pointer":"/paths/~1v3~1payments~1{paymentId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentWithDetailsV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentWithDetailsV2"}}},{"code":"400","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}/get/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1{paymentId}/get/responses/400/content/application~1json/examples/invalidRequestBody"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}/get/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1{paymentId}/get/responses/400/content/application~1json/examples/invalidRequestBody"]}}},{"code":"404","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}/get/responses/404/content/application~1json/examples/resourceNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}/get/responses/404/content/application~1json/examples/resourceNotFound"]}}},{"code":"500","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}/get/responses/500/content/application~1json/examples/internalServerError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}/get/responses/500/content/application~1json/examples/internalServerError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/paymentsv2/getpaymentbyidv2"}],"panels":[]}]},"httpPath":"/v3/payments/{paymentId}"},{"label":"Get state transitions by payment ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/paymentsv2/getpaymentstatetransitionsbyidv2","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/paymentsv2/getpaymentstatetransitionsbyidv2","metadata":{"seo":{"title":"Get state transitions by payment ID","description":"Returns the complete state transition history for a payment, including each status change and its timestamp. Use this to audit payment progress or debug processing issues."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentStateTransitionsByIdV2","name":"Get state transitions by payment ID","isWebhook":false,"pointer":"/paths/~1v3~1payments~1{paymentId}~1states/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get state transitions by payment ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the complete state transition history for a payment, including each status change and its timestamp. Use this to audit payment progress or debug processing issues."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentId","in":"path","schemaId":"schema_9","description":"Unique identifier of the payment for which you want to get state transition information.","required":true,"example":"7ea3399c-1234-5678-8d8f-d320ea406630"}],"pointer":"/paths/~1v3~1payments~1{paymentId}~1states/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/payments/{paymentId}/states","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[{"name":"paymentId","in":"path","required":true,"example":"7ea3399c-1234-5678-8d8f-d320ea406630","schemaId":"schema_9"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v3/payments/{paymentId}/states","href":"paymentsv2/getpaymentstatetransitionsbyidv2","openApiOperationId":"getPaymentStateTransitionsByIdV2","summary":"Get state transitions by payment ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully fetched payment state transitions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StateTransitionsResponseV2"}},"schemaId":"components/schemas/StateTransitionsResponseV2"},{"code":"400","description":"Invalid input variables for the payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1states/get/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1{paymentId}~1states/get/responses/400/content/application~1json/examples/invalidRequestBody"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1states/get/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1{paymentId}~1states/get/responses/400/content/application~1json/examples/invalidRequestBody"]},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1states/get/responses/404/content/application~1json/examples/resourceNotFound"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1states/get/responses/404/content/application~1json/examples/resourceNotFound"]},{"code":"500","description":"Internal processing error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1states/get/responses/500/content/application~1json/examples/internalServerError"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1states/get/responses/500/content/application~1json/examples/internalServerError"]}],"pointer":"/paths/~1v3~1payments~1{paymentId}~1states/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StateTransitionsResponseV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StateTransitionsResponseV2"}}},{"code":"400","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1states/get/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1{paymentId}~1states/get/responses/400/content/application~1json/examples/invalidRequestBody"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1states/get/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1{paymentId}~1states/get/responses/400/content/application~1json/examples/invalidRequestBody"]}}},{"code":"404","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1states/get/responses/404/content/application~1json/examples/resourceNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1states/get/responses/404/content/application~1json/examples/resourceNotFound"]}}},{"code":"500","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1states/get/responses/500/content/application~1json/examples/internalServerError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1states/get/responses/500/content/application~1json/examples/internalServerError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/paymentsv2/getpaymentstatetransitionsbyidv2"}],"panels":[]}]},"httpPath":"/v3/payments/{paymentId}/states"},{"label":"Update payment labels","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/paymentsv2/updatepaymentlabelsv2","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/paymentsv2/updatepaymentlabelsv2","metadata":{"seo":{"title":"Update payment labels","description":"Add or remove labels for grouping and categorizing payments (e.g., campaign IDs, workflow tags, or batch identifiers). Labels are optional and mutable; they can be added or removed over the payment's lifetime."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePaymentLabelsV2","name":"Update payment labels","isWebhook":false,"pointer":"/paths/~1v3~1payments~1{paymentId}~1labels/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update payment labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add or remove labels for grouping and categorizing payments (e.g., campaign IDs, workflow tags, or batch identifiers). Labels are optional and mutable; they can be added or removed over the payment's lifetime."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentId","in":"path","schemaId":"schema_9","description":"The unique ID that identifies the payment for which you want to update labels.","required":true,"example":"7ea3399c-1234-5678-8d8f-d320ea406630"}],"pointer":"/paths/~1v3~1payments~1{paymentId}~1labels/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePaymentLabelsRequest"}},"schemaId":"components/schemas/UpdatePaymentLabelsRequest","pointer":"/paths/~1v3~1payments~1{paymentId}~1labels/patch/requestBody","description":"Labels to add to or remove from the payment."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/payments/{paymentId}/labels","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[{"name":"paymentId","in":"path","required":true,"example":"7ea3399c-1234-5678-8d8f-d320ea406630","schemaId":"schema_9"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePaymentLabelsRequest"}},"responseCodes":["200","400","404","415","500"],"pointer":"/v3/payments/{paymentId}/labels","href":"paymentsv2/updatepaymentlabelsv2","openApiOperationId":"updatePaymentLabelsV2","summary":"Update payment labels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"schemaId":"components/schemas/UpdatePaymentLabelsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePaymentLabelsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the payment labels.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdatePaymentLabelsResponse"}},"schemaId":"components/schemas/UpdatePaymentLabelsResponse"},{"code":"400","description":"Invalid input variables for the request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/400/content/application~1json/examples/invalidRequestBody"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/400/content/application~1json/examples/invalidRequestBody"]},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/404/content/application~1json/examples/resourceNotFound"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/404/content/application~1json/examples/resourceNotFound"]},{"code":"415","description":"Missing or unsupported Content-Type header.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/415/content/application~1json/examples/unsupportedMediaType"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/415/content/application~1json/examples/unsupportedMediaType"]},{"code":"500","description":"Internal processing error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/500/content/application~1json/examples/internalServerError"]}},"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/500/content/application~1json/examples/internalServerError"]}],"pointer":"/paths/~1v3~1payments~1{paymentId}~1labels/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdatePaymentLabelsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdatePaymentLabelsResponse"}}},{"code":"400","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/400/content/application~1json/examples/invalidRequestBody"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/400/content/application~1json/examples/badRequest","paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/400/content/application~1json/examples/invalidRequestBody"]}}},{"code":"404","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/404/content/application~1json/examples/resourceNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/404/content/application~1json/examples/resourceNotFound"]}}},{"code":"415","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/415/content/application~1json/examples/unsupportedMediaType"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/415/content/application~1json/examples/unsupportedMediaType"]}}},{"code":"500","schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/500/content/application~1json/examples/internalServerError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentErrorResponse","exampleIds":["paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/500/content/application~1json/examples/internalServerError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/paymentsv2/updatepaymentlabelsv2"}],"panels":[]}]},"httpPath":"/v3/payments/{paymentId}/labels"}],"content":{"contentType":"group","meta":{"name":"PaymentsV2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payments","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 API operations to manage your payments with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Management v3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (recommended for all new integrations)."},"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":"Operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"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":"link","inline":true,"attributes":{"href":"#operation/searchPaymentsV2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search payments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search for payments based on filtering criteria."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/createPaymentV2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a payment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a payment by accepting a quote."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getPaymentByIdV2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get payment by payment ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a specific payment by payment ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getPaymentStateTransitionsByIdV2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get state transitions by payment ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the state transitions for a specific payment by payment ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/updatePaymentLabelsV2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update payment labels"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PATCH"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the labels for a specific payment by payment ID."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/payments/filter","summary":"Search payments","prefix":{"name":"post","color":"post"},"badges":[],"link":"/paymentsv2/searchpaymentsv2","deprecated":false},{"title":"/v3/payments","summary":"Create payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/paymentsv2/createpaymentv2","deprecated":false},{"title":"/v3/payments/{paymentId}","summary":"Get a payment by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/paymentsv2/getpaymentbyidv2","deprecated":false},{"title":"/v3/payments/{paymentId}/states","summary":"Get state transitions by payment ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/paymentsv2/getpaymentstatetransitionsbyidv2","deprecated":false},{"title":"/v3/payments/{paymentId}/labels","summary":"Update payment labels","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/paymentsv2/updatepaymentlabelsv2","deprecated":false}]}]}]}]}},{"type":"group","label":"Ledger","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/ledger-public","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/ledger-public","items":[{"label":"Get available balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/ledger-public/getbalances","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/ledger-public/getbalances","metadata":{"seo":{"title":"Get available balances","description":"Get available balances"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBalances","name":"Get available balances","isWebhook":false,"pointer":"/paths/~1v2~1balances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get available balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currency","in":"query","schemaId":"schema_2","description":"The currency for which you want to get the balance."}],"pointer":"/paths/~1v2~1balances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/balances","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"currency","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/balances","href":"ledger-public/getbalances","openApiOperationId":"getBalances","summary":"Get available balances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"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 containing balance details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10"}},"schemaId":"schema_10"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}},"schemaId":"schema_11"},{"code":"401","description":"Unauthorized access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}},"schemaId":"schema_11"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}},"schemaId":"schema_11"}],"pointer":"/paths/~1v2~1balances/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_10","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10"}}},{"code":"400","schemaId":"schema_11","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}}},{"code":"401","schemaId":"schema_11","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}}},{"code":"500","schemaId":"schema_11","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ledger-public/getbalances"}],"panels":[]}]},"httpPath":"/v2/balances"},{"label":"Get ledger transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/ledger-public/getstatementstransactionsforcustomer","routeSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api/ledger-public/getstatementstransactionsforcustomer","metadata":{"seo":{"title":"Get ledger transactions","description":"Retrieve a paginated list of ledger transactions within a specified date and time range. This endpoint returns detailed transaction data, including amounts, references, operations, and running balances."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStatementsTransactionsForCustomer","name":"Get ledger transactions","isWebhook":false,"pointer":"/paths/~1v2~1ledger-transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get ledger transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a paginated list of ledger transactions within a specified date and time range. This endpoint returns detailed transaction data, including amounts, references, operations, and running balances."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currency","in":"query","schemaId":"schema_2","description":"Three-letter ISO 4217 currency code for the transactions to return (for example, USD).","required":true,"example":"USD"},{"name":"start-dttm","in":"query","schemaId":"schema_12","description":"Start of the date and time range (inclusive), in UTC, for which you want to retrieve ledger transactions.","required":true,"example":"2022-02-27T08:30:00Z"},{"name":"end-dttm","in":"query","schemaId":"schema_12","description":"End of the date and time range (exclusive), in UTC, for which you want to retrieve ledger transactions.","required":true,"example":"2022-02-27T08:30:00Z"},{"name":"status","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter results by transaction status. Allowed values:"},"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":"SUCCESS: the ledger transaction completed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING: reserved for future use to represent an in-flight ledger transaction."},"children":[]}]}]}]}]},{"name":"txnReference","in":"query","schemaId":"schema_2","description":"Filter results by an exact transaction reference. Use this to locate all ledger transactions associated with a specific external reference."},{"name":"page-size","in":"query","schemaId":"schema_13","description":"Number of records to return in the response page. Use page-size together with offset for offset-based pagination","required":true},{"name":"offset","in":"query","schemaId":"schema_14","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of records to skip before starting to return results. Use this with page-size to implement offset-based pagination."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset=25&page-size=25"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns the second page of results."},"children":[]}]}]}]},{"name":"sort-key","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to use for sorting the results. Allowed values include:"},"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":"CREATED_AT: sort by transaction creation timestamp."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STATEMENT_OPERATION: sort by the operation type (for example, CREDIT, DEBIT)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STATEMENT_SOURCE: sort by the transaction source (for example, PAYMENTS, BANK)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STATEMENT_STATUS: sort by the ledger transaction status."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STATEMENT_TXN_REFERENCE: sort by the transaction reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STATEMENT_UPDATED_AT: sort by the last update timestamp."},"children":[]}]}]}]}]},{"name":"sort-direction","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort direction. Allowed values:"},"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":"ASC: ascending order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC: descending order."},"children":[]}]}]}]}]}],"pointer":"/paths/~1v2~1ledger-transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/ledger-transactions","servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"currency","in":"query","required":true,"example":"USD","schemaId":"schema_2"},{"name":"start-dttm","in":"query","required":true,"example":"2022-02-27T08:30:00Z","schemaId":"schema_12"},{"name":"end-dttm","in":"query","required":true,"example":"2022-02-27T08:30:00Z","schemaId":"schema_12"},{"name":"status","in":"query","required":false,"schemaId":"schema_2"},{"name":"txnReference","in":"query","required":false,"schemaId":"schema_2"},{"name":"page-size","in":"query","required":true,"schemaId":"schema_13"},{"name":"offset","in":"query","required":false,"schemaId":"schema_14"},{"name":"sort-key","in":"query","required":false,"schemaId":"schema_2"},{"name":"sort-direction","in":"query","required":false,"schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/ledger-transactions","href":"ledger-public/getstatementstransactionsforcustomer","openApiOperationId":"getStatementsTransactionsForCustomer","summary":"Get ledger transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","description":"Mock server","isMockServer":true},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A page of ledger statement transactions for the customer that match the specified query parameters.","mediaType":"application/json","mediaTypes":["application/json","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15"},"text/csv":{"schemaId":"schema_16","exampleIds":["paths/~1v2~1ledger-transactions/get/responses/200/content/text~1csv/example"]}},"schemaId":"schema_15"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}},"schemaId":"schema_11"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}},"schemaId":"schema_11"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}},"schemaId":"schema_11"}],"pointer":"/paths/~1v2~1ledger-transactions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_15","mediaTypes":["application/json","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15"},"text/csv":{"schemaId":"schema_16","exampleIds":["paths/~1v2~1ledger-transactions/get/responses/200/content/text~1csv/example"]}}},{"code":"400","schemaId":"schema_11","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}}},{"code":"401","schemaId":"schema_11","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}}},{"code":"500","schemaId":"schema_11","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ledger-public/getstatementstransactionsforcustomer"}],"panels":[]}]},"httpPath":"/v2/ledger-transactions"}],"content":{"contentType":"group","meta":{"name":"ledger-public"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ledger","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 API operation to fetch ledger transactions and check balances."},"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":"Operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"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":"link","inline":true,"attributes":{"href":"#operation/getBalances"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get balances"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View your existing balances"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getStatementsTransactionsForCustomer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get ledger transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View your ledger transactions."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/balances","summary":"Get available balances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ledger-public/getbalances","deprecated":false},{"title":"/v2/ledger-transactions","summary":"Get ledger transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ledger-public/getstatementstransactionsforcustomer","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AuthenticationRequest":{"id":"components/schemas/AuthenticationRequest","kind":"json-schema","title":"AuthenticationRequest","data":{"description":"The authentication request.","properties":{"client_id":{"type":"string","description":"The client ID associated with a specific set of API credentials.","example":"{YOUR_CLIENT_ID}"},"client_secret":{"type":"string","description":"The client secret associated with a specific set of API credentials.","example":"{YOUR_CLIENT_SECRET}"},"audience":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audience"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is based on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Uniform_Resource_Name"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" syntax."},"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":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urn:ripplexcurrent-{ENVIRONMENT_STRING}:{YOUR_TENANT_ID}"},"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":"The first component is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urn:ripplexcurrent-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The second component refers to the environment you want to access."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The third component is your tenant ID. Ripple integration engineers provide this component during training."},"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":"Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment string"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"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":"UAT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uat"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UAT environment with simulated partners and simulated currency."},"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":"Production"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prod"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production environment for Ripple's internal services."},"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":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"urn:ripplexcurrent-uat:{YOUR_TENANT_ID}"},"children":[]}]}]}],"example":"urn:ripplexcurrent-uat:{YOUR_TENANT_ID}"},"grant_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the grant-type for this client credentials request. This must be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["client_credentials"],"example":"client_credentials"}},"required":["client_id","client_secret","audience","grant_type"],"type":"object"}},"components/schemas/AuthenticationResponse":{"id":"components/schemas/AuthenticationResponse","kind":"json-schema","title":"AuthenticationResponse","data":{"description":"The authentication response object that includes the token, type, scopes, and expiry.","properties":{"access_token":{"type":"string","description":"The bearer token you use when authenticating with a Ripple API.","example":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ"},"scope":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of scopes applied to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"pos:payments:create quote_collection:quote:create quote:quote:read pos:payments:read pcs_config:external_read data_requirements:read identities:create identities:read identities:write ledger:balance:read ledger:read"},"expires_in":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How long your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid. You need to request a new token when it expires."},"children":[]}]}]}],"example":3600},"token_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of token. Ripple APIs use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" auth tokens."},"children":[]}]}]}],"example":"Bearer"}},"type":"object"}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"description":"The response object containing the error and its description if the authentication call fails.","properties":{"error_description":{"type":"string","description":"Summary of the returned problem.","example":"Unauthorized"},"error":{"type":"string","description":"Error status.","example":"access_denied"}}}},"components/schemas/ValidateTokenResponse":{"id":"components/schemas/ValidateTokenResponse","kind":"json-schema","title":"ValidateTokenResponse","data":{"description":"The response object indicating a token's validity and the time remaining on it","properties":{"message":{"type":"string","example":"token_ok"},"seconds_to_expiry":{"type":"integer","format":"int64","description":"Remaining time in seconds before the tested token expires.","example":3600}}}},"components/schemas/PaymentErrorResponse":{"id":"components/schemas/PaymentErrorResponse","kind":"json-schema","title":"PaymentErrorResponse","data":{"type":"object","required":["status","errors"],"properties":{"errors":{"description":"List of payment errors","type":"array","items":{"$ref":"#/components/schemas/PaymentError"}},"status":{"type":"integer","description":"Error Response Status","example":400}}}},"components/schemas/PaymentError":{"id":"components/schemas/PaymentError","kind":"json-schema","title":"PaymentError","data":{"type":"object","required":["code","title","type","description","timestamp"],"properties":{"code":{"type":"string","description":"A unique identifier for  the error","example":"SYS_090"},"type":{"type":"string","description":"A high-level categorization of the error, indicating the type of issue that occurred","example":"SYSTEM_ERROR"},"title":{"type":"string","description":"A brief, user-friendly description of the error","example":"Internal server error"},"description":{"type":"string","description":"A more detailed explanation of the error, potentially including information about what caused the error and the next steps","example":"Unable to process the request due to an internal server error."},"timestamp":{"type":"string","format":"date-time","example":"2024-11-21T14:15:22Z"}}}},"components/schemas/PaymentV2":{"id":"components/schemas/PaymentV2","kind":"json-schema","title":"PaymentV2","data":{"type":"object","required":["paymentId","paymentState"],"properties":{"paymentId":{"description":"The unique ID that identifies this payment. This value is the same as the quote ID.","type":"string","format":"uuid","maxLength":36,"example":"7ea3399c-1234-5678-8d8f-d320ea406630"},"cryptoTransactionHash":{"description":"Transaction hash of the crypto payment on the destination blockchain network","type":"string","example":"0x2b1f8b57dd6008143ff926ea9d9cd2365774cd0c5e6f379558a88c61c52071eb"},"initiatedAt":{"description":"The time at which the payment was initiated, specified in UTC.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z"},"expiresAt":{"description":"The time at which this payment expires, specified in UTC.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z"},"jitFundingExpiresAt":{"description":"The time at which JIT funding for this payment expires, specified in UTC.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z"},"lastStateUpdatedAt":{"description":"The time at which the payment state was last updated for this payment, specified in UTC.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z"},"paymentState":{"$ref":"#/components/schemas/PaymentStateV2"},"originator":{"$ref":"#/components/schemas/OriginatorV2"},"destination":{"$ref":"#/components/schemas/DestinationV2"},"adjustedExchangeRate":{"$ref":"#/components/schemas/AdjustedExchangeRate"},"fees":{"type":"array","description":"A summary of fees included in the payment quote.","items":{"$ref":"#/components/schemas/FeeSummary"}},"taxes":{"type":"array","description":"A summary of taxes included in the payment quote.","items":{"$ref":"#/components/schemas/TaxSummary"}},"sourceOfCash":{"description":"Source of Cash may be required depending on corridor and payout partner. Valid Source of Cash values vary by corridor.","type":"string","example":"EMIN"},"purposeCode":{"description":"Purpose Code may be required depending on corridor and payout partner. Valid Purpose Code values vary by corridor.","type":"string","example":"PAYR"},"transactionDetails":{"$ref":"#/components/schemas/TransactionDetailsV2"},"paymentLabels":{"$ref":"#/components/schemas/PaymentLabels"},"receiverRelationship":{"description":"The relationship to the debtor.","type":"string","example":"SUBS"},"paymentMemo":{"$ref":"#/components/schemas/PaymentMemo"}}}},"components/schemas/PaymentWithDetailsV2":{"id":"components/schemas/PaymentWithDetailsV2","kind":"json-schema","title":"PaymentWithDetailsV2","data":{"type":"object","required":["paymentId","paymentState"],"properties":{"paymentId":{"description":"The unique ID that identifies this payment. This value is the same as the quote ID.","type":"string","format":"uuid","maxLength":36,"example":"7ea3399c-1234-5678-8d8f-d320ea406630"},"cryptoTransactionHash":{"description":"Transaction hash of the crypto payment on the destination blockchain network","type":"string","example":"0x2b1f8b57dd6008143ff926ea9d9cd2365774cd0c5e6f379558a88c61c52071eb"},"initiatedAt":{"description":"The time at which the payment was initiated, specified in UTC.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z"},"expiresAt":{"description":"The time at which this payment expires, specified in UTC.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z"},"jitFundingExpiresAt":{"description":"The time at which JIT funding for this payment expires, specified in UTC.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z"},"lastStateUpdatedAt":{"description":"The time at which the payment state was last updated for this payment, specified in UTC.","type":"string","format":"date-time","example":"2019-08-24T14:15:22Z"},"paymentState":{"$ref":"#/components/schemas/PaymentStateV2"},"originator":{"$ref":"#/components/schemas/OriginatorV2"},"destination":{"$ref":"#/components/schemas/DestinationV2"},"adjustedExchangeRate":{"$ref":"#/components/schemas/AdjustedExchangeRate"},"fees":{"type":"array","description":"A summary of fees included in payment quote.","items":{"$ref":"#/components/schemas/FeeSummary"}},"taxes":{"type":"array","description":"A summary of taxes included in the payment quote.","items":{"$ref":"#/components/schemas/TaxSummary"}},"sourceOfCash":{"description":"Source of Cash may be required depending on corridor and payout partner. Valid Source of Cash values vary by corridor.","type":"string","example":"EMIN"},"purposeCode":{"description":"Purpose Code may be required depending on corridor and payout partner. Valid Purpose Code values vary by corridor.","type":"string","example":"PAYR"},"transactionDetails":{"$ref":"#/components/schemas/TransactionDetailsV2"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/PaymentError"}},"paymentLabels":{"$ref":"#/components/schemas/PaymentLabels"},"receiverRelationship":{"description":"The relationship to the debtor.","type":"string","example":"SUBS"},"paymentMemo":{"$ref":"#/components/schemas/PaymentMemo"},"payoutExecutionDetails":{"$ref":"#/components/schemas/PayoutExecutionDetails"}}}},"components/schemas/StateTransitionsResponseV2":{"id":"components/schemas/StateTransitionsResponseV2","kind":"json-schema","title":"StateTransitionsResponseV2","data":{"type":"object","properties":{"stateTransitions":{"type":"array","items":{"$ref":"#/components/schemas/StateTransitionV2"}}},"required":["stateTransitions"]}},"components/schemas/StateTransitionV2":{"id":"components/schemas/StateTransitionV2","kind":"json-schema","title":"StateTransitionV2","data":{"type":"object","properties":{"updatedFrom":{"$ref":"#/components/schemas/PaymentStateV2","description":"The initial payment state before it was updated.","example":"INITIATED"},"updatedTo":{"$ref":"#/components/schemas/PaymentStateV2","description":"The payment state after it was updated.","example":"VALIDATING"},"updatedAt":{"type":"string","format":"date-time","description":"The timestamp when the payment state was updated.","example":"2024-08-13T20:15:50.990995Z"}},"required":["updatedFrom","updatedTo","updatedAt"]}},"components/schemas/PaymentsResponseV2":{"id":"components/schemas/PaymentsResponseV2","kind":"json-schema","title":"PaymentsResponseV2","data":{"type":"object","properties":{"data":{"description":"Array of Payment objects","type":"array","items":{"$ref":"#/components/schemas/PaymentV2"}},"filter":{"$ref":"#/components/schemas/PaymentFilterV2"},"sort":{"$ref":"#/components/schemas/SortV2"},"page":{"$ref":"#/components/schemas/Page"}}}},"components/schemas/PaymentRequestV2":{"id":"components/schemas/PaymentRequestV2","kind":"json-schema","title":"PaymentRequestV2","data":{"type":"object","required":["quoteId","beneficiaryIdentityId","beneficiaryFinancialInstrumentId"],"properties":{"quoteId":{"description":"ID of the quote you want to accept to initiate this payment. Must be in UUID format. This will be used as paymentId.","type":"string","format":"uuid","example":"7ea3399c-1234-5678-8d8f-d320ea406630"},"originatorIdentityId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identity ID of the payment originator. You can find the identity ID using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /identities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}],"type":"string","example":"c1e92b47-4579-4a7e-9c9a-02f3e3e4bb11"},"beneficiaryIdentityId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identity ID of the payment beneficiary. You can find the identity ID using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /identities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}],"type":"string","example":"99254c4f-f207-4792-a846-06928825018c"},"internalId":{"maxLength":36,"description":"Customer defined value, such as an invoice number.","type":"string","example":"Invoice-123"},"purposeCode":{"description":"Purpose Code may be required depending on corridor and payout partner. Valid Purpose Code values vary by corridor.","type":"string","example":"PAYR"},"sourceOfCash":{"description":"Source of Cash may be required depending on corridor and payout partner. Valid Source of Cash values vary by corridor.","type":"string","example":"EMIN"},"paymentLabels":{"$ref":"#/components/schemas/PaymentLabels"},"beneficiaryFinancialInstrumentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The financial instrument ID associated with a payment beneficiary's identity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value must reference a financial instrument created for the same beneficiary identity using Identity Management v3. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"financialInstrumentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned when you create or fetch the beneficiary's payout instrument."},"children":[]}]}]}],"type":"string","example":"0e0d7b5a-7f2b-4c75-9bb9-8c4d0ff5f2a1"},"receiverRelationship":{"description":"The relationship to the debtor.","type":"string","example":"SUBS"},"paymentMemo":{"$ref":"#/components/schemas/PaymentMemo"}}}},"components/schemas/PaymentStateV2":{"id":"components/schemas/PaymentStateV2","kind":"json-schema","title":"PaymentStateV2","data":{"type":"string","example":"INITIATED","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current state of a payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment lifecycle currently uses the following values:"},"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":"QUOTED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INITIATED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VALIDATING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFERRING"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DECLINED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_FUNDING"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional states may be introduced in the future without breaking existing integrations."},"children":[]}]}]}],"x-enumDescriptions":{"QUOTED":"A quote has been created, but the payment has not yet been initiated.","INITIATED":"The payment has been submitted and is awaiting validation.","VALIDATING":"Ripple is validating the payment details and reserving funds from the originator's available balance.","TRANSFERRING":"The payment is being processed and funds are moving through the network toward the beneficiary.","COMPLETED":"The payment has completed and the beneficiary has received the funds.","FAILED":"The payment could not be completed. The failure reason, if available, is listed in the response. Funds that were previously reserved to complete the payment are released and added back to the available balance.","RETURNED":"The payment was returned by a downstream institution. The return reason, if available, is listed in the response. Funds that were previously reserved and debited to complete the payment are returned and added back to the available balance.","DECLINED":"The payment was declined due to user input errors or business rule violations. The decline reason, if available, is listed in the response. Funds that were previously reserved to complete the payment are released and added back to the available balance.","AWAITING_FUNDING":"The payment is waiting for funds to be transferred to your Ripple ledger account. This state applies only to just-in-time (JIT) funded payments."}}},"components/schemas/PaymentSortFieldV2":{"id":"components/schemas/PaymentSortFieldV2","kind":"json-schema","title":"PaymentSortFieldV2","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field to use when sorting payments in the requested sort order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently supported values include:"},"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":"internalId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentState"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceCurrency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destinationCurrency"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destinationCountry"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destinationAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initiatedAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiresAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastStateUpdatedAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentLabel"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an unsupported value is provided, the request fails with a validation error."},"children":[]}]}]}],"default":"initiatedAt","example":"initiatedAt","x-enumDescriptions":{"internalId":"Internal identifier of a payment","paymentState":"Current state of a payment","sourceCurrency":"Source currency of a payment","sourceAmount":"Source amount of a payment","destinationCurrency":"Destination currency of a payment","destinationCountry":"Destination country of a payment","destinationAmount":"Destination amount of a payment","initiatedAt":"Timestamp when a payment was initiated","expiresAt":"Timestamp when a payment will expire","lastStateUpdatedAt":"Timestamp when a payment state was last updated","paymentLabel":"Label associated with a payment"}}},"components/schemas/OriginatorV2":{"id":"components/schemas/OriginatorV2","kind":"json-schema","title":"OriginatorV2","data":{"type":"object","description":"Payment originator and source details.","properties":{"originatorIdentityId":{"description":"The unique ID associated with the payment originator's identity record.","type":"string","example":"c1e92b47-4579-4a7e-9c9a-02f3e3e4bb11"},"originatorIdentityIdVersion":{"description":"The current version of the originator's identity record.","type":"integer","example":1},"originatorIdentityNickName":{"description":"The originator's nickname at the identity version this payment references. Editing the nickname later does not change the value returned for this payment.","type":"string","maxLength":256,"example":"Successful Business Sender"},"internalId":{"description":"An ID associated with this payment, if provided by the customer during payment initiation.","type":"string","maxLength":36,"example":"Invoice-123"},"sourceCurrency":{"description":"originator's currency","type":"string","pattern":"^[A-Z]{3,5}$","maxLength":5,"example":"USD"},"sourceAmount":{"description":"The amount sent by the originator in this payment. This field can hold a value with up to 6 decimal places.","type":"number","format":"double","example":100},"payin":{"description":"Details about how this payment is funded.","type":"string","example":"FUNDED"}}}},"components/schemas/DestinationV2":{"id":"components/schemas/DestinationV2","kind":"json-schema","title":"DestinationV2","data":{"type":"object","properties":{"beneficiaryFinancialInstrumentId":{"description":"The financial instrument ID, the identity ID of the payment beneficiary is related to.","type":"string","example":"0e0d7b5a-7f2b-4c75-9bb9-8c4d0ff5f2a1"},"destinationAmount":{"description":"The amount received by the payment beneficiary. This field can hold a value with up to 6 decimal places.","type":"number","format":"double","example":1234.111223},"destinationCountry":{"description":"The country where the beneficiary is located specified in Alpha-2 Code format as defined in the ISO CountryCode ISO 3166-1 list. If the beneficiary is an individual, then this value is their country of residence. If the beneficiary is an institution, then this value is their the country of incorporation.","type":"string","pattern":"^[A-Z]{2}$","maxLength":2,"example":"US"},"destinationCurrency":{"description":"The currency code of the currency in which the beneficiary will receive this payment.","type":"string","pattern":"^[A-Z]{3,5}$","maxLength":5,"example":"USD"},"destinationBlockchainNetwork":{"description":"The name of the blockchain network on which the beneficiary will receive this payment.","type":"string","minLength":1,"maxLength":20,"example":"Ethereum, TRON"},"beneficiaryIdentityId":{"description":"The unique ID associated with the payment beneficiary's identity record.","type":"string","example":"99254c4f-f207-4792-a846-06928825018c"},"beneficiaryIdentityVersion":{"description":"The current version of the beneficiary's identity record.","type":"integer","example":1},"beneficiaryIdentityNickName":{"description":"The beneficiary's nickname at the identity version this payment references. Editing the nickname later does not change the value returned for this payment.","type":"string","maxLength":256,"example":"Successful business beneficiary"},"payout":{"description":"The payout category for this payment.","type":"string","example":"BANK"},"selectedPaymentRail":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment rail the customer selected when accepting the quote for this payment. Reflects the intended routing at the time of quote acceptance. For the rail confirmed by the payout partner at execution time, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutExecutionDetails.paymentRailUsed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". These values may differ if the payout partner executed on an alternate rail."},"children":[]}]}]}],"type":"string","example":"XRP_LEDGER"}}}},"components/schemas/TransactionDetailsV2":{"id":"components/schemas/TransactionDetailsV2","kind":"json-schema","title":"TransactionDetailsV2","data":{"type":"object","description":"A summary of the payment category.","properties":{"paymentProduct":{"description":"The Ripple payments product used to make this payment.","type":"string","nullable":true,"x-enumDescriptions":{"LICENSED":"Identifies a transaction using Ripple Payments Direct."}},"flowType":{"description":"Specifies the type of payment you're making as categorized by the identity type of the payment originator and beneficiary.","type":"string","nullable":true,"x-enumDescriptions":{"B2B":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies that this payment is made by a business originator to a business beneficiary."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of third-party payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thirdPartyPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it indicates that you're making this payment on behalf of a business originator."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thirdPartyPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it indicates that you are the business originator making this payment."},"children":[]}]}]}]}],"B2C":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies that this payment is made by a business originator to an individual beneficiary."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification of third-party payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thirdPartyPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it indicates that you're making this payment on behalf of a business originator."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thirdPartyPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it indicates that you are the business originator making this payment."},"children":[]}]}]}]}]}},"thirdPartyPayment":{"description":"Flag to indicate if this payment is initiated on behalf of a third-party originator.","nullable":true,"type":"boolean","example":false},"businessUseCase":{"description":"Indicates the type of payment you're making.","type":"string","nullable":true,"x-enumDescriptions":{"FIAT_TRANSFER":"Indicates fiat source currency to fiat destination."}}}}},"components/schemas/PayoutExecutionDetails":{"id":"components/schemas/PayoutExecutionDetails","kind":"json-schema","title":"PayoutExecutionDetails","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata about the payout execution, including the payment rail used, timing, and tracking references."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payoutExecutionDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an optional field that should be treated as informational only. Do not build required workflows that depend on its presence, as availability varies by corridor and partner."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When present, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trackingReferences"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provides network-specific identifiers useful for audit, reconciliation, or customer inquiry resolution. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"referenceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on each tracking reference to identify what a value represents rather than relying on its position in the array."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coverage will expand as additional corridors and partners are onboarded."},"children":[]}]}]}],"properties":{"paymentRailUsed":{"type":"string","description":"The payment rail or network used to execute the payout (e.g., FEDWIRE, ACH, RTP, SEPA, SWIFT).\n","example":"FEDWIRE"},"payoutStartTime":{"type":"string","format":"date-time","description":"The time at which the payout execution started, specified in UTC.\n","example":"2026-02-18T14:22:15.789Z"},"payoutEndTime":{"type":"string","format":"date-time","description":"The timestamp when the payout execution completed or was last updated, as reported by the payout partner.\nSpecified in UTC using ISO 8601 format. For in-progress payouts, this may represent the last status update time.\n","example":"2026-02-18T14:25:30.123Z"},"trackingReferences":{"type":"array","description":"A list of tracking references for this transaction, such as transaction IDs and confirmation numbers.\n","items":{"$ref":"#/components/schemas/TrackingReference"}}}}},"components/schemas/TrackingReference":{"id":"components/schemas/TrackingReference","kind":"json-schema","title":"TrackingReference","data":{"type":"object","description":"A tracking reference provided by the payout partner for this transaction.\n","properties":{"referenceType":{"type":"string","description":"The type or category of this tracking reference. Known values include IMAD and OMAD for Fedwire transfers, but additional types may be provided depending on the payment rail and payout partner.\n","example":"IMAD"},"value":{"type":"string","description":"The tracking reference value. Use this to locate the transaction with the payout partner or payment rail operator. Format varies by referenceType.","example":"TXN-RTP-20260218-456789"},"displayName":{"type":"string","description":"A human-readable name for this tracking reference, suitable for display in user interfaces.","example":"IMAD Number"},"description":{"type":"string","description":"A detailed description of what this tracking reference represents and how it can be used.","example":"Input Message Accountability Data (IMAD) for Fedwire transfer tracking"}}}},"components/schemas/Page":{"id":"components/schemas/Page","kind":"json-schema","title":"Page","data":{"type":"object","description":"Specify page size and the ID of the last fetched result.","properties":{"size":{"type":"integer","description":"Size of the page","default":20,"minimum":1,"maximum":100,"example":20},"lastPageToken":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique reference ID of the last fetched item. To retrieve subsequent item(s) if any, specify this value as the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Page.list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /payments/filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation request body."},"children":[]}]}]}]}}}},"components/schemas/SearchPaymentsRequestV2":{"id":"components/schemas/SearchPaymentsRequestV2","kind":"json-schema","title":"SearchPaymentsRequestV2","data":{"type":"object","description":"Request body containing search criteria for payments.","properties":{"filter":{"$ref":"#/components/schemas/PaymentFilterV2"},"sort":{"$ref":"#/components/schemas/SortV2"},"page":{"$ref":"#/components/schemas/Page"}}}},"components/schemas/SortV2":{"id":"components/schemas/SortV2","kind":"json-schema","title":"SortV2","data":{"type":"object","description":"Defines the sorting parameters for listing payments, including the field and sort direction.","properties":{"sortField":{"$ref":"#/components/schemas/PaymentSortFieldV2"},"sortDirection":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether results are sorted in ascending ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") order."},"children":[]}]}]}],"type":"string","default":"DESC","example":"DESC","enum":["ASC","DESC"],"x-enumDescriptions":{"ASC":"Sort results in ascending order.","DESC":"Sort results in descending order."}}}}},"components/schemas/PaymentFilterV2":{"id":"components/schemas/PaymentFilterV2","kind":"json-schema","title":"PaymentFilterV2","data":{"type":"object","description":"Filter criteria to return desired payment search results.","properties":{"paymentIds":{"description":"Specify a list of uuids to search for payment with payment ids equals one from the list","type":"array","items":{"type":"string","format":"uuid","example":"aaaaaaaa-1111-bbbb-abab-123412341234","maxLength":36}},"paymentStates":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of payment states like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/PaymentStateV2"}},"filterRangeType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify a type to filter on. For example, PAYMENT_CREATION, PAYMENT_EXPIRY, or PAYMENT_STATUS_LAST_UPDATED"},"children":[]}]}]}],"$ref":"#/components/schemas/PaymentFilterRangeTypeV2"},"beforeTimestamp":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterRangeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, this timestamp returns a list of payments that were created/modified/expired at or before the specified time."},"children":[]}]}]}],"type":"string","format":"date-time","example":"2024-04-24T14:15:22Z"},"afterTimestamp":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterRangeType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, this timestamp returns a list of payments that were created/modified/expired at or after the specified time."},"children":[]}]}]}],"type":"string","format":"date-time","example":"2024-03-24T13:15:22Z"},"beneficiaryIdentityIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get all payments made to one or more beneficiaries, specify the identity ID(s) of those beneficiaries in this field. You can find the identity ID using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /identities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}],"type":"array","items":{"type":"string","example":"aaaaaaaa-1111-bbbb-abab-123412341234"}},"internalId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get payments associated with them. A prefix match will be executed."},"children":[]}]}]}],"type":"string","maxLength":36},"beneficiaryIdentityNickname":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get all payments made to a beneficiary, specify the nickname of that beneficiary in this field. You can find the nickname using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /identities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation. The nickname is matched by the identity service, and the payments of every beneficiary it matches are returned."},"children":[]}]}]}],"type":"string","example":"Successful business beneficiary","maxLength":256},"destinationCurrencies":{"description":"Specify one or more currency codes to get payments where the beneficiary received funds in these currencies.","type":"array","items":{"type":"string"},"pattern":"^[A-Z]{3,5}$"},"paymentLabels":{"$ref":"#/components/schemas/PaymentLabels"}}}},"components/schemas/PaymentFilterRangeTypeV2":{"id":"components/schemas/PaymentFilterRangeTypeV2","kind":"json-schema","title":"PaymentFilterRangeTypeV2","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of timestamp to use when filtering payments by a date and time range."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values include:"},"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":"PAYMENT_CREATION"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_EXPIRY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_STATUS_LAST_UPDATED"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If another value is provided, the filter is rejected with a validation error."},"children":[]}]}]}],"type":"string","example":"PAYMENT_CREATION","x-enumDescriptions":{"PAYMENT_CREATION":"Filter by the time a payment was created","PAYMENT_EXPIRY":"Filter by the time a payment is scheduled to expire","PAYMENT_STATUS_LAST_UPDATED":"Filter by the time a payment state was last updated"}}},"components/schemas/PaymentLabels":{"id":"components/schemas/PaymentLabels","kind":"json-schema","title":"PaymentLabels","data":{"description":"Application-defined labels for grouping and categorizing payments (e.g., campaign IDs, workflow tags, or batch identifiers). Labels are optional and mutable; they can be added or removed over the payment's lifetime.","type":"array","maxItems":10,"items":{"type":"string","example":"batchId=aaaaaaaa-1111-bbbb-abab-123412341234","maxLength":100}}},"components/schemas/UpdatePaymentLabelsResponse":{"id":"components/schemas/UpdatePaymentLabelsResponse","kind":"json-schema","title":"UpdatePaymentLabelsResponse","data":{"type":"object","description":"Response body for modifying payment labels","required":["labels"],"properties":{"labels":{"$ref":"#/components/schemas/PaymentLabels"}}}},"components/schemas/UpdatePaymentLabelsRequest":{"id":"components/schemas/UpdatePaymentLabelsRequest","kind":"json-schema","title":"UpdatePaymentLabelsRequest","data":{"type":"object","description":"Request body containing the list of labels you want to add to or remove from the payment.","properties":{"labelsToAdd":{"$ref":"#/components/schemas/PaymentLabels"},"labelsToRemove":{"$ref":"#/components/schemas/PaymentLabels"}}}},"components/schemas/PaymentMemo":{"id":"components/schemas/PaymentMemo","kind":"json-schema","title":"PaymentMemo","data":{"type":"string","description":"Optional, transaction-specific memo carried with the payment for beneficiary reconciliation.\nValidation rules (required, allowed characters, max length) vary by corridor. Consult the data requirements for your corridor.\nNot stored in PII; persisted on the payment object and forwarded to compliance and payout partners.\nWhere possible, the memo will also be delivered to the final beneficiary's credit record, but delivery cannot be guaranteed in all cases due to payout partner or downstream constraints.\nIf omitted, Ripple may generate a memo automatically.\n","example":"ORDER 2025-09-001 PAYMENT"}},"components/schemas/AdjustedExchangeRate":{"id":"components/schemas/AdjustedExchangeRate","kind":"json-schema","title":"AdjustedExchangeRate","data":{"description":"Foreign Exchange (FX) rate used to calculate the quote.","type":"object","properties":{"adjustedRate":{"description":"Value of the Foreign Exchange (FX) rate.","type":"number","format":"double","example":2}},"additionalProperties":false}},"components/schemas/TotalFeeBreakdown":{"id":"components/schemas/TotalFeeBreakdown","kind":"json-schema","title":"TotalFeeBreakdown","data":{"description":"A breakdown of the total fees included in this quote.","type":"object","properties":{"calculatedFee":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the fee when the configured fee unit is applied against the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"number","format":"double","example":2.43},"feeName":{"description":"The name of the fee.","type":"string","minLength":1,"maxLength":128,"example":"Service fee"},"feeDescription":{"description":"Description of the fee.","type":"string","minLength":1,"maxLength":256,"example":"The service fee charged for this transaction."}},"additionalProperties":false}},"components/schemas/FeeSummary":{"id":"components/schemas/FeeSummary","kind":"json-schema","title":"FeeSummary","data":{"type":"object","description":"A summary of fees included in this quote.","properties":{"totalFee":{"description":"The value of the total fee included in this quote.","type":"number","format":"double","example":12.23},"feeCurrency":{"description":"The currency in which fees are charged.","type":"string","pattern":"^[a-zA-Z]{3,5}$","example":"USD"},"feeBreakdown":{"description":"An array of fees that provides a breakdown of how the total fees is calculated for this quote.","type":"array","items":{"$ref":"#/components/schemas/TotalFeeBreakdown"}}}}},"components/schemas/TaxBreakdown":{"id":"components/schemas/TaxBreakdown","kind":"json-schema","title":"TaxBreakdown","data":{"description":"A breakdown of the individual taxes.","type":"object","properties":{"taxAmount":{"description":"tax amount for this tax line item.","type":"number","format":"double","example":2.43},"taxName":{"description":"The name of the tax.","type":"string","minLength":1,"maxLength":128,"example":"ISS/ VAT/ GST etc"},"taxDescription":{"description":"GST service fee tax .","type":"string","minLength":1,"maxLength":256,"example":"The service fee tax charged for this transaction."},"taxRate":{"description":"The tax rate applied to calculate the tax amount.","type":"number","format":"double","example":5}},"additionalProperties":false}},"components/schemas/TaxSummary":{"id":"components/schemas/TaxSummary","kind":"json-schema","title":"TaxSummary","data":{"type":"object","description":"A summary of taxes included in this quote.","properties":{"totalTaxes":{"description":"The value of the total taxes included in this quote.","type":"number","format":"double","example":5.12},"taxCurrency":{"description":"The currency in which taxes are charged.","type":"string","pattern":"^[a-zA-Z]{3,5}$","example":"USD"},"taxBreakdown":{"description":"An array of taxes with details such as tax description, rate, name and tax amount.","type":"array","items":{"$ref":"#/components/schemas/TaxBreakdown"}}}}},"components/schemas/get-identity-response-v3":{"id":"components/schemas/get-identity-response-v3","kind":"json-schema","title":"get-identity-response-v3","data":{"allOf":[{"$ref":"#/components/schemas/ripple-identity"}],"type":"object","properties":{"identityId":{"type":"string","description":"Server-generated unique identifier of the identity.","example":"2f4ac57f-c5ba-4051-b51f-b3565778717b"},"identityState":{"$ref":"#/components/schemas/identity-state"},"nickName":{"type":"string","description":"Optional human-readable alias set by the client.","example":"nickName"},"tags":{"type":"array","description":"Optional labels used to categorize or filter identities.","maxItems":25,"items":{"type":"string","maxLength":256,"example":"tag1"}},"validatePayoutRails":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of payout methods where this identity is considered valid. Use this to indicate which payout methods (for example, US_ACH, EU_SEPA) the identity can be used with in payments."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/financial-instrument-type"}},"version":{"type":"string","description":"Sequential version number. Each successful PUT creates a higher version.","example":2},"schemaVersion":{"type":"string","description":"Schema version used to validate this identity, for example 1.0.0.","example":"1.0.0"},"createdAt":{"type":"string","format":"date-time","description":"RFC 3339 timestamp when the identity was created.","example":"2023-11-02T18:26:00.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"RFC 3339 timestamp when the identity was last updated.","example":"2023-11-03T18:26:00.000Z"}}}},"components/schemas/put-identity-request-v3":{"id":"components/schemas/put-identity-request-v3","kind":"json-schema","title":"put-identity-request-v3","data":{"allOf":[{"$ref":"#/components/schemas/put-ripple-identity"}],"type":"object","properties":{"nickName":{"type":"string","description":"The new nickname for the identity","example":"nickName"},"validatePayoutRails":{"type":"array","description":"The payment rails to validate the identity against","items":{"$ref":"#/components/schemas/financial-instrument-type"}},"tags":{"type":"array","description":"Tags are used to categorize the identity.\n","maxItems":25,"items":{"type":"string","maxLength":256,"example":"tag1"}}}}},"components/schemas/create-identity-request-v3":{"id":"components/schemas/create-identity-request-v3","kind":"json-schema","title":"create-identity-request-v3","data":{"allOf":[{"$ref":"#/components/schemas/ripple-identity"}],"type":"object","properties":{"nickName":{"type":"string","description":"The nickname for the identity","example":"nickName","maxLength":256},"validatePayoutRails":{"type":"array","description":"The payment rails to validate the identity against","items":{"$ref":"#/components/schemas/financial-instrument-type"}},"tags":{"type":"array","description":"Tags are used to categorize the identity.\n","maxItems":25,"items":{"type":"string","maxLength":256,"example":"tag1"}}}}},"components/schemas/identity-state":{"id":"components/schemas/identity-state","kind":"json-schema","title":"identity-state","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the identity"},"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":"ACTIVE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEACTIVATED"},"children":[]}]}]}]}],"x-enumDescriptions":{"ACTIVE":"The identity requested exists and is active.","DEACTIVATED":"The identity requested has been deactivated."},"example":"ACTIVE"}},"components/schemas/create-identity-response-v3":{"id":"components/schemas/create-identity-response-v3","kind":"json-schema","title":"create-identity-response-v3","data":{"type":"object","required":["identityId","version"],"properties":{"identityId":{"type":"string","description":"The unique ID of the identity","example":"2f4ac57f-c5ba-4051-b51f-b3565778717b"},"version":{"type":"string","description":"The version number of the identity","example":"2"}}}},"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"error","data":{"type":"object","required":["code","title","type","description","timestamp"],"properties":{"code":{"type":"string","minLength":1,"maxLength":128,"description":"Unique identifier of an error","example":"SYS_100"},"title":{"type":"string","minLength":1,"maxLength":128,"description":"Error message providing a brief summary of the error","example":"No identity exists for identityId"},"type":{"type":"string","minLength":1,"maxLength":128,"description":"Identifies the problem type","example":"USER_VALIDATION_ERROR"},"description":{"type":"string","minLength":1,"maxLength":1024,"description":"Provides more technical information","example":"Unable to get identity. Identity ID should be in UUID format"},"timestamp":{"type":"string","minLength":1,"maxLength":128,"format":"date-time","description":"The time when this error occurred, specified in UTC.","example":"2023-11-02T18:26:00.000123Z"}}}},"components/schemas/error-response":{"id":"components/schemas/error-response","kind":"json-schema","title":"error-response","data":{"type":"object","required":["status","errors"],"properties":{"status":{"type":"integer","description":"The HTTP status code of the error","example":404},"errors":{"type":"array","items":{"$ref":"#/components/schemas/error"}},"timestamp":{"type":"string","description":"The timestamp of the error","example":"2023-11-02T18:26:00.000Z"}}}},"components/schemas/list-identities-response-v3":{"id":"components/schemas/list-identities-response-v3","kind":"json-schema","title":"list-identities-response-v3","data":{"type":"object","format":"application/json","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/identity-response-v3"},"description":"The list of the identities that match the query parameters"},"nextToken":{"type":"string","description":"The token to retrieve the next page of results"}}}},"components/schemas/create-financial-instrument-response":{"id":"components/schemas/create-financial-instrument-response","kind":"json-schema","title":"create-financial-instrument-response","data":{"type":"object","required":["financialInstrumentId"],"properties":{"financialInstrumentId":{"type":"string","description":"The unique ID of the financial instrument","example":"2f4ac57f-c5ba-4051-b51f-b3565778717b"}}}},"components/schemas/identity-response-v3":{"id":"components/schemas/identity-response-v3","kind":"json-schema","title":"identity-response-v3","data":{"type":"object","required":["identityId","identityType","paymentRole","createdAt","updatedAt","identityState","version","schemaVersion"],"properties":{"identityId":{"type":"string","description":"The unique ID of the identity","example":"2f4ac57f-c5ba-4051-b51f-b3565778717b"},"identityType":{"$ref":"#/components/schemas/identity-type-v3"},"paymentRole":{"$ref":"#/components/schemas/payment-role"},"createdAt":{"type":"string","format":"date-time","description":"The time at which the identity was created","example":"2023-11-02T18:26:00.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"The time at which the identity was last updated","example":"2023-11-03T18:26:00.000Z"},"identityState":{"$ref":"#/components/schemas/identity-state"},"nickName":{"type":"string","description":"The nickname for the identity provided at the time of identity creation","example":"nickName"},"internalId":{"type":"string","description":"The client-provided unique identifier supplied when the identity was created or last updated.","example":"customer-12345-uuid"},"tags":{"type":"array","description":"Tags are used to categorize the identity.\n","maxItems":25,"items":{"type":"string","maxLength":256,"example":"tag1"}},"version":{"type":"integer","description":"The version number of the identity","example":2},"schemaVersion":{"type":"string","description":"The version of the schema","example":"1.0.0"}}}},"components/schemas/get-financial-instrument-response":{"id":"components/schemas/get-financial-instrument-response","kind":"json-schema","title":"get-financial-instrument-response","data":{"type":"object","required":["financialInstrument"],"description":"This object contains the details of a financial instrument and optional identity if requested.","properties":{"financialInstrument":{"$ref":"#/components/schemas/ripple-financial-instrument-entry"},"identity":{"$ref":"#/components/schemas/get-identity-response-v3"}}}},"components/schemas/update-financial-instrument-response":{"id":"components/schemas/update-financial-instrument-response","kind":"json-schema","title":"update-financial-instrument-response","data":{"allOf":[{"$ref":"#/components/schemas/ripple-financial-instrument-entry"}],"type":"object","description":"This object contains the details of the updated financial instrument.","required":["financialInstrumentId"]}},"components/schemas/list-financial-instruments-response":{"id":"components/schemas/list-financial-instruments-response","kind":"json-schema","title":"list-financial-instruments-response","data":{"type":"object","format":"application/json","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/financial-instrument-metadata"},"description":"The list of the financial instruments that match the query parameters"},"nextToken":{"type":"string","description":"The token to retrieve the next page of results"}}}},"components/schemas/identity-type-v3":{"id":"components/schemas/identity-type-v3","kind":"json-schema","title":"identity-type-v3","data":{"type":"string","x-extensible-enum":["BUSINESS","INDIVIDUAL"],"x-enumDescriptions":{"BUSINESS":"Identity associated with an institution or business","INDIVIDUAL":"Identity associated with an individual"},"description":"The type of the identity","example":"BUSINESS"}},"components/schemas/payment-role":{"id":"components/schemas/payment-role","kind":"json-schema","title":"payment-role","data":{"type":"string","x-extensible-enum":["ORIGINATOR","BENEFICIARY"],"x-enumDescriptions":{"ORIGINATOR":"Refers to originator identity","BENEFICIARY":"Refers to beneficiary identity"},"description":"The payment role of the identity","example":"BENEFICIARY"}},"components/schemas/business-identity":{"id":"components/schemas/business-identity","kind":"json-schema","title":"Business identity","data":{"type":"object","title":"Business identity","description":"PII data to support business and institutional identities\n","required":["businessName","address"],"properties":{"businessName":{"type":"string","description":"Business Legal Name","pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$","minLength":1,"maxLength":140,"example":"Widgets Org"},"address":{"type":"object","description":"Holds general information about the business","required":["streetAddress","country","city"],"properties":{"streetAddress":{"type":"array","description":"Allows the street address of the business to be held","items":{"type":"string","description":"Street address of the business","minLength":1,"maxLength":70,"pattern":"^[^\\p{C}\\r\\n<>]+$"},"example":["123 Example St. Boston, MA"]},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the country of the business to be held. Use Alpha-2 Code as defined in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/obp/ui/#search"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO CountryCode ISO 3166-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list."},"children":[]}]}]}],"minLength":2,"maxLength":2,"pattern":"^[A-Z]+$","example":"US"},"city":{"type":"string","description":"City","minLength":1,"maxLength":140,"pattern":"^(?![ .'-])(?!.*[ .'-]{2})[\\p{L} .'-]+(?<![ .'-])$","example":"Boston"},"stateOrProvince":{"x-requiredByOriginatorFor":["US_ACH","US_FEDWIRE","MX_SPEI","EU_SEPA","GB_FPS","ETH_WALLET","TRON_WALLET","SOL_WALLET","BR_PIX","CL_TEF","CO_PSE","BR_TED","CA_EFT","AE_IPI","KR_KFTC","IN_NEFT","PE_LBTR","CN_CFXPS","AU_NPP","JP_ZENGIN","TH_PROMPTPAY","AR_INTERBANKING"],"x-requiredByBeneficiaryFor":["US_ACH","US_FEDWIRE","MX_SPEI","EU_SEPA","GB_FPS","ETH_WALLET","TRON_WALLET","SOL_WALLET","BR_PIX","CL_TEF","CO_PSE","BR_TED","CA_EFT","AE_IPI","KR_KFTC","IN_NEFT","PE_LBTR","CN_CFXPS","AU_NPP","JP_ZENGIN","TH_PROMPTPAY","AR_INTERBANKING"],"type":"string","description":"State, province, or county of the business address, as defined by postal services.","minLength":1,"maxLength":140,"pattern":"^(?![ .'-])(?!.*[ .'-]{2})[\\p{L}\\p{N} .'-]+(?<![ .'-])$","example":"Massachusetts"},"postalCode":{"x-requiredByOriginatorFor":["US_ACH","US_FEDWIRE","MX_SPEI","EU_SEPA","GB_FPS","ETH_WALLET","TRON_WALLET","SOL_WALLET","BR_PIX","CL_TEF","CO_PSE","BR_TED","CA_EFT","AE_IPI","KR_KFTC","IN_NEFT","PE_LBTR","CN_CFXPS","AU_NPP","JP_ZENGIN","TH_PROMPTPAY","AR_INTERBANKING"],"x-requiredByBeneficiaryFor":["US_ACH","US_FEDWIRE","MX_SPEI","EU_SEPA","GB_FPS","ETH_WALLET","TRON_WALLET","SOL_WALLET","BR_PIX","CL_TEF","CO_PSE","BR_TED","CA_EFT","AE_IPI","KR_KFTC","IN_NEFT","PE_LBTR","CN_CFXPS","AU_NPP","JP_ZENGIN","TH_PROMPTPAY","AR_INTERBANKING"],"type":"string","description":"Postal code for the business","minLength":3,"maxLength":15,"pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} -]{1,15}[\\p{L}\\p{N}]$","example":"12345"}}},"email":{"x-requiredByBeneficiaryFor":["BR_PIX","BR_TED","CO_PSE","CL_TEF","PE_LBTR","AR_INTERBANKING"],"x-requiredByOriginatorFor":["BR_PIX","BR_TED","CL_TEF","PE_LBTR","AR_INTERBANKING"],"type":"string","description":"Address for electronic mail (e-mail).","format":"email","minLength":6,"maxLength":255,"pattern":"^(?=.{1,254}$)(?:[\\p{L}\\p{N}%+_-]+(?:\\.[\\p{L}\\p{N}%+_-]+)*)@(?:(?:[\\p{L}\\p{N}](?:[\\p{L}\\p{N}-]{0,61}[\\p{L}\\p{N}])?)\\.)+[\\p{L}]{2,63}$","example":"fake@example.com"},"phone":{"x-requiredByBeneficiaryFor":["BR_PIX","BR_TED","NG_BANK_PAYOUT","GH_BANK_PAYOUT","RW_BANK_PAYOUT","ZA_BANK_PAYOUT","UG_BANK_PAYOUT","ZM_BANK_PAYOUT","CO_PSE","KR_KFTC","CL_TEF","IN_NEFT","TH_PROMPTPAY","PE_LBTR","AR_INTERBANKING"],"x-requiredByOriginatorFor":["BR_PIX","BR_TED","NG_BANK_PAYOUT","KR_KFTC","CL_TEF","IN_NEFT","GH_BANK_PAYOUT","RW_BANK_PAYOUT","ZA_BANK_PAYOUT","UG_BANK_PAYOUT","ZM_BANK_PAYOUT","TH_PROMPTPAY","PE_LBTR","AR_INTERBANKING"],"type":"string","description":"Phone Number","minLength":8,"maxLength":16,"pattern":"^\\+[1-9]\\d+$","example":1234567890},"registration":{"x-requiredByBeneficiaryFor":["BR_PIX","BR_TED","CO_PSE","CA_EFT","CL_TEF","KR_KFTC","IN_NEFT","TH_PROMPTPAY","PE_LBTR","AR_INTERBANKING"],"x-requiredByOriginatorFor":["CA_EFT","BR_PIX","BR_TED","EU_SEPA","CN_CFXPS","GB_FPS","CL_TEF","KR_KFTC","IN_NEFT","AE_IPI","PE_LBTR","TH_PROMPTPAY","AR_INTERBANKING"],"type":"array","description":"Unique and unambiguous way to identify a business or organization. An array of objects, each containing unique identification of an organization, as assigned by an institution, using an identification scheme.","items":{"type":"object","required":["number","type"],"properties":{"number":{"type":"string","description":"The unique identifier of the organization","example":"123ABC","minLength":3,"maxLength":35,"pattern":"^(?![ .'-\\/])(?!.*[ .'-\\/]{2})([A-Za-z0-9 .'-\\/]+)(?<![ .'-\\/])\\/?$"},"type":{"type":"string","x-extensible-enum":["INCORPORATION_CERTIFICATE","TAX_ID"],"x-enumDescriptions":{"INCORPORATION_CERTIFICATE":"Certificate of Incorporation Number","TAX_ID":"Tax Identification Number"},"x-allowedEnumValuesByOriginatorFor":[{"corridor":"AR_INTERBANKING","values":["TAX_ID"]},{"corridor":"BR_PIX","values":["TAX_ID"]},{"corridor":"BR_TED","values":["TAX_ID"]},{"corridor":"CL_TEF","values":["TAX_ID"]},{"corridor":"PE_LBTR","values":["TAX_ID"]}],"x-allowedEnumValuesByBeneficiaryFor":[{"corridor":"AR_INTERBANKING","values":["TAX_ID"]},{"corridor":"BR_PIX","values":["TAX_ID"]},{"corridor":"BR_TED","values":["TAX_ID"]},{"corridor":"CL_TEF","values":["TAX_ID"]},{"corridor":"CO_PSE","values":["TAX_ID"]},{"corridor":"ETH_WALLET","values":["INCORPORATION_CERTIFICATE"]},{"corridor":"PE_LBTR","values":["TAX_ID"]},{"corridor":"SOL_WALLET","values":["INCORPORATION_CERTIFICATE"]},{"corridor":"TRON_WALLET","values":["INCORPORATION_CERTIFICATE"]}],"description":"Type of business identification document. Accepted values may vary by corridor and payment role. Some corridors accept only a subset of this list. See Ripple Docs for corridor-specific requirements.","example":"INCORPORATION_CERTIFICATE"}}}},"incorporationCountry":{"x-requiredByBeneficiaryFor":["BR_TED","NG_BANK_PAYOUT","KR_KFTC","CL_TEF","IN_NEFT","GH_BANK_PAYOUT","RW_BANK_PAYOUT","ZA_BANK_PAYOUT","UG_BANK_PAYOUT","ZM_BANK_PAYOUT","TH_PROMPTPAY","PE_LBTR","AR_INTERBANKING"],"x-requiredByOriginatorFor":["BR_PIX","BR_TED","CL_TEF","KR_KFTC","IN_NEFT","PE_LBTR","TH_PROMPTPAY","AR_INTERBANKING"],"type":"string","description":"Information that locates and identifies the country, as defined by postal services where the organization was incorporated. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.","minLength":2,"maxLength":2,"pattern":"^[A-Z]+$","example":"US"},"incorporationDate":{"x-requiredByOriginatorFor":["KR_KFTC","IN_NEFT","TH_PROMPTPAY"],"type":"string","format":"date","description":"The date when the business was incorporated.","example":"2020-01-15"},"legalEntityType":{"x-requiredByOriginatorFor":["BR_PIX"],"type":"string","x-extensible-enum":["BANK_CENTRAL","BANK_COMMERCIAL","PAYMENT_INSTITUTION","CORPORATE_PRIVATE","CORPORATE_PUBLIC","GOVERNMENT_ENTITY","NON_PROFIT","SOLE_TRADER"],"x-enumDescriptions":{"BANK_CENTRAL":"Central Banks and National Monetary Authorities.","BANK_COMMERCIAL":"Traditional regulated banks and credit unions.","PAYMENT_INSTITUTION":"Regulated Fintechs, PSPs, MSBs.","CORPORATE_PRIVATE":"Standard private commercial entities (e.g., LLC, Ltd).","CORPORATE_PUBLIC":"Publicly traded companies listed on a stock exchange.","GOVERNMENT_ENTITY":"Non-financial state bodies","NON_PROFIT":"Charitable Org, NGOs, and foundations.","SOLE_TRADER":"Registered businesses owned/operated by a single individual."},"description":"Type of legal entity to distinguish between Financial Institutions and Non-Financial Institutions.\n\nThis classification is used to determine regulatory treatment and compliance requirements for certain payment corridors.\n","example":"BANK_CENTRAL"},"localized":{"type":"object","description":"Identity fields supplied in a non-Latin script, in addition to the Latin-script values\nelsewhere on the identity. Populate the script block that the destination corridor\nrequires.\n","properties":{"hanzi":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Localized identity fields in Chinese Hanzi characters (汉字)."},"children":[]}]}]}],"properties":{"businessName":{"type":"string","description":"Business legal name in Chinese Hanzi characters.\n","maxLength":256,"example":"上海示例贸易有限公司"}}}}}}}},"components/schemas/individual-identity":{"id":"components/schemas/individual-identity","kind":"json-schema","title":"Individual identity","data":{"type":"object","title":"Individual identity","description":"Data for an individual\n","required":["firstName","lastName","address"],"properties":{"firstName":{"type":"string","description":"First name of the individual","pattern":"^(?![ .'-])(?!.*([ .'-])\\1)[\\p{L} .'-]+(?<![ .'-])$","minLength":1,"maxLength":140,"example":"John"},"lastName":{"type":"string","description":"Last name of the individual","pattern":"^(?![ .'-])(?!.*([ .'-])\\1)[\\p{L} .'-]+(?<![ .'-])$","minLength":1,"maxLength":140,"example":"Smith"},"address":{"type":"object","description":"Holds general information about the individual","required":["streetAddress","country","city"],"properties":{"streetAddress":{"type":"array","description":"Allows the street address of the individual to be held","items":{"type":"string","description":"Street address of the individual","minLength":1,"maxLength":70,"pattern":"^[^\\p{C}\\r\\n<>]+$"},"example":["123 Example St. Boston, MA"]},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the Country of the individual to be held. Use Alpha-2 Code as defined in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/obp/ui/#search"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO CountryCode ISO 3166-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list."},"children":[]}]}]}],"minLength":2,"maxLength":2,"pattern":"^[A-Z]+$","example":"US"},"city":{"type":"string","description":"City","minLength":1,"maxLength":140,"pattern":"^(?![ .'-])(?!.*[ .'-]{2})[\\p{L} .'-]+(?<![ .'-])$","example":"Boston"},"stateOrProvince":{"x-requiredByOriginatorFor":["US_ACH","US_FEDWIRE","MX_SPEI","EU_SEPA","GB_FPS","ETH_WALLET","TRON_WALLET","SOL_WALLET","BR_PIX","CL_TEF","CO_PSE","BR_TED","CA_EFT","AE_IPI","KR_KFTC","IN_NEFT","PE_LBTR","CN_CFXPS","AU_NPP","JP_ZENGIN","TH_PROMPTPAY","AR_INTERBANKING"],"x-requiredByBeneficiaryFor":["US_ACH","US_FEDWIRE","MX_SPEI","EU_SEPA","GB_FPS","ETH_WALLET","TRON_WALLET","SOL_WALLET","BR_PIX","CL_TEF","CO_PSE","BR_TED","CA_EFT","AE_IPI","KR_KFTC","IN_NEFT","PE_LBTR","CN_CFXPS","AU_NPP","JP_ZENGIN","TH_PROMPTPAY","AR_INTERBANKING"],"type":"string","description":"Information that locates and identifies the state / county for the party, as defined by postal services","minLength":1,"maxLength":140,"pattern":"^(?![ .'-])(?!.*[ .'-]{2})[\\p{L}\\p{N} .'-]+(?<![ .'-])$","example":"Massachusetts"},"postalCode":{"x-requiredByOriginatorFor":["US_ACH","US_FEDWIRE","MX_SPEI","EU_SEPA","GB_FPS","ETH_WALLET","TRON_WALLET","SOL_WALLET","BR_PIX","CL_TEF","CO_PSE","BR_TED","CA_EFT","AE_IPI","KR_KFTC","IN_NEFT","PE_LBTR","CN_CFXPS","AU_NPP","JP_ZENGIN","TH_PROMPTPAY","AR_INTERBANKING"],"x-requiredByBeneficiaryFor":["US_ACH","US_FEDWIRE","MX_SPEI","EU_SEPA","GB_FPS","ETH_WALLET","TRON_WALLET","SOL_WALLET","BR_PIX","CL_TEF","CO_PSE","BR_TED","CA_EFT","AE_IPI","KR_KFTC","IN_NEFT","PE_LBTR","CN_CFXPS","AU_NPP","JP_ZENGIN","TH_PROMPTPAY","AR_INTERBANKING"],"type":"string","description":"Postal code for the individual's address","minLength":3,"maxLength":15,"pattern":"^[\\p{L}\\p{N}][\\p{L}\\p{N} -]{1,15}[\\p{L}\\p{N}]$","example":"12345"}}},"email":{"x-requiredByBeneficiaryFor":["BR_PIX","BR_TED","CO_PSE","CL_TEF","PE_LBTR","AR_INTERBANKING"],"x-requiredByOriginatorFor":["BR_PIX","CL_TEF","PE_LBTR","AR_INTERBANKING"],"type":"string","description":"Address for electronic mail (e-mail).","format":"email","minLength":6,"maxLength":255,"pattern":"^(?=.{1,254}$)(?:[\\p{L}\\p{N}%+_-]+(?:\\.[\\p{L}\\p{N}%+_-]+)*)@(?:(?:[\\p{L}\\p{N}](?:[\\p{L}\\p{N}-]{0,61}[\\p{L}\\p{N}])?)\\.)+[\\p{L}]{2,63}$","example":"fake@example.com"},"phone":{"x-requiredByBeneficiaryFor":["BR_PIX","BR_TED","NG_BANK_PAYOUT","GH_BANK_PAYOUT","RW_BANK_PAYOUT","ZA_BANK_PAYOUT","UG_BANK_PAYOUT","ZM_BANK_PAYOUT","CO_PSE","CL_TEF","KR_KFTC","IN_NEFT","PE_LBTR","TH_PROMPTPAY","AR_INTERBANKING"],"x-requiredByOriginatorFor":["BR_PIX","NG_BANK_PAYOUT","KR_KFTC","CL_TEF","IN_NEFT","PE_LBTR","GH_BANK_PAYOUT","RW_BANK_PAYOUT","ZA_BANK_PAYOUT","UG_BANK_PAYOUT","ZM_BANK_PAYOUT","TH_PROMPTPAY","AR_INTERBANKING"],"type":"string","description":"Phone Number.\n","minLength":8,"maxLength":16,"pattern":"^\\+[1-9]\\d+$","example":1234567890},"identityDocuments":{"x-requiredByBeneficiaryFor":["BR_PIX","BR_TED","CO_PSE","KR_KFTC","CL_TEF","IN_NEFT","PE_LBTR","TH_PROMPTPAY","AR_INTERBANKING"],"x-requiredByOriginatorFor":["BR_PIX","BR_TED","CL_TEF","KR_KFTC","IN_NEFT","PE_LBTR","TH_PROMPTPAY","AR_INTERBANKING"],"x-requiredByJurisdictionForOriginator":["BR"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification documents for the identity, such as a passport, national ID, or tax ID. Required for ORIGINATOR and BENEFICIARY identities on some corridors and optional on others; see the Payload schema utility for the corridors that require it. Also required for ORIGINATOR identities when your organization is configured for the Brazil (BR) jurisdiction, on every corridor, including corridors that do not otherwise require it. Jurisdiction comes from your organization's configuration, not from a value in the request. Where the field is required, omitting it fails identity create and update with 400 Bad Request (USR_111)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For accepted document types per corridor and role, see Accepted document types by corridor."},"children":[]}]}]}],"type":"array","items":{"type":"object","required":["idNumber","idType"],"properties":{"idNumber":{"type":"string","description":"Identification Number.","minLength":3,"maxLength":35,"pattern":"^(?![ .'-\\/])(?!.*[ .'-\\/]{2})([A-Za-z0-9 .'-\\/]+)(?<![ .'-\\/])\\/?$","example":"123ABC"},"idType":{"type":"string","x-extensible-enum":["ALIEN_REGISTRATION","CUSTOMER_ID","DRIVERS_LICENSE","EMPLOYEE_ID","NATIONAL_ID_NUMBER","PASSPORT","SSN","TAX_ID"],"x-enumDescriptions":{"ALIEN_REGISTRATION":"Alien Registration Number","CUSTOMER_ID":"Customer ID Number","DRIVERS_LICENSE":"Driver's License Number","EMPLOYEE_ID":"Employee ID Number","NATIONAL_ID_NUMBER":"National ID Number","PASSPORT":"Passport Number","SSN":"Social Security Number","TAX_ID":"Tax Identification Number"},"x-allowedEnumValuesByOriginatorFor":[{"corridor":"AR_INTERBANKING","values":["TAX_ID"]},{"corridor":"AU_NPP","values":["PASSPORT"]},{"corridor":"BR_PIX","values":["PASSPORT","TAX_ID"]},{"corridor":"BR_TED","values":["PASSPORT","TAX_ID"]},{"corridor":"CL_TEF","values":["PASSPORT","TAX_ID"]},{"corridor":"IN_NEFT","values":["PASSPORT"]},{"corridor":"KR_KFTC","values":["PASSPORT"]},{"corridor":"PE_LBTR","values":["PASSPORT","TAX_ID"]},{"corridor":"TH_PROMPTPAY","values":["PASSPORT"]}],"x-allowedEnumValuesByBeneficiaryFor":[{"corridor":"AR_INTERBANKING","values":["NATIONAL_ID_NUMBER","SSN"]},{"corridor":"BR_PIX","values":["TAX_ID"]},{"corridor":"BR_TED","values":["TAX_ID"]},{"corridor":"CL_TEF","values":["NATIONAL_ID_NUMBER","TAX_ID"]},{"corridor":"CO_PSE","values":["ALIEN_REGISTRATION","NATIONAL_ID_NUMBER","TAX_ID"]},{"corridor":"PE_LBTR","values":["NATIONAL_ID_NUMBER","TAX_ID"]},{"corridor":"TH_PROMPTPAY","values":["ALIEN_REGISTRATION","DRIVERS_LICENSE","EMPLOYEE_ID","NATIONAL_ID_NUMBER","PASSPORT","SSN","TAX_ID"]}],"description":"The type of identification document used to identify the identity. Accepted values may vary by corridor and payment role. Some corridors accept only a subset of this list. See Ripple Docs for corridor-specific requirements."},"expiryDate":{"x-requiredByOriginatorFor":["IN_NEFT","KR_KFTC","TH_PROMPTPAY"],"type":"string","format":"date","description":"Expiration date of the identification document.","example":"2030-01-15"}}}},"dateOfBirth":{"x-requiredByBeneficiaryFor":["EU_SEPA","GB_FPS","BR_PIX","BR_TED","CA_EFT","CL_TEF","PE_LBTR","AR_INTERBANKING"],"x-requiredByOriginatorFor":["EU_SEPA","GB_FPS","BR_PIX","BR_TED","KR_KFTC","CL_TEF","IN_NEFT","PE_LBTR","AE_IPI","TH_PROMPTPAY","AR_INTERBANKING"],"type":"string","format":"date","description":"Date of Birth.","example":"2001-01-24"},"countryOfBirth":{"x-requiredByOriginatorFor":["BR_PIX","BR_TED","CL_TEF","PE_LBTR","AR_INTERBANKING"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country of Birth. Use Alpha-2 Code as defined in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/obp/ui/#search"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO CountryCode ISO 3166-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list."},"children":[]}]}]}],"minLength":2,"maxLength":2,"pattern":"^[A-Z]+$","example":"US"},"citizenship":{"x-requiredByBeneficiaryFor":["BR_PIX","BR_TED","CL_TEF","IN_NEFT","KR_KFTC","PE_LBTR","TH_PROMPTPAY","AR_INTERBANKING"],"x-requiredByOriginatorFor":["BR_PIX","BR_TED","CL_TEF","KR_KFTC","IN_NEFT","PE_LBTR","TH_PROMPTPAY","AR_INTERBANKING"],"type":"string","description":"Alpha-2 country code for the nationality of the individual in ISO 3166-1 format.","minLength":2,"maxLength":2,"pattern":"^[A-Z]+$","example":"US"},"gender":{"type":"string","x-extensible-enum":["MALE","FEMALE","OTHER"],"x-enumDescriptions":{"MALE":"Male identity","FEMALE":"Female identity","OTHER":"Other identity"},"description":"Gender of the identity.","example":"FEMALE"},"localized":{"type":"object","description":"Identity fields supplied in a non-Latin script, in addition to the Latin-script values\nelsewhere on the identity. Populate the script block that the destination corridor\nrequires.\n","properties":{"hanzi":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Localized identity fields in Chinese Hanzi characters (汉字)."},"children":[]}]}]}],"properties":{"firstName":{"type":"string","description":"Individual given name in Chinese Hanzi characters.","maxLength":32,"example":"伟"},"lastName":{"type":"string","description":"Individual family name in Chinese Hanzi characters.","maxLength":32,"example":"张"},"businessName":{"type":"string","description":"Business name associated with the individual in Chinese Hanzi characters, for\ntrade payments.\n","maxLength":256,"example":"上海示例贸易有限公司"}}}}}}}},"components/schemas/ripple-identity":{"id":"components/schemas/ripple-identity","kind":"json-schema","title":"ripple-identity","data":{"type":"object","required":["identityType","paymentRole"],"properties":{"identityType":{"$ref":"#/components/schemas/identity-type-v3"},"paymentRole":{"$ref":"#/components/schemas/payment-role"},"internalId":{"x-requiredByOriginatorFor":["ALL"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client-provided unique identifier for idempotency and deduplication. Required for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORIGINATOR identities; optional for BENEFICIARY identities. Must be unique across"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all active identities in your organization. Duplicate values will result in a 409"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is your own reference key, not the originator's account number. Use"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originatorAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for that."},"children":[]}]}]}],"example":"customer-12345-uuid"},"originatorAccountNumber":{"x-requiredByOriginatorFor":["CN_CFXPS"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The originator's account number, or your customer identifier for the originator."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for ORIGINATOR identities on USD payments to China ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CN_CFXPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); optional"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"elsewhere. Only sent to payout partners for ORIGINATOR identities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be unique across all active identities in your organization, including"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BENEFICIARY identities. Duplicate values return a 409 Conflict error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Corridor length and character limits apply to this value but are not enforced on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this field. See the corridor's Integration resources page."},"children":[]}]}]}],"example":"6222021001125874"},"business":{"$ref":"#/components/schemas/business-identity"},"individual":{"$ref":"#/components/schemas/individual-identity"}}}},"components/schemas/financial-instrument-type":{"id":"components/schemas/financial-instrument-type","kind":"json-schema","title":"financial-instrument-type","data":{"type":"string","description":"The type of financial instrument or payment rail used for executing the transaction.\nThis determines the structure and validation of account details required for the payout.\n","x-extensible-enum":["US_ACH","US_FEDWIRE","MX_SPEI","EU_SEPA","GB_FPS","NG_BANK_PAYOUT","GH_BANK_PAYOUT","RW_BANK_PAYOUT","ZA_BANK_PAYOUT","UG_BANK_PAYOUT","ZM_BANK_PAYOUT","ETH_WALLET","TRON_WALLET","SOL_WALLET","BR_PIX","CO_PSE","BR_TED","CA_EFT","KR_KFTC","IN_NEFT","AU_NPP","JP_ZENGIN","TH_PROMPTPAY","CN_CFXPS","CL_TEF","PE_LBTR","AE_IPI","AR_INTERBANKING"],"x-enumDescriptions":{"US_ACH":"Automated Clearing House - U.S. batch processing network used for domestic payments.","US_FEDWIRE":"Fedwire Funds Service - U.S. real-time gross settlement network for high-value domestic USD transfers.","MX_SPEI":"Mexico's real-time interbank transfer system.","EU_SEPA":"European Union's standardized payment system for euro-denominated transactions.","GB_FPS":"Faster Payments Service in the UK for near-instant payments.","NG_BANK_PAYOUT":"Nigeria Bank Payout - A payment method for bank transfers in Nigeria.","GH_BANK_PAYOUT":"Ghana Bank Payout - A payment method for bank transfers in Ghana.","RW_BANK_PAYOUT":"Rwanda Bank Payout - A payment method for bank transfers in Rwanda.","ZA_BANK_PAYOUT":"South Africa Bank Payout - A payment method for bank transfers in South Africa.","UG_BANK_PAYOUT":"Uganda Bank Payout - A payment method for bank transfers in Uganda.","ZM_BANK_PAYOUT":"Zambia Bank Payout - A payment method for bank transfers in Zambia.","ETH_WALLET":"Ethereum-based crypto transactions using blockchain wallet addresses.","TRON_WALLET":"Tron-based crypto transactions using blockchain wallet addresses.","SOL_WALLET":"Solana-based crypto transactions using blockchain wallet addresses.","BR_PIX":"Brazil's instant payment platform developed by the Central Bank of Brazil.","CO_PSE":"Colombia's secure online banking payment system.","BR_TED":"Brazil's Electronic Funds Transfer system for high-value transactions.","CA_EFT":"Canada's Electronic Funds Transfer system for batch processing.","IN_NEFT":"India National Electronic Funds Transfer - bank payout for INR denominated transfers using IFSC routing codes.","AU_NPP":"Australia New Payments Platform - real-time payment rail for AUD-denominated domestic transfers, with Direct Entry (BECS) fallback for high-value and batch.","JP_ZENGIN":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Japan Zengin - multi-rail (Zengin + Zengin Prompt Service) domestic clearing system for JPY-denominated payments."},"children":[]}]}]}],"TH_PROMPTPAY":"Thailand PromptPay - Thailand's national real-time retail payment system for THB domestic bank transfers.","CN_CFXPS":"China Foreign Exchange Payment System, enabling USD business-to-business transfers to China via SWIFT/BIC routing.","CL_TEF":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chile TEF (Transferencia Electrónica de Fondos) - business-day domestic transfer system for CLP-denominated payments."},"children":[]}]}]}],"PE_LBTR":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peru LBTR (Liquidación Bruta en Tiempo Real) - real-time settlement system for PEN-denominated payments."},"children":[]}]}]}],"KR_KFTC":"South Korea KFTC - 24/7 real-time payment rail via Korea Financial Telecommunications and Clearings for KRW-denominated payments.","AE_IPI":"United Arab Emirates' Instant Payment Interface for real-time transactions.","AR_INTERBANKING":"Argentina Interbanking - CBU/CVU-based domestic transfer system for ARS-denominated payments."},"example":"BR_PIX"}},"components/schemas/put-ripple-identity":{"id":"components/schemas/put-ripple-identity","kind":"json-schema","title":"put-ripple-identity","data":{"type":"object","description":"Request to update an existing identity.\n","properties":{"internalId":{"x-requiredByOriginatorFor":["ALL"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client-provided unique identifier for idempotency and deduplication. Required for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORIGINATOR identities; optional for BENEFICIARY identities. Must be unique across"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all active identities in your organization. Duplicate values will result in a 409"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is your own reference key, not the originator's account number. Use"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originatorAccountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for that."},"children":[]}]}]}],"example":"customer-12345-uuid"},"originatorAccountNumber":{"x-requiredByOriginatorFor":["CN_CFXPS"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The originator's account number, or your customer identifier for the originator."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for ORIGINATOR identities on USD payments to China ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CN_CFXPS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); optional"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"elsewhere. Only sent to payout partners for ORIGINATOR identities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be unique across all active identities in your organization, including"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BENEFICIARY identities. Duplicate values return a 409 Conflict error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Corridor length and character limits apply to this value but are not enforced on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this field. See the corridor's Integration resources page."},"children":[]}]}]}],"example":"6222021001125874"},"business":{"$ref":"#/components/schemas/business-identity"},"individual":{"$ref":"#/components/schemas/individual-identity"}}}},"components/schemas/financial-instrument-currency":{"id":"components/schemas/financial-instrument-currency","kind":"json-schema","title":"financial-instrument-currency","data":{"type":"string","description":"The 3-letter ISO currency code of the financial instrument.","example":"MXN","x-extensible-enum":["AED","ARS","AUD","BRL","CAD","CLP","COP","EUR","GBP","GHS","INR","KRW","MXN","NGN","PEN","RWF","UGX","USD","ZAR","ZMW","RLUSD","USDC","USDT"]}},"components/schemas/financial-instrument-metadata":{"id":"components/schemas/financial-instrument-metadata","kind":"json-schema","title":"financial-instrument-metadata","data":{"type":"object","description":"Metadata information for a financial instrument without the payment rail specific details.\nUsed in list operations to provide summary information.\n","required":["financialInstrumentId","financialInstrumentType","currency"],"properties":{"financialInstrumentId":{"type":"string","description":"The unique identifier of the financial instrument.","example":"3fc74743-e7f3-414a-9fcf-eb8c1d52356a"},"financialInstrumentType":{"$ref":"#/components/schemas/financial-instrument-type"},"currency":{"$ref":"#/components/schemas/financial-instrument-currency"},"label":{"type":"string","maxLength":256,"description":"A user-defined label for the financial instrument.","example":"mexico bank account"},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 2-letter ISO 3166-1 alpha-2 country code of the financial instrument. This field is omitted when no country jurisdiction applies (for example, crypto wallet instruments such as ETH_WALLET, TRON_WALLET, and SOL_WALLET). An absent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be interpreted as \"no applicable jurisdiction\"."},"children":[]}]}]}],"example":"MX","minLength":2,"maxLength":2,"pattern":"^[A-Z]+$"},"createdAt":{"type":"string","format":"date-time","description":"The time at which the financial instrument was created","example":"2023-11-02T18:26:00.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"The time at which the financial instrument was last updated","example":"2023-11-03T18:26:00.000Z"}}}},"components/schemas/us-ach":{"id":"components/schemas/us-ach","kind":"json-schema","title":"us-ach","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: RTP, ACH"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RTP:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: $5,000,000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: <5 minutes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Not applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH:"},"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":"Availability: Business days only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: $1,000,000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Same-day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: 3:00 PM EST"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: U.S. banking holidays apply"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order:"},"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":"text","inline":true,"attributes":{"content":"RTP"},"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":"Conditions: beneficiary account is RTP-addressable AND amount ≤ $5,000,000"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH"},"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":"Conditions: otherwise applicable"},"children":[]}]}]}]}]}]}],"required":["bankName","bankRoutingNumber","accountNumber","accountType"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"bankRoutingNumber":{"type":"string","description":"The identity's bank routing number","minLength":9,"maxLength":9,"pattern":"^\\d+$"},"accountNumber":{"type":"string","description":"The identity's account number into which the funds must be credited","minLength":4,"maxLength":21,"pattern":"^\\d+$"},"accountType":{"type":"string","x-extensible-enum":["CHECKING","SAVINGS"],"x-enumDescriptions":{"CHECKING":"Checking account","SAVINGS":"Savings account"},"description":"The identity's account type."}}}},"components/schemas/us-fedwire":{"id":"components/schemas/us-fedwire","kind":"json-schema","title":"us-fedwire","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: FEDWIRE"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FEDWIRE:"},"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":"Availability: U.S. business days and operating hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: No limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Real-time gross settlement (typically within minutes)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: 5:00 p.m. ET; transfers submitted after cut-off queue for next business day."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Follows the Federal Reserve holiday schedule."},"children":[]}]}]}]}],"required":["bankName","bankRoutingNumber","accountNumber"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank.","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"bankRoutingNumber":{"type":"string","description":"9-digit ABA Routing Transit Number (RTN) of the beneficiary's bank.","minLength":9,"maxLength":9,"pattern":"^\\d+$"},"accountNumber":{"type":"string","description":"The identity's account number to be credited.","minLength":4,"maxLength":21,"pattern":"^\\d+$"}}}},"components/schemas/mx-spei":{"id":"components/schemas/mx-spei","kind":"json-schema","title":"mx-spei","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: SPEI"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPEI:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Instant"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Not applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order: Not applicable"},"children":[]}]}]}],"type":"object","required":["bankName","clabe"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"clabe":{"type":"string","description":"The identity's CLABE account identification code","minLength":18,"maxLength":18,"pattern":"^\\d+$"}}}},"components/schemas/eu-sepa":{"id":"components/schemas/eu-sepa","kind":"json-schema","title":"eu-sepa","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: SCT Inst, SCT"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCT Inst:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: €100,000 (bank-dependent)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Instant"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Not applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCT:"},"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":"Availability: Business days only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: No limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: T+2 to T+5"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: 3:00PM GMT/BST"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: TARGET2 holidays apply"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order:"},"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":"text","inline":true,"attributes":{"content":"SCT Inst"},"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":"Conditions: beneficiary account is SCT Inst-addressable AND amount ≤ €100,000"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCT"},"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":"Conditions: otherwise applicable"},"children":[]}]}]}]}]}]}],"required":["bankName","iban"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"iban":{"type":"string","description":"The International Bank Account Number (IBAN) of the identity's account","minLength":15,"maxLength":34,"pattern":"^[A-Z]{2}\\d{2}[A-Z0-9]{11,30}$"}}}},"components/schemas/gb-fps":{"id":"components/schemas/gb-fps","kind":"json-schema","title":"gb-fps","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: FPS, CHAPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FPS:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: £1,000,000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Instant"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Not applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHAPS:"},"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":"Availability: Business days only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: No limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Same-day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: Typically 5:00 PM GMT/BST (bank-dependent)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: UK banking holidays apply"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order:"},"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":"text","inline":true,"attributes":{"content":"FPS"},"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":"Conditions: beneficiary account is FPS-addressable AND amount ≤ £1,000,000"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHAPS"},"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":"Conditions: otherwise applicable"},"children":[]}]}]}]}]}]}],"required":["bankName","sortCode","accountNumber"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"sortCode":{"type":"string","description":"The sort code of the identity's bank account","minLength":6,"maxLength":6,"pattern":"^[0-9]+$"},"accountNumber":{"type":"string","description":"The account number of the identity's bank account","minLength":8,"maxLength":8,"pattern":"^[0-9]+$"}}}},"components/schemas/ng-bank-payout":{"id":"components/schemas/ng-bank-payout","kind":"json-schema","title":"ng-bank-payout","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: Bank Payout"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank Payout:"},"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":"Availability: Country-dependant"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nigeria: ₦5,000,000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Real time to 48 hours"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: Real time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Nigeria banking holidays apply"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order: Not applicable"},"children":[]}]}]}],"required":["bankName","bankCode","accountNumber"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"bankCode":{"type":"string","description":"Ripple Bank Code (RBC) for the destination bank in Nigeria. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.","minLength":1,"maxLength":50,"pattern":"^([A-Za-z0-9 ._-]+|RPL:[A-Z]{2}:[A-Z0-9]{7,11}(_\\d+)?:(BNK|WAL))$"},"accountNumber":{"type":"string","description":"The identity's account number associated with the Account Identification Scheme","minLength":4,"maxLength":21,"pattern":"^[a-zA-Z0-9]+$"}}}},"components/schemas/gh-bank-payout":{"id":"components/schemas/gh-bank-payout","kind":"json-schema","title":"gh-bank-payout","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: GIP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GIP:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: ₵100,000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Real time to 48 hours"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: Real time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order:"},"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":"text","inline":true,"attributes":{"content":"GIP – Conditions: Account addressability, amount ≤ ₵100,000"},"children":[]}]}]}]}],"required":["bankName","bankCode","accountNumber"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"bankCode":{"type":"string","description":"Ripple Bank Code (RBC) for the destination bank in Ghana. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.","minLength":1,"maxLength":50,"pattern":"^([A-Za-z0-9 ._-]+|RPL:[A-Z]{2}:[A-Z0-9]{7,11}(_\\d+)?:(BNK|WAL))$"},"accountNumber":{"type":"string","description":"The identity's account number associated with the Account Identification Scheme","minLength":4,"maxLength":21,"pattern":"^[a-zA-Z0-9]+$"}}}},"components/schemas/rw-bank-payout":{"id":"components/schemas/rw-bank-payout","kind":"json-schema","title":"rw-bank-payout","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: RSwitch"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RSwitch:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: RWF 10,000,000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Real time to 48 hours"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: Real time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order:"},"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":"text","inline":true,"attributes":{"content":"RSwitch – Conditions: Account addressability, amount ≤ RWF 10,000,000"},"children":[]}]}]}]}],"required":["bankName","bankCode","accountNumber"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"bankCode":{"type":"string","description":"Ripple Bank Code (RBC) for the destination bank in Rwanda. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.","minLength":1,"maxLength":50,"pattern":"^([A-Za-z0-9 ._-]+|RPL:[A-Z]{2}:[A-Z0-9]{7,11}(_\\d+)?:(BNK|WAL))$"},"accountNumber":{"type":"string","description":"The identity's account number associated with the Account Identification Scheme","minLength":4,"maxLength":21,"pattern":"^[a-zA-Z0-9]+$"}}}},"components/schemas/za-bank-payout":{"id":"components/schemas/za-bank-payout","kind":"json-schema","title":"za-bank-payout","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: Bank Payout"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank Payout:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: R 300,000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Real time to 48 hours"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: Real time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order:"},"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":"text","inline":true,"attributes":{"content":"Bank Payout – Conditions: Account addressability, amount ≤ R 300,000"},"children":[]}]}]}]}],"required":["bankName","bankCode","accountNumber"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"bankCode":{"type":"string","description":"Ripple Bank Code (RBC) for the destination bank in South Africa. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.","minLength":1,"maxLength":50,"pattern":"^([A-Za-z0-9 ._-]+|RPL:[A-Z]{2}:[A-Z0-9]{7,11}(_\\d+)?:(BNK|WAL))$"},"accountNumber":{"type":"string","description":"The identity's account number associated with the Account Identification Scheme","minLength":4,"maxLength":21,"pattern":"^[a-zA-Z0-9]+$"}}}},"components/schemas/ug-bank-payout":{"id":"components/schemas/ug-bank-payout","kind":"json-schema","title":"ug-bank-payout","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: Bank Payout"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank Payout:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: UGX 20,000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Real time to 48 hours"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: Real time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order:"},"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":"text","inline":true,"attributes":{"content":"Bank Payout – Conditions: Account addressability, amount ≤ UGX 20,000"},"children":[]}]}]}]}],"required":["bankName","bankCode","accountNumber"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"bankCode":{"type":"string","description":"Ripple Bank Code (RBC) for the destination bank in Uganda. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.","minLength":1,"maxLength":50,"pattern":"^([A-Za-z0-9 ._-]+|RPL:[A-Z]{2}:[A-Z0-9]{7,11}(_\\d+)?:(BNK|WAL))$"},"accountNumber":{"type":"string","description":"The identity's account number associated with the Account Identification Scheme","minLength":4,"maxLength":21,"pattern":"^[a-zA-Z0-9]+$"}}}},"components/schemas/zm-bank-payout":{"id":"components/schemas/zm-bank-payout","kind":"json-schema","title":"zm-bank-payout","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: Bank Payout"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank Payout:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: ZK 150,000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Real time to 48 hours"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: Real time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order:"},"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":"text","inline":true,"attributes":{"content":"Bank Payout – Conditions: Account addressability, amount ≤ ZK 150,000"},"children":[]}]}]}]}],"required":["bankName","bankCode","accountNumber"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"bankCode":{"type":"string","description":"Ripple Bank Code (RBC) for the destination bank in Zambia. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.","minLength":1,"maxLength":50,"pattern":"^([A-Za-z0-9 ._-]+|RPL:[A-Z]{2}:[A-Z0-9]{7,11}(_\\d+)?:(BNK|WAL))$"},"accountNumber":{"type":"string","description":"The identity's account number associated with the Account Identification Scheme","minLength":4,"maxLength":21,"pattern":"^[a-zA-Z0-9]+$"}}}},"components/schemas/eth-wallet":{"id":"components/schemas/eth-wallet","kind":"json-schema","title":"eth-wallet","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: CRYPTO"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRYPTO:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Blockchain dependent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Not applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Policy: Not applicable"},"children":[]}]}]}],"required":["walletAddress","cryptoInstitutionName"],"properties":{"walletAddress":{"type":"string","description":"Receiving wallet address at the exchange","minLength":42,"maxLength":42,"pattern":"^0x[a-fA-F0-9]+$","example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"},"cryptoInstitutionName":{"type":"string","description":"Name of the crypto exchange","example":"Bitso"},"network":{"type":"string","description":"The default name of the blockchain network for this instrument","default":"ETHEREUM","readOnly":true},"supportedCorridors":{"type":"array","readOnly":true,"description":"The list of supported corridors for the payout method","items":{"type":"string","enum":["ETH_USDT","ETH_USDC","ETH_RLUSD"]}}}}},"components/schemas/tron-wallet":{"id":"components/schemas/tron-wallet","kind":"json-schema","title":"tron-wallet","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: CRYPTO"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRYPTO:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Blockchain dependent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Not applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Policy: Not applicable"},"children":[]}]}]}],"required":["walletAddress","cryptoInstitutionName"],"properties":{"walletAddress":{"type":"string","description":"Receiving wallet address at the exchange","minLength":34,"maxLength":34,"pattern":"^T[1-9A-HJ-NP-Za-km-z]+$","example":"T9yD14Nj9j7xAB4dbGeiX9h8unkKHxuWwb"},"cryptoInstitutionName":{"type":"string","description":"Name of the crypto exchange","example":"Bitso"},"network":{"type":"string","description":"The default name of the blockchain network for this instrument","default":"TRON","readOnly":true},"supportedCorridors":{"type":"array","readOnly":true,"description":"The list of supported corridors for the payout method","items":{"type":"string","enum":["TRON_USDT"]}}}}},"components/schemas/sol-wallet":{"id":"components/schemas/sol-wallet","kind":"json-schema","title":"sol-wallet","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: CRYPTO"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRYPTO:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Blockchain dependent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Not applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Policy: Not applicable"},"children":[]}]}]}],"required":["walletAddress","cryptoInstitutionName"],"properties":{"walletAddress":{"type":"string","description":"Receiving wallet address at the exchange","minLength":32,"maxLength":44,"pattern":"^[1-9A-HJ-NP-Za-km-z]+$","example":"7EcDhSYGxXyscszYEp35KHN8vvw3svAuLKTzXwCFLtV"},"cryptoInstitutionName":{"type":"string","description":"Name of the crypto exchange","example":"Bitso"},"network":{"type":"string","description":"The default name of the blockchain network for this instrument","default":"SOLANA","readOnly":true},"supportedCorridors":{"type":"array","readOnly":true,"description":"The list of supported corridors for the payout method","items":{"type":"string","enum":["SOLANA_USDC"]}}}}},"components/schemas/br-pix":{"id":"components/schemas/br-pix","kind":"json-schema","title":"br-pix","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: PIX"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PIX:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: No limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Instant"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Not applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order: Not applicable"},"children":[]}]}]}],"type":"object","required":["bankName","branchNumber","pixKey","pixKeyType"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"bankCode":{"type":"string","description":"The code of the identity's bank (BICFI code)","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"branchNumber":{"type":"string","description":"The identity's bank branch number","minLength":4,"maxLength":6,"pattern":"^\\d{4}(-?[0-9X])?$"},"pixKey":{"type":"string","description":"The identity's PIX key, which can be an email, phone number, or a hash","minLength":6,"maxLength":77,"pattern":"(?x) ^( \\+[1-9]\\d{7,15}$ | [\\p{L}\\p{N}._%+\\-]+@[\\p{L}\\p{N}.\\-]+\\.[\\p{L}]{2,} | [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}- [0-9A-Fa-f]{4}-[0-9A-Fa-f]{12} | \\d{11} | \\d{14} | \\d{3}\\.\\d{3}\\.\\d{3}-\\d{2} | \\d{2}\\.\\d{3}\\.\\d{3}\\/\\d{4}-\\d{2} )$"},"pixKeyType":{"type":"string","x-extensible-enum":["CPF","CNPJ","EMAIL","PHONE","EVP"],"x-enumDescriptions":{"CPF":"Individual taxpayer registry number","CNPJ":"Legal entity identification number","EMAIL":"Email address","PHONE":"Phone number","EVP":"Bank account"},"description":"The type of PIX key used by the identity."}}}},"components/schemas/co-pse":{"id":"components/schemas/co-pse","kind":"json-schema","title":"co-pse","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: PSE"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PSE:"},"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":"Availability: Business days and banking hours only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement:"},"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":"Major banks (Bancolombia, Davivienda, Banco de Bogotá, BBVA, Grupo Aval, Nequi): 35–100 min"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other banks (via ACH): Same-day or T+1 depending on cutoff"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: 3PM COT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Colombia banking holidays apply"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order: Not applicable"},"children":[]}]}]}],"type":"object","required":["bankName","bankCode","accountNumber","accountType"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"bankCode":{"type":"string","description":"The identity's bank identifier code","minLength":1,"maxLength":4,"pattern":"^\\d+$"},"accountNumber":{"type":"string","description":"The identity's account number associated with the Account Identification Scheme","minLength":1,"maxLength":20,"pattern":"^\\d+$"},"accountType":{"type":"string","x-extensible-enum":["CURRENT","SAVINGS"],"x-enumDescriptions":{"CURRENT":"Current account","SAVINGS":"Savings account"},"description":"The type of account associated with the identity."}}}},"components/schemas/br-ted":{"id":"components/schemas/br-ted","kind":"json-schema","title":"br-ted","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: TED"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TED:"},"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":"Availability: Business days only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: No limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Same-day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: ~5:00 PM BRT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Brazil banking holidays apply"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order: Not applicable"},"children":[]}]}]}],"required":["bankName","bankCode","branchNumber","accountNumber","accountType"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"bankCode":{"type":"string","description":"The code of the identity's bank (BICFI code)","minLength":8,"maxLength":11,"pattern":"^[A-Za-z0-9]+$"},"branchNumber":{"type":"string","description":"The branch number of the identity's bank account","minLength":4,"maxLength":6,"pattern":"^\\d{4}(-?[0-9X])?$"},"accountNumber":{"type":"string","description":"The identity's account number associated with the Account Identification Scheme","minLength":5,"maxLength":14,"pattern":"^\\d+$"},"accountType":{"type":"string","x-extensible-enum":["CHECKING","SAVINGS"],"x-enumDescriptions":{"CHECKING":"Checking account","SAVINGS":"Savings account"},"description":"The identity's account type (Savings, Checking etc.)","example":"SAVINGS"}}}},"components/schemas/ca-eft":{"id":"components/schemas/ca-eft","kind":"json-schema","title":"ca-eft","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: EFT"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EFT:"},"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":"Availability: Business days only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: CAD 1,000,000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: T+1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: ~4:30 PM EST"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Canadian banking holidays apply"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order: Not applicable"},"children":[]}]}]}],"required":["bankName","institutionNumber","transitNumber","accountNumber","accountType"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"institutionNumber":{"type":"string","description":"The institution number of the identity's bank","minLength":3,"maxLength":3,"pattern":"^\\d+$"},"transitNumber":{"type":"string","description":"The transit number of the identity's bank account","minLength":5,"maxLength":5,"pattern":"^\\d+$"},"accountNumber":{"type":"string","description":"The identity's account number associated with the Account Identification Scheme","minLength":7,"maxLength":12,"pattern":"^\\d+$"},"accountType":{"type":"string","x-extensible-enum":["CHECKING","SAVINGS"],"x-enumDescriptions":{"CHECKING":"Checking account","SAVINGS":"Savings account"},"description":"The identity's account type."}}}},"components/schemas/kr-kftc":{"id":"components/schemas/kr-kftc","kind":"json-schema","title":"kr-kftc","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: KFTC (Korea Financial Telecommunications and Clearings)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KFTC:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: KRW 10,000,000 per transaction (varies)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Real-time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Not applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order: Not applicable"},"children":[]}]}]}],"required":["bankName","bankCode","accountNumber"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"bankCode":{"type":"string","description":"KFTC-assigned Korean domestic clearing code. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.","minLength":1,"maxLength":10,"pattern":"^[0-9]+$"},"accountNumber":{"type":"string","description":"The identity's bank account number","minLength":1,"maxLength":45,"pattern":"^[A-Za-z0-9]+$"}}}},"components/schemas/in-neft":{"id":"components/schemas/in-neft","kind":"json-schema","title":"in-neft","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: NEFT (National Electronic Funds Transfer)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEFT:"},"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":"Availability: Business days and banking hours only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: No limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Same-day (by end of business day)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: 7:00 PM IST (varies by bank)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: India banking holidays apply"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order: Not applicable"},"children":[]}]}]}],"required":["bankName","ifscCode","accountNumber"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"ifscCode":{"type":"string","description":"The 11-character IFSC code of the identity's bank branch","minLength":11,"maxLength":11,"pattern":"^[A-Z]{4}0[A-Z0-9]{6}$"},"accountNumber":{"type":"string","description":"The identity's bank account number","minLength":4,"maxLength":45,"pattern":"^[A-Za-z0-9]+$"}}}},"components/schemas/pe-lbtr":{"id":"components/schemas/pe-lbtr","kind":"json-schema","title":"pe-lbtr","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: LBTR (Sistema de Liquidación Bruta en Tiempo Real)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LBTR:"},"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":"Availability: Business days and banking hours only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: Minimum Transaction amount is 5 USD"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Same-day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: 3:00 PM PET"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Peru banking holidays apply"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order: Not applicable"},"children":[]}]}]}],"required":["bankName","swiftCode","accountNumber","accountType"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"swiftCode":{"type":"string","description":"SWIFT/BIC code of the identity's bank","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"accountNumber":{"type":"string","description":"The identity's bank account number","minLength":10,"maxLength":20,"pattern":"^[A-Za-z0-9]+$"},"accountType":{"type":"string","x-extensible-enum":["CHECKING","SAVINGS"],"x-enumDescriptions":{"CHECKING":"Checking account","SAVINGS":"Savings account"},"description":"The identity's account type"}}}},"components/schemas/au-npp":{"id":"components/schemas/au-npp","kind":"json-schema","title":"au-npp","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: NPP (New Payments Platform), Direct Entry (DE/BECS)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NPP:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: AUD 20,000 per transaction (higher with arrangement)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Real-time (within 15 minutes)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Not applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Entry (BECS):"},"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":"Availability: Business days only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: No limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Same-day or next business day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: Bank-dependent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Australian banking holidays apply"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order:"},"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":"text","inline":true,"attributes":{"content":"NPP"},"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":"Conditions: beneficiary account is NPP-addressable AND amount ≤ AUD 20,000"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct Entry"},"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":"Conditions: otherwise applicable"},"children":[]}]}]}]}]}]}],"required":["bankName","bsbCode","accountNumber"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"bsbCode":{"type":"string","description":"The 6-digit Bank-State-Branch (BSB) routing code","minLength":6,"maxLength":6,"pattern":"^[0-9]{6}$"},"accountNumber":{"type":"string","description":"The identity's bank account number","minLength":1,"maxLength":11,"pattern":"^\\d+$"}}}},"components/schemas/jp-zengin":{"id":"components/schemas/jp-zengin","kind":"json-schema","title":"jp-zengin","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: Zengin, Zengin Prompt Service"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zengin:"},"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":"Availability: Business days and banking hours only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: No limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Same-day or next business day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: 9:00 PM JST (varies by bank)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Japan banking holidays apply"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zengin Prompt Service:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: JPY 1,000,000 (typically)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Real-time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Not applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order:"},"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":"text","inline":true,"attributes":{"content":"Zengin Prompt Service"},"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":"Conditions: beneficiary account is ZPS-addressable AND amount ≤ JPY 1,000,000"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zengin"},"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":"Conditions: otherwise applicable"},"children":[]}]}]}]}]}]}],"required":["bankName","bankCode","branchCode","accountNumber","accountType","accountHolderName"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"accountHolderName":{"type":"string","description":"Name of the account holder in Japanese Katakana characters","minLength":1,"maxLength":100,"pattern":"^[\\p{L}\\p{N} .,'&\\/()-]+$"},"bankCode":{"type":"string","description":"Zengin-Net/BOJ-assigned 4-digit Japanese bank code (e.g. 0001 Mizuho Bank, 0005 MUFG Bank). See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.","minLength":1,"maxLength":16,"pattern":"^[A-Za-z0-9]+$"},"branchCode":{"type":"string","description":"Bank-assigned branch code identifying the specific branch","minLength":1,"maxLength":50,"pattern":"^[A-Za-z0-9]+$"},"accountNumber":{"type":"string","description":"The identity's bank account number","minLength":1,"maxLength":45,"pattern":"^[A-Za-z0-9]+$"},"accountType":{"type":"string","x-extensible-enum":["CHECKING","ORDINARY","SAVINGS"],"x-enumDescriptions":{"CHECKING":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checking account (当座預金)"},"children":[]}]}]}],"ORDINARY":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ordinary deposit account (普通預金)"},"children":[]}]}]}],"SAVINGS":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Savings account (貯蓄預金)"},"children":[]}]}]}]},"description":"The identity's account type"}}}},"components/schemas/cn-cfxps":{"id":"components/schemas/cn-cfxps","kind":"json-schema","title":"cn-cfxps","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: CFXPS (China Foreign Exchange Payment System)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CFXPS:"},"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":"Availability: Business days and banking hours only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: No limit (institutional)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Same-day or next business day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: 5:00 PM CST (varies by bank)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: China banking holidays apply"},"children":[]}]}]}]}],"required":["bankName","swiftCode","accountNumber","accountHolderName"],"properties":{"bankName":{"type":"string","description":"Beneficiary Bank Name. Looked up from swiftCode.","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"swiftCode":{"type":"string","description":"Beneficiary Bank SWIFT/BIC Code. See the China entry in the bank code lookup in the integration resources for the supported list.","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"accountNumber":{"type":"string","description":"Beneficiary Account Number.","minLength":1,"maxLength":34,"pattern":"^[A-Za-z0-9]+$"},"accountHolderName":{"type":"string","description":"Beneficiary Account Holder Name (English).","minLength":1,"maxLength":140,"pattern":"^[A-Za-z0-9 .,'&\\/()-]+$"}}}},"components/schemas/cl-tef":{"id":"components/schemas/cl-tef","kind":"json-schema","title":"cl-tef","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: TEF (Transferencia Electrónica de Fondos)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEF:"},"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":"Availability: Business days only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: No limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Same-day or next business day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: 3:00 PM CLT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Chile banking holidays apply"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order: Not applicable"},"children":[]}]}]}],"required":["bankName","swiftCode","accountNumber","accountType"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"swiftCode":{"type":"string","description":"SWIFT/BIC code of the identity's bank","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"accountNumber":{"type":"string","description":"The identity's bank account number","minLength":6,"maxLength":34,"pattern":"^[A-Za-z0-9]+$"},"accountType":{"type":"string","x-extensible-enum":["CHECKING","SAVINGS"],"x-enumDescriptions":{"CHECKING":"Checking account","SAVINGS":"Savings account"},"description":"The identity's account type"}}}},"components/schemas/ae-ipi":{"id":"components/schemas/ae-ipi","kind":"json-schema","title":"ae-ipi","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: IPI, FTS"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IPI:"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: AED 25,000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Instant"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Not applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FTS:"},"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":"Availability: Business days only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: No limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Same-day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: ~2:00 PM GST"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: UAE Central Bank holidays apply"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order:"},"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":"text","inline":true,"attributes":{"content":"IPI"},"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":"Conditions: beneficiary account is IPI-addressable AND amount ≤ AED 25,000"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FTS"},"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":"Conditions: otherwise applicable"},"children":[]}]}]}]}]}]}],"required":["bankName","iban"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"iban":{"type":"string","description":"The International Bank Account Number (IBAN) of the identity's account","minLength":23,"maxLength":23,"pattern":"^AE[0-9]{21}$"}}}},"components/schemas/th-promptpay":{"id":"components/schemas/th-promptpay","kind":"json-schema","title":"th-promptpay","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: PromptPay"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PromptPay (National ITMX):"},"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":"Availability: 24/7/365"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: THB 500,000 per transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Real-time (within seconds)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: None"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Not applicable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order: Not applicable"},"children":[]}]}]}],"required":["bankName","bankCode","accountNumber"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$","example":"Bangkok Bank"},"bankCode":{"type":"string","description":"Domestic bank code for the identity's bank in Thailand. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.","minLength":1,"maxLength":16,"pattern":"^[A-Za-z0-9]+$","example":"002"},"accountNumber":{"type":"string","description":"The identity's bank account number","minLength":1,"maxLength":45,"pattern":"^[A-Za-z0-9]+$","example":"1234567890"}}}},"components/schemas/ar-interbanking":{"id":"components/schemas/ar-interbanking","kind":"json-schema","title":"ar-interbanking","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rails: Interbanking"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rail Definitions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interbanking:"},"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":"Availability: Business days only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit: ARS 10,000,000"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement: Same-day or next business day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cut-off time: 3:00 PM ART"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Banking holidays: Argentina banking holidays apply"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Evaluation Order: AR_INTERBANKING has a single payment rail; no routing evaluation order applies."},"children":[]}]}]}],"required":["bankName","bankCode","accountNumber","accountType"],"properties":{"bankName":{"type":"string","description":"The name of the identity's bank. Must begin and end with a letter or digit, and consecutive identical punctuation characters are not permitted.","minLength":2,"maxLength":140,"pattern":"^(?![ .,'&\\/()-])(?!.*([ .,'&\\/()-])\\1)[\\p{L}\\p{N} .,'&\\/()-]+(?<![ .,'&\\/-])?$"},"bankCode":{"type":"string","description":"BCRA-assigned 3-digit Argentine bank code. See the Bank Codes resource in Ripple Docs for the authoritative list of supported values.","minLength":3,"maxLength":3,"pattern":"^\\d{3}$"},"accountNumber":{"type":"string","description":"The identity's account number (CBU or CVU)","minLength":22,"maxLength":22,"pattern":"^\\d{22}$"},"accountType":{"type":"string","x-extensible-enum":["CHECKING","SAVINGS"],"x-enumDescriptions":{"CHECKING":"Checking account (Cuenta Corriente)","SAVINGS":"Savings account (Caja de Ahorro)"},"description":"The identity's account type"}}}},"components/schemas/payment-rail-objects":{"id":"components/schemas/payment-rail-objects","kind":"json-schema","title":"payment-rail-objects","data":{"type":"object","properties":{"usAch":{"$ref":"#/components/schemas/us-ach"},"usFedwire":{"$ref":"#/components/schemas/us-fedwire"},"mxSpei":{"$ref":"#/components/schemas/mx-spei"},"euSepa":{"$ref":"#/components/schemas/eu-sepa"},"gbFps":{"$ref":"#/components/schemas/gb-fps"},"ngBankPayout":{"$ref":"#/components/schemas/ng-bank-payout"},"ghBankPayout":{"$ref":"#/components/schemas/gh-bank-payout"},"rwBankPayout":{"$ref":"#/components/schemas/rw-bank-payout"},"zaBankPayout":{"$ref":"#/components/schemas/za-bank-payout"},"ugBankPayout":{"$ref":"#/components/schemas/ug-bank-payout"},"zmBankPayout":{"$ref":"#/components/schemas/zm-bank-payout"},"ethWallet":{"$ref":"#/components/schemas/eth-wallet"},"tronWallet":{"$ref":"#/components/schemas/tron-wallet"},"solWallet":{"$ref":"#/components/schemas/sol-wallet"},"brPix":{"$ref":"#/components/schemas/br-pix"},"coPse":{"$ref":"#/components/schemas/co-pse"},"brTed":{"$ref":"#/components/schemas/br-ted"},"caEft":{"$ref":"#/components/schemas/ca-eft"},"krKftc":{"$ref":"#/components/schemas/kr-kftc"},"inNeft":{"$ref":"#/components/schemas/in-neft"},"peLbtr":{"$ref":"#/components/schemas/pe-lbtr"},"auNpp":{"$ref":"#/components/schemas/au-npp"},"jpZengin":{"$ref":"#/components/schemas/jp-zengin"},"cnCfxps":{"$ref":"#/components/schemas/cn-cfxps"},"clTef":{"$ref":"#/components/schemas/cl-tef"},"aeIpi":{"$ref":"#/components/schemas/ae-ipi"},"thPromptpay":{"$ref":"#/components/schemas/th-promptpay"},"arInterbanking":{"$ref":"#/components/schemas/ar-interbanking"}}}},"components/schemas/ripple-financial-instrument":{"id":"components/schemas/ripple-financial-instrument","kind":"json-schema","title":"ripple-financial-instrument","data":{"type":"object","description":"Request to create a new financial instrument for an identity.\n","allOf":[{"$ref":"#/components/schemas/payment-rail-objects"},{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/financial-instrument-currency"},"label":{"type":"string","maxLength":256,"description":"A user-defined label for the financial instrument.","example":"mexico bank account"},"financialInstrumentType":{"$ref":"#/components/schemas/financial-instrument-type"}}}],"required":["financialInstrumentType","currency"]}},"components/schemas/ripple-financial-instrument-entry":{"id":"components/schemas/ripple-financial-instrument-entry","kind":"json-schema","title":"ripple-financial-instrument-entry","data":{"allOf":[{"$ref":"#/components/schemas/ripple-financial-instrument"},{"type":"object","properties":{"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 2-letter ISO 3166-1 alpha-2 country code of the financial instrument. This field is omitted when no country jurisdiction applies (for example, crypto wallet instruments such as ETH_WALLET, TRON_WALLET, and SOL_WALLET). An absent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be interpreted as \"no applicable jurisdiction\"."},"children":[]}]}]}],"example":"MX","minLength":2,"maxLength":2,"pattern":"^[A-Z]+$"},"financialInstrumentId":{"type":"string","description":"The unique identifier of the financial instrument.","example":"3fc74743-e7f3-414a-9fcf-eb8c1d52356a"},"createdAt":{"type":"string","format":"date-time","description":"The time at which the financial instrument was created","example":"2023-11-02T18:26:00.000Z"},"updatedAt":{"type":"string","format":"date-time","description":"The time at which the financial instrument was last updated","example":"2023-11-03T18:26:00.000Z"}}}]}},"components/schemas/put-ripple-financial-instrument":{"id":"components/schemas/put-ripple-financial-instrument","kind":"json-schema","title":"put-ripple-financial-instrument","data":{"type":"object","description":"Request to update an existing financial instrument of an identity.\n","allOf":[{"$ref":"#/components/schemas/payment-rail-objects"}],"properties":{"label":{"type":"string","maxLength":256,"description":"A user-defined label for the financial instrument.","example":"mexico bank account"}}}},"components/schemas/QuoteErrorResponse":{"id":"components/schemas/QuoteErrorResponse","kind":"json-schema","title":"QuoteErrorResponse","data":{"type":"object","required":["errors","status"],"properties":{"errors":{"description":"List of quote errors","type":"array","items":{"$ref":"#/components/schemas/QuoteError"}},"status":{"type":"integer","description":"Response status code"}},"additionalProperties":false}},"components/schemas/QuoteError":{"id":"components/schemas/QuoteError","kind":"json-schema","title":"QuoteError","data":{"type":"object","required":["code","title","type","description","timestamp"],"properties":{"code":{"type":"string","minLength":1,"maxLength":128,"description":"Unique identifier of an error","example":"SYS_100"},"title":{"type":"string","minLength":1,"maxLength":128,"description":"Error message providing a brief summary of the error","example":"Unable to process the request due to an internal server error."},"type":{"type":"string","minLength":1,"maxLength":128,"description":"Identifies the problem type","example":"USER_VALIDATION_ERROR"},"description":{"type":"string","minLength":1,"maxLength":1024,"description":"Provides more technical information","example":"Customer not found"},"timestamp":{"type":"string","minLength":1,"maxLength":128,"format":"date-time","description":"The time when this error occurred, specified in UTC.","example":"2023-11-02T18:26:00.000123Z"}},"additionalProperties":false}},"components/schemas/QuoteStatus":{"id":"components/schemas/QuoteStatus","kind":"json-schema","title":"QuoteStatus","data":{"type":"string","enum":["EXPIRED","ACTIVE"],"x-enumDescriptions":{"EXPIRED":"Expired quote","ACTIVE":"Quote that you can accept to create a payment."},"example":"ACTIVE"}},"components/schemas/QuoteAmountType":{"id":"components/schemas/QuoteAmountType","kind":"json-schema","title":"QuoteAmountType","data":{"type":"string","description":"The type of amount for which you want to get a quote.","default":"SOURCE_AMOUNT","enum":["SOURCE_AMOUNT","DESTINATION_AMOUNT"],"x-enumDescriptions":{"SOURCE_AMOUNT":"Specify this value to get a quote for the amount that you want to send.","DESTINATION_AMOUNT":"Specify this value to get a quote for the amount that the beneficiary should receive."}}},"components/schemas/QuoteCollectionRequest":{"id":"components/schemas/QuoteCollectionRequest","kind":"json-schema","title":"QuoteCollectionRequest","data":{"type":"object","description":"Request to create a quote collection","required":["quoteAmountType","quoteAmount","sourceCurrency","destinationCurrency","payoutCategory","payinCategory"],"properties":{"quoteAmount":{"description":"The amount for which you wish to receive a collection of quotes.","type":"number","format":"double","minimum":1,"example":123.45},"quoteAmountType":{"$ref":"#/components/schemas/QuoteAmountType"},"sourceCurrency":{"description":"The currency code of the currency that you are sending.","type":"string","pattern":"^[a-zA-Z]{3,5}$","example":"USD"},"destinationCurrency":{"description":"The currency code of the currency in which your beneficiary will receive this payment.","type":"string","pattern":"^[a-zA-Z]{3,5}$","example":"MXN"},"sourceCountry":{"description":"The country code of the country from where you are sending the funds. This is an ISO 3166-1 alpha-2 code.","type":"string","pattern":"^[a-zA-Z]{2}$","example":"US"},"destinationCountry":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country where the beneficiary is located specified in Alpha-2 Code format as defined in the ISO CountryCode ISO 3166-1 list. If the beneficiary is an individual, then this value is their country of residence. If the beneficiary is an institution, then this value is their country of incorporation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for a fiat payout; omitting it returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USR_017"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Ignored for a stablecoin payout."},"children":[]}]}]}],"type":"string","pattern":"^[a-zA-Z]{2}$","example":"PH"},"payoutCategory":{"description":"The name of the payout category.","type":"string","minLength":1,"maxLength":128,"x-enumDescriptions":{"BANK":"Indicates that the payout will be made in fiat currency to a recipient's bank account through local banking rails.","CRYPTO":"Indicates that the payout will be made in stablecoin to a recipient's crypto wallet address."},"example":"BANK"},"payinCategory":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the pay in category indicating how this payment will be funded. The values FUNDED and T_PLUS_ONE are deprecated and will be removed in a future release."},"children":[]}]}]}],"type":"string","minLength":1,"maxLength":128,"x-enumDescriptions":{"PRE_FUNDING":"Indicates that the payment is being made from funds you've deposited with Ripple.","CREDIT_FUNDING":"Indicates the payment is being made and you will pay the outstanding invoice.","JIT_FUNDING":"Indicates that the payment is being made and you will pay the outstanding amount before the payment expires.","FUNDED":"Indicates that the payment is being made from funds you've deposited with Ripple.","T_PLUS_ONE":"Indicates the payment is being made and you will pay the outstanding invoice."},"example":"PRE_FUNDING"},"destinationBlockchainNetwork":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the blockchain network on which the beneficiary will receive this payment. Required for a stablecoin payout; omitting it returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USR_017"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","minLength":1,"maxLength":20,"example":"Ethereum"}},"additionalProperties":false}},"components/schemas/Quote":{"id":"components/schemas/Quote","kind":"json-schema","title":"Quote","data":{"type":"object","required":["quoteId","quoteStatus","sourceCurrency","destinationCurrency","payoutCategory","payinCategory"],"properties":{"quoteId":{"description":"Unique ID that represents this quote.","type":"string","format":"uuid","minLength":1,"maxLength":36,"example":"7ea3399c-1234-5678-8d8f-d320ea406630"},"quoteStatus":{"$ref":"#/components/schemas/QuoteStatus"},"quoteAmountType":{"$ref":"#/components/schemas/QuoteAmountType"},"sourceAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to be sent by the originator. The value is rounded to the number of decimal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"places defined by the ISO 4217 standard for the source currency (for example, 2 for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD/EUR, 0 for JPY/KRW, 3 for BHD/KWD), using HALF_UP rounding mode."},"children":[]}]}]}],"type":"number","format":"double","minimum":1,"example":123.45},"destinationAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to be received by the beneficiary. The value is rounded to the number of decimal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"places defined by the ISO 4217 standard for the destination currency (for example, 2 for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USD/EUR, 0 for JPY/KRW, 3 for BHD/KWD), using HALF_UP rounding mode."},"children":[]}]}]}],"type":"number","minimum":1,"format":"double","example":2438.19},"sourceCurrency":{"description":"The currency code of the currency that you are sending.","type":"string","pattern":"^[a-zA-Z]{3,5}$","example":"USD"},"destinationCurrency":{"description":"The currency code of the currency in which your beneficiary will receive this payment.","type":"string","pattern":"^[a-zA-Z]{3,5}$","example":"MXN"},"sourceCountry":{"description":"The country where the payment originator is located or incorporated, specified in Alpha-2 Code format as defined in the ISO CountryCode ISO 3166-1 list.","type":"string","pattern":"^[a-zA-Z]{2}$","example":"US"},"destinationCountry":{"description":"The country code to which you wish to send the funds. It follows ISO 3166-1 alpha-2 code","type":"string","pattern":"^[a-zA-Z]{2}$","example":"MX"},"payoutCategory":{"description":"Name of the payout category specified in the quote request.","type":"string","minLength":1,"maxLength":128,"example":"BANK"},"payinCategory":{"description":"The name of payin category specified in the quote request.","type":"string","minLength":1,"maxLength":128,"example":"PRE_FUNDING"},"adjustedExchangeRate":{"$ref":"#/components/schemas/AdjustedExchangeRate"},"fees":{"type":"array","description":"A summary of fees included in this quote.","items":{"$ref":"#/components/schemas/FeeSummary"}},"taxes":{"type":"array","description":"A summary of taxes included in this quote.","items":{"$ref":"#/components/schemas/TaxSummary"}},"createdAt":{"type":"string","minLength":1,"maxLength":128,"format":"date-time","example":"2023-11-02T18:26:00.000123Z","description":"The time when this quote was created, specified in UTC."},"expiresAt":{"type":"string","minLength":1,"maxLength":128,"format":"date-time","example":"2023-11-02T18:26:00.000123Z","description":"The time when this quote expires, specified in UTC."},"destinationBlockchainNetwork":{"description":"The name of the blockchain network on which the beneficiary will receive this payment.","type":"string","minLength":1,"maxLength":20,"example":"Ethereum"},"paymentRail":{"description":"The payment rail used for this quote.","type":"string","minLength":1,"maxLength":50,"example":"RTP"}},"additionalProperties":false}},"components/schemas/QuoteCollection":{"id":"components/schemas/QuoteCollection","kind":"json-schema","title":"QuoteCollection","data":{"type":"object","required":["quoteCollectionId","quotes"],"properties":{"quoteCollectionId":{"description":"Unique ID that represents this quote collection.","type":"string","minLength":1,"maxLength":36,"format":"uuid","example":"11111111-aaaa-2222-bbbb-222222222222"},"quotes":{"description":"List of quotes","type":"array","minItems":0,"items":{"$ref":"#/components/schemas/Quote"}}},"additionalProperties":false}},"schema_0":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7617"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"base64-encoded"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id:client_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If provided here they aren't required in the request body."},"children":[]}]}]}],"example":"Basic ZGVtbzpwQDU1dzByZA=="},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ValidateTokenResponse"},"type":"array"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string","maxLength":256},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"integer","minimum":1,"example":20,"default":10},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"example":20,"default":10},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"boolean","example":true},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"11111111-aaaa-2222-bbbb-222222222222"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"22222222-aaaa-2222-bbbb-222222222222"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"object","description":"Customer available prefund balance details.","properties":{"timestamp":{"type":"string","format":"date-time","example":"2025-01-10T00:00:00.000000Z","description":"Timestamp of the balance response."},"balances":{"type":"array","items":{"type":"object","description":"Customer available prefund balance for specific currency","properties":{"fundingType":{"enum":["FUNDED"],"x-enumDescriptions":{"FUNDED":"Indicates that you initiate payments using the funds you added to your account."},"description":"The funding method associated with your account."},"currency":{"type":"string","example":"USD","description":"Currency code."},"availableBalance":{"type":"string","example":"1000.00","description":"Available funded balance that you can use to initiate payments, represented as a decimal string."},"reservedBalance":{"type":"string","example":"100.00","description":"Amount reserved to complete in-progress transactions. You can't use this amount to initiate new payments, represented as a decimal string."}},"required":["fundingType","currency","availableBalance","reservedBalance"]},"description":"List of available prefund balances."}},"required":["timestamp","balances"]},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"object","required":["status","errors"],"properties":{"status":{"type":"integer","description":"The HTTP status code representing the error response","example":400},"errors":{"type":"array","description":"An array containing details about the errors encountered","items":{"type":"object","required":["code","title","type","description","timestamp"],"properties":{"code":{"type":"string","description":"A unique error code that identifies the specific error","example":"SYS_003"},"type":{"type":"string","description":"A high-level categorization of the error, indicating the type of issue that occurred","example":"SYSTEM_ERROR"},"title":{"type":"string","description":"A brief, user-friendly description of the error","example":"Internal Server Error"},"description":{"type":"string","description":"A more detailed explanation of the error, including potential causes and next steps","example":"The payout category value must be one of BANK, EWALLET, CASH_PICKUP, or ATM."},"timestamp":{"type":"string","format":"date-time","description":"The timestamp of the error occurrence","example":"2024-01-02T14:16:00Z"}}}}}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":50},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"object","description":"A page of ledger statement transactions and pagination metadata.","properties":{"offset":{"type":"string","description":"Offset used in the request to skip a specific number of records.","example":"0"},"pageSize":{"type":"string","description":"Number of records requested per page","example":"25"},"pageElements":{"type":"string","description":"Number of records returned in requested page","example":"25"},"total":{"type":"string","description":"Total number of records available for the given filters.","example":"1000"},"statementTransactions":{"type":"array","description":"Statement transaction details for the customer.","items":{"type":"object","properties":{"tenant":{"type":"string","description":"Identifier of the customer that owns this ledger transaction.","example":"rocketfuel"},"amount":{"type":"string","description":"Amount of the transaction applied to the customer's ledger account, represented as a decimal string.","example":"100.00"},"currency":{"type":"string","description":"Three-letter ISO 4217 currency code of the transaction.","example":"USD"},"txnReference":{"type":"string","nullable":true,"description":"External reference that links this ledger transaction to a payment or other upstream operation.\n"},"operation":{"type":"string","description":"Operation performed on the customer's prefunded ledger account.","x-enumDescriptions":{"CREDIT":"Credit to the ledger account.","RESERVE":"Funds reserved in an intermediate state.","DEBIT":"Funds debited from the reserved state.","RELEASE":"Reserved funds released back to the account.","VOID_PREFUND_BALANCE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefund balance has been voided. [Deprecated]"},"children":[]}]}]}],"OVERRIDE_PREFUND_BALANCE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefund balance has been overridden. [Deprecated]"},"children":[]}]}]}],"VOID_BALANCE":"Balance has been voided.","OVERRIDE_BALANCE":"Balance has been overridden."}},"txnSource":{"type":"string","description":"Source of the ledger transaction (for example, which system or flow created it).","x-enumDescriptions":{"PAYMENTS":"Created by a payments flow.","BANK":"Created by a bank transaction.","POSTED_PAYMENT":"Created by a posted payment operation.","CREDIT_MEMO":"Created by a credit memo.","MANUAL":"Created manually via API."}},"status":{"type":"string","description":"State of the ledger transaction.","x-enumDescriptions":{"SUCCESS":"Ledger transaction completed successfully.","PENDING":"Reserved for future use to represent an in-flight ledger transaction."}},"createdDttm":{"type":"string","format":"date-time","nullable":false,"description":"Timestamp (UTC) when the ledger transaction was created.","example":"2024-06-01T00:00:00.000000Z"},"updatedDttm":{"type":"string","format":"date-time","nullable":false,"description":"Timestamp (UTC) when the ledger transaction was last updated.","example":"2024-06-01T00:00:00.000000Z"},"availableBalanceBefore":{"type":"string","description":"Available ledger account balance (in the transaction currency) immediately before this transaction was applied, represented as a decimal string.","example":"100.00"},"availableBalanceAfter":{"type":"string","description":"Available ledger account balance (in the transaction currency) immediately after this transaction was applied, represented as a decimal string.","example":"90.00"}}}}}},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"string","description":"A CSV formatted string containing the ledger transactions.\nColumns include: tenant, amount, currency, txnReference, operation, txnSource, status, createdDttm, updatedDttm, availableBalanceBefore, availableBalanceAfter.\n"},"id":"schema_16"}},"exampleStore":{"components/examples/error-500-example":{"id":"components/examples/error-500-example","value":{"code":"500","category":"APPLICATION","title":"Internal Server Error","detail":"The server encountered an error.","retryable":true}},"components/examples/error-400-example":{"id":"components/examples/error-400-example","value":{"code":"400","category":"CLIENT_ERROR","title":"Bad Request","detail":"Invalid request. Check your request parameters and try again.","retryable":true}},"components/examples/error-404-example":{"id":"components/examples/error-404-example","value":{"code":"404","category":"CLIENT_ERROR","title":"Not Found","detail":"The identity does not exist. Please provide a valid identityId.","retryable":false}},"components/examples/error-409-example":{"id":"components/examples/error-409-example","value":{"code":"409","category":"CLIENT_ERROR","title":"Conflict","detail":"A conflict occurred. The resource already exists or cannot be processed due to a conflict.","retryable":false}},"components/examples/error-bad-request":{"id":"components/examples/error-bad-request","value":{"status":400,"errors":[{"code":"USR_001","type":"USER_ERROR","title":"Bad request","description":"Invalid request. Check your request parameters and try again.","timestamp":"2024-12-01T12:00:00Z"}]},"description":"Default response when the request is malformed or a parameter fails validation."},"components/examples/error-invalid-request-body":{"id":"components/examples/error-invalid-request-body","value":{"status":400,"errors":[{"code":"USR_055","type":"USER_ERROR","title":"Invalid request body","description":"Unable to create payment because the request body is empty or contains unexpected characters. Try again with all valid request body.","timestamp":"2024-12-01T12:00:00Z"}]},"description":"Returned when a field in the request body has an unexpected type or value."},"components/examples/error-forbidden":{"id":"components/examples/error-forbidden","value":{"status":403,"errors":[{"code":"AUTH_051","type":"AUTH_ERROR","title":"Unauthorized","description":"Invalid request. Check your request parameters and try again.","timestamp":"2024-12-01T12:00:00Z"}]},"description":"Returned when the payment exists but is owned by another tenant."},"components/examples/error-resource-not-found":{"id":"components/examples/error-resource-not-found","value":{"status":404,"errors":[{"code":"USR_002","type":"NOT_FOUND","title":"Resource not found","description":"The requested resource could not be found.","timestamp":"2024-12-01T12:00:00Z"}]},"description":"Returned when no resource matches the supplied identifier."},"components/examples/error-unsupported-media-type":{"id":"components/examples/error-unsupported-media-type","value":{"status":415,"errors":[{"code":"USR_075","type":"USER_ERROR","title":"Missing or unsupported content type","description":"The request is either missing the 'Content-Type' header or the header contains an unsupported value. Set the 'Content-Type' header value to 'application/json' and try again.","timestamp":"2024-12-01T12:00:00Z"}]},"description":"Returned when the Content-Type header is missing or not supported."},"components/examples/error-insufficient-balance":{"id":"components/examples/error-insufficient-balance","value":{"status":402,"errors":[{"code":"USR_067","type":"USER_ERROR","title":"Insufficient balance","description":"Payment failed due to insufficient balance. Add funds to your account and try again.","timestamp":"2024-12-01T12:00:00Z"}]},"description":"Returned when the account does not hold enough balance to fund the payment."},"components/examples/error-internal-server":{"id":"components/examples/error-internal-server","value":{"status":500,"errors":[{"code":"SYS_001","type":"SYSTEM_ERROR","title":"Internal server error","description":"Unable to process the request due to an internal server error.","timestamp":"2024-12-01T12:00:00Z"}]},"description":"Default response for an unhandled server-side failure."},"paths/~1v2~1oauth~1token/post/responses/400/content/application~1json/example":{"value":{"error_description":"Missing required parameter: grant_type","error":"invalid_request"},"id":"paths/~1v2~1oauth~1token/post/responses/400/content/application~1json/example"},"paths/~1v2~1oauth~1token/post/responses/401/content/application~1json/example":{"value":{"error_description":"Unauthorized","error":"access_denied"},"id":"paths/~1v2~1oauth~1token/post/responses/401/content/application~1json/example"},"paths/~1v2~1oauth~1token/post/responses/403/content/application~1json/example":{"value":{"error_description":"Service not enabled within domain: <wrong:domain>","error":"access_denied"},"id":"paths/~1v2~1oauth~1token/post/responses/403/content/application~1json/example"},"paths/~1v2~1oauth~1token~1test/get/responses/400/content/text~1plain/example":{"value":"Invalid Request parameters [Invalid bearer authentication token]","id":"paths/~1v2~1oauth~1token~1test/get/responses/400/content/text~1plain/example"},"paths/~1v3~1identities/post/requestBody/content/application~1json/examples/create-individual-originator":{"value":{"identityType":"INDIVIDUAL","paymentRole":"ORIGINATOR","internalId":"customer-12345-uuid","nickName":"Alice Sender USD","tags":["sender","priority"],"validatePayoutRails":["CO_PSE"],"individual":{"firstName":"Alice","lastName":"Chen","dateOfBirth":"1990-05-14","citizenship":"US","address":{"streetAddress":["123 Main Street"],"city":"San Francisco","stateOrProvince":"CA","postalCode":"94105","country":"US"}}},"key":"create-individual-originator","summary":"INDIVIDUAL ORIGINATOR","id":"paths/~1v3~1identities/post/requestBody/content/application~1json/examples/create-individual-originator"},"paths/~1v3~1identities/post/requestBody/content/application~1json/examples/create-business-beneficiary":{"value":{"identityType":"BUSINESS","paymentRole":"BENEFICIARY","nickName":"Widgets Org MX","tags":["beneficiary","mx"],"validatePayoutRails":["CO_PSE"],"business":{"businessName":"Widgets Org","incorporationCountry":"US","registration":[{"number":"123ABC","type":"INCORPORATION_CERTIFICATE"}],"email":"fake@example.com","phone":"+1234567890","address":{"streetAddress":["123 Example MA"],"city":"Boston","stateOrProvince":"MS","postalCode":"12345","country":"US"}}},"key":"create-business-beneficiary","summary":"BUSINESS BENEFICIARY","id":"paths/~1v3~1identities/post/requestBody/content/application~1json/examples/create-business-beneficiary"},"paths/~1v3~1identities/post/responses/201/content/application~1json/example":{"value":{"identityId":"99254c4f-f207-4792-a846-06928825018c","version":"1"},"id":"paths/~1v3~1identities/post/responses/201/content/application~1json/example"},"paths/~1v3~1identities/post/responses/400/content/application~1json/examples/error-response-400":{"value":{"code":"400","category":"CLIENT_ERROR","title":"Bad Request","detail":"Invalid request. Check your request parameters and try again.","retryable":true},"key":"error-response-400","summary":"error-response-400","id":"paths/~1v3~1identities/post/responses/400/content/application~1json/examples/error-response-400"},"paths/~1v3~1identities/post/responses/500/content/application~1json/examples/error-response-500":{"value":{"code":"500","category":"APPLICATION","title":"Internal Server Error","detail":"The server encountered an error.","retryable":true},"key":"error-response-500","summary":"error-response-500","id":"paths/~1v3~1identities/post/responses/500/content/application~1json/examples/error-response-500"},"paths/~1v3~1identities/get/responses/200/content/application~1json/examples/list-identities-v3":{"value":{"data":[{"identityId":"0116bacc-ffbf-4fa2-a29c-ecd9ea346806","identityType":"BUSINESS","paymentRole":"BENEFICIARY","createdAt":"2025-10-01T16:14:13.200Z","updatedAt":"2025-10-01T16:14:15.763Z","identityState":"ACTIVE","nickName":"testNickName","tags":["tag1"],"version":2,"schemaVersion":"1.0.0"},{"identityId":"1d927c62-45fa-4f42-b9f8-8210e1a111bb","identityType":"INDIVIDUAL","paymentRole":"ORIGINATOR","createdAt":"2025-10-01T17:20:05.111Z","updatedAt":"2025-10-01T17:20:06.500Z","identityState":"ACTIVE","nickName":"Alice Originator","tags":["sender","priority"],"version":1,"schemaVersion":"1.0.0"}],"nextToken":"eyJrZXkxIjoidmFsdWUifQ=="},"key":"list-identities-v3","summary":"list-identities-v3","id":"paths/~1v3~1identities/get/responses/200/content/application~1json/examples/list-identities-v3"},"paths/~1v3~1identities/get/responses/400/content/application~1json/examples/error-response-400":{"value":{"code":"400","category":"CLIENT_ERROR","title":"Bad Request","detail":"Invalid request. Check your request parameters and try again.","retryable":true},"key":"error-response-400","summary":"error-response-400","id":"paths/~1v3~1identities/get/responses/400/content/application~1json/examples/error-response-400"},"paths/~1v3~1identities/get/responses/404/content/application~1json/examples/error-response-404":{"value":{"code":"404","category":"CLIENT_ERROR","title":"Not Found","detail":"The identity does not exist. Please provide a valid identityId.","retryable":false},"key":"error-response-404","summary":"error-response-404","id":"paths/~1v3~1identities/get/responses/404/content/application~1json/examples/error-response-404"},"paths/~1v3~1identities/get/responses/500/content/application~1json/examples/error-response-500":{"value":{"code":"500","category":"APPLICATION","title":"Internal Server Error","detail":"The server encountered an error.","retryable":true},"key":"error-response-500","summary":"error-response-500","id":"paths/~1v3~1identities/get/responses/500/content/application~1json/examples/error-response-500"},"paths/~1v3~1identities~1{identity-id}/get/responses/200/content/application~1json/examples/get-identity-v3":{"value":{"identityId":"9d839f58-7fd3-4913-a27e-48d31973d3f9","identityState":"ACTIVE","nickName":"nickName","tags":["tag1"],"version":"2","schemaVersion":"1.0.0","createdAt":"2025-10-01T18:46:41.833Z","updatedAt":"2025-10-01T18:46:47.430Z","identityType":"BUSINESS","paymentRole":"BENEFICIARY","business":{"businessName":"Widgets Org","address":{"streetAddress":["123 Example MA"],"country":"US","city":"Boston","stateOrProvince":"MS","postalCode":"12345"},"email":"fake@example.com","phone":"+1234567890","registration":[{"number":"123ABC","type":"INCORPORATION_CERTIFICATE"}],"incorporationCountry":"US"}},"key":"get-identity-v3","summary":"get-identity-v3","id":"paths/~1v3~1identities~1{identity-id}/get/responses/200/content/application~1json/examples/get-identity-v3"},"paths/~1v3~1identities~1{identity-id}/get/responses/400/content/application~1json/examples/error-response-400":{"value":{"code":"400","category":"CLIENT_ERROR","title":"Bad Request","detail":"Invalid request. Check your request parameters and try again.","retryable":true},"key":"error-response-400","summary":"error-response-400","id":"paths/~1v3~1identities~1{identity-id}/get/responses/400/content/application~1json/examples/error-response-400"},"paths/~1v3~1identities~1{identity-id}/get/responses/404/content/application~1json/examples/error-response-404":{"value":{"code":"404","category":"CLIENT_ERROR","title":"Not Found","detail":"The identity does not exist. Please provide a valid identityId.","retryable":false},"key":"error-response-404","summary":"error-response-404","id":"paths/~1v3~1identities~1{identity-id}/get/responses/404/content/application~1json/examples/error-response-404"},"paths/~1v3~1identities~1{identity-id}/get/responses/500/content/application~1json/examples/error-response-500":{"value":{"code":"500","category":"APPLICATION","title":"Internal Server Error","detail":"The server encountered an error.","retryable":true},"key":"error-response-500","summary":"error-response-500","id":"paths/~1v3~1identities~1{identity-id}/get/responses/500/content/application~1json/examples/error-response-500"},"paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-metadata":{"value":{"nickName":"Alice Sender USD - Updated","tags":["usd","high-value"]},"key":"put-metadata","summary":"Update nickname and tags","id":"paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-metadata"},"paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-individual-address":{"value":{"individual":{"address":{"streetAddress":["500 Market Street"],"city":"San Francisco","stateOrProvince":"CA","postalCode":"94103","country":"US"}}},"key":"put-individual-address","summary":"Update INDIVIDUAL address","id":"paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-individual-address"},"paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-business-contact":{"value":{"business":{"email":"ops@example.com","phone":"+14155551234"}},"key":"put-business-contact","summary":"Update BUSINESS contact info","id":"paths/~1v3~1identities~1{identity-id}/put/requestBody/content/application~1json/examples/put-business-contact"},"paths/~1v3~1identities~1{identity-id}/put/responses/400/content/application~1json/examples/error-response-400":{"value":{"code":"400","category":"CLIENT_ERROR","title":"Bad Request","detail":"Invalid request. Check your request parameters and try again.","retryable":true},"key":"error-response-400","summary":"error-response-400","id":"paths/~1v3~1identities~1{identity-id}/put/responses/400/content/application~1json/examples/error-response-400"},"paths/~1v3~1identities~1{identity-id}/put/responses/404/content/application~1json/examples/error-response-404":{"value":{"code":"404","category":"CLIENT_ERROR","title":"Not Found","detail":"The identity does not exist. Please provide a valid identityId.","retryable":false},"key":"error-response-404","summary":"error-response-404","id":"paths/~1v3~1identities~1{identity-id}/put/responses/404/content/application~1json/examples/error-response-404"},"paths/~1v3~1identities~1{identity-id}/put/responses/500/content/application~1json/examples/error-response-500":{"value":{"code":"500","category":"APPLICATION","title":"Internal Server Error","detail":"The server encountered an error.","retryable":true},"key":"error-response-500","summary":"error-response-500","id":"paths/~1v3~1identities~1{identity-id}/put/responses/500/content/application~1json/examples/error-response-500"},"paths/~1v3~1identities~1{identity-id}/delete/responses/400/content/application~1json/examples/error-response-400":{"value":{"code":"400","category":"CLIENT_ERROR","title":"Bad Request","detail":"Invalid request. Check your request parameters and try again.","retryable":true},"key":"error-response-400","summary":"error-response-400","id":"paths/~1v3~1identities~1{identity-id}/delete/responses/400/content/application~1json/examples/error-response-400"},"paths/~1v3~1identities~1{identity-id}/delete/responses/404/content/application~1json/examples/error-response-404":{"value":{"code":"404","category":"CLIENT_ERROR","title":"Not Found","detail":"The identity does not exist. Please provide a valid identityId.","retryable":false},"key":"error-response-404","summary":"error-response-404","id":"paths/~1v3~1identities~1{identity-id}/delete/responses/404/content/application~1json/examples/error-response-404"},"paths/~1v3~1identities~1{identity-id}/delete/responses/500/content/application~1json/examples/error-response-500":{"value":{"code":"500","category":"APPLICATION","title":"Internal Server Error","detail":"The server encountered an error.","retryable":true},"key":"error-response-500","summary":"error-response-500","id":"paths/~1v3~1identities~1{identity-id}/delete/responses/500/content/application~1json/examples/error-response-500"},"paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/200/content/application~1json/examples/get-identity-v3":{"value":{"identityId":"9d839f58-7fd3-4913-a27e-48d31973d3f9","identityState":"ACTIVE","nickName":"nickName","tags":["tag1"],"version":"2","schemaVersion":"1.0.0","createdAt":"2025-10-01T18:46:41.833Z","updatedAt":"2025-10-01T18:46:47.430Z","identityType":"BUSINESS","paymentRole":"ORIGINATOR","internalId":"customer-12345-uuid","business":{"businessName":"Widgets Org","address":{"streetAddress":["123 Example MA"],"country":"US","city":"Boston","stateOrProvince":"MS","postalCode":"12345"},"email":"fake@example.com","phone":"+1234567890","registration":[{"number":"123ABC","type":"INCORPORATION_CERTIFICATE"}],"incorporationCountry":"US"}},"key":"get-identity-v3","summary":"get-identity-v3","id":"paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/200/content/application~1json/examples/get-identity-v3"},"paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/400/content/application~1json/examples/error-response-400":{"value":{"code":"400","category":"CLIENT_ERROR","title":"Bad Request","detail":"Invalid request. Check your request parameters and try again.","retryable":true},"key":"error-response-400","summary":"error-response-400","id":"paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/400/content/application~1json/examples/error-response-400"},"paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/404/content/application~1json/examples/error-response-404":{"value":{"code":"404","category":"CLIENT_ERROR","title":"Not Found","detail":"The identity does not exist. Please provide a valid identityId.","retryable":false},"key":"error-response-404","summary":"error-response-404","id":"paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/404/content/application~1json/examples/error-response-404"},"paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/500/content/application~1json/examples/error-response-500":{"value":{"code":"500","category":"APPLICATION","title":"Internal Server Error","detail":"The server encountered an error.","retryable":true},"key":"error-response-500","summary":"error-response-500","id":"paths/~1v3~1identities~1by-internal-id~1{internal-id}/get/responses/500/content/application~1json/examples/error-response-500"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/requestBody/content/application~1json/examples/create-us-ach":{"value":{"financialInstrumentType":"US_ACH","currency":"USD","label":"US bank account","usAch":{"bankName":"Bank of Example","bankRoutingNumber":"266231608","accountNumber":"60480","accountType":"CHECKING"}},"key":"create-us-ach","summary":"US_ACH bank account","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/requestBody/content/application~1json/examples/create-us-ach"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/201/content/application~1json/example":{"value":{"financialInstrumentId":"d3cd4f8e-3a6d-46e6-bdb6-0b7f358f2ad8"},"id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/201/content/application~1json/example"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/400/content/application~1json/examples/error-response-400":{"value":{"code":"400","category":"CLIENT_ERROR","title":"Bad Request","detail":"Invalid request. Check your request parameters and try again.","retryable":true},"key":"error-response-400","summary":"error-response-400","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/400/content/application~1json/examples/error-response-400"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/404/content/application~1json/examples/error-response-404":{"value":{"code":"404","category":"CLIENT_ERROR","title":"Not Found","detail":"The identity does not exist. Please provide a valid identityId.","retryable":false},"key":"error-response-404","summary":"error-response-404","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/404/content/application~1json/examples/error-response-404"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/500/content/application~1json/examples/error-response-500":{"value":{"code":"500","category":"APPLICATION","title":"Internal Server Error","detail":"The server encountered an error.","retryable":true},"key":"error-response-500","summary":"error-response-500","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments/post/responses/500/content/application~1json/examples/error-response-500"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/200/content/application~1json/examples/list-fi-v3":{"value":{"data":[{"financialInstrumentId":"7f2bac05-42a3-4b26-89fd-333396fdba70","financialInstrumentType":"US_ACH","currency":"USD","label":"US bank account","country":"US","createdAt":"2025-10-01T18:46:47.430Z","updatedAt":"2025-10-01T18:46:47.430Z"}]},"key":"list-fi-v3","summary":"list-fi-v3","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/200/content/application~1json/examples/list-fi-v3"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/400/content/application~1json/examples/error-response-400":{"value":{"code":"400","category":"CLIENT_ERROR","title":"Bad Request","detail":"Invalid request. Check your request parameters and try again.","retryable":true},"key":"error-response-400","summary":"error-response-400","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/400/content/application~1json/examples/error-response-400"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/404/content/application~1json/examples/error-response-404":{"value":{"code":"404","category":"CLIENT_ERROR","title":"Not Found","detail":"The identity does not exist. Please provide a valid identityId.","retryable":false},"key":"error-response-404","summary":"error-response-404","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/404/content/application~1json/examples/error-response-404"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/500/content/application~1json/examples/error-response-500":{"value":{"code":"500","category":"APPLICATION","title":"Internal Server Error","detail":"The server encountered an error.","retryable":true},"key":"error-response-500","summary":"error-response-500","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments/get/responses/500/content/application~1json/examples/error-response-500"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/200/content/application~1json/examples/get-fi-v3":{"value":{"financialInstrument":{"country":"US","financialInstrumentId":"7f2bac05-42a3-4b26-89fd-333396fdba70","createdAt":"2025-10-01T18:46:47.430Z","updatedAt":"2025-10-01T18:46:47.430Z","usAch":{"bankName":"string","bankRoutingNumber":"266231608","accountNumber":"60480","accountType":"CHECKING"},"currency":"USD","label":"US bank account","financialInstrumentType":"US_ACH"}},"key":"get-fi-v3","summary":"get-fi-v3","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/200/content/application~1json/examples/get-fi-v3"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/400/content/application~1json/examples/error-response-400":{"value":{"code":"400","category":"CLIENT_ERROR","title":"Bad Request","detail":"Invalid request. Check your request parameters and try again.","retryable":true},"key":"error-response-400","summary":"error-response-400","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/400/content/application~1json/examples/error-response-400"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/404/content/application~1json/examples/error-response-404":{"value":{"code":"404","category":"CLIENT_ERROR","title":"Not Found","detail":"The identity does not exist. Please provide a valid identityId.","retryable":false},"key":"error-response-404","summary":"error-response-404","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/404/content/application~1json/examples/error-response-404"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/500/content/application~1json/examples/error-response-500":{"value":{"code":"500","category":"APPLICATION","title":"Internal Server Error","detail":"The server encountered an error.","retryable":true},"key":"error-response-500","summary":"error-response-500","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/get/responses/500/content/application~1json/examples/error-response-500"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/requestBody/content/application~1json/examples/put-label-only":{"value":{"label":"Operating account"},"key":"put-label-only","summary":"Update label","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/requestBody/content/application~1json/examples/put-label-only"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/requestBody/content/application~1json/examples/put-ach-details":{"value":{"usAch":{"bankRoutingNumber":"266231608","accountNumber":987654321,"accountType":"SAVINGS"}},"key":"put-ach-details","summary":"Update ACH details","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/requestBody/content/application~1json/examples/put-ach-details"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/400/content/application~1json/examples/error-response-400":{"value":{"code":"400","category":"CLIENT_ERROR","title":"Bad Request","detail":"Invalid request. Check your request parameters and try again.","retryable":true},"key":"error-response-400","summary":"error-response-400","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/400/content/application~1json/examples/error-response-400"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/404/content/application~1json/examples/error-response-404":{"value":{"code":"404","category":"CLIENT_ERROR","title":"Not Found","detail":"The identity does not exist. Please provide a valid identityId.","retryable":false},"key":"error-response-404","summary":"error-response-404","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/404/content/application~1json/examples/error-response-404"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/409/content/application~1json/examples/error-response-409":{"value":{"code":"409","category":"CLIENT_ERROR","title":"Conflict","detail":"A conflict occurred. The resource already exists or cannot be processed due to a conflict.","retryable":false},"key":"error-response-409","summary":"error-response-409","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/409/content/application~1json/examples/error-response-409"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/500/content/application~1json/examples/error-response-500":{"value":{"code":"500","category":"APPLICATION","title":"Internal Server Error","detail":"The server encountered an error.","retryable":true},"key":"error-response-500","summary":"error-response-500","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/put/responses/500/content/application~1json/examples/error-response-500"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/400/content/application~1json/examples/error-response-400":{"value":{"code":"400","category":"CLIENT_ERROR","title":"Bad Request","detail":"Invalid request. Check your request parameters and try again.","retryable":true},"key":"error-response-400","summary":"error-response-400","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/400/content/application~1json/examples/error-response-400"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/404/content/application~1json/examples/error-response-404":{"value":{"code":"404","category":"CLIENT_ERROR","title":"Not Found","detail":"The identity does not exist. Please provide a valid identityId.","retryable":false},"key":"error-response-404","summary":"error-response-404","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/404/content/application~1json/examples/error-response-404"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/409/content/application~1json/examples/error-response-409":{"value":{"code":"409","category":"CLIENT_ERROR","title":"Conflict","detail":"A conflict occurred. The resource already exists or cannot be processed due to a conflict.","retryable":false},"key":"error-response-409","summary":"error-response-409","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/409/content/application~1json/examples/error-response-409"},"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/500/content/application~1json/examples/error-response-500":{"value":{"code":"500","category":"APPLICATION","title":"Internal Server Error","detail":"The server encountered an error.","retryable":true},"key":"error-response-500","summary":"error-response-500","id":"paths/~1v3~1identities~1{identity-id}~1financial-instruments~1{financial-instrument-id}/delete/responses/500/content/application~1json/examples/error-response-500"},"paths/~1v3~1payments~1filter/post/responses/400/content/application~1json/examples/badRequest":{"value":{"status":400,"errors":[{"code":"USR_001","type":"USER_ERROR","title":"Bad request","description":"Invalid request. Check your request parameters and try again.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"badRequest","summary":"badRequest","description":"Default response when the request is malformed or a parameter fails validation.","id":"paths/~1v3~1payments~1filter/post/responses/400/content/application~1json/examples/badRequest"},"paths/~1v3~1payments~1filter/post/responses/400/content/application~1json/examples/invalidRequestBody":{"value":{"status":400,"errors":[{"code":"USR_055","type":"USER_ERROR","title":"Invalid request body","description":"Unable to create payment because the request body is empty or contains unexpected characters. Try again with all valid request body.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"invalidRequestBody","summary":"invalidRequestBody","description":"Returned when a field in the request body has an unexpected type or value.","id":"paths/~1v3~1payments~1filter/post/responses/400/content/application~1json/examples/invalidRequestBody"},"paths/~1v3~1payments~1filter/post/responses/415/content/application~1json/examples/unsupportedMediaType":{"value":{"status":415,"errors":[{"code":"USR_075","type":"USER_ERROR","title":"Missing or unsupported content type","description":"The request is either missing the 'Content-Type' header or the header contains an unsupported value. Set the 'Content-Type' header value to 'application/json' and try again.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"unsupportedMediaType","summary":"unsupportedMediaType","description":"Returned when the Content-Type header is missing or not supported.","id":"paths/~1v3~1payments~1filter/post/responses/415/content/application~1json/examples/unsupportedMediaType"},"paths/~1v3~1payments~1filter/post/responses/500/content/application~1json/examples/internalServerError":{"value":{"status":500,"errors":[{"code":"SYS_001","type":"SYSTEM_ERROR","title":"Internal server error","description":"Unable to process the request due to an internal server error.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"internalServerError","summary":"internalServerError","description":"Default response for an unhandled server-side failure.","id":"paths/~1v3~1payments~1filter/post/responses/500/content/application~1json/examples/internalServerError"},"paths/~1v3~1payments/post/responses/400/content/application~1json/examples/badRequest":{"value":{"status":400,"errors":[{"code":"USR_001","type":"USER_ERROR","title":"Bad request","description":"Invalid request. Check your request parameters and try again.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"badRequest","summary":"badRequest","description":"Default response when the request is malformed or a parameter fails validation.","id":"paths/~1v3~1payments/post/responses/400/content/application~1json/examples/badRequest"},"paths/~1v3~1payments/post/responses/400/content/application~1json/examples/invalidRequestBody":{"value":{"status":400,"errors":[{"code":"USR_055","type":"USER_ERROR","title":"Invalid request body","description":"Unable to create payment because the request body is empty or contains unexpected characters. Try again with all valid request body.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"invalidRequestBody","summary":"invalidRequestBody","description":"Returned when a field in the request body has an unexpected type or value.","id":"paths/~1v3~1payments/post/responses/400/content/application~1json/examples/invalidRequestBody"},"paths/~1v3~1payments/post/responses/402/content/application~1json/examples/insufficientBalance":{"value":{"status":402,"errors":[{"code":"USR_067","type":"USER_ERROR","title":"Insufficient balance","description":"Payment failed due to insufficient balance. Add funds to your account and try again.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"insufficientBalance","summary":"insufficientBalance","description":"Returned when the account does not hold enough balance to fund the payment.","id":"paths/~1v3~1payments/post/responses/402/content/application~1json/examples/insufficientBalance"},"paths/~1v3~1payments/post/responses/403/content/application~1json/examples/forbidden":{"value":{"status":403,"errors":[{"code":"AUTH_051","type":"AUTH_ERROR","title":"Unauthorized","description":"Invalid request. Check your request parameters and try again.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"forbidden","summary":"forbidden","description":"Returned when the payment exists but is owned by another tenant.","id":"paths/~1v3~1payments/post/responses/403/content/application~1json/examples/forbidden"},"paths/~1v3~1payments/post/responses/415/content/application~1json/examples/unsupportedMediaType":{"value":{"status":415,"errors":[{"code":"USR_075","type":"USER_ERROR","title":"Missing or unsupported content type","description":"The request is either missing the 'Content-Type' header or the header contains an unsupported value. Set the 'Content-Type' header value to 'application/json' and try again.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"unsupportedMediaType","summary":"unsupportedMediaType","description":"Returned when the Content-Type header is missing or not supported.","id":"paths/~1v3~1payments/post/responses/415/content/application~1json/examples/unsupportedMediaType"},"paths/~1v3~1payments/post/responses/500/content/application~1json/examples/internalServerError":{"value":{"status":500,"errors":[{"code":"SYS_001","type":"SYSTEM_ERROR","title":"Internal server error","description":"Unable to process the request due to an internal server error.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"internalServerError","summary":"internalServerError","description":"Default response for an unhandled server-side failure.","id":"paths/~1v3~1payments/post/responses/500/content/application~1json/examples/internalServerError"},"paths/~1v3~1payments~1{paymentId}/get/responses/400/content/application~1json/examples/badRequest":{"value":{"status":400,"errors":[{"code":"USR_001","type":"USER_ERROR","title":"Bad request","description":"Invalid request. Check your request parameters and try again.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"badRequest","summary":"badRequest","description":"Default response when the request is malformed or a parameter fails validation.","id":"paths/~1v3~1payments~1{paymentId}/get/responses/400/content/application~1json/examples/badRequest"},"paths/~1v3~1payments~1{paymentId}/get/responses/400/content/application~1json/examples/invalidRequestBody":{"value":{"status":400,"errors":[{"code":"USR_055","type":"USER_ERROR","title":"Invalid request body","description":"Unable to create payment because the request body is empty or contains unexpected characters. Try again with all valid request body.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"invalidRequestBody","summary":"invalidRequestBody","description":"Returned when a field in the request body has an unexpected type or value.","id":"paths/~1v3~1payments~1{paymentId}/get/responses/400/content/application~1json/examples/invalidRequestBody"},"paths/~1v3~1payments~1{paymentId}/get/responses/404/content/application~1json/examples/resourceNotFound":{"value":{"status":404,"errors":[{"code":"USR_002","type":"NOT_FOUND","title":"Resource not found","description":"The requested resource could not be found.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"resourceNotFound","summary":"resourceNotFound","description":"Returned when no resource matches the supplied identifier.","id":"paths/~1v3~1payments~1{paymentId}/get/responses/404/content/application~1json/examples/resourceNotFound"},"paths/~1v3~1payments~1{paymentId}/get/responses/500/content/application~1json/examples/internalServerError":{"value":{"status":500,"errors":[{"code":"SYS_001","type":"SYSTEM_ERROR","title":"Internal server error","description":"Unable to process the request due to an internal server error.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"internalServerError","summary":"internalServerError","description":"Default response for an unhandled server-side failure.","id":"paths/~1v3~1payments~1{paymentId}/get/responses/500/content/application~1json/examples/internalServerError"},"paths/~1v3~1payments~1{paymentId}~1states/get/responses/400/content/application~1json/examples/badRequest":{"value":{"status":400,"errors":[{"code":"USR_001","type":"USER_ERROR","title":"Bad request","description":"Invalid request. Check your request parameters and try again.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"badRequest","summary":"badRequest","description":"Default response when the request is malformed or a parameter fails validation.","id":"paths/~1v3~1payments~1{paymentId}~1states/get/responses/400/content/application~1json/examples/badRequest"},"paths/~1v3~1payments~1{paymentId}~1states/get/responses/400/content/application~1json/examples/invalidRequestBody":{"value":{"status":400,"errors":[{"code":"USR_055","type":"USER_ERROR","title":"Invalid request body","description":"Unable to create payment because the request body is empty or contains unexpected characters. Try again with all valid request body.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"invalidRequestBody","summary":"invalidRequestBody","description":"Returned when a field in the request body has an unexpected type or value.","id":"paths/~1v3~1payments~1{paymentId}~1states/get/responses/400/content/application~1json/examples/invalidRequestBody"},"paths/~1v3~1payments~1{paymentId}~1states/get/responses/404/content/application~1json/examples/resourceNotFound":{"value":{"status":404,"errors":[{"code":"USR_002","type":"NOT_FOUND","title":"Resource not found","description":"The requested resource could not be found.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"resourceNotFound","summary":"resourceNotFound","description":"Returned when no resource matches the supplied identifier.","id":"paths/~1v3~1payments~1{paymentId}~1states/get/responses/404/content/application~1json/examples/resourceNotFound"},"paths/~1v3~1payments~1{paymentId}~1states/get/responses/500/content/application~1json/examples/internalServerError":{"value":{"status":500,"errors":[{"code":"SYS_001","type":"SYSTEM_ERROR","title":"Internal server error","description":"Unable to process the request due to an internal server error.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"internalServerError","summary":"internalServerError","description":"Default response for an unhandled server-side failure.","id":"paths/~1v3~1payments~1{paymentId}~1states/get/responses/500/content/application~1json/examples/internalServerError"},"paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/400/content/application~1json/examples/badRequest":{"value":{"status":400,"errors":[{"code":"USR_001","type":"USER_ERROR","title":"Bad request","description":"Invalid request. Check your request parameters and try again.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"badRequest","summary":"badRequest","description":"Default response when the request is malformed or a parameter fails validation.","id":"paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/400/content/application~1json/examples/badRequest"},"paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/400/content/application~1json/examples/invalidRequestBody":{"value":{"status":400,"errors":[{"code":"USR_055","type":"USER_ERROR","title":"Invalid request body","description":"Unable to create payment because the request body is empty or contains unexpected characters. Try again with all valid request body.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"invalidRequestBody","summary":"invalidRequestBody","description":"Returned when a field in the request body has an unexpected type or value.","id":"paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/400/content/application~1json/examples/invalidRequestBody"},"paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/404/content/application~1json/examples/resourceNotFound":{"value":{"status":404,"errors":[{"code":"USR_002","type":"NOT_FOUND","title":"Resource not found","description":"The requested resource could not be found.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"resourceNotFound","summary":"resourceNotFound","description":"Returned when no resource matches the supplied identifier.","id":"paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/404/content/application~1json/examples/resourceNotFound"},"paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/415/content/application~1json/examples/unsupportedMediaType":{"value":{"status":415,"errors":[{"code":"USR_075","type":"USER_ERROR","title":"Missing or unsupported content type","description":"The request is either missing the 'Content-Type' header or the header contains an unsupported value. Set the 'Content-Type' header value to 'application/json' and try again.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"unsupportedMediaType","summary":"unsupportedMediaType","description":"Returned when the Content-Type header is missing or not supported.","id":"paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/415/content/application~1json/examples/unsupportedMediaType"},"paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/500/content/application~1json/examples/internalServerError":{"value":{"status":500,"errors":[{"code":"SYS_001","type":"SYSTEM_ERROR","title":"Internal server error","description":"Unable to process the request due to an internal server error.","timestamp":"2024-12-01T12:00:00Z"}]},"key":"internalServerError","summary":"internalServerError","description":"Default response for an unhandled server-side failure.","id":"paths/~1v3~1payments~1{paymentId}~1labels/patch/responses/500/content/application~1json/examples/internalServerError"},"paths/~1v2~1ledger-transactions/get/responses/200/content/text~1csv/example":{"value":"tenant,amount,currency,txnReference,operation,txnSource,status,createdDttm,updatedDttm,availableBalanceBefore,availableBalanceAfter\nrpd2demo,2.06,USD,b6176a4a-c89e-44c9-a1c2-acf149c6f013,DEBIT,PAYMENTS,SUCCESS,2025-12-12T23:08:23.399345535Z,2025-12-12T23:08:23.399345704Z,1140833.98234594,1140831.92234594\n","id":"paths/~1v2~1ledger-transactions/get/responses/200/content/text~1csv/example"}},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"},"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","isMockServer":true,"description":"Mock server"},{"url":"https://api.test.ripple.com","description":"UAT environment with simulated currency"},{"url":"https://api.ripple.com","description":"Production environment"}],"specType":"openapi"},"options":{"codeSamples":{"languages":[{"lang":"curl"},{"lang":"Python"}]},"schemasExpansionLevel":3,"hideReplay":true,"hideSchemaTitles":true,"hidePropertiesPrefix":true,"hideDownloadButtons":false,"mockServer":{"url":"/_mock/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/payments-direct-2/@v2026.03/api-docs/payments-direct-api/payments-direct-2-api.json?download"},{"url":"/_bundle/products/payments-direct-2/@v2026.03/api-docs/payments-direct-api/payments-direct-2-api.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Payments Direct API","description":"Use the Payments Direct API to get quotes, create and manage payments, and manage originator and beneficiary identities.\n\n## API environments\n\nThe Payments Direct API offers the following environments:\n\n| <div style=\"width:90px\">Environment</div>  | Base URL                      | Description                               |\n| ------------------------------------------ | ----------------------------- | ----------------------------------------- |\n| UAT                                       | `https://api.test.ripple.com` | UAT environment with simulated currency. |\n| Production                                 | `https://api.ripple.com`      | Production environment                    |\n\n## API authentication\n\nAll {% $env.PUBLIC_VAR_RPD %} API operations require a Bearer access token specific to the environment you're using. Ripple provides a secure model for authentication and authorization by providing access tokens scoped for a set of credentials.\n\n### Generate client ID and client secret\n\nYou will need your _client ID_ and _client secret_ to obtain an access token.\n\nIf you do not already have your client ID and client secret, do the following:\n\n1. Log into the Ripple Payments UI.\n2. In the left navigation menu, click **Settings**.\n3. Under **Administration**, click **API Credentials**.\n4. In the dropdown list next to the page title, select the access environment. For example, to provision credentials for the test environment, select **UAT** from the dropdown list.\n5. In the upper right corner of the page, click **New Credential**.\n6. Click **Save and Generate Key**.\n\n**Caution:** The *client secret* is displayed only once when you are creating new credentials. You cannot retrieve the secret after exiting this page. Copy and store the client secret securely and share it with authorized individuals in accordance with your organization's security policy.\n\nYou can now use the client ID and client secret to generate access tokens using the [Request an access token](#operation/authenticate) operation.\n\n### Request an access token\n\nTo get an access token, use the [Request an access token](#operation/authenticate) operation with your `client_id` and `client_secret`. The response contains a token in the `access_token` field.\n\nWe recommend rotating your API credentials at regular intervals according to your organization's security policy.\n\n**Note**: Authentication tokens are not a fixed length and can vary, avoid validating tokens based on character length.\n"}},"baseSlug":"/products/payments-direct-2/v2026.03/api-docs/payments-direct-api/payments-direct-2-api","routesMapping":{}}