{"items":[{"type":"link","label":"API reference","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"API reference"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"API reference (3.0.0)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intro"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LeanX API facilitates fast payments via bank transfers to specified beneficiaries."},"children":[]}]}]}]}],"sectionId":"/openapi"}]}]}},{"type":"separator","label":"Getting started","content":null},{"type":"group","label":"Changelog","link":"/openapi/guide-changelog","routeSlug":"/openapi/guide-changelog","items":[{"type":"link","label":"3.0.0 (2026-07-02) v3 API","link":"/openapi/guide-changelog/3.0.0-(2026-07-02)-v3-api","routeSlug":"/openapi/guide-changelog/3.0.0-(2026-07-02)-v3-api","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"3.0.0 (2026-07-02) v3 API"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"guide-changelog/3.0.0-(2026-07-02)-v3-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3.0.0 (2026-07-02) v3 API"},"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":"New major version under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", running alongside v2. v2 is unchanged."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quotes and payments take "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Payable"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"today: C2C to India (bank transfer, and UPI as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instant_payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pakistan (bank transfer) and Nigeria (bank transfer). See the table on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v3/quote"},"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":"Nested request bodies: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_details"},"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":"Errors are RFC 9457 problem responses."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v3/payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the event stream resumes with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Last-Event-ID"},"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":"v3 is enabled per organisation."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"2.5.1 (2025-07-15) Amount required for quote ","link":"/openapi/guide-changelog/2.5.1-(2025-07-15)-amount-required-for-quote","routeSlug":"/openapi/guide-changelog/2.5.1-(2025-07-15)-amount-required-for-quote","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"2.5.1 (2025-07-15) Amount required for quote "},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"guide-changelog/2.5.1-(2025-07-15)-amount-required-for-quote"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.5.1 (2025-07-15) Amount required for quote "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Breaking"},"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":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires an amount ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"so every quote carries a rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in the source currency; a payment's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the destination currency. Send the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment amount; it is checked against the quote's min/max band."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"2.5.0 (2025-07-11) Sender details required for payments ","link":"/openapi/guide-changelog/2.5.0-(2025-07-11)-sender-details-required-for-payments","routeSlug":"/openapi/guide-changelog/2.5.0-(2025-07-11)-sender-details-required-for-payments","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"2.5.0 (2025-07-11) Sender details required for payments "},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"guide-changelog/2.5.0-(2025-07-11)-sender-details-required-for-payments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.5.0 (2025-07-11) Sender details required for payments "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Breaking"},"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":"POST /v2/payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires sender details (name, date of birth, identity"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"document and more). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/payment_ext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is merged into it; do not use"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/payment_ext"},"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":"Quotes are single-use: one payment per quote."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quotes accept amount and bank details for better routing."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"2.1.1 (2025-06-24) External ID for payments","link":"/openapi/guide-changelog/2.1.1-(2025-06-24)-external-id-for-payments","routeSlug":"/openapi/guide-changelog/2.1.1-(2025-06-24)-external-id-for-payments","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"2.1.1 (2025-06-24) External ID for payments"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"guide-changelog/2.1.1-(2025-06-24)-external-id-for-payments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.1.1 (2025-06-24) External ID for payments"},"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":"POST /v2/payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts your own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; look a payment up by it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payments/{external_id}?external=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"2.1.0 (2025-06-05) Extended quote and payment API","link":"/openapi/guide-changelog/2.1.0-(2025-06-05)-extended-quote-and-payment-api","routeSlug":"/openapi/guide-changelog/2.1.0-(2025-06-05)-extended-quote-and-payment-api","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"2.1.0 (2025-06-05) Extended quote and payment API"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"guide-changelog/2.1.0-(2025-06-05)-extended-quote-and-payment-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.1.0 (2025-06-05) Extended quote and payment API"},"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":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beneficiary_account_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank_branch_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a better quote and higher success rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/payment_ext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" added for sender details. Superseded in 2.5.0."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"2.0.0 Initial release of the v2 API","link":"/openapi/guide-changelog/2.0.0-initial-release-of-the-v2-api","routeSlug":"/openapi/guide-changelog/2.0.0-initial-release-of-the-v2-api","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"2.0.0 Initial release of the v2 API"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"guide-changelog/2.0.0-initial-release-of-the-v2-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.0.0 Initial release of the v2 API"},"children":[]}]}]}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"guide-changelog"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Changelog","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":"Newest first. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Breaking"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" marks a change that needs work on your side."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guide-changelog"}],"panels":[]}]}},{"type":"group","label":"Credentials","link":"/openapi/guide-credentials","routeSlug":"/openapi/guide-credentials","items":[],"content":{"contentType":"group","meta":{"name":"guide-credentials"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credentials","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":"Before using this API you need credentials issued by LeanX:"},"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":"ACCESS KEY — identifies you, and is sent as the JWT's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"claims. A random base64 string with a readable prefix."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A signing credential, whose kind depends on the authentication method"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LeanX selects for your integration: a SECRET KEY (a random base64"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string) for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HS256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a private/public key pair for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication below."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACCESS KEY carries a prefix for convenience, e.g."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"    company-test-sIEUpUP7b41n51WY\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"    company-test-sIEUpUP7b41n51WY\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"where the first part is your company tag, followed by a key usage hint and a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"random value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keep your ACCESS KEY private where you can, and never share your SECRET KEY"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or your RS256 private key."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guide-credentials"}],"panels":[]}]}},{"type":"group","label":"Authentication","link":"/openapi/guide-authentication","routeSlug":"/openapi/guide-authentication","items":[],"content":{"contentType":"group","meta":{"name":"guide-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":"For API authentication we use JWT/Bearer tokens, passed on the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently supported JWT algorithms are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HS256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — symmetric: the token is signed with your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SECRET KEY"},"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":"code","inline":true,"attributes":{"content":"RS256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — asymmetric: LeanX issues you a private/public key pair. You sign"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the token with the private key, and LeanX verifies it with the matching"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"public key. Use this when you prefer not to sign with a shared secret."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The LeanX team will select and deliver the authentication method to be used"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for your integration. The algorithm is selected from the token's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"so the same endpoint accepts either. The required claims are identical for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"both; only the header and signing method differ."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT token header MUST include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"alg\": \"HS256\",\n  \"typ\": \"JWT\",\n  \"kid\": \"someuser-demo-1234567890ABCDEF\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"alg\": \"HS256\",\n  \"typ\": \"JWT\",\n  \"kid\": \"someuser-demo-1234567890ABCDEF\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"alg\": \"RS256\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead when LeanX has issued you a key pair."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HS256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCESS KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which of the public keys issued to you by LeanX should be used to verify the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"signature."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT token body MUST include the following claims:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"sub\": \"someuser-demo-1234567890ABCD\",\n    \"exp\": 1767225600,\n    \"iat\": 1767225300,\n    \"aud\": \"https://api.leanx.me\",\n    \"iss\": \"https://api.leanx.me\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"sub\": \"someuser-demo-1234567890ABCD\",\n    \"exp\": 1767225600,\n    \"iat\": 1767225300,\n    \"aud\": \"https://api.leanx.me\",\n    \"iss\": \"https://api.leanx.me\"\n}\n"},"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":"sub"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCESS KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kid"},"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":"code","inline":true,"attributes":{"content":"exp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — expiry, UNIX timestamp in UTC. Keep tokens short-lived."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — issued-at, UNIX timestamp in UTC."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the same value in both"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the base URL of the server"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you are calling, with no path (see Servers). Setting them to different"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values, or appending a path, is the usual cause of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guide-authentication"}],"panels":[]}]}},{"type":"group","label":"Signing a token","link":"/openapi/guide-signing-a-token","routeSlug":"/openapi/guide-signing-a-token","items":[],"content":{"contentType":"group","meta":{"name":"guide-signing-a-token"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Signing a token","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":"Sign tokens inside your own application with a standard JWT library — for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PyJWT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Python), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jsonwebtoken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Node), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jjwt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Java) or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"golang-jwt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Go). Mint a short-lived token and refresh it rather than"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"holding a long-lived one:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"import jwt  # PyJWT\nfrom datetime import UTC, datetime, timedelta\n\nnow = datetime.now(tz=UTC)\ntoken = jwt.encode(\n    {\n        \"sub\": ACCESS_KEY,\n        \"iat\": int(now.timestamp()),\n        \"exp\": int((now + timedelta(minutes=5)).timestamp()),\n        \"aud\": API_URL,\n        \"iss\": API_URL,\n    },\n    SIGNING_KEY,\n    algorithm=\"RS256\",  # or \"HS256\"\n    headers={\"kid\": KEY_ID},\n)\n","language":"python"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"import jwt  # PyJWT\nfrom datetime import UTC, datetime, timedelta\n\nnow = datetime.now(tz=UTC)\ntoken = jwt.encode(\n    {\n        \"sub\": ACCESS_KEY,\n        \"iat\": int(now.timestamp()),\n        \"exp\": int((now + timedelta(minutes=5)).timestamp()),\n        \"aud\": API_URL,\n        \"iss\": API_URL,\n    },\n    SIGNING_KEY,\n    algorithm=\"RS256\",  # or \"HS256\"\n    headers={\"kid\": KEY_ID},\n)\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KEY_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCESS KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HS256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it is the id of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"key pair LeanX issued you."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The same with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jsonwebtoken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Node):"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"const jwt = require(\"jsonwebtoken\");\n\nconst now = Math.floor(Date.now() / 1000); // seconds, not milliseconds\nconst token = jwt.sign(\n  { sub: ACCESS_KEY, iat: now, exp: now + 300, aud: API_URL, iss: API_URL },\n  SIGNING_KEY,\n  { algorithm: \"RS256\", keyid: KEY_ID }, // or \"HS256\"\n);\n","language":"javascript"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"const jwt = require(\"jsonwebtoken\");\n\nconst now = Math.floor(Date.now() / 1000); // seconds, not milliseconds\nconst token = jwt.sign(\n  { sub: ACCESS_KEY, iat: now, exp: now + 300, aud: API_URL, iss: API_URL },\n  SIGNING_KEY,\n  { algorithm: \"RS256\", keyid: KEY_ID }, // or \"HS256\"\n);\n"},"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":"Never paste a SECRET KEY or an RS256 private key into a web-based JWT"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tool."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jwt.io"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jwt.io"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is useful for "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inspecting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a token you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"already hold — decoding requires no key — but not for signing one."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guide-signing-a-token"}],"panels":[]}]}},{"type":"group","label":"Why am I getting a 401?","link":"/openapi/guide-why-am-i-getting-a-401","routeSlug":"/openapi/guide-why-am-i-getting-a-401","items":[],"content":{"contentType":"group","meta":{"name":"guide-why-am-i-getting-a-401"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Why am I getting a 401?","showPageActions":true},{"nodeType":"markdoc","content":[{"$$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":"Symptom"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Likely cause"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fix"},"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":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on every call"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" differ, carry a path ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or name another environment's host"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set both to the base URL you call, with no path"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on every call"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in milliseconds, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" already passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Unix seconds; mint a fresh short-lived token"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on every call"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signed with the wrong key or algorithm, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names a different key"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sign with the key issued for this environment; put its id in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on every call"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the header does not equal the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send your key id in both"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" works"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"v3 is not enabled for your organisation"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ask us to enable v3"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with no token checks at all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header missing or not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <token>"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]}]}]}]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guide-why-am-i-getting-a-401"}],"panels":[]}]}},{"type":"group","label":"Transaction states","link":"/openapi/guide-transaction-states","routeSlug":"/openapi/guide-transaction-states","items":[],"content":{"contentType":"group","meta":{"name":"guide-transaction-states"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction states","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":"Transactions accepted by the API can be in one of the following states."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As soon as the order is accepted you will get a unique id in the response, which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can be used to track the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that orders rejected up-front by the API with 4xx (authentication or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"validation errors) are not represented in the state table, since they've never been accepted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for processing."},"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":"Status Category"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"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":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Progress"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queued"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment order accepted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order is accepted and waiting to be submitted for processing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","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":"In Progress"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment order pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reported by a processor that accepts a payment before it begins processing it"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","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":"In Progress"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment order is processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment submitted and accepted by processor"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","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":"Success"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment executed successfully"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funds delivered; your balance is debited"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","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":"Failed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment failed by the processor"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","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":"Failed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment rejected by processor or by API during processing (e.g. API could not route)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","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":"Failed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment is canceled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancelled or expired by the processor before it settled; no funds moved"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","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":"Failed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment is reversed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reversed (and refunded) by the processor after it had succeeded; the debit is credited back"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","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":"Call Support"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment state is unknown"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment has encountered an unknown status at the processor and needs manual intervention"},"children":[]}]}]}]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guide-transaction-states"}],"panels":[]}]}},{"type":"group","label":"Settlement currencies","link":"/openapi/guide-settlement-currencies","routeSlug":"/openapi/guide-settlement-currencies","items":[],"content":{"contentType":"group","meta":{"name":"guide-settlement-currencies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settlement currencies","showPageActions":true},{"nodeType":"markdoc","content":"This API enables processing and settlement of transactions in fiat currency USD, and stable coins: USDT and USDC. \nIt supports seamless currency conversion, validation, and settlement routing between traditional and digital assets."}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guide-settlement-currencies"}],"panels":[]}]}},{"type":"separator","label":"API v3 (current)","content":null},{"type":"group","label":"Quotes & payments","link":"/openapi/v3-quotes-payments","routeSlug":"/openapi/v3-quotes-payments","items":[{"label":"Quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v3-quotes-payments/quote_v3_quote_post","routeSlug":"/openapi/v3-quotes-payments/quote_v3_quote_post","metadata":{"seo":{"title":"Quote","description":"Create quote for use with payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quote_v3_quote_post","name":"Quote","isWebhook":false,"pointer":"/paths/~1v3~1quote/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote","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 quote for use with payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also accepted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the name "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v3/payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses for it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are independent enums, but only 4 of the 128 combinations they can spell between them can be paid end to end:"},"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":"Destination"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method"},"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":"India ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C2C"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank_transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instant_payment"},"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":"Pakistan ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C2C"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank_transfer"},"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":"Nigeria ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NGA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C2C"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank_transfer"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"B2B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"B2C"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C2B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" have no payable combination on any corridor today, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BGD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EGY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NPL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VNM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be paid at all. Anything outside the table either fails the quote or, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v3/payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" still accepts the request, fails before the payment completes — do not build against it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether a listed combination is enabled for "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"your"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" account is a separate question, answered by the provider routes configured for it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"timeout","in":"query","schemaId":"schema_38"}],"pointer":"/paths/~1v3~1quote/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QuoteRequest"}},"schemaId":"components/schemas/QuoteRequest","pointer":"/paths/~1v3~1quote/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/quote","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[{"name":"timeout","in":"query","required":false,"schemaId":"schema_38"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/QuoteRequest"}},"responseCodes":["200","400","401","403","422","429","500"],"pointer":"/v3/quote","href":"v3-quotes-payments/quote_v3_quote_post","openApiOperationId":"quote_v3_quote_post","summary":"Quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"schemaId":"components/schemas/QuoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QuoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteResponse"}},"schemaId":"components/schemas/QuoteResponse"},{"code":"400","description":"Bad data in the request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"422","description":"One or more request fields are invalid","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}},"schemaId":"components/schemas/ValidationProblem"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the seconds to wait."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v3~1quote/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"422","schemaId":"components/schemas/ValidationProblem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v3-quotes-payments/quote_v3_quote_post"}],"panels":[]}]},"httpPath":"/v3/quote"},{"label":"Quote Get","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v3-quotes-payments/quote_get_v3_quotes__id__get","routeSlug":"/openapi/v3-quotes-payments/quote_get_v3_quotes__id__get","metadata":{"seo":{"title":"Quote Get","description":"Fetch quote info"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quote_get_v3_quotes__id__get","name":"Quote Get","isWebhook":false,"pointer":"/paths/~1v3~1quotes~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote Get","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch quote info"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_39","description":"Quote id","required":true}],"pointer":"/paths/~1v3~1quotes~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/quotes/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_39"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/v3/quotes/{id}","href":"v3-quotes-payments/quote_get_v3_quotes__id__get","openApiOperationId":"quote_get_v3_quotes__id__get","summary":"Quote Get"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteResponse"}},"schemaId":"components/schemas/QuoteResponse"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Requested resource not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the seconds to wait."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v3~1quotes~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteResponse"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v3-quotes-payments/quote_get_v3_quotes__id__get"}],"panels":[]}]},"httpPath":"/v3/quotes/{id}"},{"label":"Payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v3-quotes-payments/payment_v3_payment_post","routeSlug":"/openapi/v3-quotes-payments/payment_v3_payment_post","metadata":{"seo":{"title":"Payment","description":"Execute payment to beneficiary with specified bank details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payment_v3_payment_post","name":"Payment","isWebhook":false,"pointer":"/paths/~1v3~1payment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Execute payment to beneficiary with specified bank details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"timeout","in":"query","schemaId":"schema_40","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How long to wait for the payment to be accepted. When the wait runs out the payment is failed with status reason "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Submit timeout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and is never submitted to a provider."},"children":[]}]}]}]}],"pointer":"/paths/~1v3~1payment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentOrder"}},"schemaId":"components/schemas/PaymentOrder","pointer":"/paths/~1v3~1payment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/payment","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[{"name":"timeout","in":"query","required":false,"schemaId":"schema_40"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentOrder"}},"responseCodes":["202","400","401","403","422","429","500"],"pointer":"/v3/payment","href":"v3-quotes-payments/payment_v3_payment_post","openApiOperationId":"payment_v3_payment_post","summary":"Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"schemaId":"components/schemas/PaymentOrder","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentOrder"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInfo"}},"schemaId":"components/schemas/PaymentInfo"},{"code":"400","description":"Bad data in the request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"422","description":"One or more request fields are invalid","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}},"schemaId":"components/schemas/ValidationProblem"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the seconds to wait."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v3~1payment/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/PaymentInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInfo"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"422","schemaId":"components/schemas/ValidationProblem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v3-quotes-payments/payment_v3_payment_post"}],"panels":[]}]},"httpPath":"/v3/payment"},{"label":"Payment Get","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v3-quotes-payments/payment_get_v3_payments__id__get","routeSlug":"/openapi/v3-quotes-payments/payment_get_v3_payments__id__get","metadata":{"seo":{"title":"Payment Get","description":"Get info about previously executed payment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payment_get_v3_payments__id__get","name":"Payment Get","isWebhook":false,"pointer":"/paths/~1v3~1payments~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Get","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get info about previously executed payment"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_41","description":"Payment id","required":true}],"pointer":"/paths/~1v3~1payments~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"external","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supplied is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the original payment request."},"children":[]}]}]}]}],"pointer":"/paths/~1v3~1payments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/payments/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_41"}],"query":[{"name":"external","in":"query","required":false,"schemaId":"schema_42"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/v3/payments/{id}","href":"v3-quotes-payments/payment_get_v3_payments__id__get","openApiOperationId":"payment_get_v3_payments__id__get","summary":"Payment Get"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInfo"}},"schemaId":"components/schemas/PaymentInfo"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Requested resource not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the seconds to wait."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v3~1payments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentInfo"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v3-quotes-payments/payment_get_v3_payments__id__get"}],"panels":[]}]},"httpPath":"/v3/payments/{id}"},{"label":"Payments History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v3-quotes-payments/payments_history_v3_payments_get","routeSlug":"/openapi/v3-quotes-payments/payments_history_v3_payments_get","metadata":{"seo":{"title":"Payments History","description":"History of executed payments. Returns up to 7 days worth of data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payments_history_v3_payments_get","name":"Payments History","isWebhook":false,"pointer":"/paths/~1v3~1payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payments History","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"History of executed payments. Returns up to 7 days worth of data"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_43","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start timestamp (must be lower than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", max timespan 7 days)"},"children":[]}]}]}]},{"name":"end","in":"query","schemaId":"schema_44","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End timestamp (must be greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", max timespan 7 days)"},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"schema_45"},{"name":"direction","in":"query","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort direction on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (oldest first). Note "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sorting_order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v3~1payments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/payments","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[{"name":"start","in":"query","required":false,"schemaId":"schema_43"},{"name":"end","in":"query","required":false,"schemaId":"schema_44"},{"name":"status","in":"query","required":false,"schemaId":"schema_45"},{"name":"direction","in":"query","required":false,"schemaId":"components/schemas/SortingOrder"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/v3/payments","href":"v3-quotes-payments/payments_history_v3_payments_get","openApiOperationId":"payments_history_v3_payments_get","summary":"Payments History"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/jsonl","mediaTypes":["application/jsonl"],"mediaTypeContent":{"application/jsonl":{"schemaId":"components/schemas/PaymentInfo"}},"schemaId":"components/schemas/PaymentInfo"},{"code":"400","description":"Bad data in the request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the seconds to wait."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v3~1payments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentInfo","mediaTypes":["application/jsonl"],"mediaTypeContent":{"application/jsonl":{"schemaId":"components/schemas/PaymentInfo"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v3-quotes-payments/payments_history_v3_payments_get"}],"panels":[]}]},"httpPath":"/v3/payments"}],"content":{"contentType":"group","meta":{"name":"v3-quotes-payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quotes & 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":"v3 is the current version: build new integrations against it. v3 has to be enabled for your organisation; it does not come with your credentials automatically, and until it is, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" calls return 401 with a token that works on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/quote","summary":"Quote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v3-quotes-payments/quote_v3_quote_post","deprecated":false},{"title":"/v3/quotes/{id}","summary":"Quote Get","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v3-quotes-payments/quote_get_v3_quotes__id__get","deprecated":false},{"title":"/v3/payment","summary":"Payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v3-quotes-payments/payment_v3_payment_post","deprecated":false},{"title":"/v3/payments/{id}","summary":"Payment Get","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v3-quotes-payments/payment_get_v3_payments__id__get","deprecated":false},{"title":"/v3/payments","summary":"Payments History","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v3-quotes-payments/payments_history_v3_payments_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Beneficiary validation","link":"/openapi/v3-validation","routeSlug":"/openapi/v3-validation","items":[{"label":"Validate Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v3-validation/validate_account_v3_validate_account_post","routeSlug":"/openapi/v3-validation/validate_account_v3_validate_account_post","metadata":{"seo":{"title":"Validate Account","description":"Check that a beneficiary bank account exists and, when a name is supplied, that it matches the account holder. India only (country must be IND)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validate_account_v3_validate_account_post","name":"Validate Account","isWebhook":false,"pointer":"/paths/~1v3~1validate_account/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check that a beneficiary bank account exists and, when a name is supplied, that it matches the account holder. India only ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountValidationRequest"}},"schemaId":"components/schemas/AccountValidationRequest","pointer":"/paths/~1v3~1validate_account/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/validate_account","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountValidationRequest"}},"responseCodes":["200","400","401","403","404","422","429","500"],"pointer":"/v3/validate_account","href":"v3-validation/validate_account_v3_validate_account_post","openApiOperationId":"validate_account_v3_validate_account_post","summary":"Validate Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"schemaId":"components/schemas/AccountValidationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountValidationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountValidationResponse"}},"schemaId":"components/schemas/AccountValidationResponse"},{"code":"400","description":"Bad data in the request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"404","description":"Requested resource not found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"422","description":"One or more request fields are invalid","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}},"schemaId":"components/schemas/ValidationProblem"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the seconds to wait."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem","headers":{"retry-after":{"description":"Seconds to wait before retrying this request.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_47"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v3~1validate_account/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountValidationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountValidationResponse"}}},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"404","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"422","schemaId":"components/schemas/ValidationProblem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v3-validation/validate_account_v3_validate_account_post"}],"panels":[]}]},"httpPath":"/v3/validate_account"}],"content":{"contentType":"group","meta":{"name":"v3-validation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Beneficiary validation","showPageActions":true},{"nodeType":"markdoc","content":"Check a beneficiary account before paying it."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/validate_account","summary":"Validate Account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v3-validation/validate_account_v3_validate_account_post","deprecated":false}]}]}]}]}},{"type":"group","label":"Balances","link":"/openapi/v3-balances","routeSlug":"/openapi/v3-balances","items":[{"label":"Get Balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v3-balances/get_balance_v3_balance_get","routeSlug":"/openapi/v3-balances/get_balance_v3_balance_get","metadata":{"seo":{"title":"Get Balance","description":"Balance info"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_balance_v3_balance_get","name":"Get Balance","isWebhook":false,"pointer":"/paths/~1v3~1balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Balance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Balance info"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"country","in":"query","schemaId":"schema_48","description":"Payment country","required":true}],"pointer":"/paths/~1v3~1balance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/balance","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[{"name":"country","in":"query","required":true,"schemaId":"components/schemas/ApiCountry"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","422","429","500"],"pointer":"/v3/balance","href":"v3-balances/get_balance_v3_balance_get","openApiOperationId":"get_balance_v3_balance_get","summary":"Get Balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BalanceInfo"}},"schemaId":"components/schemas/BalanceInfo"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"422","description":"One or more request fields are invalid","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}},"schemaId":"components/schemas/ValidationProblem"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the seconds to wait."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v3~1balance/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BalanceInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BalanceInfo"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"422","schemaId":"components/schemas/ValidationProblem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v3-balances/get_balance_v3_balance_get"}],"panels":[]}]},"httpPath":"/v3/balance"}],"content":{"contentType":"group","meta":{"name":"v3-balances"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balances","showPageActions":true},{"nodeType":"markdoc","content":"What you can pay out, per corridor."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/balance","summary":"Get Balance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v3-balances/get_balance_v3_balance_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Event stream","link":"/openapi/v3-events","routeSlug":"/openapi/v3-events","items":[{"label":"Get Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v3-events/get_events_v3_events_get","routeSlug":"/openapi/v3-events/get_events_v3_events_get","metadata":{"seo":{"title":"Get Events","description":"Stream payment events such as payment status or quote responses"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_events_v3_events_get","name":"Get Events","isWebhook":false,"pointer":"/paths/~1v3~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Stream payment events such as payment status or quote responses"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"last-event-id","in":"header","schemaId":"schema_49","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSE Last-Event-ID: the UUID7 id of the last event the client received. On reconnect, streaming resumes from that event's timestamp (browser EventSource sends this automatically). Replay is best-effort — only events still retained in the stream can be re-delivered, and same-millisecond events may be re-sent, so treat the SSE id as an idempotency key."},"children":[]}]}]}]}],"pointer":"/paths/~1v3~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/events","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"last-event-id","in":"header","required":false,"schemaId":"schema_49"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","422","429","500"],"pointer":"/v3/events","href":"v3-events/get_events_v3_events_get","openApiOperationId":"get_events_v3_events_get","summary":"Get Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Server-sent event stream ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/event-stream"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Each event carries an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name, a UUID7 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (echo it back via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Last-Event-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to resume), and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" line holding JSON: a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment-error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events."},"children":[]}]}]}],"mediaType":"text/event-stream","mediaTypes":["text/event-stream"],"mediaTypeContent":{"text/event-stream":{"schemaId":"schema_50","exampleIds":["paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_queued","paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_processing","paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_error"]}},"schemaId":"schema_50","exampleIds":["paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_queued","paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_processing","paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_error"]},{"code":"401","description":"Access token not valid or expired","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"422","description":"One or more request fields are invalid","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}},"schemaId":"components/schemas/ValidationProblem"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the seconds to wait."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v3~1events/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_50","exampleIds":["paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_queued","paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_processing","paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_error"],"mediaTypes":["text/event-stream"],"mediaTypeContent":{"text/event-stream":{"schemaId":"schema_50","exampleIds":["paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_queued","paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_processing","paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_error"]}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"422","schemaId":"components/schemas/ValidationProblem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v3-events/get_events_v3_events_get"}],"panels":[]}]},"httpPath":"/v3/events"}],"content":{"contentType":"group","meta":{"name":"v3-events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Event stream","showPageActions":true},{"nodeType":"markdoc","content":"Payment updates as server-sent events."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/events","summary":"Get Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v3-events/get_events_v3_events_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Reports","link":"/openapi/v3-reports","routeSlug":"/openapi/v3-reports","items":[{"label":"Payout Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v3-reports/payout_report_v3_reports_payout_post","routeSlug":"/openapi/v3-reports/payout_report_v3_reports_payout_post","metadata":{"seo":{"title":"Payout Report","description":"Payout report as CSV, one row per payment in the window, streamed as it is read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payout_report_v3_reports_payout_post","name":"Payout Report","isWebhook":false,"pointer":"/paths/~1v3~1reports~1payout/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payout Report","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":"Payout report as CSV, one row per payment in the window, streamed as it is read."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" bound the window on payment creation time, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" picks the corridor; both are required. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" narrows to the listed statuses. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" narrows to specific payments — set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to supply the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values from the original payment requests instead of LeanX ids. An id that matches nothing still gets a row carrying just that id, so the report accounts for every id sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary account validation is not part of this report."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutReportFilter"}},"schemaId":"components/schemas/PayoutReportFilter","pointer":"/paths/~1v3~1reports~1payout/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/reports/payout","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PayoutReportFilter"}},"responseCodes":["200","400","401","403","422","429","500"],"pointer":"/v3/reports/payout","href":"v3-reports/payout_report_v3_reports_payout_post","openApiOperationId":"payout_report_v3_reports_payout_post","summary":"Payout Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"schemaId":"components/schemas/PayoutReportFilter","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutReportFilter"}},"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"},{"code":"400","description":"Bad data in the request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"422","description":"One or more request fields are invalid","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}},"schemaId":"components/schemas/ValidationProblem"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the seconds to wait."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v3~1reports~1payout/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"422","schemaId":"components/schemas/ValidationProblem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v3-reports/payout_report_v3_reports_payout_post"}],"panels":[]}]},"httpPath":"/v3/reports/payout"},{"label":"Statement Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v3-reports/statement_report_v3_reports_statement_post","routeSlug":"/openapi/v3-reports/statement_report_v3_reports_statement_post","metadata":{"seo":{"title":"Statement Report","description":"Statement report as CSV, one row per day from date_from to date_to (both inclusive) that has ledger activity in country."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"statement_report_v3_reports_statement_post","name":"Statement Report","isWebhook":false,"pointer":"/paths/~1v3~1reports~1statement/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Statement Report","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":"Statement report as CSV, one row per day from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date_from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (both inclusive) that has ledger activity in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"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":"code","inline":true,"attributes":{"content":"timezone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" defines where a day starts; omit it for UTC. Balance columns are named after the organization's settlement currency."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatementReportFilter"}},"schemaId":"components/schemas/StatementReportFilter","pointer":"/paths/~1v3~1reports~1statement/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/reports/statement","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StatementReportFilter"}},"responseCodes":["200","400","401","403","422","429","500"],"pointer":"/v3/reports/statement","href":"v3-reports/statement_report_v3_reports_statement_post","openApiOperationId":"statement_report_v3_reports_statement_post","summary":"Statement Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"schemaId":"components/schemas/StatementReportFilter","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatementReportFilter"}},"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"},{"code":"400","description":"Bad data in the request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"422","description":"One or more request fields are invalid","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}},"schemaId":"components/schemas/ValidationProblem"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the seconds to wait."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v3~1reports~1statement/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"422","schemaId":"components/schemas/ValidationProblem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v3-reports/statement_report_v3_reports_statement_post"}],"panels":[]}]},"httpPath":"/v3/reports/statement"},{"label":"Wallet Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v3-reports/wallet_report_v3_reports_wallet_post","routeSlug":"/openapi/v3-reports/wallet_report_v3_reports_wallet_post","metadata":{"seo":{"title":"Wallet Report","description":"Wallet report as CSV, one row per ledger entry in api_country, streamed as it is read. v2 and v3 entries alike, none hidden."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"wallet_report_v3_reports_wallet_post","name":"Wallet Report","isWebhook":false,"pointer":"/paths/~1v3~1reports~1wallet/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Wallet Report","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":"Wallet report as CSV, one row per ledger entry in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", streamed as it is read. v2 and v3 entries alike, none hidden."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" bounds the window, both ends inclusive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_txn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" come from the payment in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"txn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_txn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the payment a reversal retry was made for. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timezone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sets the zone timestamps are written in; omit it for UTC."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"timezone","in":"query","schemaId":"schema_51"}],"pointer":"/paths/~1v3~1reports~1wallet/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LedgerDataPublicFilterBy"}},"schemaId":"components/schemas/LedgerDataPublicFilterBy","pointer":"/paths/~1v3~1reports~1wallet/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/reports/wallet","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[{"name":"timezone","in":"query","required":false,"schemaId":"schema_51"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LedgerDataPublicFilterBy"}},"responseCodes":["200","400","401","403","422","429","500"],"pointer":"/v3/reports/wallet","href":"v3-reports/wallet_report_v3_reports_wallet_post","openApiOperationId":"wallet_report_v3_reports_wallet_post","summary":"Wallet Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"schemaId":"components/schemas/LedgerDataPublicFilterBy","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LedgerDataPublicFilterBy"}},"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"},{"code":"400","description":"Bad data in the request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"422","description":"One or more request fields are invalid","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}},"schemaId":"components/schemas/ValidationProblem"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the seconds to wait."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v3~1reports~1wallet/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"422","schemaId":"components/schemas/ValidationProblem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v3-reports/wallet_report_v3_reports_wallet_post"}],"panels":[]}]},"httpPath":"/v3/reports/wallet"}],"content":{"contentType":"group","meta":{"name":"v3-reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports","showPageActions":true},{"nodeType":"markdoc","content":"Generate payout, statement and wallet reports."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/reports/payout","summary":"Payout Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v3-reports/payout_report_v3_reports_payout_post","deprecated":false},{"title":"/v3/reports/statement","summary":"Statement Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v3-reports/statement_report_v3_reports_statement_post","deprecated":false},{"title":"/v3/reports/wallet","summary":"Wallet Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v3-reports/wallet_report_v3_reports_wallet_post","deprecated":false}]}]}]}]}},{"type":"group","label":"Utilities","link":"/openapi/v3-utilities","routeSlug":"/openapi/v3-utilities","items":[{"label":"Banks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v3-utilities/banks_v3_info_payment_banks_get","routeSlug":"/openapi/v3-utilities/banks_v3_info_payment_banks_get","metadata":{"seo":{"title":"Banks","description":"Banks reachable in this corridor. swift_code is what payment_details.bank_code carries, or iban_code for an institution with no BIC."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"banks_v3_info_payment_banks_get","name":"Banks","isWebhook":false,"pointer":"/paths/~1v3~1info~1payment_banks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Banks","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":"Banks reachable in this corridor. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"swift_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is what "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_details.bank_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iban_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an institution with no BIC."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"country","in":"query","schemaId":"schema_48","description":"Payment country","required":true},{"name":"payment_method","in":"query","schemaId":"schema_52","description":"Restrict to banks reachable on this rail"}],"pointer":"/paths/~1v3~1info~1payment_banks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/info/payment_banks","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[{"name":"country","in":"query","required":true,"schemaId":"components/schemas/ApiCountry"},{"name":"payment_method","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","422","429"],"pointer":"/v3/info/payment_banks","href":"v3-utilities/banks_v3_info_payment_banks_get","openApiOperationId":"banks_v3_info_payment_banks_get","summary":"Banks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankList"}},"schemaId":"components/schemas/BankList"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"422","description":"One or more request fields are invalid","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}},"schemaId":"components/schemas/ValidationProblem"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the seconds to wait."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v3~1info~1payment_banks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BankList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankList"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"422","schemaId":"components/schemas/ValidationProblem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ValidationProblem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v3-utilities/banks_v3_info_payment_banks_get"}],"panels":[]}]},"httpPath":"/v3/info/payment_banks"},{"label":"Debug","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v3-utilities/debug_v3_debug_get","routeSlug":"/openapi/v3-utilities/debug_v3_debug_get","metadata":{"seo":{"title":"Debug","description":"Echo back the request headers the API received"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"debug_v3_debug_get","name":"Debug","isWebhook":false,"pointer":"/paths/~1v3~1debug/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Debug","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Echo back the request headers the API received"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/debug","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","429","500"],"pointer":"/v3/debug","href":"v3-utilities/debug_v3_debug_get","openApiOperationId":"debug_v3_debug_get","summary":"Debug"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53"}},"schemaId":"schema_53"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the seconds to wait."},"children":[]}]}]}],"mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}},"schemaId":"components/schemas/Problem"}],"pointer":"/paths/~1v3~1debug/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_53","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53"}}},{"code":"401","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"403","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"429","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}},{"code":"500","schemaId":"components/schemas/Problem","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Problem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v3-utilities/debug_v3_debug_get"}],"panels":[]}]},"httpPath":"/v3/debug"}],"content":{"contentType":"group","meta":{"name":"v3-utilities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Utilities","showPageActions":true},{"nodeType":"markdoc","content":"Reference data and connectivity checks."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/info/payment_banks","summary":"Banks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v3-utilities/banks_v3_info_payment_banks_get","deprecated":false},{"title":"/v3/debug","summary":"Debug","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v3-utilities/debug_v3_debug_get","deprecated":false}]}]}]}]}},{"type":"separator","label":"API v2 (maintenance)","content":null},{"type":"group","label":"Quotes & payments","link":"/openapi/v2-quotes-payments","routeSlug":"/openapi/v2-quotes-payments","items":[{"label":"Payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v2-quotes-payments/payment_v2_payment_post","routeSlug":"/openapi/v2-quotes-payments/payment_v2_payment_post","metadata":{"seo":{"title":"Payment","description":"Execute payment to beneficiary with specified bank details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payment_v2_payment_post","name":"Payment","isWebhook":false,"pointer":"/paths/~1v2~1payment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Execute payment to beneficiary with specified bank details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment","pointer":"/paths/~1v2~1payment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/payment","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Payment"}},"responseCodes":["202","400","401","403","422","429","500"],"pointer":"/v2/payment","href":"v2-quotes-payments/payment_v2_payment_post","openApiOperationId":"payment_v2_payment_post","summary":"Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Payment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResponseLive"}},"schemaId":"components/schemas/PaymentResponseLive"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment was not created. Fix the cause and resend with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; for an expired or used quote, request a fresh quote first. A duplicate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a payment with it already exists: look it up with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payments/{external_id}?external=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead of resending."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError","exampleIds":["paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example1","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example2","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example3","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example4","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example5","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example6","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example7"]}},"schemaId":"components/schemas/BadRequestError","exampleIds":["paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example1","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example2","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example3","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example4","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example5","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example6","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example7"]},{"code":"401","description":"Access token not valid or expired","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"422","description":"Unprocessable Entry","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnprocessableError"}},"schemaId":"components/schemas/UnprocessableError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate is too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the number of seconds to wait."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}},"schemaId":"components/schemas/TooManyRequestsError"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v2~1payment/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/PaymentResponseLive","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResponseLive"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","exampleIds":["paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example1","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example2","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example3","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example4","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example5","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example6","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example7"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError","exampleIds":["paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example1","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example2","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example3","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example4","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example5","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example6","paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example7"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"422","schemaId":"components/schemas/UnprocessableError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnprocessableError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequestsError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v2-quotes-payments/payment_v2_payment_post"}],"panels":[]}]},"httpPath":"/v2/payment"},{"label":"Quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v2-quotes-payments/quote_v2_quote_post","routeSlug":"/openapi/v2-quotes-payments/quote_v2_quote_post","metadata":{"seo":{"title":"Quote","description":"Create quote for use with payment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quote_v2_quote_post","name":"Quote","isWebhook":false,"pointer":"/paths/~1v2~1quote/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create quote for use with payment"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_54"}},"schemaId":"schema_54","pointer":"/paths/~1v2~1quote/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/quote","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_54"}},"responseCodes":["200","400","401","403","422","429","500"],"pointer":"/v2/quote","href":"v2-quotes-payments/quote_v2_quote_post","openApiOperationId":"quote_v2_quote_post","summary":"Quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"schemaId":"schema_54","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_54"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteResponseV2"}},"schemaId":"components/schemas/QuoteResponseV2"},{"code":"400","description":"Bad data in the request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError","exampleIds":["paths/~1v2~1quote/post/responses/400/content/application~1json/examples/example1"]}},"schemaId":"components/schemas/BadRequestError","exampleIds":["paths/~1v2~1quote/post/responses/400/content/application~1json/examples/example1"]},{"code":"401","description":"Access token not valid or expired","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"422","description":"Unprocessable Entry","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnprocessableError"}},"schemaId":"components/schemas/UnprocessableError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate is too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the number of seconds to wait."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}},"schemaId":"components/schemas/TooManyRequestsError"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError","exampleIds":["paths/~1v2~1quote/post/responses/500/content/application~1json/examples/example1","paths/~1v2~1quote/post/responses/500/content/application~1json/examples/example2"]}},"schemaId":"components/schemas/InternalServerError","exampleIds":["paths/~1v2~1quote/post/responses/500/content/application~1json/examples/example1","paths/~1v2~1quote/post/responses/500/content/application~1json/examples/example2"]}],"pointer":"/paths/~1v2~1quote/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteResponseV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteResponseV2"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","exampleIds":["paths/~1v2~1quote/post/responses/400/content/application~1json/examples/example1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError","exampleIds":["paths/~1v2~1quote/post/responses/400/content/application~1json/examples/example1"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"422","schemaId":"components/schemas/UnprocessableError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnprocessableError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequestsError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","exampleIds":["paths/~1v2~1quote/post/responses/500/content/application~1json/examples/example1","paths/~1v2~1quote/post/responses/500/content/application~1json/examples/example2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError","exampleIds":["paths/~1v2~1quote/post/responses/500/content/application~1json/examples/example1","paths/~1v2~1quote/post/responses/500/content/application~1json/examples/example2"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v2-quotes-payments/quote_v2_quote_post"}],"panels":[]}]},"httpPath":"/v2/quote"},{"label":"Quote Get","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v2-quotes-payments/quote_get_v2_quote__id__get","routeSlug":"/openapi/v2-quotes-payments/quote_get_v2_quote__id__get","metadata":{"seo":{"title":"Quote Get","description":"Get info about previously created Quote"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"quote_get_v2_quote__id__get","name":"Quote Get","isWebhook":false,"pointer":"/paths/~1v2~1quote~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote Get","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get info about previously created Quote"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_55","required":true}],"pointer":"/paths/~1v2~1quote~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"country","in":"query","schemaId":"schema_56","required":true}],"pointer":"/paths/~1v2~1quote~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/quote/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_55"}],"query":[{"name":"country","in":"query","required":true,"schemaId":"components/schemas/ApiCountry"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v2/quote/{id}","href":"v2-quotes-payments/quote_get_v2_quote__id__get","openApiOperationId":"quote_get_v2_quote__id__get","summary":"Quote Get"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteResponseV2"}},"schemaId":"components/schemas/QuoteResponseV2"},{"code":"400","description":"Bad data in the request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":"No quote with this id for your account, or it has expired.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundError","exampleIds":["paths/~1v2~1quote~1{id}/get/responses/404/content/application~1json/examples/example1"]}},"schemaId":"components/schemas/NotFoundError","exampleIds":["paths/~1v2~1quote~1{id}/get/responses/404/content/application~1json/examples/example1"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate is too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the number of seconds to wait."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}},"schemaId":"components/schemas/TooManyRequestsError"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v2~1quote~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteResponseV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteResponseV2"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/NotFoundError","exampleIds":["paths/~1v2~1quote~1{id}/get/responses/404/content/application~1json/examples/example1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundError","exampleIds":["paths/~1v2~1quote~1{id}/get/responses/404/content/application~1json/examples/example1"]}}},{"code":"429","schemaId":"components/schemas/TooManyRequestsError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v2-quotes-payments/quote_get_v2_quote__id__get"}],"panels":[]}]},"httpPath":"/v2/quote/{id}"},{"label":"Payment Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v2-quotes-payments/payment_status_v2_payments__id__get","routeSlug":"/openapi/v2-quotes-payments/payment_status_v2_payments__id__get","metadata":{"seo":{"title":"Payment Status","description":"Get info about previously executed payment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payment_status_v2_payments__id__get","name":"Payment Status","isWebhook":false,"pointer":"/paths/~1v2~1payments~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get info about previously executed payment"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_57","required":true}],"pointer":"/paths/~1v2~1payments~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"country","in":"query","schemaId":"schema_56","required":true},{"name":"external","in":"query","schemaId":"schema_42","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supplied is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the original payment request."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1payments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/payments/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_57"}],"query":[{"name":"country","in":"query","required":true,"schemaId":"components/schemas/ApiCountry"},{"name":"external","in":"query","required":false,"schemaId":"schema_42"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v2/payments/{id}","href":"v2-quotes-payments/payment_status_v2_payments__id__get","openApiOperationId":"payment_status_v2_payments__id__get","summary":"Payment Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentOrderInfoLive"}},"schemaId":"components/schemas/PaymentOrderInfoLive"},{"code":"400","description":"Bad data in the request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError","exampleIds":["paths/~1v2~1payments~1{id}/get/responses/400/content/application~1json/examples/example1"]}},"schemaId":"components/schemas/BadRequestError","exampleIds":["paths/~1v2~1payments~1{id}/get/responses/400/content/application~1json/examples/example1"]},{"code":"401","description":"Access token not valid or expired","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No payment with this id for your account in the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A lookup in the wrong "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns the same 404 as an unknown id. With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a 404 means no payment has been created with this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is the expected answer to a pre-send duplicate check."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundError","exampleIds":["paths/~1v2~1payments~1{id}/get/responses/404/content/application~1json/examples/example1"]}},"schemaId":"components/schemas/NotFoundError","exampleIds":["paths/~1v2~1payments~1{id}/get/responses/404/content/application~1json/examples/example1"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate is too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the number of seconds to wait."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}},"schemaId":"components/schemas/TooManyRequestsError"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v2~1payments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentOrderInfoLive","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentOrderInfoLive"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","exampleIds":["paths/~1v2~1payments~1{id}/get/responses/400/content/application~1json/examples/example1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError","exampleIds":["paths/~1v2~1payments~1{id}/get/responses/400/content/application~1json/examples/example1"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"404","schemaId":"components/schemas/NotFoundError","exampleIds":["paths/~1v2~1payments~1{id}/get/responses/404/content/application~1json/examples/example1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundError","exampleIds":["paths/~1v2~1payments~1{id}/get/responses/404/content/application~1json/examples/example1"]}}},{"code":"429","schemaId":"components/schemas/TooManyRequestsError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v2-quotes-payments/payment_status_v2_payments__id__get"}],"panels":[]}]},"httpPath":"/v2/payments/{id}"},{"label":"Payment History","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v2-quotes-payments/payment_history_v2_payments_get","routeSlug":"/openapi/v2-quotes-payments/payment_history_v2_payments_get","metadata":{"seo":{"title":"Payment History","description":"List payments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"payment_history_v2_payments_get","name":"Payment History","isWebhook":false,"pointer":"/paths/~1v2~1payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment History","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List payments"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"country","in":"query","schemaId":"schema_56","required":true},{"name":"limit","in":"query","schemaId":"schema_58"},{"name":"offset","in":"query","schemaId":"schema_59"},{"name":"sorting_order","in":"query","schemaId":"schema_60","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort direction on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (newest first). Note "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v3/payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"start_ts","in":"query","schemaId":"schema_61"},{"name":"end_ts","in":"query","schemaId":"schema_62"},{"name":"status","in":"query","schemaId":"schema_45"},{"name":"search_type","in":"query","schemaId":"schema_63"},{"name":"search_term","in":"query","schemaId":"schema_64"}],"pointer":"/paths/~1v2~1payments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/payments","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[{"name":"country","in":"query","required":true,"schemaId":"components/schemas/ApiCountry"},{"name":"limit","in":"query","required":false,"schemaId":"schema_58"},{"name":"offset","in":"query","required":false,"schemaId":"schema_59"},{"name":"sorting_order","in":"query","required":false,"schemaId":"components/schemas/SortingOrder"},{"name":"start_ts","in":"query","required":false,"schemaId":"schema_61"},{"name":"end_ts","in":"query","required":false,"schemaId":"schema_62"},{"name":"status","in":"query","required":false,"schemaId":"schema_45"},{"name":"search_type","in":"query","required":false,"schemaId":"schema_63"},{"name":"search_term","in":"query","required":false,"schemaId":"schema_64"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/v2/payments","href":"v2-quotes-payments/payment_history_v2_payments_get","openApiOperationId":"payment_history_v2_payments_get","summary":"Payment History"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}},"schemaId":"schema_65"},{"code":"400","description":"Bad data in the request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate is too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the number of seconds to wait."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}},"schemaId":"components/schemas/TooManyRequestsError"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v2~1payments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_65","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequestsError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v2-quotes-payments/payment_history_v2_payments_get"}],"panels":[]}]},"httpPath":"/v2/payments"}],"content":{"contentType":"group","meta":{"name":"v2-quotes-payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quotes & payments","showPageActions":true},{"nodeType":"markdoc","content":"v2 is supported and not deprecated, with no sunset date. New integrations should use v3."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/payment","summary":"Payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v2-quotes-payments/payment_v2_payment_post","deprecated":false},{"title":"/v2/quote","summary":"Quote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v2-quotes-payments/quote_v2_quote_post","deprecated":false},{"title":"/v2/quote/{id}","summary":"Quote Get","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v2-quotes-payments/quote_get_v2_quote__id__get","deprecated":false},{"title":"/v2/payments/{id}","summary":"Payment Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v2-quotes-payments/payment_status_v2_payments__id__get","deprecated":false},{"title":"/v2/payments","summary":"Payment History","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v2-quotes-payments/payment_history_v2_payments_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Beneficiary validation","link":"/openapi/v2-validation","routeSlug":"/openapi/v2-validation","items":[{"label":"Validate Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v2-validation/validate_account_v2_validate_account_post","routeSlug":"/openapi/v2-validation/validate_account_v2_validate_account_post","metadata":{"seo":{"title":"Validate Account","description":"Check that a beneficiary bank account exists and, when a name is supplied, that it matches the account holder. India only (country must be IND)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validate_account_v2_validate_account_post","name":"Validate Account","isWebhook":false,"pointer":"/paths/~1v2~1validate_account/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check that a beneficiary bank account exists and, when a name is supplied, that it matches the account holder. India only ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateBeneficiaryRequest"}},"schemaId":"components/schemas/ValidateBeneficiaryRequest","pointer":"/paths/~1v2~1validate_account/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/validate_account","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ValidateBeneficiaryRequest"}},"responseCodes":["200","400","401","403","422","429","500"],"pointer":"/v2/validate_account","href":"v2-validation/validate_account_v2_validate_account_post","openApiOperationId":"validate_account_v2_validate_account_post","summary":"Validate Account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"schemaId":"components/schemas/ValidateBeneficiaryRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateBeneficiaryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}},"schemaId":"schema_66"},{"code":"400","description":"Bad data in the request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"422","description":"Unprocessable Entry","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnprocessableError"}},"schemaId":"components/schemas/UnprocessableError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate is too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the number of seconds to wait."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}},"schemaId":"components/schemas/TooManyRequestsError","headers":{"retry-after":{"description":"Seconds to wait before retrying this request.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_47"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v2~1validate_account/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_66","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"422","schemaId":"components/schemas/UnprocessableError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnprocessableError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequestsError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v2-validation/validate_account_v2_validate_account_post"}],"panels":[]}]},"httpPath":"/v2/validate_account"},{"label":"Validate Bank","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v2-validation/validate_bank_v2_validate_bank_post","routeSlug":"/openapi/v2-validation/validate_bank_v2_validate_bank_post","metadata":{"seo":{"title":"Validate Bank","description":"Look up an Indian bank branch by its IFSC code. Returns the bank and branch details and whether the branch accepts NEFT, IMPS and RTGS. This is a directory lookup: it does not check a beneficiary account or send any funds (use POST /v2/validate_account to check an account). India only; any other country returns 400. Lookups are rate-limited per account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validate_bank_v2_validate_bank_post","name":"Validate Bank","isWebhook":false,"pointer":"/paths/~1v2~1validate_bank/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate Bank","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":"Look up an Indian bank branch by its IFSC code. Returns the bank and branch details and whether the branch accepts NEFT, IMPS and RTGS. This is a directory lookup: it does not check a beneficiary account or send any funds (use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/validate_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check an account). India only; any other "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns 400. Lookups are rate-limited per account."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateBankRequest"}},"schemaId":"components/schemas/ValidateBankRequest","pointer":"/paths/~1v2~1validate_bank/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/validate_bank","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ValidateBankRequest"}},"responseCodes":["200","400","401","403","422","429","500"],"pointer":"/v2/validate_bank","href":"v2-validation/validate_bank_v2_validate_bank_post","openApiOperationId":"validate_bank_v2_validate_bank_post","summary":"Validate Bank"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"schemaId":"components/schemas/ValidateBankRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateBankRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_67"}},"schemaId":"schema_67"},{"code":"400","description":"Bad data in the request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"422","description":"Unprocessable Entry","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnprocessableError"}},"schemaId":"components/schemas/UnprocessableError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate is too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the number of seconds to wait."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}},"schemaId":"components/schemas/TooManyRequestsError"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v2~1validate_bank/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_67","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_67"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"422","schemaId":"components/schemas/UnprocessableError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnprocessableError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequestsError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v2-validation/validate_bank_v2_validate_bank_post"}],"panels":[]}]},"httpPath":"/v2/validate_bank"}],"content":{"contentType":"group","meta":{"name":"v2-validation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Beneficiary validation","showPageActions":true},{"nodeType":"markdoc","content":"Check a beneficiary account or bank branch before paying."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/validate_account","summary":"Validate Account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v2-validation/validate_account_v2_validate_account_post","deprecated":false},{"title":"/v2/validate_bank","summary":"Validate Bank","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v2-validation/validate_bank_v2_validate_bank_post","deprecated":false}]}]}]}]}},{"type":"group","label":"Balances","link":"/openapi/v2-balances","routeSlug":"/openapi/v2-balances","items":[{"label":"Balance Info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v2-balances/balance_info_v2_balance_get","routeSlug":"/openapi/v2-balances/balance_info_v2_balance_get","metadata":{"seo":{"title":"Balance Info","description":"Get balance info"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"balance_info_v2_balance_get","name":"Balance Info","isWebhook":false,"pointer":"/paths/~1v2~1balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balance Info","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get balance info"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"country","in":"query","schemaId":"schema_68","description":"Destination country","required":true}],"pointer":"/paths/~1v2~1balance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/balance","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[{"name":"country","in":"query","required":true,"schemaId":"components/schemas/ApiCountry"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/v2/balance","href":"v2-balances/balance_info_v2_balance_get","openApiOperationId":"balance_info_v2_balance_get","summary":"Balance Info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BalanceInfoResponse"}},"schemaId":"components/schemas/BalanceInfoResponse"},{"code":"400","description":"Bad data in the request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate is too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the number of seconds to wait."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}},"schemaId":"components/schemas/TooManyRequestsError"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v2~1balance/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BalanceInfoResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BalanceInfoResponse"}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequestsError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v2-balances/balance_info_v2_balance_get"}],"panels":[]}]},"httpPath":"/v2/balance"}],"content":{"contentType":"group","meta":{"name":"v2-balances"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balances","showPageActions":true},{"nodeType":"markdoc","content":"What you can pay out, per corridor."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/balance","summary":"Balance Info","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v2-balances/balance_info_v2_balance_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Event stream","link":"/openapi/v2-events","routeSlug":"/openapi/v2-events","items":[{"label":"Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v2-events/events_v2_events_get","routeSlug":"/openapi/v2-events/events_v2_events_get","metadata":{"seo":{"title":"Events","description":"Stream payment events such as payment status or quote responses"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"events_v2_events_get","name":"Events","isWebhook":false,"pointer":"/paths/~1v2~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Stream payment events such as payment status or quote responses"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/events","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/v2/events","href":"v2-events/events_v2_events_get","openApiOperationId":"events_v2_events_get","summary":"Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Server-sent event stream of your payments. Each event has an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name and a JSON "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" line: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the full payment (the same shape as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payments/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment-update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries only its id, timestamp and new status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The stream starts when you connect. Events carry no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so there is no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Last-Event-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resume, and events sent while you were disconnected are not replayed: after reconnecting, fetch the payments you are waiting on with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payments/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Lines starting with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are comments (a ping every 30 seconds keeps the connection open) and carry no data. There is no filtering: you receive events for every payment on your account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required, so use a server-side SSE client; the browser "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EventSource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API cannot send it."},"children":[]}]}]}],"mediaType":"text/event-stream","mediaTypes":["text/event-stream"],"mediaTypeContent":{"text/event-stream":{"schemaId":"schema_69","exampleIds":["paths/~1v2~1events/get/responses/200/content/text~1event-stream/examples/payment_update"]}},"schemaId":"schema_69","exampleIds":["paths/~1v2~1events/get/responses/200/content/text~1event-stream/examples/payment_update"]},{"code":"400","description":"Bad data in the request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}},"schemaId":"components/schemas/BadRequestError"},{"code":"401","description":"Access token not valid or expired","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}},"schemaId":"components/schemas/UnauthorizedError"},{"code":"403","description":"Access token missing permissions to access the resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}},"schemaId":"components/schemas/ForbiddenError"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request rate is too high; back off and retry. Where a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retry-after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header is present it gives the number of seconds to wait."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}},"schemaId":"components/schemas/TooManyRequestsError"},{"code":"500","description":"Internal server error (contact administrator)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v2~1events/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_69","exampleIds":["paths/~1v2~1events/get/responses/200/content/text~1event-stream/examples/payment_update"],"mediaTypes":["text/event-stream"],"mediaTypeContent":{"text/event-stream":{"schemaId":"schema_69","exampleIds":["paths/~1v2~1events/get/responses/200/content/text~1event-stream/examples/payment_update"]}}},{"code":"400","schemaId":"components/schemas/BadRequestError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestError"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenError"}}},{"code":"429","schemaId":"components/schemas/TooManyRequestsError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TooManyRequestsError"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v2-events/events_v2_events_get"}],"panels":[]}]},"httpPath":"/v2/events"}],"content":{"contentType":"group","meta":{"name":"v2-events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Event stream","showPageActions":true},{"nodeType":"markdoc","content":"Payment updates as server-sent events."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/events","summary":"Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v2-events/events_v2_events_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Reports","link":"/openapi/v2-reports","routeSlug":"/openapi/v2-reports","items":[{"label":"Report Create","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v2-reports/report_create_v2_reports__report_type__post","routeSlug":"/openapi/v2-reports/report_create_v2_reports__report_type__post","metadata":{"seo":{"title":"Report Create","description":"Request an asynchronous report generation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"report_create_v2_reports__report_type__post","name":"Report Create","isWebhook":false,"pointer":"/paths/~1v2~1reports~1{report_type}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Create","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 asynchronous report generation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a report file record with status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and enqueues a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"background job that builds the report from the supplied parameters"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and uploads it to storage."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" report type is supported."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_type","in":"path","schemaId":"schema_70","required":true}],"pointer":"/paths/~1v2~1reports~1{report_type}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClientPayoutReportParams"}},"schemaId":"components/schemas/ClientPayoutReportParams","pointer":"/paths/~1v2~1reports~1{report_type}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/reports/{report_type}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[{"name":"report_type","in":"path","required":true,"schemaId":"components/schemas/ClientReportType"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ClientPayoutReportParams"}},"responseCodes":["202","422"],"pointer":"/v2/reports/{report_type}","href":"v2-reports/report_create_v2_reports__report_type__post","openApiOperationId":"report_create_v2_reports__report_type__post","summary":"Report Create"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"schemaId":"components/schemas/ClientPayoutReportParams","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClientPayoutReportParams"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportResponse"}},"schemaId":"components/schemas/ReportResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1v2~1reports~1{report_type}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/ReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v2-reports/report_create_v2_reports__report_type__post"}],"panels":[]}]},"httpPath":"/v2/reports/{report_type}"},{"label":"Report List","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v2-reports/report_list_v2_reports_list__put","routeSlug":"/openapi/v2-reports/report_list_v2_reports_list__put","metadata":{"seo":{"title":"Report List","description":"List generated reports, newest first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"report_list_v2_reports_list__put","name":"Report List","isWebhook":false,"pointer":"/paths/~1v2~1reports~1list~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report List","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":"List generated reports, newest first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns only reports generated by the caller. Results can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"narrowed with the optional body filter (report type, country and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" time range)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_71"},{"name":"offset","in":"query","schemaId":"schema_59"}],"pointer":"/paths/~1v2~1reports~1list~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_72"}},"schemaId":"schema_72","pointer":"/paths/~1v2~1reports~1list~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/reports/list/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_71"},{"name":"offset","in":"query","required":false,"schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_72"}},"responseCodes":["200","422"],"pointer":"/v2/reports/list/","href":"v2-reports/report_list_v2_reports_list__put","openApiOperationId":"report_list_v2_reports_list__put","summary":"Report List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"schemaId":"schema_72","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_72"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_73"}},"schemaId":"schema_73"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1v2~1reports~1list~1/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_73","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_73"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v2-reports/report_list_v2_reports_list__put"}],"panels":[]}]},"httpPath":"/v2/reports/list/"},{"label":"Report Get","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v2-reports/report_get_v2_reports__id__get","routeSlug":"/openapi/v2-reports/report_get_v2_reports__id__get","metadata":{"seo":{"title":"Report Get","description":"Fetch a single generated report by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"report_get_v2_reports__id__get","name":"Report Get","isWebhook":false,"pointer":"/paths/~1v2~1reports~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Get","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch a single generated report by id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only reports generated by the caller are visible. Use this to poll"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after requesting a report: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" mean the report is still being built, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"means it is ready for download and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means generation failed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_55","required":true}],"pointer":"/paths/~1v2~1reports~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/reports/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_55"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/reports/{id}","href":"v2-reports/report_get_v2_reports__id__get","openApiOperationId":"report_get_v2_reports__id__get","summary":"Report Get"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportResponse"}},"schemaId":"components/schemas/ReportResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1v2~1reports~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v2-reports/report_get_v2_reports__id__get"}],"panels":[]}]},"httpPath":"/v2/reports/{id}"},{"label":"Report Latest","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v2-reports/report_latest_v2_reports__report_type__latest_get","routeSlug":"/openapi/v2-reports/report_latest_v2_reports__report_type__latest_get","metadata":{"seo":{"title":"Report Latest","description":"Fetch the caller's most recently created report of a given type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"report_latest_v2_reports__report_type__latest_get","name":"Report Latest","isWebhook":false,"pointer":"/paths/~1v2~1reports~1{report_type}~1latest/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Latest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch the caller's most recently created report of a given type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_type","in":"path","schemaId":"schema_70","required":true}],"pointer":"/paths/~1v2~1reports~1{report_type}~1latest/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"auto_generated","in":"query","schemaId":"schema_74"}],"pointer":"/paths/~1v2~1reports~1{report_type}~1latest/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/reports/{report_type}/latest","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[{"name":"report_type","in":"path","required":true,"schemaId":"components/schemas/ClientReportType"}],"query":[{"name":"auto_generated","in":"query","required":false,"schemaId":"schema_74"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/reports/{report_type}/latest","href":"v2-reports/report_latest_v2_reports__report_type__latest_get","openApiOperationId":"report_latest_v2_reports__report_type__latest_get","summary":"Report Latest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportResponse"}},"schemaId":"components/schemas/ReportResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1v2~1reports~1{report_type}~1latest/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v2-reports/report_latest_v2_reports__report_type__latest_get"}],"panels":[]}]},"httpPath":"/v2/reports/{report_type}/latest"},{"label":"Report Presigned Url","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v2-reports/report_presigned_url_v2_reports__id__presigned_url_get","routeSlug":"/openapi/v2-reports/report_presigned_url_v2_reports__id__presigned_url_get","metadata":{"seo":{"title":"Report Presigned Url","description":"Get a temporary download URL for a successfully generated report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"report_presigned_url_v2_reports__id__presigned_url_get","name":"Report Presigned Url","isWebhook":false,"pointer":"/paths/~1v2~1reports~1{id}~1presigned-url/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Presigned Url","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a temporary download URL for a successfully generated report."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_55","required":true}],"pointer":"/paths/~1v2~1reports~1{id}~1presigned-url/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/reports/{id}/presigned-url","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_55"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/reports/{id}/presigned-url","href":"v2-reports/report_presigned_url_v2_reports__id__presigned_url_get","openApiOperationId":"report_presigned_url_v2_reports__id__presigned_url_get","summary":"Report Presigned Url"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportPresignedUrlResponse"}},"schemaId":"components/schemas/ReportPresignedUrlResponse"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1v2~1reports~1{id}~1presigned-url/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportPresignedUrlResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportPresignedUrlResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v2-reports/report_presigned_url_v2_reports__id__presigned_url_get"}],"panels":[]}]},"httpPath":"/v2/reports/{id}/presigned-url"}],"content":{"contentType":"group","meta":{"name":"v2-reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports","showPageActions":true},{"nodeType":"markdoc","content":"Generate and download payout reports."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/reports/{report_type}","summary":"Report Create","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v2-reports/report_create_v2_reports__report_type__post","deprecated":false},{"title":"/v2/reports/list/","summary":"Report List","prefix":{"name":"put","color":"put"},"badges":[],"link":"/v2-reports/report_list_v2_reports_list__put","deprecated":false},{"title":"/v2/reports/{id}","summary":"Report Get","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v2-reports/report_get_v2_reports__id__get","deprecated":false},{"title":"/v2/reports/{report_type}/latest","summary":"Report Latest","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v2-reports/report_latest_v2_reports__report_type__latest_get","deprecated":false},{"title":"/v2/reports/{id}/presigned-url","summary":"Report Presigned Url","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v2-reports/report_presigned_url_v2_reports__id__presigned_url_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Utilities","link":"/openapi/v2-utilities","routeSlug":"/openapi/v2-utilities","items":[{"label":"Debug Get","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/v2-utilities/debug_get_v2_debug_get","routeSlug":"/openapi/v2-utilities/debug_get_v2_debug_get","metadata":{"seo":{"title":"Debug Get","description":"Echo the request headers the API received, excluding internal x- headers. Use it to check that your requests reach the API. It does not report which corridors or features are enabled for your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"debug_get_v2_debug_get","name":"Debug Get","isWebhook":false,"pointer":"/paths/~1v2~1debug/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Debug Get","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":"Echo the request headers the API received, excluding internal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers. Use it to check that your requests reach the API. It does not report which corridors or features are enabled for your account."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/debug","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/debug","href":"v2-utilities/debug_get_v2_debug_get","openApiOperationId":"debug_get_v2_debug_get","summary":"Debug Get"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_75","exampleIds":["paths/~1v2~1debug/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_75","exampleIds":["paths/~1v2~1debug/get/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1v2~1debug/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_75","exampleIds":["paths/~1v2~1debug/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_75","exampleIds":["paths/~1v2~1debug/get/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v2-utilities/debug_get_v2_debug_get"}],"panels":[]}]},"httpPath":"/v2/debug"}],"content":{"contentType":"group","meta":{"name":"v2-utilities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Utilities","showPageActions":true},{"nodeType":"markdoc","content":"Connectivity checks."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/debug","summary":"Debug Get","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v2-utilities/debug_get_v2_debug_get","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ApiCountry":{"id":"components/schemas/ApiCountry","kind":"json-schema","title":"ApiCountry","data":{"type":"string","enum":["BGD","IND","PAK","PHL","NPL","EGY","VNM","NGA"],"title":"ApiCountry"}},"components/schemas/BadRequestError":{"id":"components/schemas/BadRequestError","kind":"json-schema","title":"BadRequestError","data":{"properties":{"detail":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Detail"}},"type":"object","title":"BadRequestError"}},"components/schemas/BalanceInfoResponse":{"id":"components/schemas/BalanceInfoResponse","kind":"json-schema","title":"BalanceInfoResponse","data":{"properties":{"currency":{"type":"string","title":"Currency","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The destination country's local currency; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in it."},"children":[]}]}]}]},"balance":{"type":"number","title":"Balance","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you can pay out to this country right now, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Check it before a payout."},"children":[]}]}]}]},"reserved_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Reserved Balance","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Held by payments still in progress, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wallet_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wallet_balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" already exclude it."},"children":[]}]}]}]},"wallet_currency":{"type":"string","title":"Wallet Currency","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your settlement wallet currency: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USDT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USDC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":"USDT"},"wallet_currency_rate":{"type":"number","title":"Wallet Currency Rate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wallet_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":0},"wallet_balance":{"type":"number","title":"Wallet Balance","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The same funds as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wallet_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including any credit line."},"children":[]}]}]}],"default":0},"deals":{"anyOf":[{"$ref":"#/components/schemas/DealBalanceInfo"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your rate-lock deal position for this corridor, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wallet_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Absent when you have no active deals."},"children":[]}]}]}]}},"type":"object","required":["currency","balance"],"title":"BalanceInfoResponse","examples":[{"balance":848879.12,"currency":"INR","reserved_balance":250,"wallet_balance":10000,"wallet_currency":"USDT","wallet_currency_rate":84.887912}]}},"components/schemas/BangladeshPayment":{"id":"components/schemas/BangladeshPayment","kind":"json-schema","title":"BangladeshPayment","data":{"properties":{"country":{"type":"string","const":"BGD","title":"Country","description":"ISO 3166-1 alpha-3 Country Code"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source currency. Must be the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the quote in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the amount is converted to the local currency at that quote's rate."},"children":[]}]}]}]},"quote":{"type":"string","format":"uuid","title":"Quote","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid currency quote id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UUID4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quote currency must match base currency."},"children":[]}]}]}]},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payout amount, in the DESTINATION (local) currency - INR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country=IND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", PKR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and so on."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" verbatim; do not recompute it. Note the naming trap: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is the SOURCE amount on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the DESTINATION amount here. The value is rounded to 2 decimal places and must fall"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inside the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" band, which is the only amount check performed - a value outside the band is a 400."},"children":[]}]}]}]},"bank_name":{"type":"string","title":"Bank Name","description":"Bank name where the beneficiary account is held."},"beneficiary_name":{"type":"string","maxLength":128,"title":"Beneficiary Name","description":"Full name of the beneficiary (name and surname)."},"beneficiary_city":{"type":"string","title":"Beneficiary City","description":"Beneficiary address (city)"},"beneficiary_address":{"type":"string","maxLength":70,"title":"Beneficiary Address","description":"Beneficiary address (street and number)"},"beneficiary_account_number":{"type":"string","title":"Beneficiary Account Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account id of the beneficiary. The same value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/validate_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"beneficiary_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Beneficiary Mobile","description":"Beneficiary mobile number in ITU E.164 format: the destination country's calling-code prefix followed by the national number, with no spaces, hyphens or parentheses."},"beneficiary_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Beneficiary Email","description":"If specified, must be a valid email address"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks","description":"Supplementary info and notes for tracking the transaction."},"sender_name":{"type":"string","title":"Sender Name","description":"Full name of Sender (name and surname)"},"sender_birthdate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Birthdate","description":"Sender birthdate"},"sender_identity_doc_exp":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Identity Doc Exp","description":"Expiry date for the sender identity document"},"sender_identity_doc_country":{"anyOf":[{"type":"string","maxLength":3,"minLength":3},{"type":"null"}],"title":"Sender Identity Doc Country","description":"Sender country (nationality) (ISO 3166-1 alpha-3 Country Code)"},"sender_city":{"type":"string","title":"Sender City","description":"Sender residency/address (city)"},"sender_address":{"type":"string","maxLength":70,"title":"Sender Address","description":"Sender residency/address (street and number)"},"sender_country":{"type":"string","maxLength":3,"minLength":3,"title":"Sender Country","description":"Sender residency/country (ISO 3166-1 alpha-3 Country Code)"},"sender_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Mobile","description":"Sender mobile number (ITU E.164 format)"},"sender_relation":{"$ref":"#/components/schemas/Relation","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the beneficiary is to the sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"father"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the beneficiary is the sender's father. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"own"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a transfer to the sender's own account."},"children":[]}]}]}]},"external_id":{"anyOf":[{"$ref":"#/components/schemas/ExternalIdStr"},{"type":"null"}]},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp of the order (will be filled in automatically server side)"},"beneficiary_account_type":{"$ref":"#/components/schemas/BankAccountType","description":"Bank account type","default":"savings"},"bank_branch_code":{"type":"string","title":"Bank Branch Code","description":"SWIFT / BIC code of the beneficiary bank branch"},"sender_identity_doc_type":{"$ref":"#/components/schemas/IdentityDocumentType","description":"Sender identity document type"},"sender_identity_doc":{"type":"string","title":"Sender Identity Doc","description":"Sender identity document number"}},"type":"object","required":["country","currency","quote","amount","bank_name","beneficiary_name","beneficiary_city","beneficiary_address","beneficiary_account_number","sender_name","sender_city","sender_address","sender_country","sender_relation","bank_branch_code","sender_identity_doc_type","sender_identity_doc"],"title":"BangladeshPayment","examples":[{"amount":100,"bank_branch_code":"ABBLBDDH201","bank_name":"Bangladesh Bank","beneficiary_account_number":"9934572443993487","beneficiary_account_type":"savings","beneficiary_address":"Main Road","beneficiary_city":"Dhaka","beneficiary_email":"bashir.ahmed@domain.com","beneficiary_mobile":"+8801700000000","beneficiary_name":"Bashir Ahmed","country":"BGD","currency":"AED","quote":"00000000-0000-4000-A000-000000000000","remarks":"test","sender_address":"Jumeirah Beach Road","sender_birthdate":"1970-01-01","sender_city":"Dubai","sender_country":"ARE","sender_identity_doc":"A987654","sender_identity_doc_country":"ARE","sender_identity_doc_exp":"2038-01-19","sender_identity_doc_type":"idcard","sender_mobile":"+9715850185684","sender_name":"Ahmed Ahmed","sender_relation":"other"}]}},"components/schemas/BankAccountStatus":{"id":"components/schemas/BankAccountStatus","kind":"json-schema","title":"BankAccountStatus","data":{"type":"string","enum":["valid","invalid","nre","pending"],"title":"BankAccountStatus","description":"Result of a beneficiary account check.","x-enumDescriptions":{"invalid":"The account was not found, or is blocked, closed or inactive, or the IFSC code is invalid. Do not send a payment to it.","nre":"The account exists and is an Indian NRE (Non-Resident External) account. It passes validation; payments to it are handled under NRE rules.","pending":"The check is still running at the provider. This is not a failure: check again later.","valid":"The account exists and is active."}}},"components/schemas/BankAccountType":{"id":"components/schemas/BankAccountType","kind":"json-schema","title":"BankAccountType","data":{"type":"string","enum":["savings","current"],"title":"BankAccountType"}},"components/schemas/BatchJobItemStatus":{"id":"components/schemas/BatchJobItemStatus","kind":"json-schema","title":"BatchJobItemStatus","data":{"type":"string","enum":["pending","processing","success","fail"],"title":"BatchJobItemStatus"}},"components/schemas/ClientPayoutReportParams":{"id":"components/schemas/ClientPayoutReportParams","kind":"json-schema","title":"ClientPayoutReportParams","data":{"properties":{"country":{"$ref":"#/components/schemas/ApiCountry"},"sorting_order":{"$ref":"#/components/schemas/SortingOrder","default":"desc"},"start_ts":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Ts"},"end_ts":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Ts"},"status":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentOrderState"},"type":"array"},{"type":"null"}],"title":"Status"},"ids":{"anyOf":[{"items":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}]},"type":"array","maxItems":1000},{"type":"null"}],"title":"Ids"},"external":{"type":"boolean","title":"External","default":false}},"type":"object","required":["country"],"title":"ClientPayoutReportParams","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout report parameters available to API clients."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mirrors the client-facing parameters of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stream_order_results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generated report can be reproduced exactly from the persisted params."},"children":[]}]}]}]}},"components/schemas/ClientReportListFilter":{"id":"components/schemas/ClientReportListFilter","kind":"json-schema","title":"ClientReportListFilter","data":{"properties":{"report_type":{"anyOf":[{"$ref":"#/components/schemas/ClientReportType"},{"type":"null"}]},"country":{"anyOf":[{"$ref":"#/components/schemas/ApiCountry"},{"type":"null"}]},"start_ts":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Ts"},"end_ts":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Ts"}},"type":"object","title":"ClientReportListFilter"}},"components/schemas/ClientReportType":{"id":"components/schemas/ClientReportType","kind":"json-schema","title":"ClientReportType","data":{"type":"string","enum":["payout"],"title":"ClientReportType","description":"Report types API clients can generate and filter by."}},"components/schemas/CurrencyCode":{"id":"components/schemas/CurrencyCode","kind":"json-schema","title":"CurrencyCode","data":{"type":"string","enum":["BHD","EUR","KWD","MYR","OMR","QAR","SAR","SGD","TRY","AED","USD","INR","PHP","EGP","VND","PKR","NGN"],"title":"CurrencyCode"}},"components/schemas/DealBalanceInfo":{"id":"components/schemas/DealBalanceInfo","kind":"json-schema","title":"DealBalanceInfo","data":{"properties":{"committed":{"type":"number","title":"Committed","description":"Total approved amount across active deals in this corridor","default":0},"settled":{"type":"number","title":"Settled","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"committed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", how much has already been deducted from the ledger by payments that settled against those deals. The difference is what is still withheld from the spendable balance -- the settled part is not withheld again"},"children":[]}]}]}],"default":0}},"type":"object","title":"DealBalanceInfo","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deal position for one corridor, in the wallet currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Summed over the organization's active deals there. Lives here because"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BalanceInfoResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries it and the v3 models import this module."},"children":[]}]}]}]}},"components/schemas/DestinationCurrency":{"id":"components/schemas/DestinationCurrency","kind":"json-schema","title":"DestinationCurrency","data":{"type":"string","enum":["BDT","INR","PKR","PHP","NPR","EGP","VND","NGN"],"title":"DestinationCurrency"}},"components/schemas/EgyptPayment":{"id":"components/schemas/EgyptPayment","kind":"json-schema","title":"EgyptPayment","data":{"properties":{"country":{"type":"string","const":"EGY","title":"Country","description":"ISO 3166-1 alpha-3 Country Code"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source currency. Must be the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the quote in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the amount is converted to the local currency at that quote's rate."},"children":[]}]}]}]},"quote":{"type":"string","format":"uuid","title":"Quote","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid currency quote id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UUID4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quote currency must match base currency."},"children":[]}]}]}]},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payout amount, in the DESTINATION (local) currency - INR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country=IND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", PKR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and so on."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" verbatim; do not recompute it. Note the naming trap: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is the SOURCE amount on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the DESTINATION amount here. The value is rounded to 2 decimal places and must fall"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inside the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" band, which is the only amount check performed - a value outside the band is a 400."},"children":[]}]}]}]},"bank_name":{"type":"string","title":"Bank Name","description":"Bank name where the beneficiary account is held."},"beneficiary_name":{"type":"string","maxLength":128,"title":"Beneficiary Name","description":"Full name of the beneficiary (name and surname)."},"beneficiary_city":{"type":"string","title":"Beneficiary City","description":"Beneficiary address (city)"},"beneficiary_address":{"type":"string","maxLength":70,"title":"Beneficiary Address","description":"Beneficiary address (street and number)"},"beneficiary_account_number":{"type":"string","title":"Beneficiary Account Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account id of the beneficiary. The same value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/validate_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"beneficiary_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Beneficiary Mobile","description":"Beneficiary mobile number in ITU E.164 format: the destination country's calling-code prefix followed by the national number, with no spaces, hyphens or parentheses."},"beneficiary_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Beneficiary Email","description":"If specified, must be a valid email address"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks","description":"Supplementary info and notes for tracking the transaction."},"sender_name":{"type":"string","title":"Sender Name","description":"Full name of Sender (name and surname)"},"sender_birthdate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Birthdate","description":"Sender birthdate"},"sender_identity_doc_exp":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Identity Doc Exp","description":"Expiry date for the sender identity document"},"sender_identity_doc_country":{"anyOf":[{"type":"string","maxLength":3,"minLength":3},{"type":"null"}],"title":"Sender Identity Doc Country","description":"Sender country (nationality) (ISO 3166-1 alpha-3 Country Code)"},"sender_city":{"type":"string","title":"Sender City","description":"Sender residency/address (city)"},"sender_address":{"type":"string","maxLength":70,"title":"Sender Address","description":"Sender residency/address (street and number)"},"sender_country":{"type":"string","maxLength":3,"minLength":3,"title":"Sender Country","description":"Sender residency/country (ISO 3166-1 alpha-3 Country Code)"},"sender_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Mobile","description":"Sender mobile number (ITU E.164 format)"},"sender_relation":{"$ref":"#/components/schemas/Relation","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the beneficiary is to the sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"father"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the beneficiary is the sender's father. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"own"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a transfer to the sender's own account."},"children":[]}]}]}]},"external_id":{"anyOf":[{"$ref":"#/components/schemas/ExternalIdStr"},{"type":"null"}]},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp of the order (will be filled in automatically server side)"},"sender_identity_doc_type":{"$ref":"#/components/schemas/IdentityDocumentType","description":"Sender identity document type"},"sender_identity_doc":{"type":"string","title":"Sender Identity Doc","description":"Sender identity document number"}},"type":"object","required":["country","currency","quote","amount","bank_name","beneficiary_name","beneficiary_city","beneficiary_address","beneficiary_account_number","sender_name","sender_city","sender_address","sender_country","sender_relation","sender_identity_doc_type","sender_identity_doc"],"title":"EgyptPayment","examples":[{"amount":100,"bank_name":"National Bank of Egypt","beneficiary_account_number":"1234567890123456","beneficiary_address":"Main Road","beneficiary_city":"Cairo","beneficiary_email":"omar.salah@domain.com","beneficiary_mobile":"+201000000000","beneficiary_name":"Omar Salah","country":"EGY","currency":"AED","quote":"00000000-0000-4000-A000-000000000000","remarks":"test","sender_address":"Jumeirah Beach Road","sender_birthdate":"1970-01-01","sender_city":"Dubai","sender_country":"ARE","sender_identity_doc":"A987654","sender_identity_doc_country":"ARE","sender_identity_doc_exp":"2038-01-19","sender_identity_doc_type":"idcard","sender_mobile":"+9715850185684","sender_name":"Ahmed Ahmed","sender_relation":"other"}]}},"components/schemas/ExternalIdStr":{"id":"components/schemas/ExternalIdStr","kind":"json-schema","title":"ExternalIdStr","data":{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9._#-]+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID provided by API user. Alphanumerics and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}]}},"components/schemas/ForbiddenError":{"id":"components/schemas/ForbiddenError","kind":"json-schema","title":"ForbiddenError","data":{"properties":{"detail":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Detail"}},"type":"object","title":"ForbiddenError"}},"components/schemas/HTTPValidationError":{"id":"components/schemas/HTTPValidationError","kind":"json-schema","title":"HTTPValidationError","data":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}},"components/schemas/IdentityDocumentType":{"id":"components/schemas/IdentityDocumentType","kind":"json-schema","title":"IdentityDocumentType","data":{"type":"string","enum":["idcard","passport","resident_card","other"],"title":"IdentityDocumentType","description":"Type of the sender's identity document.","x-enumDescriptions":{"idcard":"A national identity card, issued by the sender's country of citizenship.","other":"Any other government-issued identity document.","passport":"A passport.","resident_card":"A residence identity card, issued by the sender's country of residence."}}},"components/schemas/IndiaPayment":{"id":"components/schemas/IndiaPayment","kind":"json-schema","title":"IndiaPayment","data":{"properties":{"country":{"type":"string","const":"IND","title":"Country","description":"ISO 3166-1 alpha-3 Country Code"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source currency. Must be the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the quote in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the amount is converted to the local currency at that quote's rate."},"children":[]}]}]}]},"quote":{"type":"string","format":"uuid","title":"Quote","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid currency quote id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UUID4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quote currency must match base currency."},"children":[]}]}]}]},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payout amount, in the DESTINATION (local) currency - INR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country=IND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", PKR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and so on."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" verbatim; do not recompute it. Note the naming trap: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is the SOURCE amount on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the DESTINATION amount here. The value is rounded to 2 decimal places and must fall"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inside the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" band, which is the only amount check performed - a value outside the band is a 400."},"children":[]}]}]}]},"bank_name":{"type":"string","title":"Bank Name","description":"Bank name where the beneficiary account is held."},"beneficiary_name":{"type":"string","maxLength":128,"title":"Beneficiary Name","description":"Full name of the beneficiary (name and surname)."},"beneficiary_city":{"type":"string","title":"Beneficiary City","description":"Beneficiary address (city)"},"beneficiary_address":{"type":"string","maxLength":70,"title":"Beneficiary Address","description":"Beneficiary address (street and number)"},"beneficiary_account_number":{"type":"string","title":"Beneficiary Account Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account id of the beneficiary. The same value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/validate_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"beneficiary_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Beneficiary Mobile","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary mobile number, validated as an Indian number and normalised to ITU E.164 ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+91"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix) before the order is stored."},"children":[]}]}]}]},"beneficiary_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Beneficiary Email","description":"If specified, must be a valid email address"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks","description":"Supplementary info and notes for tracking the transaction."},"sender_name":{"type":"string","title":"Sender Name","description":"Full name of Sender (name and surname)"},"sender_birthdate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Birthdate","description":"Sender birthdate"},"sender_identity_doc_exp":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Identity Doc Exp","description":"Expiry date for the sender identity document"},"sender_identity_doc_country":{"anyOf":[{"type":"string","maxLength":3,"minLength":3},{"type":"null"}],"title":"Sender Identity Doc Country","description":"Sender country (nationality) (ISO 3166-1 alpha-3 Country Code)"},"sender_city":{"type":"string","title":"Sender City","description":"Sender residency/address (city)"},"sender_address":{"type":"string","maxLength":70,"title":"Sender Address","description":"Sender residency/address (street and number)"},"sender_country":{"type":"string","maxLength":3,"minLength":3,"title":"Sender Country","description":"Sender residency/country (ISO 3166-1 alpha-3 Country Code)"},"sender_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Mobile","description":"Sender mobile number (ITU E.164 format)"},"sender_relation":{"$ref":"#/components/schemas/Relation","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the beneficiary is to the sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"father"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the beneficiary is the sender's father. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"own"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a transfer to the sender's own account."},"children":[]}]}]}]},"external_id":{"anyOf":[{"$ref":"#/components/schemas/ExternalIdStr"},{"type":"null"}]},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp of the order (will be filled in automatically server side)"},"beneficiary_account_type":{"$ref":"#/components/schemas/BankAccountType","description":"Bank account type","default":"savings"},"bank_branch_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Branch Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Branch name of the specified bank. OPTIONAL — omit it or send null. Passed through to providers that accept a branch name; the branch is identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank_branch_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (IFSC), not by this field."},"children":[]}]}]}]},"bank_branch_code":{"type":"string","title":"Bank Branch Code","description":"Bank branch code (e.g. for India it is equivalent to IFSC)"},"sender_identity_doc_type":{"$ref":"#/components/schemas/IdentityDocumentType","description":"Sender identity document type"},"sender_identity_doc":{"type":"string","title":"Sender Identity Doc","description":"Sender identity document number"}},"type":"object","required":["country","currency","quote","amount","bank_name","beneficiary_name","beneficiary_city","beneficiary_address","beneficiary_account_number","sender_name","sender_city","sender_address","sender_country","sender_relation","bank_branch_code","sender_identity_doc","sender_identity_doc_type"],"title":"IndiaPayment","examples":[{"amount":8488.79,"bank_branch_code":"HDFC0001234","bank_name":"HDFC Bank","beneficiary_account_number":"7823732431829188","beneficiary_account_type":"savings","beneficiary_address":"Linking Road","beneficiary_city":"Mumbai","beneficiary_email":"rkgupta@domain.com","beneficiary_mobile":"+918834907438","beneficiary_name":"Rakesh Gupta","country":"IND","currency":"USD","quote":"00000000-0000-4000-A000-000000000000","remarks":"test","sender_address":"Jumeirah Beach Road","sender_birthdate":"1970-01-01","sender_city":"Dubai","sender_country":"ARE","sender_identity_doc":"A987654","sender_identity_doc_country":"ARE","sender_identity_doc_exp":"2038-01-19","sender_identity_doc_type":"idcard","sender_mobile":"+9715850185684","sender_name":"Ahmed Ahmed","sender_relation":"other"}]}},"components/schemas/InternalServerError":{"id":"components/schemas/InternalServerError","kind":"json-schema","title":"InternalServerError","data":{"properties":{"detail":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Detail"}},"type":"object","title":"InternalServerError"}},"components/schemas/NepalPayment":{"id":"components/schemas/NepalPayment","kind":"json-schema","title":"NepalPayment","data":{"properties":{"country":{"type":"string","const":"NPL","title":"Country","description":"ISO 3166-1 alpha-3 Country Code"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source currency. Must be the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the quote in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the amount is converted to the local currency at that quote's rate."},"children":[]}]}]}]},"quote":{"type":"string","format":"uuid","title":"Quote","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid currency quote id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UUID4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quote currency must match base currency."},"children":[]}]}]}]},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payout amount, in the DESTINATION (local) currency - INR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country=IND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", PKR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and so on."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" verbatim; do not recompute it. Note the naming trap: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is the SOURCE amount on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the DESTINATION amount here. The value is rounded to 2 decimal places and must fall"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inside the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" band, which is the only amount check performed - a value outside the band is a 400."},"children":[]}]}]}]},"bank_name":{"type":"string","title":"Bank Name","description":"Bank name where the beneficiary account is held."},"beneficiary_name":{"type":"string","maxLength":128,"title":"Beneficiary Name","description":"Full name of the beneficiary (name and surname)."},"beneficiary_city":{"type":"string","title":"Beneficiary City","description":"Beneficiary address (city)"},"beneficiary_address":{"type":"string","maxLength":70,"title":"Beneficiary Address","description":"Beneficiary address (street and number)"},"beneficiary_account_number":{"type":"string","title":"Beneficiary Account Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account id of the beneficiary. The same value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/validate_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"beneficiary_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Beneficiary Mobile","description":"Beneficiary mobile number in ITU E.164 format: the destination country's calling-code prefix followed by the national number, with no spaces, hyphens or parentheses."},"beneficiary_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Beneficiary Email","description":"If specified, must be a valid email address"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks","description":"Supplementary info and notes for tracking the transaction."},"sender_name":{"type":"string","title":"Sender Name","description":"Full name of Sender (name and surname)"},"sender_birthdate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Birthdate","description":"Sender birthdate"},"sender_identity_doc_exp":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Identity Doc Exp","description":"Expiry date for the sender identity document"},"sender_identity_doc_country":{"anyOf":[{"type":"string","maxLength":3,"minLength":3},{"type":"null"}],"title":"Sender Identity Doc Country","description":"Sender country (nationality) (ISO 3166-1 alpha-3 Country Code)"},"sender_city":{"type":"string","title":"Sender City","description":"Sender residency/address (city)"},"sender_address":{"type":"string","maxLength":70,"title":"Sender Address","description":"Sender residency/address (street and number)"},"sender_country":{"type":"string","maxLength":3,"minLength":3,"title":"Sender Country","description":"Sender residency/country (ISO 3166-1 alpha-3 Country Code)"},"sender_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Mobile","description":"Sender mobile number (ITU E.164 format)"},"sender_relation":{"$ref":"#/components/schemas/Relation","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the beneficiary is to the sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"father"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the beneficiary is the sender's father. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"own"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a transfer to the sender's own account."},"children":[]}]}]}]},"external_id":{"anyOf":[{"$ref":"#/components/schemas/ExternalIdStr"},{"type":"null"}]},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp of the order (will be filled in automatically server side)"}},"type":"object","required":["country","currency","quote","amount","bank_name","beneficiary_name","beneficiary_city","beneficiary_address","beneficiary_account_number","sender_name","sender_city","sender_address","sender_country","sender_relation"],"title":"NepalPayment"}},"components/schemas/NigeriaPayment":{"id":"components/schemas/NigeriaPayment","kind":"json-schema","title":"NigeriaPayment","data":{"properties":{"country":{"type":"string","const":"NGA","title":"Country","description":"ISO 3166-1 alpha-3 Country Code"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source currency. Must be the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the quote in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the amount is converted to the local currency at that quote's rate."},"children":[]}]}]}]},"quote":{"type":"string","format":"uuid","title":"Quote","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid currency quote id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UUID4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quote currency must match base currency."},"children":[]}]}]}]},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payout amount, in the DESTINATION (local) currency - INR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country=IND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", PKR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and so on."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" verbatim; do not recompute it. Note the naming trap: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is the SOURCE amount on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the DESTINATION amount here. The value is rounded to 2 decimal places and must fall"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inside the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" band, which is the only amount check performed - a value outside the band is a 400."},"children":[]}]}]}]},"bank_name":{"type":"string","title":"Bank Name","description":"Bank name where the beneficiary account is held."},"beneficiary_name":{"type":"string","maxLength":128,"title":"Beneficiary Name","description":"Full name of the beneficiary (name and surname)."},"beneficiary_city":{"type":"string","title":"Beneficiary City","description":"Beneficiary address (city)"},"beneficiary_address":{"type":"string","maxLength":70,"title":"Beneficiary Address","description":"Beneficiary address (street and number)"},"beneficiary_account_number":{"type":"string","title":"Beneficiary Account Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account id of the beneficiary. The same value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/validate_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"beneficiary_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Beneficiary Mobile","description":"Beneficiary mobile number in ITU E.164 format: the destination country's calling-code prefix followed by the national number, with no spaces, hyphens or parentheses."},"beneficiary_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Beneficiary Email","description":"If specified, must be a valid email address"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks","description":"Supplementary info and notes for tracking the transaction."},"sender_name":{"type":"string","title":"Sender Name","description":"Full name of Sender (name and surname)"},"sender_birthdate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Birthdate","description":"Sender birthdate"},"sender_identity_doc_exp":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Identity Doc Exp","description":"Expiry date for the sender identity document"},"sender_identity_doc_country":{"anyOf":[{"type":"string","maxLength":3,"minLength":3},{"type":"null"}],"title":"Sender Identity Doc Country","description":"Sender country (nationality) (ISO 3166-1 alpha-3 Country Code)"},"sender_city":{"type":"string","title":"Sender City","description":"Sender residency/address (city)"},"sender_address":{"type":"string","maxLength":70,"title":"Sender Address","description":"Sender residency/address (street and number)"},"sender_country":{"type":"string","maxLength":3,"minLength":3,"title":"Sender Country","description":"Sender residency/country (ISO 3166-1 alpha-3 Country Code)"},"sender_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Mobile","description":"Sender mobile number (ITU E.164 format)"},"sender_relation":{"$ref":"#/components/schemas/Relation","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the beneficiary is to the sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"father"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the beneficiary is the sender's father. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"own"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a transfer to the sender's own account."},"children":[]}]}]}]},"external_id":{"anyOf":[{"$ref":"#/components/schemas/ExternalIdStr"},{"type":"null"}]},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp of the order (will be filled in automatically server side)"},"bank_code":{"type":"string","title":"Bank Code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NIBSS Instant Payment (NIP) bank code: the 6-digit NIBSS institution code of the beneficiary's bank (e.g. Access Bank "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"000014"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", GTBank "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"000013"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zenith Bank "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"000015"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"sender_identity_doc_type":{"$ref":"#/components/schemas/IdentityDocumentType","description":"Sender identity document type"},"sender_identity_doc":{"type":"string","title":"Sender Identity Doc","description":"Sender identity document number"}},"type":"object","required":["country","currency","quote","amount","bank_name","beneficiary_name","beneficiary_city","beneficiary_address","beneficiary_account_number","sender_name","sender_city","sender_address","sender_country","sender_relation","bank_code","sender_identity_doc_type","sender_identity_doc"],"title":"NigeriaPayment","examples":[{"amount":100,"bank_code":"000014","bank_name":"Access Bank","beneficiary_account_number":"0123456789","beneficiary_address":"Victoria Island","beneficiary_city":"Lagos","beneficiary_email":"chinedu.okeke@domain.com","beneficiary_mobile":"+2348012345678","beneficiary_name":"Chinedu Okeke","country":"NGA","currency":"AED","quote":"00000000-0000-4000-A000-000000000000","remarks":"test","sender_address":"Jumeirah Beach Road","sender_birthdate":"1970-01-01","sender_city":"Dubai","sender_country":"ARE","sender_identity_doc":"A987654","sender_identity_doc_country":"ARE","sender_identity_doc_exp":"2038-01-19","sender_identity_doc_type":"idcard","sender_mobile":"+9715850185684","sender_name":"Ahmed Ahmed","sender_relation":"other"}]}},"components/schemas/NotFoundError":{"id":"components/schemas/NotFoundError","kind":"json-schema","title":"NotFoundError","data":{"properties":{"detail":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Detail"}},"type":"object","title":"NotFoundError"}},"components/schemas/PakistanPayment":{"id":"components/schemas/PakistanPayment","kind":"json-schema","title":"PakistanPayment","data":{"properties":{"country":{"type":"string","const":"PAK","title":"Country","description":"ISO 3166-1 alpha-3 Country Code"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source currency. Must be the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the quote in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the amount is converted to the local currency at that quote's rate."},"children":[]}]}]}]},"quote":{"type":"string","format":"uuid","title":"Quote","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid currency quote id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UUID4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quote currency must match base currency."},"children":[]}]}]}]},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payout amount, in the DESTINATION (local) currency - INR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country=IND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", PKR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and so on."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" verbatim; do not recompute it. Note the naming trap: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is the SOURCE amount on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the DESTINATION amount here. The value is rounded to 2 decimal places and must fall"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inside the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" band, which is the only amount check performed - a value outside the band is a 400."},"children":[]}]}]}]},"bank_name":{"type":"string","title":"Bank Name","description":"Bank name where the beneficiary account is held."},"beneficiary_name":{"type":"string","maxLength":128,"title":"Beneficiary Name","description":"Full name of the beneficiary (name and surname)."},"beneficiary_city":{"type":"string","title":"Beneficiary City","description":"Beneficiary address (city)"},"beneficiary_address":{"type":"string","maxLength":70,"title":"Beneficiary Address","description":"Beneficiary address (street and number)"},"beneficiary_account_number":{"type":"string","title":"Beneficiary Account Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account id of the beneficiary. The same value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/validate_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"beneficiary_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Beneficiary Mobile","description":"Beneficiary mobile number in ITU E.164 format: the destination country's calling-code prefix followed by the national number, with no spaces, hyphens or parentheses."},"beneficiary_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Beneficiary Email","description":"If specified, must be a valid email address"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks","description":"Supplementary info and notes for tracking the transaction."},"sender_name":{"type":"string","title":"Sender Name","description":"Full name of Sender (name and surname)"},"sender_birthdate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Birthdate","description":"Sender birthdate"},"sender_identity_doc_exp":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Identity Doc Exp","description":"Expiry date for the sender identity document"},"sender_identity_doc_country":{"anyOf":[{"type":"string","maxLength":3,"minLength":3},{"type":"null"}],"title":"Sender Identity Doc Country","description":"Sender country (nationality) (ISO 3166-1 alpha-3 Country Code)"},"sender_city":{"type":"string","title":"Sender City","description":"Sender residency/address (city)"},"sender_address":{"type":"string","maxLength":70,"title":"Sender Address","description":"Sender residency/address (street and number)"},"sender_country":{"type":"string","maxLength":3,"minLength":3,"title":"Sender Country","description":"Sender residency/country (ISO 3166-1 alpha-3 Country Code)"},"sender_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Mobile","description":"Sender mobile number (ITU E.164 format)"},"sender_relation":{"$ref":"#/components/schemas/Relation","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the beneficiary is to the sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"father"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the beneficiary is the sender's father. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"own"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a transfer to the sender's own account."},"children":[]}]}]}]},"external_id":{"anyOf":[{"$ref":"#/components/schemas/ExternalIdStr"},{"type":"null"}]},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp of the order (will be filled in automatically server side)"},"beneficiary_account_type":{"$ref":"#/components/schemas/BankAccountType","description":"Bank account type","default":"savings"},"bank_code":{"type":"string","title":"Bank Code","description":"SWIFT / BIC code of the beneficiary bank, full or 8-character (e.g. ALFHPKKAXXX or ALFHPKKA), or the four characters an IBAN carries (e.g. ALFH)"},"sender_identity_doc_type":{"$ref":"#/components/schemas/IdentityDocumentType","description":"Sender identity document type"},"sender_identity_doc":{"type":"string","title":"Sender Identity Doc","description":"Sender identity document number"}},"type":"object","required":["country","currency","quote","amount","bank_name","beneficiary_name","beneficiary_city","beneficiary_address","beneficiary_account_number","sender_name","sender_city","sender_address","sender_country","sender_relation","bank_code","sender_identity_doc_type","sender_identity_doc"],"title":"PakistanPayment","examples":[{"amount":100,"bank_code":"ALFHPKKAXXX","bank_name":"Pakistan Bank","beneficiary_account_number":"PK12ABCD1234567891234567","beneficiary_account_type":"savings","beneficiary_address":"Main Road","beneficiary_city":"Karachi","beneficiary_email":"ahmad.khan@domain.com","beneficiary_mobile":"+923001234567","beneficiary_name":"Ahmad Khan","country":"PAK","currency":"AED","quote":"00000000-0000-4000-A000-000000000000","remarks":"test","sender_address":"Jumeirah Beach Road","sender_birthdate":"1970-01-01","sender_city":"Dubai","sender_country":"ARE","sender_identity_doc":"A987654","sender_identity_doc_country":"ARE","sender_identity_doc_exp":"2038-01-19","sender_identity_doc_type":"idcard","sender_mobile":"+9715850185684","sender_name":"Ahmed Ahmed","sender_relation":"other"}]}},"components/schemas/Payment":{"id":"components/schemas/Payment","kind":"json-schema","title":"Payment","data":{"oneOf":[{"$ref":"#/components/schemas/IndiaPayment"},{"$ref":"#/components/schemas/PakistanPayment"},{"$ref":"#/components/schemas/BangladeshPayment"},{"$ref":"#/components/schemas/PhilippinesPayment"},{"$ref":"#/components/schemas/NepalPayment"},{"$ref":"#/components/schemas/EgyptPayment"},{"$ref":"#/components/schemas/VietnamPayment"},{"$ref":"#/components/schemas/NigeriaPayment"}],"discriminator":{"propertyName":"country","mapping":{"BGD":"#/components/schemas/BangladeshPayment","EGY":"#/components/schemas/EgyptPayment","IND":"#/components/schemas/IndiaPayment","NGA":"#/components/schemas/NigeriaPayment","NPL":"#/components/schemas/NepalPayment","PAK":"#/components/schemas/PakistanPayment","PHL":"#/components/schemas/PhilippinesPayment","VNM":"#/components/schemas/VietnamPayment"}}}},"components/schemas/PaymentOrderInfoLive":{"id":"components/schemas/PaymentOrderInfoLive","kind":"json-schema","title":"PaymentOrderInfoLive","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"order":{"$ref":"#/components/schemas/Payment"},"response":{"anyOf":[{"$ref":"#/components/schemas/PaymentResponseLive"},{"type":"null"}]},"quote":{"$ref":"#/components/schemas/QuoteResponseV2"},"account":{"anyOf":[{"$ref":"#/components/schemas/ValidateBeneficiaryResponsePublic"},{"type":"null"}]}},"type":"object","required":["id","order","response","quote"],"title":"PaymentOrderInfoLive"}},"components/schemas/PaymentOrderState":{"id":"components/schemas/PaymentOrderState","kind":"json-schema","title":"PaymentOrderState","data":{"type":"string","enum":["queued","rejected","pending","processing","succeeded","failed","canceled","unknown","reversed"],"title":"PaymentOrderState"}},"components/schemas/PaymentResponseLive":{"id":"components/schemas/PaymentResponseLive","kind":"json-schema","title":"PaymentResponseLive","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment id, as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When this status was recorded (UTC)."},"status":{"$ref":"#/components/schemas/PaymentOrderState","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment state. Release funds to your customer only on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"msg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Msg","description":"Free-text processing message. Not a failure reason; do not parse it."},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout amount, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"amount_currency":{"anyOf":[{"$ref":"#/components/schemas/DestinationCurrency"},{"type":"null"}],"description":"Payout (destination) currency."},"base_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Base Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source amount from the quote, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"base_currency":{"anyOf":[{"$ref":"#/components/schemas/CurrencyCode"},{"type":"null"}],"description":"Source currency from the quote."},"wallet_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Wallet Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payout converted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wallet_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wallet_rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Premium and transaction cost are reported separately."},"children":[]}]}]}]},"wallet_currency":{"anyOf":[{"$ref":"#/components/schemas/StableCoin"},{"type":"string","const":"USD"},{"type":"null"}],"title":"Wallet Currency","description":"Your settlement wallet currency."},"wallet_premium":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Wallet Premium","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Premium charged, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wallet_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"wallet_txn_cost":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Wallet Txn Cost","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction cost charged, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wallet_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"bank_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Reference","description":"Bank or processor reference for the transfer, when available."}},"type":"object","required":["id","timestamp","status"],"title":"PaymentResponseLive","examples":[{"id":"00000000-0000-4000-A000-000000000000","msg":"OK","status":"queued","timestamp":"2024-12-01T01:02:03.000000Z"},{"id":"00000000-0000-4000-A000-000000000000","status":"processing","timestamp":"2024-12-01T01:02:03.000000Z"},{"amount":8488.79,"amount_currency":"INR","bank_reference":"412345678901","base_amount":100,"base_currency":"USD","id":"00000000-0000-4000-A000-000000000000","msg":"OK","status":"succeeded","timestamp":"2024-12-01T01:05:00.000000Z","wallet_amount":100,"wallet_currency":"USDT","wallet_premium":0.5,"wallet_txn_cost":1}]}},"components/schemas/PhilippinesPayment":{"id":"components/schemas/PhilippinesPayment","kind":"json-schema","title":"PhilippinesPayment","data":{"properties":{"country":{"type":"string","const":"PHL","title":"Country","description":"ISO 3166-1 alpha-3 Country Code"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source currency. Must be the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the quote in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the amount is converted to the local currency at that quote's rate."},"children":[]}]}]}]},"quote":{"type":"string","format":"uuid","title":"Quote","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid currency quote id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UUID4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quote currency must match base currency."},"children":[]}]}]}]},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payout amount, in the DESTINATION (local) currency - INR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country=IND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", PKR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and so on."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" verbatim; do not recompute it. Note the naming trap: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is the SOURCE amount on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the DESTINATION amount here. The value is rounded to 2 decimal places and must fall"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inside the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" band, which is the only amount check performed - a value outside the band is a 400."},"children":[]}]}]}]},"bank_name":{"type":"string","title":"Bank Name","description":"Bank name where the beneficiary account is held."},"beneficiary_name":{"type":"string","maxLength":128,"title":"Beneficiary Name","description":"Full name of the beneficiary (name and surname)."},"beneficiary_city":{"type":"string","title":"Beneficiary City","description":"Beneficiary address (city)"},"beneficiary_address":{"type":"string","maxLength":70,"title":"Beneficiary Address","description":"Beneficiary address (street and number)"},"beneficiary_account_number":{"type":"string","title":"Beneficiary Account Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account id of the beneficiary. The same value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/validate_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"beneficiary_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Beneficiary Mobile","description":"Beneficiary mobile number in ITU E.164 format: the destination country's calling-code prefix followed by the national number, with no spaces, hyphens or parentheses."},"beneficiary_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Beneficiary Email","description":"If specified, must be a valid email address"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks","description":"Supplementary info and notes for tracking the transaction."},"sender_name":{"type":"string","title":"Sender Name","description":"Full name of Sender (name and surname)"},"sender_birthdate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Birthdate","description":"Sender birthdate"},"sender_identity_doc_exp":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Identity Doc Exp","description":"Expiry date for the sender identity document"},"sender_identity_doc_country":{"anyOf":[{"type":"string","maxLength":3,"minLength":3},{"type":"null"}],"title":"Sender Identity Doc Country","description":"Sender country (nationality) (ISO 3166-1 alpha-3 Country Code)"},"sender_city":{"type":"string","title":"Sender City","description":"Sender residency/address (city)"},"sender_address":{"type":"string","maxLength":70,"title":"Sender Address","description":"Sender residency/address (street and number)"},"sender_country":{"type":"string","maxLength":3,"minLength":3,"title":"Sender Country","description":"Sender residency/country (ISO 3166-1 alpha-3 Country Code)"},"sender_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Mobile","description":"Sender mobile number (ITU E.164 format)"},"sender_relation":{"$ref":"#/components/schemas/Relation","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the beneficiary is to the sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"father"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the beneficiary is the sender's father. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"own"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a transfer to the sender's own account."},"children":[]}]}]}]},"external_id":{"anyOf":[{"$ref":"#/components/schemas/ExternalIdStr"},{"type":"null"}]},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp of the order (will be filled in automatically server side)"},"sender_identity_doc_type":{"$ref":"#/components/schemas/IdentityDocumentType","description":"Sender identity document type"},"sender_identity_doc":{"type":"string","title":"Sender Identity Doc","description":"Sender identity document number"}},"type":"object","required":["country","currency","quote","amount","bank_name","beneficiary_name","beneficiary_city","beneficiary_address","beneficiary_account_number","sender_name","sender_city","sender_address","sender_country","sender_relation","sender_identity_doc_type","sender_identity_doc"],"title":"PhilippinesPayment","examples":[{"amount":100,"bank_name":"Philippine Bank","beneficiary_account_number":"123456789012345","beneficiary_address":"Main Road","beneficiary_city":"Manila","beneficiary_email":"juan.delacruz@domain.com","beneficiary_mobile":"+639171234567","beneficiary_name":"Juan Dela Cruz","country":"PHL","currency":"AED","quote":"00000000-0000-4000-A000-000000000000","remarks":"test","sender_address":"Jumeirah Beach Road","sender_birthdate":"1970-01-01","sender_city":"Dubai","sender_country":"ARE","sender_identity_doc":"A987654","sender_identity_doc_country":"ARE","sender_identity_doc_exp":"2038-01-19","sender_identity_doc_type":"idcard","sender_mobile":"+9715850185684","sender_name":"Ahmed Ahmed","sender_relation":"other"}]}},"components/schemas/QuoteRequestDestination":{"id":"components/schemas/QuoteRequestDestination","kind":"json-schema","title":"QuoteRequestDestination","data":{"properties":{"country":{"$ref":"#/components/schemas/ApiCountry","description":"Destination country"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Source currency. Which currencies you can use depends on the exchange rates configured for your account and this corridor; a currency without a rate returns no quote."},"beneficiary_account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Beneficiary Account Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account id of the beneficiary. [OPTIONAL]"},"children":[]}]}]}]},"bank_branch_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Branch Code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank branch code of the beneficiary (e.g. IFSC for India) [OPTIONAL]"},"children":[]}]}]}]},"amount_destination":{"type":"number","exclusiveMinimum":0,"title":"Amount Destination","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount the beneficiary is to receive, in the DESTINATION country's local currency (e.g INR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country=IND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":");"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" remains the SOURCE currency you fund from. Rounded to 2 decimal places."},"children":[]}]}]}]}},"type":"object","required":["country","currency","amount_destination"],"title":"QuoteRequestDestination","description":"Quote request with destination amount"}},"components/schemas/Relation":{"id":"components/schemas/Relation","kind":"json-schema","title":"Relation","data":{"type":"string","enum":["aunt","brother","colleague","cousin","daughter","father","friend","husband","inlaws","mother","nephew","niece","other","own","self","sister","son","uncle","wife"],"title":"Relation","description":"What the beneficiary is to the sender.","x-enumDescriptions":{"inlaws":"The beneficiary is a relative by marriage.","other":"None of the listed relations.","own":"The beneficiary is the sender: a transfer to the sender's own account. Use this value.","self":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"own"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; accepted for compatibility."},"children":[]}]}]}]}}},"components/schemas/ReportPresignedUrlResponse":{"id":"components/schemas/ReportPresignedUrlResponse","kind":"json-schema","title":"ReportPresignedUrlResponse","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"url":{"type":"string","title":"Url"},"expires_in":{"type":"integer","title":"Expires In"}},"type":"object","required":["id","url","expires_in"],"title":"ReportPresignedUrlResponse"}},"components/schemas/ReportResponse":{"id":"components/schemas/ReportResponse","kind":"json-schema","title":"ReportResponse","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report id, for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/reports/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the presigned download URL."},"children":[]}]}]}]},"file_name":{"type":"string","title":"File Name","description":"Report file name."},"content_type":{"type":"string","title":"Content Type","description":"MIME type of the file."},"report_type":{"$ref":"#/components/schemas/ReportType","description":"Kind of report."},"file_status":{"$ref":"#/components/schemas/BatchJobItemStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generation status. The file can be downloaded once this is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"auto_generated":{"type":"boolean","title":"Auto Generated","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the scheduler created this report, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you requested it."},"children":[]}]}]}]},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the report was created (UTC)."},"params":{"anyOf":[{"$ref":"#/components/schemas/ClientPayoutReportParams"},{"type":"null"}],"title":"Params","description":"The filters the report was generated with."}},"type":"object","required":["id","file_name","content_type","report_type","file_status","auto_generated","created_at","params"],"title":"ReportResponse","description":"A generated report file.","examples":[{"auto_generated":false,"content_type":"text/csv","created_at":"2024-12-01T01:02:03.000000Z","file_name":"payout_IND_2024-12-01.csv","file_status":"success","id":"00000000-0000-4000-A000-000000000000","report_type":"payout"}]}},"components/schemas/ReportType":{"id":"components/schemas/ReportType","kind":"json-schema","title":"ReportType","data":{"type":"string","enum":["payout","statement","wallet","funding_history","pnl","reversed_payouts","agent_payout"],"title":"ReportType"}},"components/schemas/SearchType":{"id":"components/schemas/SearchType","kind":"json-schema","title":"SearchType","data":{"type":"string","enum":["id","external_id","linked_txn"],"title":"SearchType"}},"components/schemas/SortingOrder":{"id":"components/schemas/SortingOrder","kind":"json-schema","title":"SortingOrder","data":{"type":"string","enum":["asc","desc"],"title":"SortingOrder","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORDER BY direction with explicit nulls handling."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" => "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC NULLS LAST"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" => "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC NULLS LAST"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both place nulls at the end, which should be a sane default"},"children":[]}]}]}]}},"components/schemas/StableCoin":{"id":"components/schemas/StableCoin","kind":"json-schema","title":"StableCoin","data":{"type":"string","enum":["USDT","USDC","ETH"],"title":"StableCoin","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A coin a balance can be denominated in."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Despite the name, not every member is dollar-pegged. Payouts settle in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USDT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USDC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" today; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ETH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is accepted by the type but no provider"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settles in it."},"children":[]}]}]}]}},"components/schemas/TooManyRequestsError":{"id":"components/schemas/TooManyRequestsError","kind":"json-schema","title":"TooManyRequestsError","data":{"properties":{"detail":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Detail"}},"type":"object","title":"TooManyRequestsError"}},"components/schemas/UnauthorizedError":{"id":"components/schemas/UnauthorizedError","kind":"json-schema","title":"UnauthorizedError","data":{"properties":{"detail":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Detail"}},"type":"object","title":"UnauthorizedError"}},"components/schemas/UnprocessableError":{"id":"components/schemas/UnprocessableError","kind":"json-schema","title":"UnprocessableError","data":{"properties":{"detail":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Detail"}},"type":"object","title":"UnprocessableError"}},"components/schemas/ValidateBankRequest":{"id":"components/schemas/ValidateBankRequest","kind":"json-schema","title":"ValidateBankRequest","data":{"properties":{"country":{"$ref":"#/components/schemas/ApiCountry","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination country. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported."},"children":[]}]}]}]},"bank_branch_code":{"type":"string","title":"Bank Branch Code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IFSC code of the branch, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HDFC0002019"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"type":"object","required":["country","bank_branch_code"],"title":"ValidateBankRequest"}},"components/schemas/ValidateBankResponse":{"id":"components/schemas/ValidateBankResponse","kind":"json-schema","title":"ValidateBankResponse","data":{"properties":{"valid":{"type":"boolean","title":"Valid","description":"Whether the IFSC code exists."},"bank":{"type":"string","title":"Bank","description":"Bank name."},"code":{"type":"string","title":"Code","description":"Bank code."},"ifsc":{"type":"string","title":"Ifsc","description":"The IFSC code."},"micr":{"type":"string","title":"Micr","description":"MICR code of the branch."},"branch":{"type":"string","title":"Branch","description":"Branch name."},"city":{"type":"string","title":"City","description":"Branch city."},"district":{"type":"string","title":"District","description":"Branch district."},"state":{"type":"string","title":"State","description":"Branch state."},"address":{"type":"string","title":"Address","description":"Branch address."},"neft":{"type":"boolean","title":"Neft","description":"Whether the branch accepts NEFT."},"imps":{"type":"boolean","title":"Imps","description":"Whether the branch accepts IMPS."},"rtgs":{"type":"boolean","title":"Rtgs","description":"Whether the branch accepts RTGS."}},"type":"object","required":["valid","bank","code","ifsc","micr","branch","city","district","state","address","neft","imps","rtgs"],"title":"ValidateBankResponse"}},"components/schemas/ValidateBeneficiaryRequest":{"id":"components/schemas/ValidateBeneficiaryRequest","kind":"json-schema","title":"ValidateBeneficiaryRequest","data":{"properties":{"country":{"$ref":"#/components/schemas/ApiCountry","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination country. Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — account validation is available for India only, because it is the only corridor with the bank reference data the validation backends need. Any other value is a 400."},"children":[]}]}]}]},"account_number":{"type":"string","title":"Account Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account id of the beneficiary. The same value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beneficiary_account_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"bank_branch_code":{"type":"string","title":"Bank Branch Code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indian Financial System Code (IFSC) of the bank branch, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HDFC0001234"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"beneficiary_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Beneficiary Name","description":"Bank account holder name"}},"type":"object","required":["country","account_number","bank_branch_code"],"title":"ValidateBeneficiaryRequest"}},"components/schemas/ValidateBeneficiaryResponse":{"id":"components/schemas/ValidateBeneficiaryResponse","kind":"json-schema","title":"ValidateBeneficiaryResponse","data":{"properties":{"account_number":{"type":"string","title":"Account Number","description":"Bank account id of the beneficiary."},"bank_branch_code":{"type":"string","title":"Bank Branch Code","description":"Indian Financial System Code (IFSC) of the bank branch"},"status":{"$ref":"#/components/schemas/BankAccountStatus"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","required":["account_number","bank_branch_code","status"],"title":"ValidateBeneficiaryResponse"}},"components/schemas/ValidateBeneficiaryResponsePublic":{"id":"components/schemas/ValidateBeneficiaryResponsePublic","kind":"json-schema","title":"ValidateBeneficiaryResponsePublic","data":{"properties":{"status":{"$ref":"#/components/schemas/BankAccountStatus"}},"type":"object","required":["status"],"title":"ValidateBeneficiaryResponsePublic"}},"components/schemas/ValidationError":{"id":"components/schemas/ValidationError","kind":"json-schema","title":"ValidationError","data":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"components/schemas/VietnamPayment":{"id":"components/schemas/VietnamPayment","kind":"json-schema","title":"VietnamPayment","data":{"properties":{"country":{"type":"string","const":"VNM","title":"Country","description":"ISO 3166-1 alpha-3 Country Code"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source currency. Must be the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the quote in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the amount is converted to the local currency at that quote's rate."},"children":[]}]}]}]},"quote":{"type":"string","format":"uuid","title":"Quote","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid currency quote id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UUID4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quote currency must match base currency."},"children":[]}]}]}]},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payout amount, in the DESTINATION (local) currency - INR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country=IND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", PKR for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and so on."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" verbatim; do not recompute it. Note the naming trap: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is the SOURCE amount on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the DESTINATION amount here. The value is rounded to 2 decimal places and must fall"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inside the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" band, which is the only amount check performed - a value outside the band is a 400."},"children":[]}]}]}]},"bank_name":{"type":"string","title":"Bank Name","description":"Bank name where the beneficiary account is held."},"beneficiary_name":{"type":"string","maxLength":128,"title":"Beneficiary Name","description":"Full name of the beneficiary (name and surname)."},"beneficiary_city":{"type":"string","title":"Beneficiary City","description":"Beneficiary address (city)"},"beneficiary_address":{"type":"string","maxLength":70,"title":"Beneficiary Address","description":"Beneficiary address (street and number)"},"beneficiary_account_number":{"type":"string","title":"Beneficiary Account Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account id of the beneficiary. The same value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/validate_account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" takes as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"beneficiary_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Beneficiary Mobile","description":"Beneficiary mobile number in ITU E.164 format: the destination country's calling-code prefix followed by the national number, with no spaces, hyphens or parentheses."},"beneficiary_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Beneficiary Email","description":"If specified, must be a valid email address"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks","description":"Supplementary info and notes for tracking the transaction."},"sender_name":{"type":"string","title":"Sender Name","description":"Full name of Sender (name and surname)"},"sender_birthdate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Birthdate","description":"Sender birthdate"},"sender_identity_doc_exp":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Sender Identity Doc Exp","description":"Expiry date for the sender identity document"},"sender_identity_doc_country":{"anyOf":[{"type":"string","maxLength":3,"minLength":3},{"type":"null"}],"title":"Sender Identity Doc Country","description":"Sender country (nationality) (ISO 3166-1 alpha-3 Country Code)"},"sender_city":{"type":"string","title":"Sender City","description":"Sender residency/address (city)"},"sender_address":{"type":"string","maxLength":70,"title":"Sender Address","description":"Sender residency/address (street and number)"},"sender_country":{"type":"string","maxLength":3,"minLength":3,"title":"Sender Country","description":"Sender residency/country (ISO 3166-1 alpha-3 Country Code)"},"sender_mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Mobile","description":"Sender mobile number (ITU E.164 format)"},"sender_relation":{"$ref":"#/components/schemas/Relation","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the beneficiary is to the sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"father"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the beneficiary is the sender's father. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"own"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a transfer to the sender's own account."},"children":[]}]}]}]},"external_id":{"anyOf":[{"$ref":"#/components/schemas/ExternalIdStr"},{"type":"null"}]},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp of the order (will be filled in automatically server side)"},"sender_identity_doc_type":{"$ref":"#/components/schemas/IdentityDocumentType","description":"Sender identity document type"},"sender_identity_doc":{"type":"string","title":"Sender Identity Doc","description":"Sender identity document number"}},"type":"object","required":["country","currency","quote","amount","bank_name","beneficiary_name","beneficiary_city","beneficiary_address","beneficiary_account_number","sender_name","sender_city","sender_address","sender_country","sender_relation","sender_identity_doc_type","sender_identity_doc"],"title":"VietnamPayment","examples":[{"amount":100,"bank_name":"Vietcombank","beneficiary_account_number":"0123456789012345","beneficiary_address":"District 1","beneficiary_city":"Ho Chi Minh City","beneficiary_email":"nguyenvanan@domain.com","beneficiary_mobile":"+84901234567","beneficiary_name":"Nguyen Van An","country":"VNM","currency":"AED","quote":"00000000-0000-4000-A000-000000000000","remarks":"test","sender_address":"Jumeirah Beach Road","sender_birthdate":"1970-01-01","sender_city":"Dubai","sender_country":"ARE","sender_identity_doc":"A987654","sender_identity_doc_country":"ARE","sender_identity_doc_exp":"2038-01-19","sender_identity_doc_type":"idcard","sender_mobile":"+9715850185684","sender_name":"Ahmed Ahmed","sender_relation":"other"}]}},"components/schemas/QuoteResponseV2":{"id":"components/schemas/QuoteResponseV2","kind":"json-schema","title":"QuoteResponse","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quote id. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a quote can back one payment only."},"children":[]}]}]}]},"country":{"$ref":"#/components/schemas/ApiCountry","description":"Destination country."},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source currency, the one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in."},"children":[]}]}]}]},"amount":{"type":"number","title":"Amount","description":"What you pay, in the source currency."},"amount_destination":{"type":"number","title":"Amount Destination","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the beneficiary receives, in the destination currency. Send it verbatim as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"rate":{"type":"number","title":"Rate","description":"Exchange rate from the source currency to the destination currency. This is the rate your customer sees."},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When the quote was issued (UTC)."},"expires":{"type":"string","format":"date-time","title":"Expires","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the quote stops being usable (UTC), currently 15 minutes after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Read this value rather than hard-coding the window."},"children":[]}]}]}]},"wallet_rate":{"type":"number","title":"Wallet Rate","description":"Exchange rate from your settlement wallet currency to the destination currency. For settlement only: do not show it to your customer or use it to compute a payout."},"min_amount_destination":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Amount Destination","description":"Smallest payout your account may send on this corridor, in the destination currency. Set per account, so read it from every quote rather than caching it."},"max_amount_destination":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Amount Destination","description":"Largest payout your account may send on this corridor, in the destination currency. Set per account, so read it from every quote rather than caching it."}},"type":"object","required":["id","country","currency","amount","amount_destination","rate","timestamp","expires","wallet_rate"],"title":"QuoteResponse","examples":[{"amount":100,"amount_destination":8488.79,"country":"IND","currency":"USD","expires":"2024-12-01T01:17:03.000000Z","id":"00000000-0000-4000-A000-000000000000","max_amount_destination":100000,"min_amount_destination":100,"rate":84.887912,"timestamp":"2024-12-01T01:02:03.000000Z","wallet_rate":84.887912}]}},"components/schemas/QuoteRequestV2":{"id":"components/schemas/QuoteRequestV2","kind":"json-schema","title":"QuoteRequest","data":{"properties":{"country":{"$ref":"#/components/schemas/ApiCountry","description":"Destination country"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Source currency. Which currencies you can use depends on the exchange rates configured for your account and this corridor; a currency without a rate returns no quote."},"beneficiary_account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Beneficiary Account Number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account id of the beneficiary. [OPTIONAL]"},"children":[]}]}]}]},"bank_branch_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Branch Code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank branch code of the beneficiary (e.g. IFSC for India) [OPTIONAL]"},"children":[]}]}]}]},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount to convert, in the SOURCE currency - the one named in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. AED, USD), not the destination country's."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rounded to 4 decimal places."},"children":[]}]}]}]}},"type":"object","required":["country","currency","amount"],"title":"QuoteRequest"}},"components/schemas/AccountValidationRequest":{"id":"components/schemas/AccountValidationRequest","kind":"json-schema","title":"AccountValidationRequest","data":{"properties":{"country":{"$ref":"#/components/schemas/ApiCountry","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination country. Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — account validation is available for India only, because it is the only corridor with the bank reference data the validation backends need. Any other value is a 400."},"children":[]}]}]}]},"payment_type":{"$ref":"#/components/schemas/PaymentType","description":"Payment type the beneficiary will be paid out under; picks the provider route the validation runs on","default":"C2C"},"account_number":{"type":"string","title":"Account Number","description":"Bank account id of the beneficiary"},"branch_code":{"type":"string","title":"Branch Code","description":"Bank branch code (IFSC code for India)"},"beneficiary_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Beneficiary Name","description":"Bank account holder name, when known"}},"type":"object","required":["country","account_number","branch_code"],"title":"AccountValidationRequest","examples":[{"account_number":"99345724439934","beneficiary_name":"Nikhil Sharma","branch_code":"FDRL0001883","country":"IND","payment_type":"C2C"}]}},"components/schemas/AccountValidationResponse":{"id":"components/schemas/AccountValidationResponse","kind":"json-schema","title":"AccountValidationResponse","data":{"properties":{"country":{"$ref":"#/components/schemas/ApiCountry","description":"Destination country"},"account_number":{"type":"string","title":"Account Number","description":"Bank account id of the beneficiary"},"branch_code":{"type":"string","title":"Branch Code","description":"Bank branch code (IFSC code for India)"},"status":{"$ref":"#/components/schemas/BankAccountStatus","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account status as reported by the validation backend. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the backend has queued the check and the account should be validated again later"},"children":[]}]}]}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Account holder name reported by the backend"}},"type":"object","required":["country","account_number","branch_code","status"],"title":"AccountValidationResponse","examples":[{"account_number":"99345724439934","branch_code":"FDRL0001883","country":"IND","name":"Nikhil Sharma","status":"valid"}]}},"components/schemas/BalanceInfo":{"id":"components/schemas/BalanceInfo","kind":"json-schema","title":"BalanceInfo","data":{"properties":{"currency":{"type":"string","title":"Currency","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The corridor's local currency; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reserved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are in it."},"children":[]}]}]}]},"available":{"type":"number","title":"Available","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What you can pay out now, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Already net of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reserved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and of any deal hold."},"children":[]}]}]}]},"reserved":{"type":"number","title":"Reserved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Held by payments still in progress, on either API version, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":0},"total":{"type":"number","title":"Total","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reserved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus the amount held for active deals, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"wallet":{"$ref":"#/components/schemas/WalletBalanceInfo","description":"The same position in your wallet currency."},"deals":{"anyOf":[{"$ref":"#/components/schemas/DealBalanceInfo"},{"type":"null"}],"description":"Your rate-lock deal position for this corridor, in the wallet currency. Absent when you have no active deals."}},"type":"object","required":["currency","available","total","wallet"],"title":"BalanceInfo"}},"components/schemas/BankInfo":{"id":"components/schemas/BankInfo","kind":"json-schema","title":"BankInfo","data":{"properties":{"swift_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Swift Code"},"iban_code":{"type":"string","title":"Iban Code"},"bank_name":{"type":"string","title":"Bank Name"},"segment":{"$ref":"#/components/schemas/BankSegment"}},"type":"object","required":["iban_code","bank_name","segment"],"title":"BankInfo"}},"components/schemas/BankList":{"id":"components/schemas/BankList","kind":"json-schema","title":"BankList","data":{"properties":{"country":{"$ref":"#/components/schemas/ApiCountry"},"banks":{"items":{"$ref":"#/components/schemas/BankInfo"},"type":"array","title":"Banks"}},"type":"object","required":["country","banks"],"title":"BankList"}},"components/schemas/BankSegment":{"id":"components/schemas/BankSegment","kind":"json-schema","title":"BankSegment","data":{"type":"string","enum":["bank","m_wallet","other"],"title":"BankSegment","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank_codes_pak"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry is on the local rails. Keys a registry"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"both generations read, so it lives here; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"app.models.v3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" re-exports it."},"children":[]}]}]}]}},"components/schemas/BeneficiaryX2B":{"id":"components/schemas/BeneficiaryX2B","kind":"json-schema","title":"Beneficiary[X2B,PaymentCountry,PaymentMethod]","data":{"properties":{"name":{"type":"string","title":"Name"},"address":{"type":"string","title":"Address"},"country":{"$ref":"#/components/schemas/CountryAlpha3"}},"type":"object","required":["name","address","country"],"title":"Beneficiary[X2B,PaymentCountry,PaymentMethod]"}},"components/schemas/BeneficiaryX2C":{"id":"components/schemas/BeneficiaryX2C","kind":"json-schema","title":"Beneficiary[X2C,PaymentCountry,PaymentMethod]","data":{"properties":{"first_name":{"$ref":"#/components/schemas/PersonName","description":"Beneficiary first name"},"last_name":{"$ref":"#/components/schemas/PersonName","description":"Beneficiary last name (surname)"},"city":{"type":"string","title":"City","description":"Beneficiary address (city)"},"address":{"type":"string","maxLength":70,"title":"Address","description":"Beneficiary address (street and number)"},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile","description":"Beneficiary mobile number (ITU E.164 format with country code prefix)"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email","description":"Beneficiary email address"}},"type":"object","required":["first_name","last_name","city","address"],"title":"Beneficiary[X2C,PaymentCountry,PaymentMethod]"}},"components/schemas/CountryAlpha3":{"id":"components/schemas/CountryAlpha3","kind":"json-schema","title":"CountryAlpha3","data":{"type":"string","maxLength":3,"minLength":3}},"components/schemas/LedgerDataPublicFilterBy":{"id":"components/schemas/LedgerDataPublicFilterBy","kind":"json-schema","title":"LedgerDataPublicFilterBy","data":{"properties":{"api_country":{"$ref":"#/components/schemas/ApiCountry"},"operation":{"anyOf":[{"$ref":"#/components/schemas/LedgerOperation"},{"type":"null"}]},"txn":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Txn"},"timestamp":{"anyOf":[{"items":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"type":"array"},{"type":"null"}],"title":"Timestamp"}},"type":"object","required":["api_country"],"title":"LedgerDataPublicFilterBy"}},"components/schemas/LedgerOperation":{"id":"components/schemas/LedgerOperation","kind":"json-schema","title":"LedgerOperation","data":{"type":"string","enum":["add","deduct","reverse"],"title":"LedgerOperation"}},"components/schemas/PaymentB2BIndia":{"id":"components/schemas/PaymentB2BIndia","kind":"json-schema","title":"Payment[B2B,India,BankTransfer]","data":{"properties":{"external_id":{"anyOf":[{"$ref":"#/components/schemas/ExternalIdStr"},{"type":"null"}]},"payment_type":{"type":"string","const":"B2B","title":"Payment Type"},"payment_country":{"type":"string","const":"IND","title":"Payment Country"},"payment_method":{"type":"string","const":"bank_transfer","title":"Payment Method"},"payment_details":{"$ref":"#/components/schemas/PaymentDetailsB2BIndiaBankTransfer"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Source currency (the currency will be automatically converted to local currency using the provided quote)"},"quote":{"type":"string","format":"uuid","title":"Quote","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid currency quote id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UUID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v3/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quote currency must match base currency."},"children":[]}]}]}]},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payout amount, in the destination (local) currency. Send the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" verbatim; do not recompute it from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must fall inside the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limits.min_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limits.max_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" band."},"children":[]}]}]}]},"sender":{"anyOf":[{"$ref":"#/components/schemas/SenderB2X"},{"$ref":"#/components/schemas/SenderC2X"}],"title":"Sender","description":"Sender details"},"beneficiary":{"anyOf":[{"$ref":"#/components/schemas/BeneficiaryX2B"},{"$ref":"#/components/schemas/BeneficiaryX2C"}],"title":"Beneficiary","description":"Beneficiary details"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks","description":"Supplementary note"},"payment_currency":{"anyOf":[{"$ref":"#/components/schemas/DestinationCurrency"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination currency. Informational -- it is fixed by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and is rejected if it disagrees. Filled in from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted."},"children":[]}]}]}]}},"type":"object","required":["payment_type","payment_country","payment_method","payment_details","currency","quote","amount","sender","beneficiary"],"title":"Payment[B2B,India,BankTransfer]"}},"components/schemas/PaymentB2CIndia":{"id":"components/schemas/PaymentB2CIndia","kind":"json-schema","title":"Payment[B2C,India,BankTransfer]","data":{"properties":{"external_id":{"anyOf":[{"$ref":"#/components/schemas/ExternalIdStr"},{"type":"null"}]},"payment_type":{"type":"string","const":"B2C","title":"Payment Type"},"payment_country":{"type":"string","const":"IND","title":"Payment Country"},"payment_method":{"type":"string","const":"bank_transfer","title":"Payment Method"},"payment_details":{"$ref":"#/components/schemas/PaymentDetailsB2CIndiaBankTransfer"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Source currency (the currency will be automatically converted to local currency using the provided quote)"},"quote":{"type":"string","format":"uuid","title":"Quote","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid currency quote id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UUID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v3/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quote currency must match base currency."},"children":[]}]}]}]},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payout amount, in the destination (local) currency. Send the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" verbatim; do not recompute it from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must fall inside the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limits.min_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limits.max_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" band."},"children":[]}]}]}]},"sender":{"anyOf":[{"$ref":"#/components/schemas/SenderB2X"},{"$ref":"#/components/schemas/SenderC2X"}],"title":"Sender","description":"Sender details"},"beneficiary":{"anyOf":[{"$ref":"#/components/schemas/BeneficiaryX2B"},{"$ref":"#/components/schemas/BeneficiaryX2C"}],"title":"Beneficiary","description":"Beneficiary details"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks","description":"Supplementary note"},"payment_currency":{"anyOf":[{"$ref":"#/components/schemas/DestinationCurrency"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination currency. Informational -- it is fixed by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and is rejected if it disagrees. Filled in from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted."},"children":[]}]}]}]}},"type":"object","required":["payment_type","payment_country","payment_method","payment_details","currency","quote","amount","sender","beneficiary"],"title":"Payment[B2C,India,BankTransfer]"}},"components/schemas/PaymentC2BIndia":{"id":"components/schemas/PaymentC2BIndia","kind":"json-schema","title":"Payment[C2B,India,BankTransfer]","data":{"properties":{"external_id":{"anyOf":[{"$ref":"#/components/schemas/ExternalIdStr"},{"type":"null"}]},"payment_type":{"type":"string","const":"C2B","title":"Payment Type"},"payment_country":{"type":"string","const":"IND","title":"Payment Country"},"payment_method":{"type":"string","const":"bank_transfer","title":"Payment Method"},"payment_details":{"$ref":"#/components/schemas/PaymentDetailsC2BIndiaBankTransfer"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Source currency (the currency will be automatically converted to local currency using the provided quote)"},"quote":{"type":"string","format":"uuid","title":"Quote","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid currency quote id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UUID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v3/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quote currency must match base currency."},"children":[]}]}]}]},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payout amount, in the destination (local) currency. Send the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" verbatim; do not recompute it from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must fall inside the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limits.min_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limits.max_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" band."},"children":[]}]}]}]},"sender":{"anyOf":[{"$ref":"#/components/schemas/SenderB2X"},{"$ref":"#/components/schemas/SenderC2X"}],"title":"Sender","description":"Sender details"},"beneficiary":{"anyOf":[{"$ref":"#/components/schemas/BeneficiaryX2B"},{"$ref":"#/components/schemas/BeneficiaryX2C"}],"title":"Beneficiary","description":"Beneficiary details"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks","description":"Supplementary note"},"payment_currency":{"anyOf":[{"$ref":"#/components/schemas/DestinationCurrency"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination currency. Informational -- it is fixed by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and is rejected if it disagrees. Filled in from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted."},"children":[]}]}]}]}},"type":"object","required":["payment_type","payment_country","payment_method","payment_details","currency","quote","amount","sender","beneficiary"],"title":"Payment[C2B,India,BankTransfer]"}},"components/schemas/PaymentDetailsB2BIndiaBankTransfer":{"id":"components/schemas/PaymentDetailsB2BIndiaBankTransfer","kind":"json-schema","title":"PaymentDetailsB2BIndiaBankTransfer","data":{"properties":{},"type":"object","title":"PaymentDetailsB2BIndiaBankTransfer"}},"components/schemas/PaymentDetailsB2CIndiaBankTransfer":{"id":"components/schemas/PaymentDetailsB2CIndiaBankTransfer","kind":"json-schema","title":"PaymentDetailsB2CIndiaBankTransfer","data":{"properties":{},"type":"object","title":"PaymentDetailsB2CIndiaBankTransfer"}},"components/schemas/PaymentDetailsC2BIndiaBankTransfer":{"id":"components/schemas/PaymentDetailsC2BIndiaBankTransfer","kind":"json-schema","title":"PaymentDetailsC2BIndiaBankTransfer","data":{"properties":{},"type":"object","title":"PaymentDetailsC2BIndiaBankTransfer"}},"components/schemas/PaymentDetailsC2CIndiaBankTransfer":{"id":"components/schemas/PaymentDetailsC2CIndiaBankTransfer","kind":"json-schema","title":"PaymentDetailsC2CIndiaBankTransfer","data":{"properties":{"bank_name":{"type":"string","title":"Bank Name","description":"Bank name where the beneficiary account is held"},"branch_code":{"type":"string","title":"Branch Code","description":"Bank branch code (IFSC code)"},"account_number":{"type":"string","title":"Account Number","description":"Bank account id of the beneficiary"},"branch_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Branch Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Branch name of the specified bank. OPTIONAL — omit it or send null. Passed through to providers that accept a branch name; the branch is identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"branch_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (IFSC), not by this field."},"children":[]}]}]}]}},"type":"object","required":["bank_name","branch_code","account_number"],"title":"PaymentDetailsC2CIndiaBankTransfer"}},"components/schemas/PaymentDetailsC2CIndiaInstantPayment":{"id":"components/schemas/PaymentDetailsC2CIndiaInstantPayment","kind":"json-schema","title":"PaymentDetailsC2CIndiaInstantPayment","data":{"properties":{"virtual_payment_address":{"type":"string","title":"Virtual Payment Address","description":"UPI virtual payment address of the beneficiary."}},"type":"object","required":["virtual_payment_address"],"title":"PaymentDetailsC2CIndiaInstantPayment"}},"components/schemas/PaymentDetailsC2CNigeriaBankTransfer":{"id":"components/schemas/PaymentDetailsC2CNigeriaBankTransfer","kind":"json-schema","title":"PaymentDetailsC2CNigeriaBankTransfer","data":{"properties":{"bank_name":{"type":"string","title":"Bank Name","description":"Bank name where the beneficiary account is held"},"bank_code":{"type":"string","title":"Bank Code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NIBSS Instant Payment (NIP) bank code: the 6-digit NIBSS institution code of the beneficiary's bank (e.g. Access Bank "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"000014"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", GTBank "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"000013"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Zenith Bank "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"000015"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"account_number":{"type":"string","title":"Account Number","description":"Bank account id of the beneficiary"}},"type":"object","required":["bank_name","bank_code","account_number"],"title":"PaymentDetailsC2CNigeriaBankTransfer"}},"components/schemas/PaymentDetailsC2CPakistanBankTransfer":{"id":"components/schemas/PaymentDetailsC2CPakistanBankTransfer","kind":"json-schema","title":"PaymentDetailsC2CPakistanBankTransfer","data":{"properties":{"bank_name":{"type":"string","title":"Bank Name","description":"Bank name where the beneficiary account is held"},"bank_code":{"type":"string","title":"Bank Code","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SWIFT/BIC code of the beneficiary bank, full or 8-character (e.g. ABPAPKKA443 or ABPAPKKA), or the four characters an IBAN carries (e.g. ABPA). Listed by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v3/info/payment_banks?country=PAK"},"children":[]}]}]}]},"account_number":{"type":"string","title":"Account Number","description":"Bank account id of the beneficiary"}},"type":"object","required":["bank_name","bank_code","account_number"],"title":"PaymentDetailsC2CPakistanBankTransfer"}},"components/schemas/PaymentExchangeInfo":{"id":"components/schemas/PaymentExchangeInfo","kind":"json-schema","title":"PaymentExchangeInfo","data":{"properties":{"amount":{"type":"number","title":"Amount","description":"Source currency amount"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Source currency"}},"type":"object","required":["amount","currency"],"title":"PaymentExchangeInfo"}},"components/schemas/PaymentInfo":{"id":"components/schemas/PaymentInfo","kind":"json-schema","title":"PaymentInfo","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Payment id."},"quote":{"$ref":"#/components/schemas/QuoteResponse","description":"The quote this payment was made against."},"order":{"$ref":"#/components/schemas/PaymentOrder","description":"The payment as you submitted it."},"response":{"$ref":"#/components/schemas/PaymentResponse","description":"Current status and processing result."},"account":{"anyOf":[{"$ref":"#/components/schemas/ValidateBeneficiaryResponsePublic"},{"type":"null"}],"description":"Beneficiary account validation result, when validation ran."}},"type":"object","required":["id","quote","order","response"],"title":"PaymentInfo"}},"components/schemas/PaymentMethod":{"id":"components/schemas/PaymentMethod","kind":"json-schema","title":"PaymentMethod","data":{"type":"string","enum":["bank_transfer","cash_pickup","mobile_wallet","instant_payment"],"title":"PaymentMethod","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rail a payment travels on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keys "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing_flat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_access"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the v3 payment models, so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it is defined here rather than in v3 -- this module cannot import that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"app.models.v3.common"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" re-exports it."},"children":[]}]}]}]}},"components/schemas/PaymentResponse":{"id":"components/schemas/PaymentResponse","kind":"json-schema","title":"PaymentResponse","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"status":{"$ref":"#/components/schemas/PaymentOrderState"},"msg":{"type":"string","title":"Msg","description":"Status info message"},"quote":{"type":"string","format":"uuid","title":"Quote"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount","description":"The amount in destination currency"},"currency":{"anyOf":[{"$ref":"#/components/schemas/DestinationCurrency"},{"type":"null"}]},"exchange_info":{"anyOf":[{"$ref":"#/components/schemas/PaymentExchangeInfo"},{"type":"null"}]},"wallet_info":{"anyOf":[{"$ref":"#/components/schemas/PaymentWalletInfo"},{"type":"null"}]},"payment_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Reference","description":"Payment reference (e.g. UTR for bank transfers in India)"}},"type":"object","required":["id","timestamp","status","msg","quote"],"title":"PaymentResponse"}},"components/schemas/PaymentType":{"id":"components/schemas/PaymentType","kind":"json-schema","title":"PaymentType","data":{"type":"string","enum":["B2B","B2C","C2B","C2C"],"title":"PaymentType","description":"Who is paying whom: consumer or business, either side."}},"components/schemas/PaymentWalletInfo":{"id":"components/schemas/PaymentWalletInfo","kind":"json-schema","title":"PaymentWalletInfo","data":{"properties":{"amount":{"type":"number","title":"Amount","description":"Wallet currency amount"},"rate":{"type":"number","title":"Rate","description":"Wallet currency rate"},"currency":{"$ref":"#/components/schemas/WalletCurrency","description":"Wallet currency"},"premium":{"type":"number","title":"Premium","description":"Premium in wallet currency"},"txn_cost":{"type":"number","title":"Txn Cost","description":"Per transaction cost in wallet currency"},"fx":{"type":"number","title":"Fx","description":"FX spread in wallet currency","default":0}},"type":"object","required":["amount","rate","currency","premium","txn_cost"],"title":"PaymentWalletInfo"}},"components/schemas/PayoutReportFilter":{"id":"components/schemas/PayoutReportFilter","kind":"json-schema","title":"PayoutReportFilter","data":{"properties":{"start":{"type":"string","format":"date-time","title":"Start","description":"Start of the window, on order creation"},"end":{"type":"string","format":"date-time","title":"End","description":"End of the window, exclusive"},"country":{"$ref":"#/components/schemas/ApiCountry","description":"Payment country"},"status":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentOrderState"},"type":"array","maxItems":9},{"type":"null"}],"title":"Status","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter on the effective status — the one the report reports, overrides applied"},"children":[]}]}]}]},"external":{"type":"boolean","title":"External","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values from the original payment requests rather than LeanX ids"},"children":[]}]}]}],"default":false},"ids":{"anyOf":[{"items":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}]},"type":"array","maxItems":10000},{"type":"null"}],"title":"Ids","description":"Only report these payments. An id that matches nothing still gets a row, carrying just the id."},"sorting_order":{"$ref":"#/components/schemas/SortingOrder","default":"desc"}},"type":"object","required":["start","end","country"],"title":"PayoutReportFilter","description":"Payout report parameters available to API clients."}},"components/schemas/PersonName":{"id":"components/schemas/PersonName","kind":"json-schema","title":"PersonName","data":{"type":"string","maxLength":64}},"components/schemas/Problem":{"id":"components/schemas/Problem","kind":"json-schema","title":"Problem","data":{"properties":{"type":{"type":"string","title":"Type"},"title":{"type":"string","title":"Title"},"status":{"type":"integer","title":"Status"},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail"},"instance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance"}},"type":"object","required":["type","title","status"],"title":"Problem","description":"An RFC 9457 problem detail object."}},"components/schemas/ProblemError":{"id":"components/schemas/ProblemError","kind":"json-schema","title":"ProblemError","data":{"properties":{"detail":{"type":"string","title":"Detail"},"pointer":{"type":"string","title":"Pointer"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"input":{"title":"Input"}},"type":"object","required":["detail","pointer"],"title":"ProblemError"}},"components/schemas/QuoteAmountType":{"id":"components/schemas/QuoteAmountType","kind":"json-schema","title":"QuoteAmountType","data":{"type":"string","enum":["destination","source"],"title":"QuoteAmountType"}},"components/schemas/QuoteLimits":{"id":"components/schemas/QuoteLimits","kind":"json-schema","title":"QuoteLimits","data":{"properties":{"expires":{"type":"string","format":"date-time","title":"Expires","description":"Quote expiration timestamp (in the future)"},"min_amount_destination":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Amount Destination","description":"Minimum payment amount for this quote"},"max_amount_destination":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Amount Destination","description":"Maximum payment amount for this quote"}},"type":"object","required":["expires","min_amount_destination","max_amount_destination"],"title":"QuoteLimits"}},"components/schemas/QuoteRequest":{"id":"components/schemas/QuoteRequest","kind":"json-schema","title":"QuoteRequest","data":{"properties":{"country":{"$ref":"#/components/schemas/ApiCountry","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination country. Also accepted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the name "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v3/payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses for the same value."},"children":[]}]}]}]},"payment_currency":{"anyOf":[{"$ref":"#/components/schemas/DestinationCurrency"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination currency. Informational — it is fixed by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and is rejected if it disagrees. Filled in from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted."},"children":[]}]}]}]},"payment_type":{"$ref":"#/components/schemas/PaymentType","description":"Payment type for the quote"},"payment_method":{"$ref":"#/components/schemas/PaymentMethod","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method/rail for the quote. Not every country/payment_type/payment_method combination has a payment variant — see the table on this operation for the supported set."},"children":[]}]}]}]},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Source currency. Which currencies you can use depends on the exchange rates configured for your account and this corridor; a currency without a rate returns no quote."},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":"Valid amount in source or destination currency"},"amount_type":{"$ref":"#/components/schemas/QuoteAmountType","default":"source"},"deal":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deal","description":"Price this quote against an active deal instead of the live rate. The deal must cover this country, payment type and payment method, and must have room for the amount."}},"type":"object","required":["country","payment_type","payment_method","currency","amount"],"title":"QuoteRequest","examples":[{"amount":100,"amount_type":"source","country":"IND","currency":"USD","payment_method":"bank_transfer","payment_type":"C2C"},{"amount":8488.79,"amount_type":"destination","country":"IND","currency":"USD","payment_method":"bank_transfer","payment_type":"C2C"},{"amount":100,"amount_type":"source","country":"IND","currency":"USD","payment_method":"instant_payment","payment_type":"C2C"}]}},"components/schemas/QuoteResponse":{"id":"components/schemas/QuoteResponse","kind":"json-schema","title":"QuoteResponse","data":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","default":"Quote ID"},"country":{"$ref":"#/components/schemas/ApiCountry","description":"Destination country"},"payment_type":{"$ref":"#/components/schemas/PaymentType","description":"Payment type for the quote"},"payment_method":{"$ref":"#/components/schemas/PaymentMethod","description":"Payment method/rail for the quote"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Source currency"},"amount_source":{"type":"number","exclusiveMinimum":0,"title":"Amount Source","description":"Amount in the source currency"},"amount_destination":{"type":"number","exclusiveMinimum":0,"title":"Amount Destination","description":"Amount in the destination currency"},"rate":{"type":"number","title":"Rate","description":"Currency rate"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Quote creation timestamp"},"limits":{"$ref":"#/components/schemas/QuoteLimits","default":"Quote limits"},"wallet_info":{"$ref":"#/components/schemas/QuoteWalletInfo","description":""}},"type":"object","required":["country","payment_type","payment_method","currency","amount_source","amount_destination","rate","timestamp","wallet_info"],"title":"QuoteResponse","examples":[{"amount_destination":8488.79,"amount_source":100,"country":"IND","currency":"USD","id":"00000000-0000-7000-8000-000000000000","limits":{"expires":"2024-12-01T01:17:03.000000Z","max_amount_destination":100000,"min_amount_destination":100},"payment_method":"bank_transfer","rate":84.887912,"timestamp":"2024-12-01T01:02:03.000000Z","wallet_info":{"currency":"USDT","rate":84.887912}},{"amount_destination":8488.79,"amount_source":100,"country":"IND","currency":"USD","id":"00000000-0000-7000-8000-000000000000","limits":{"expires":"2024-12-01T01:17:03.000000Z","max_amount_destination":100000,"min_amount_destination":100},"payment_method":"instant_payment","rate":84.887912,"timestamp":"2024-12-01T01:02:03.000000Z","wallet_info":{"currency":"USDT","rate":84.887912}}]}},"components/schemas/QuoteWalletInfo":{"id":"components/schemas/QuoteWalletInfo","kind":"json-schema","title":"QuoteWalletInfo","data":{"properties":{"currency":{"$ref":"#/components/schemas/WalletCurrency","description":"Active wallet currency"},"rate":{"type":"number","title":"Rate","description":"Wallet currency rate (against destination)"}},"type":"object","required":["currency","rate"],"title":"QuoteWalletInfo"}},"components/schemas/SenderB2X":{"id":"components/schemas/SenderB2X","kind":"json-schema","title":"Sender[B2X, PaymentCountry, PaymentMethod]","data":{"properties":{"name":{"type":"string","title":"Name"},"address":{"type":"string","title":"Address"},"country":{"$ref":"#/components/schemas/CountryAlpha3"},"id":{"type":"string","title":"ID","description":"Business registration id/number"}},"type":"object","required":["name","address","country","id"],"title":"Sender[B2X, PaymentCountry, PaymentMethod]"}},"components/schemas/SenderC2X":{"id":"components/schemas/SenderC2X","kind":"json-schema","title":"Sender[C2X,PaymentCountry,PaymentMethod]","data":{"properties":{"first_name":{"$ref":"#/components/schemas/PersonName","description":"Sender first name"},"last_name":{"$ref":"#/components/schemas/PersonName","description":"Sender last name (surname)"},"birthdate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Birthdate","description":"Sender birthdate"},"identity_doc_type":{"$ref":"#/components/schemas/IdentityDocumentType","description":"Sender identity document type"},"identity_doc":{"type":"string","title":"Identity Doc","description":"Sender identity document number"},"identity_doc_exp":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Identity Doc Exp","description":"Expiry date for the sender identity document (must be in the future)"},"identity_doc_country":{"$ref":"#/components/schemas/CountryAlpha3","description":"Country that issued the sender identity document (ISO 3166-1 alpha-3 Country Code)","default":"ARE"},"city":{"type":"string","title":"City","description":"Sender address (city)"},"address":{"type":"string","maxLength":70,"title":"Address","description":"Sender address (street and number)"},"country":{"$ref":"#/components/schemas/CountryAlpha3","description":"Sender residency/country (ISO 3166-1 alpha-3 Country Code)","default":"ARE"},"relation":{"$ref":"#/components/schemas/Relation","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the beneficiary is to the sender: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"father"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the beneficiary is the sender's father. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"own"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a transfer to the sender's own account."},"children":[]}]}]}]},"mobile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile","description":"Sender mobile number (ITU E.164 format with country code prefix)"}},"type":"object","required":["first_name","last_name","identity_doc_type","identity_doc","city","address","relation"],"title":"Sender[C2X,PaymentCountry,PaymentMethod]"}},"components/schemas/StatementReportFilter":{"id":"components/schemas/StatementReportFilter","kind":"json-schema","title":"StatementReportFilter","data":{"properties":{"date_from":{"type":"string","format":"date","title":"Date From","description":"First day, inclusive"},"date_to":{"type":"string","format":"date","title":"Date To","description":"Last day, inclusive"},"country":{"$ref":"#/components/schemas/ApiCountry","description":"Payment country"},"timezone":{"anyOf":[{"$ref":"#/components/schemas/SupportedTimeZone"},{"type":"null"}],"description":"Timezone that defines a day. Omit for UTC."}},"type":"object","required":["date_from","date_to","country"],"title":"StatementReportFilter","description":"Statement report parameters available to API clients."}},"components/schemas/SupportedTimeZone":{"id":"components/schemas/SupportedTimeZone","kind":"json-schema","title":"SupportedTimeZone","data":{"type":"string","enum":["Asia/Kolkata","Asia/Karachi","Asia/Dubai","Canada/Mountain","Europe/Paris"],"title":"SupportedTimeZone"}},"components/schemas/ValidationProblem":{"id":"components/schemas/ValidationProblem","kind":"json-schema","title":"ValidationProblem","data":{"properties":{"type":{"type":"string","title":"Type"},"title":{"type":"string","title":"Title"},"status":{"type":"integer","title":"Status"},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail"},"instance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance"},"errors":{"items":{"$ref":"#/components/schemas/ProblemError"},"type":"array","title":"Errors"}},"type":"object","required":["type","title","status","errors"],"title":"ValidationProblem"}},"components/schemas/WalletBalanceInfo":{"id":"components/schemas/WalletBalanceInfo","kind":"json-schema","title":"WalletBalanceInfo","data":{"properties":{"currency":{"$ref":"#/components/schemas/WalletCurrency","description":"Your settlement wallet currency."},"rate":{"type":"number","title":"Rate","description":"Rate from the wallet currency to the corridor's local currency."},"balance":{"type":"number","title":"Balance","description":"What you can pay out now, in the wallet currency. Already net of reserved amounts and deal holds."}},"type":"object","required":["currency","rate","balance"],"title":"WalletBalanceInfo"}},"components/schemas/WalletCurrency":{"id":"components/schemas/WalletCurrency","kind":"json-schema","title":"WalletCurrency","data":{"type":"string","enum":["USD","USDT","USDC","ETH"],"title":"WalletCurrency","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency a wallet is denominated in — what your balance is held"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and settled in."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payouts settle in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USDT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USDC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ETH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is accepted by the type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but no provider settles in it today."},"children":[]}]}]}]}},"components/schemas/PaymentC2CIndia":{"id":"components/schemas/PaymentC2CIndia","kind":"json-schema","title":"Payment[C2C,India,PaymentMethod]","data":{"properties":{"external_id":{"anyOf":[{"$ref":"#/components/schemas/ExternalIdStr"},{"type":"null"}]},"payment_type":{"type":"string","const":"C2C","title":"Payment Type"},"payment_country":{"type":"string","const":"IND","title":"Payment Country"},"payment_method":{"$ref":"#/components/schemas/PaymentMethod"},"payment_details":{"anyOf":[{"$ref":"#/components/schemas/PaymentDetailsC2CIndiaBankTransfer"},{"$ref":"#/components/schemas/PaymentDetailsC2CIndiaInstantPayment"}],"title":"Payment Details"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Source currency (the currency will be automatically converted to local currency using the provided quote)"},"quote":{"type":"string","format":"uuid","title":"Quote","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid currency quote id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UUID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v3/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quote currency must match base currency."},"children":[]}]}]}]},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payout amount, in the destination (local) currency. Send the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" verbatim; do not recompute it from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must fall inside the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limits.min_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limits.max_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" band."},"children":[]}]}]}]},"sender":{"anyOf":[{"$ref":"#/components/schemas/SenderB2X"},{"$ref":"#/components/schemas/SenderC2X"}],"title":"Sender","description":"Sender details"},"beneficiary":{"anyOf":[{"$ref":"#/components/schemas/BeneficiaryX2B"},{"$ref":"#/components/schemas/BeneficiaryX2C"}],"title":"Beneficiary","description":"Beneficiary details"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks","description":"Supplementary note"},"payment_currency":{"anyOf":[{"$ref":"#/components/schemas/DestinationCurrency"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination currency. Informational -- it is fixed by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and is rejected if it disagrees. Filled in from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted."},"children":[]}]}]}]}},"type":"object","required":["payment_type","payment_country","payment_method","payment_details","currency","quote","amount","sender","beneficiary"],"title":"Payment[C2C,India,PaymentMethod]"}},"components/schemas/PaymentC2CPakistan":{"id":"components/schemas/PaymentC2CPakistan","kind":"json-schema","title":"Payment[C2C,Pakistan,PaymentMethod]","data":{"properties":{"external_id":{"anyOf":[{"$ref":"#/components/schemas/ExternalIdStr"},{"type":"null"}]},"payment_type":{"type":"string","const":"C2C","title":"Payment Type"},"payment_country":{"type":"string","const":"PAK","title":"Payment Country"},"payment_method":{"$ref":"#/components/schemas/PaymentMethod"},"payment_details":{"$ref":"#/components/schemas/PaymentDetailsC2CPakistanBankTransfer"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Source currency (the currency will be automatically converted to local currency using the provided quote)"},"quote":{"type":"string","format":"uuid","title":"Quote","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid currency quote id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UUID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v3/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quote currency must match base currency."},"children":[]}]}]}]},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payout amount, in the destination (local) currency. Send the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" verbatim; do not recompute it from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must fall inside the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limits.min_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limits.max_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" band."},"children":[]}]}]}]},"sender":{"anyOf":[{"$ref":"#/components/schemas/SenderB2X"},{"$ref":"#/components/schemas/SenderC2X"}],"title":"Sender","description":"Sender details"},"beneficiary":{"anyOf":[{"$ref":"#/components/schemas/BeneficiaryX2B"},{"$ref":"#/components/schemas/BeneficiaryX2C"}],"title":"Beneficiary","description":"Beneficiary details"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks","description":"Supplementary note"},"payment_currency":{"anyOf":[{"$ref":"#/components/schemas/DestinationCurrency"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination currency. Informational -- it is fixed by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and is rejected if it disagrees. Filled in from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted."},"children":[]}]}]}]}},"type":"object","required":["payment_type","payment_country","payment_method","payment_details","currency","quote","amount","sender","beneficiary"],"title":"Payment[C2C,Pakistan,PaymentMethod]"}},"components/schemas/PaymentC2CNigeria":{"id":"components/schemas/PaymentC2CNigeria","kind":"json-schema","title":"Payment[C2C,Nigeria,PaymentMethod]","data":{"properties":{"external_id":{"anyOf":[{"$ref":"#/components/schemas/ExternalIdStr"},{"type":"null"}]},"payment_type":{"type":"string","const":"C2C","title":"Payment Type"},"payment_country":{"type":"string","const":"NGA","title":"Payment Country"},"payment_method":{"$ref":"#/components/schemas/PaymentMethod"},"payment_details":{"$ref":"#/components/schemas/PaymentDetailsC2CNigeriaBankTransfer"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Source currency (the currency will be automatically converted to local currency using the provided quote)"},"quote":{"type":"string","format":"uuid","title":"Quote","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid currency quote id ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UUID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v3/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Quote currency must match base currency."},"children":[]}]}]}]},"amount":{"type":"number","exclusiveMinimum":0,"title":"Amount","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payout amount, in the destination (local) currency. Send the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" verbatim; do not recompute it from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It must fall inside the quote's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limits.min_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limits.max_amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" band."},"children":[]}]}]}]},"sender":{"anyOf":[{"$ref":"#/components/schemas/SenderB2X"},{"$ref":"#/components/schemas/SenderC2X"}],"title":"Sender","description":"Sender details"},"beneficiary":{"anyOf":[{"$ref":"#/components/schemas/BeneficiaryX2B"},{"$ref":"#/components/schemas/BeneficiaryX2C"}],"title":"Beneficiary","description":"Beneficiary details"},"remarks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remarks","description":"Supplementary note"},"payment_currency":{"anyOf":[{"$ref":"#/components/schemas/DestinationCurrency"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination currency. Informational -- it is fixed by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and is rejected if it disagrees. Filled in from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted."},"children":[]}]}]}]}},"type":"object","required":["payment_type","payment_country","payment_method","payment_details","currency","quote","amount","sender","beneficiary"],"title":"Payment[C2C,Nigeria,PaymentMethod]"}},"components/schemas/PaymentOrder":{"id":"components/schemas/PaymentOrder","kind":"json-schema","title":"PaymentOrder","data":{"anyOf":[{"$ref":"#/components/schemas/PaymentB2BIndia"},{"$ref":"#/components/schemas/PaymentB2CIndia"},{"$ref":"#/components/schemas/PaymentC2BIndia"},{"$ref":"#/components/schemas/PaymentC2CIndia"},{"$ref":"#/components/schemas/PaymentC2CPakistan"},{"$ref":"#/components/schemas/PaymentC2CNigeria"}]}},"schema_38":{"kind":"json-schema","data":{"type":"number","maximum":120,"minimum":10,"default":30,"title":"Timeout"},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"string","format":"uuid","description":"Quote id","title":"Id"},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"number","maximum":120,"minimum":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How long to wait for the payment to be accepted. When the wait runs out the payment is failed with status reason "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Submit timeout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and is never submitted to a provider."},"children":[]}]}]}],"default":30,"title":"Timeout"},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}],"description":"Payment id","title":"Id"},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supplied is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the original payment request."},"children":[]}]}]}],"default":false,"title":"External"},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start timestamp (must be lower than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", max timespan 7 days)"},"children":[]}]}]}],"title":"Start"},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End timestamp (must be greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", max timespan 7 days)"},"children":[]}]}]}],"title":"End"},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PaymentOrderState"},"maxItems":9},{"type":"null"}],"title":"Status"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SortingOrder","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort direction on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (oldest first). Note "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sorting_order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":"asc"},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"object","properties":{"retry-after":{"type":"integer","minimum":0,"description":"Seconds to wait before retrying this request."}}},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ApiCountry","description":"Payment country"},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSE Last-Event-ID: the UUID7 id of the last event the client received. On reconnect, streaming resumes from that event's timestamp (browser EventSource sends this automatically). Replay is best-effort — only events still retained in the stream can be re-delivered, and same-millisecond events may be re-sent, so treat the SSE id as an idempotency key."},"children":[]}]}]}],"title":"Last-Event-Id"},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"string","contentMediaType":"application/json","contentSchema":{"oneOf":[{"$ref":"#/components/schemas/PaymentResponse"},{"properties":{"id":{"format":"uuid","title":"Id","type":"string"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"detail":{"title":"Detail","type":"string"},"status_code":{"title":"Status Code","type":"integer"}},"required":["id","external_id","detail","status_code"],"title":"PaymentError","type":"object"}]}},"event":{"type":"string","enum":["payment","payment-error"],"description":"Event type / data payload variant"},"id":{"type":"string","format":"uuid","description":"UUID7 event id (SSE Last-Event-ID cursor)"},"retry":{"type":"integer","minimum":0}}},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/SupportedTimeZone"},{"type":"null"}],"title":"Timezone"},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/PaymentMethod"},{"type":"null"}],"description":"Restrict to banks reachable on this rail","title":"Payment Method"},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"object","additionalProperties":{"type":"string"},"title":"Response Debug V3 Debug Get"},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/QuoteRequestV2"},{"$ref":"#/components/schemas/QuoteRequestDestination"}],"title":"Quote request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fix the source amount, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fix the payout amount."},"children":[]}]}]}]},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"string","format":"uuid","title":"Id"},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ApiCountry"},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"Id"},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"integer","maximum":1000,"minimum":0,"default":20,"title":"Limit"},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"integer","minimum":0,"default":0,"title":"Offset"},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SortingOrder","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort direction on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (newest first). Note "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v3/payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":"desc"},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Ts"},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Ts"},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/SearchType"},{"type":"null"}],"title":"Search Type"},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Term"},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentOrderInfoLive"},"title":"Response Payment History V2 Payments Get"},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ValidateBeneficiaryResponse"},{"type":"null"}],"title":"Response Validate Account V2 Validate Account Post"},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ValidateBankResponse"},{"type":"null"}],"title":"Response Validate Bank V2 Validate Bank Post"},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ApiCountry","description":"Destination country"},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"type":"object","properties":{"event":{"type":"string","enum":["payment","payment-update"],"description":"Event type; selects the `data` shape."},"data":{"type":"string","contentMediaType":"application/json","contentSchema":{"oneOf":[{"$ref":"#/components/schemas/PaymentOrderInfoLive"},{"properties":{"id":{"description":"Payment id.","format":"uuid","title":"Id","type":"string"},"timestamp":{"description":"When the status changed (UTC).","format":"date-time","title":"Timestamp","type":"string"},"status":{"$ref":"#/components/schemas/PaymentOrderState","description":"The new payment state."}},"required":["id","timestamp","status"],"title":"PaymentStatusChange","type":"object"}]}}}},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ClientReportType"},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"type":"integer","maximum":1000,"minimum":0,"default":50,"title":"Limit"},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ClientReportListFilter"},{"type":"null"}],"description":"Report list filter","title":"Filter By"},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ReportResponse"},"title":"Response Report List V2 Reports List  Put"},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Auto Generated"},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"type":"object","additionalProperties":{"type":"string"},"title":"Response Debug Get V2 Debug Get"},"id":"schema_75"}},"exampleStore":{"paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_queued":{"value":{"event":"payment","id":"019f8da0-6a1b-7c4e-8f21-0a1b2c3d4e5f","data":"{\"id\":\"019f8da0-591c-771e-b353-cdc75173dccc\",\"external_id\":\"29fc8b3dc79442c3\",\"timestamp\":\"2026-07-23T06:18:43.873162Z\",\"status\":\"queued\",\"msg\":\"Queued\",\"quote\":\"019f8da0-58d4-760a-8dcf-4a221003a022\"}"},"key":"payment_queued","summary":"payment — accepted (queued)","id":"paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_queued"},"paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_processing":{"value":{"event":"payment","id":"019f8df6-6c12-7705-a34b-f2f812bd9785","data":"{\"id\":\"019f8df6-5ad5-7926-882f-f1995d89b2aa\",\"external_id\":\"8d6d0e0a7afb4c79\",\"timestamp\":\"2026-07-23T07:52:44.815311Z\",\"status\":\"processing\",\"msg\":\"OK\",\"quote\":\"019f8df6-5a86-7a5d-a643-34d25428f0f1\",\"amount\":101.0,\"currency\":\"INR\"}"},"key":"payment_processing","summary":"payment — submitted to provider (processing)","id":"paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_processing"},"paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_error":{"value":{"event":"payment-error","id":"019f8da0-7b2c-7d5f-9a32-1b2c3d4e5f60","data":"{\"id\":\"019f8da0-591c-771e-b353-cdc75173dccc\",\"external_id\":\"29fc8b3dc79442c3\",\"detail\":\"Quote 019f8da0-58d4-760a-8dcf-4a221003a022 not found\",\"status_code\":400}"},"key":"payment_error","summary":"payment-error — rejected (quote not found)","id":"paths/~1v3~1events/get/responses/200/content/text~1event-stream/examples/payment_error"},"paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example1":{"value":{"detail":"Duplicate `external_id` field detected."},"key":"example1","summary":"Duplicate `external_id` field detected.","id":"paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example1"},"paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example2":{"value":{"detail":"Quote already used"},"key":"example2","summary":"Quote already used","id":"paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example2"},"paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example3":{"value":{"detail":"Quote has expired"},"key":"example3","summary":"Quote has expired","id":"paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example3"},"paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example4":{"value":{"detail":"Insufficient balance detected (0.0)"},"key":"example4","summary":"Insufficient balance detected (0.0)","id":"paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example4"},"paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example5":{"value":{"detail":"Mismatching currency from quote (USD) and payment (AED)"},"key":"example5","summary":"Mismatching currency from quote (USD) and payment (AED)","id":"paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example5"},"paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example6":{"value":{"detail":"Payment `amount_destination` lower than minimum amount for selected quote: 100.0 INR"},"key":"example6","summary":"Payment `amount_destination` lower than minimum amount for selected quote: 100.0 INR","id":"paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example6"},"paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example7":{"value":{"detail":"Payment `amount_destination` greater than maximum amount for selected quote: 100000.0 INR"},"key":"example7","summary":"Payment `amount_destination` greater than maximum amount for selected quote: 100000.0 INR","id":"paths/~1v2~1payment/post/responses/400/content/application~1json/examples/example7"},"paths/~1v2~1quote/post/responses/400/content/application~1json/examples/example1":{"value":{"detail":"Unable to fetch quote (min/max amount requirements)"},"key":"example1","summary":"Unable to fetch quote (min/max amount requirements)","id":"paths/~1v2~1quote/post/responses/400/content/application~1json/examples/example1"},"paths/~1v2~1quote/post/responses/500/content/application~1json/examples/example1":{"value":{"detail":"Could not obtain quote."},"key":"example1","summary":"Could not obtain quote.","id":"paths/~1v2~1quote/post/responses/500/content/application~1json/examples/example1"},"paths/~1v2~1quote/post/responses/500/content/application~1json/examples/example2":{"value":{"detail":"Could not fetch quote at this time."},"key":"example2","summary":"Could not fetch quote at this time.","id":"paths/~1v2~1quote/post/responses/500/content/application~1json/examples/example2"},"paths/~1v2~1quote~1{id}/get/responses/404/content/application~1json/examples/example1":{"value":{"detail":"Not found (or expired)"},"key":"example1","summary":"Not found (or expired)","id":"paths/~1v2~1quote~1{id}/get/responses/404/content/application~1json/examples/example1"},"paths/~1v2~1payments~1{id}/get/responses/400/content/application~1json/examples/example1":{"value":{"detail":"Path parameter `id` must be UUID when external=false"},"key":"example1","summary":"Path parameter `id` must be UUID when external=false","id":"paths/~1v2~1payments~1{id}/get/responses/400/content/application~1json/examples/example1"},"paths/~1v2~1payments~1{id}/get/responses/404/content/application~1json/examples/example1":{"value":{"detail":"Not Found"},"key":"example1","summary":"Not Found","id":"paths/~1v2~1payments~1{id}/get/responses/404/content/application~1json/examples/example1"},"paths/~1v2~1events/get/responses/200/content/text~1event-stream/examples/payment_update":{"value":{"event":"payment-update","data":"{\"id\":\"00000000-0000-4000-A000-000000000000\",\"timestamp\":\"2024-12-01T01:05:00Z\",\"status\":\"succeeded\"}"},"key":"payment_update","summary":"payment-update: status changed","id":"paths/~1v2~1events/get/responses/200/content/text~1event-stream/examples/payment_update"},"paths/~1v2~1debug/get/responses/200/content/application~1json/example":{"value":{"host":"api.leanxtest.me","user-agent":"curl/8.5.0","accept":"*/*"},"id":"paths/~1v2~1debug/get/responses/200/content/application~1json/example"}},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token: a JWT signed with the credentials issued to you. See Authentication for the required claims and supported algorithms."}},"servers":[{"url":"/_mock/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://api.leanxtest.me","description":"Leanx Test server"},{"url":"https://api.leanx.me","description":"Leanx Production server"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"API reference","description":"","summary":"\n### Intro\n\nLeanX API facilitates fast payments via bank transfers to specified beneficiaries.\n    "}},"baseSlug":"/openapi","routesMapping":{}}