{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"LeanX payment API","link":"/","routeSlug":"/","relativePathFromDirectory":"index.md"},{"type":"link","label":"API reference","link":"/openapi","routeSlug":"/openapi"},{"type":"separator","label":"Getting started"},{"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"},{"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"},{"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"},{"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"},{"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"},{"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"}]},{"type":"group","label":"Credentials","link":"/openapi/guide-credentials","routeSlug":"/openapi/guide-credentials","items":[]},{"type":"group","label":"Authentication","link":"/openapi/guide-authentication","routeSlug":"/openapi/guide-authentication","items":[]},{"type":"group","label":"Signing a token","link":"/openapi/guide-signing-a-token","routeSlug":"/openapi/guide-signing-a-token","items":[]},{"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":[]},{"type":"group","label":"Transaction states","link":"/openapi/guide-transaction-states","routeSlug":"/openapi/guide-transaction-states","items":[]},{"type":"group","label":"Settlement currencies","link":"/openapi/guide-settlement-currencies","routeSlug":"/openapi/guide-settlement-currencies","items":[]},{"type":"separator","label":"API v3 (current)"},{"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."}},"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"}},"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."}},"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"}},"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"}},"httpPath":"/v3/payments"}]},{"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)."}},"httpPath":"/v3/validate_account"}]},{"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"}},"httpPath":"/v3/balance"}]},{"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"}},"httpPath":"/v3/events"}]},{"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."}},"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."}},"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."}},"httpPath":"/v3/reports/wallet"}]},{"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."}},"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"}},"httpPath":"/v3/debug"}]},{"type":"separator","label":"API v2 (maintenance)"},{"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."}},"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"}},"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"}},"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"}},"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"}},"httpPath":"/v2/payments"}]},{"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)."}},"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."}},"httpPath":"/v2/validate_bank"}]},{"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"}},"httpPath":"/v2/balance"}]},{"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"}},"httpPath":"/v2/events"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/v2/reports/{id}/presigned-url"}]},{"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."}},"httpPath":"/v2/debug"}]}]}