{"items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/index.md","metadata":{"type":"markdown"},"label":"Welcome","link":"/pt-br/products/payments-odl","routeSlug":"/pt-br/products/payments-odl"},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/introduction.md","metadata":{"type":"markdown"},"label":"Introduction","link":"/pt-br/products/payments-odl/introduction","routeSlug":"/pt-br/products/payments-odl/introduction","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/introduction/products.md","metadata":{"type":"markdown"},"label":"Products","link":"/pt-br/products/payments-odl/introduction/products","routeSlug":"/pt-br/products/payments-odl/introduction/products"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/introduction/use-cases.md","metadata":{"type":"markdown"},"label":"Use cases","link":"/pt-br/products/payments-odl/introduction/use-cases","routeSlug":"/pt-br/products/payments-odl/introduction/use-cases"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/introduction/concepts.md","metadata":{"type":"markdown"},"label":"Concepts","link":"/pt-br/products/payments-odl/introduction/concepts","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/introduction/concepts/payment-participants.md","metadata":{"type":"markdown"},"label":"Payment participants","link":"/pt-br/products/payments-odl/introduction/concepts/payment-participants","routeSlug":"/pt-br/products/payments-odl/introduction/concepts/payment-participants"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/introduction/concepts/payment-types.md","metadata":{"type":"markdown"},"label":"Payment types","link":"/pt-br/products/payments-odl/introduction/concepts/payment-types","routeSlug":"/pt-br/products/payments-odl/introduction/concepts/payment-types"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/introduction/concepts/payment-flow.md","metadata":{"type":"markdown"},"label":"Payment flow","link":"/pt-br/products/payments-odl/introduction/concepts/payment-flow","routeSlug":"/pt-br/products/payments-odl/introduction/concepts/payment-flow"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/introduction/concepts/payment-states.md","metadata":{"type":"markdown"},"label":"Payment states","link":"/pt-br/products/payments-odl/introduction/concepts/payment-states","routeSlug":"/pt-br/products/payments-odl/introduction/concepts/payment-states"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/introduction/concepts/quotes.md","metadata":{"type":"markdown"},"label":"Quotes","link":"/pt-br/products/payments-odl/introduction/concepts/quotes","routeSlug":"/pt-br/products/payments-odl/introduction/concepts/quotes"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/introduction/concepts/using-on-demand-liquidity.md","metadata":{"type":"markdown"},"label":"Using On-Demand Liquidity","link":"/pt-br/products/payments-odl/introduction/concepts/using-on-demand-liquidity","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/introduction/concepts/on-demand-liquidity/onboarding-overview.md","metadata":{"type":"markdown"},"label":"Onboarding overview","link":"/pt-br/products/payments-odl/introduction/concepts/on-demand-liquidity/onboarding-overview","routeSlug":"/pt-br/products/payments-odl/introduction/concepts/on-demand-liquidity/onboarding-overview"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/introduction/concepts/on-demand-liquidity/connecting-to-digital-asset-exchanges.md","metadata":{"type":"markdown"},"label":"Connecting to digital asset exchanges","link":"/pt-br/products/payments-odl/introduction/concepts/on-demand-liquidity/connecting-to-digital-asset-exchanges","routeSlug":"/pt-br/products/payments-odl/introduction/concepts/on-demand-liquidity/connecting-to-digital-asset-exchanges"}],"routeSlug":"/pt-br/products/payments-odl/introduction/concepts/using-on-demand-liquidity"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/introduction/concepts/funding-methods.md","metadata":{"type":"markdown"},"label":"Funding methods","link":"/pt-br/products/payments-odl/introduction/concepts/funding-methods","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/introduction/concepts/funding-methods/wallet-funding.md","metadata":{"type":"markdown"},"label":"Wallet Funding","link":"/pt-br/products/payments-odl/introduction/concepts/funding-methods/wallet-funding","routeSlug":"/pt-br/products/payments-odl/introduction/concepts/funding-methods/wallet-funding"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/introduction/concepts/funding-methods/t_1-invoicing.md","metadata":{"type":"markdown"},"label":"T+1 Invoicing","link":"/pt-br/products/payments-odl/introduction/concepts/funding-methods/t_1-invoicing","routeSlug":"/pt-br/products/payments-odl/introduction/concepts/funding-methods/t_1-invoicing"}],"routeSlug":"/pt-br/products/payments-odl/introduction/concepts/funding-methods"}],"routeSlug":"/pt-br/products/payments-odl/introduction/concepts"}],"separatorLine":true},{"type":"separator","label":"Payments ODL UI"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/home.md","metadata":{"type":"markdown"},"label":"Home","link":"/pt-br/products/payments-odl/user-interface/home","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/login.md","metadata":{"type":"markdown"},"label":"Login","link":"/pt-br/products/payments-odl/user-interface/login","routeSlug":"/pt-br/products/payments-odl/user-interface/login"}],"routeSlug":"/pt-br/products/payments-odl/user-interface/home"},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/payments.md","metadata":{"type":"markdown"},"label":"Payments","link":"/pt-br/products/payments-odl/user-interface/payments","routeSlug":"/pt-br/products/payments-odl/user-interface/payments","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/payments/new-payment-form.md","metadata":{"type":"markdown"},"label":"New payment form","link":"/pt-br/products/payments-odl/user-interface/payments/new-payment-form","routeSlug":"/pt-br/products/payments-odl/user-interface/payments/new-payment-form"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/payments/payment-details.md","metadata":{"type":"markdown"},"label":"Payment details","link":"/pt-br/products/payments-odl/user-interface/payments/payment-details","routeSlug":"/pt-br/products/payments-odl/user-interface/payments/payment-details"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/payments/payment-reports.md","metadata":{"type":"markdown"},"label":"ODL statements","link":"/pt-br/products/payments-odl/user-interface/payments/payment-reports","routeSlug":"/pt-br/products/payments-odl/user-interface/payments/payment-reports"}]},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/accounts.md","metadata":{"type":"markdown"},"label":"Accounts","link":"/pt-br/products/payments-odl/user-interface/accounts","routeSlug":"/pt-br/products/payments-odl/user-interface/accounts","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/accounts/account-details.md","metadata":{"type":"markdown"},"label":"Account details","link":"/pt-br/products/payments-odl/user-interface/accounts/account-details","routeSlug":"/pt-br/products/payments-odl/user-interface/accounts/account-details"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/accounts/new-account.md","metadata":{"type":"markdown"},"label":"New account page","link":"/pt-br/products/payments-odl/user-interface/accounts/new-account","routeSlug":"/pt-br/products/payments-odl/user-interface/accounts/new-account"}]},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/reports.md","metadata":{"type":"markdown"},"label":"Reports","link":"/pt-br/products/payments-odl/user-interface/reports","routeSlug":"/pt-br/products/payments-odl/user-interface/reports"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/notifications.md","metadata":{"type":"markdown"},"label":"Notifications","link":"/pt-br/products/payments-odl/user-interface/notifications","routeSlug":"/pt-br/products/payments-odl/user-interface/notifications"},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/settings.md","metadata":{"type":"markdown"},"label":"Settings","link":"/pt-br/products/payments-odl/user-interface/settings","routeSlug":"/pt-br/products/payments-odl/user-interface/settings","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/users.md","metadata":{"type":"markdown"},"label":"User management","link":"/pt-br/products/payments-odl/user-interface/users","routeSlug":"/pt-br/products/payments-odl/user-interface/users"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/settings/activity-logs.md","metadata":{"type":"markdown"},"label":"Activity logs","link":"/pt-br/products/payments-odl/user-interface/settings/activity-logs","routeSlug":"/pt-br/products/payments-odl/user-interface/settings/activity-logs"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/settings/api-credentials.md","metadata":{"type":"markdown"},"label":"API credentials","link":"/pt-br/products/payments-odl/user-interface/settings/api-credentials","routeSlug":"/pt-br/products/payments-odl/user-interface/settings/api-credentials"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/settings/ip-allowlist.md","metadata":{"type":"markdown"},"label":"IP allowlist","link":"/pt-br/products/payments-odl/user-interface/settings/ip-allowlist","routeSlug":"/pt-br/products/payments-odl/user-interface/settings/ip-allowlist"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/settings/exchange-credentials.md","metadata":{"type":"markdown"},"label":"Exchange credentials","link":"/pt-br/products/payments-odl/user-interface/settings/exchange-credentials","routeSlug":"/pt-br/products/payments-odl/user-interface/settings/exchange-credentials"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/settings/payment-settings.md","metadata":{"type":"markdown"},"label":"Payment settings","link":"/pt-br/products/payments-odl/user-interface/settings/payment-settings","routeSlug":"/pt-br/products/payments-odl/user-interface/settings/payment-settings"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/settings/payment-presets.md","metadata":{"type":"markdown"},"label":"Payment presets","link":"/pt-br/products/payments-odl/user-interface/settings/payment-presets","routeSlug":"/pt-br/products/payments-odl/user-interface/settings/payment-presets"}]},{"type":"group","label":"Tutorials","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/tutorials/send-an-individual-payment.md","metadata":{"type":"markdown"},"label":"Send an individual payment","link":"/pt-br/products/payments-odl/user-interface/tutorials/send-an-individual-payment","routeSlug":"/pt-br/products/payments-odl/user-interface/tutorials/send-an-individual-payment"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/tutorials/create-a-batch-payment-file.md","metadata":{"type":"markdown"},"label":"Create a batch payment file","link":"/pt-br/products/payments-odl/user-interface/tutorials/create-a-batch-payment-file","routeSlug":"/pt-br/products/payments-odl/user-interface/tutorials/create-a-batch-payment-file"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/tutorials/send-a-batch-payment.md","metadata":{"type":"markdown"},"label":"Send a batch payment","link":"/pt-br/products/payments-odl/user-interface/tutorials/send-a-batch-payment","routeSlug":"/pt-br/products/payments-odl/user-interface/tutorials/send-a-batch-payment"}],"separatorLine":true},{"type":"separator","label":"Payments ODL API"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/onboarding-process.md","metadata":{"type":"markdown"},"label":"Onboarding process","link":"/pt-br/products/payments-odl/api-docs/ripplenet/onboarding-process","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/onboarding-process"},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/system-components.md","metadata":{"type":"markdown"},"label":"System components","link":"/pt-br/products/payments-odl/api-docs/ripplenet/system-components","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/system-components","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/system-components/liquidation/smart-liquidation.md","metadata":{"type":"markdown"},"label":"Smart Liquidation","link":"/pt-br/products/payments-odl/api-docs/ripplenet/system-components/liquidation/smart-liquidation","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/system-components/liquidation/smart-liquidation"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/system-components/failure-conversion-and-ssa/failure-conversion.md","metadata":{"type":"markdown"},"label":"Failure conversion","link":"/pt-br/products/payments-odl/api-docs/ripplenet/system-components/failure-conversion-and-ssa/failure-conversion","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/system-components/failure-conversion-and-ssa/odl-features-cross-dependencies.md","metadata":{"type":"markdown"},"label":"ODL features cross-dependencies","link":"/pt-br/products/payments-odl/api-docs/ripplenet/system-components/failure-conversion-and-ssa/odl-features-cross-dependencies","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/system-components/failure-conversion-and-ssa/odl-features-cross-dependencies"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/system-components/failure-conversion-and-ssa/sender-segregated-account.md","metadata":{"type":"markdown"},"label":"Sender Segregated Account","link":"/pt-br/products/payments-odl/api-docs/ripplenet/system-components/failure-conversion-and-ssa/sender-segregated-account","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/system-components/failure-conversion-and-ssa/sender-segregated-account"}],"routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/system-components/failure-conversion-and-ssa/failure-conversion"}]},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/tutorials.md","metadata":{"type":"markdown"},"label":"Tutorials","link":"/pt-br/products/payments-odl/api-docs/ripplenet/tutorials","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/tutorials","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/tutorials/send-a-payment/send-a-payment-basic.md","metadata":{"type":"markdown"},"label":"Send a payment","link":"/pt-br/products/payments-odl/api-docs/ripplenet/tutorials/send-a-payment/send-a-payment-basic","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/tutorials/send-a-payment/send-a-payment-basic"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/tutorials/receive-a-payment/receive-a-payment-basic.md","metadata":{"type":"markdown"},"label":"Receive a payment","link":"/pt-br/products/payments-odl/api-docs/ripplenet/tutorials/receive-a-payment/receive-a-payment-basic","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/tutorials/receive-a-payment/receive-a-payment-basic"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/tutorials/non-orchestration.md","metadata":{"type":"markdown"},"label":"Non-orchestration payments","link":"/pt-br/products/payments-odl/api-docs/ripplenet/tutorials/non-orchestration","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/tutorials/non-orchestration/send-a-payment-advanced.md","metadata":{"type":"markdown"},"label":"Sender payment flow — non-orchestration","link":"/pt-br/products/payments-odl/api-docs/ripplenet/tutorials/non-orchestration/send-a-payment-advanced","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/tutorials/non-orchestration/send-a-payment-advanced"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/tutorials/non-orchestration/receive-a-payment-advanced.md","metadata":{"type":"markdown"},"label":"Receiver payment flow — non-orchestration","link":"/pt-br/products/payments-odl/api-docs/ripplenet/tutorials/non-orchestration/receive-a-payment-advanced","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/tutorials/non-orchestration/receive-a-payment-advanced"}],"routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/tutorials/non-orchestration"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/tutorials/configure-fees.md","metadata":{"type":"markdown"},"label":"Configure fees","link":"/pt-br/products/payments-odl/api-docs/ripplenet/tutorials/configure-fees","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/tutorials/configure-fees"}]},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/test-automation.md","metadata":{"type":"markdown"},"label":"Test automation","link":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/test-automation/test-harness-overview.md","metadata":{"type":"markdown"},"label":"Test Harness overview","link":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/test-harness-overview","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/test-automation/test-harness-overview/definitions.md","metadata":{"type":"markdown"},"label":"Definitions","link":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/test-harness-overview/definitions","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/test-harness-overview/definitions"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/test-automation/test-harness-overview/testing-basics.md","metadata":{"type":"markdown"},"label":"Testing basics","link":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/test-harness-overview/testing-basics","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/test-harness-overview/testing-basics"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/test-automation/test-harness-overview/profile-editor.md","metadata":{"type":"markdown"},"label":"Profile Editor","link":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/test-harness-overview/profile-editor","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/test-harness-overview/profile-editor"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/test-automation/test-harness-overview/aligned-testing.md","metadata":{"type":"markdown"},"label":"Aligned testing","link":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/test-harness-overview/aligned-testing","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/test-harness-overview/aligned-testing"}],"routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/test-harness-overview"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/test-automation/sender-testing.md","metadata":{"type":"markdown"},"label":"Sender testing","link":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/sender-testing","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/test-automation/sender-testing/run-passive-mode-sender-tests.md","metadata":{"type":"markdown"},"label":"Run passive mode sender tests","link":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/sender-testing/run-passive-mode-sender-tests","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/sender-testing/run-passive-mode-sender-tests"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/test-automation/sender-testing/run-active-mode-sender-tests.md","metadata":{"type":"markdown"},"label":"Run active mode sender tests","link":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/sender-testing/run-active-mode-sender-tests","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/sender-testing/run-active-mode-sender-tests"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/test-automation/sender-testing/exception-handling.md","metadata":{"type":"markdown"},"label":"Exception handling","link":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/sender-testing/exception-handling","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/sender-testing/exception-handling"}],"routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/sender-testing"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/test-automation/receiver-testing.md","metadata":{"type":"markdown"},"label":"Receiver testing","link":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/receiver-testing","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/test-automation/receiver-testing/run-passive-mode-receiver-tests.md","metadata":{"type":"markdown"},"label":"Run passive mode receiver tests","link":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/receiver-testing/run-passive-mode-receiver-tests","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/receiver-testing/run-passive-mode-receiver-tests"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/test-automation/receiver-testing/run-active-mode-receiver-tests.md","metadata":{"type":"markdown"},"label":"Run active mode receiver tests","link":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/receiver-testing/run-active-mode-receiver-tests","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/receiver-testing/run-active-mode-receiver-tests"}],"routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/test-automation/receiver-testing"}]},{"type":"group","label":"API reference","items":[{"type":"group","label":"API operations by use case","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/ripplenet-apis/sender-basic-payment-flow.md","metadata":{"type":"markdown"},"label":"Sender - basic payment flow","link":"/pt-br/products/payments-odl/ripplenet-apis/sender-basic-payment-flow","routeSlug":"/pt-br/products/payments-odl/ripplenet-apis/sender-basic-payment-flow"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/ripplenet-apis/receiver-basic-payment-flow.md","metadata":{"type":"markdown"},"label":"Receiver - basic payment flow","link":"/pt-br/products/payments-odl/ripplenet-apis/receiver-basic-payment-flow","routeSlug":"/pt-br/products/payments-odl/ripplenet-apis/receiver-basic-payment-flow"}]},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/reference/openapi.yaml","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi","label":"RippleNet Server API","items":[{"type":"link","label":"Authentication","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/section/authentication","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/section/authentication"},{"type":"link","label":"API environments","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/section/api-environments","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/section/api-environments"},{"type":"group","label":"Auditing","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/auditing","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/auditing","items":[{"label":"Get audits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/auditing/getaudits","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/auditing/getaudits","metadata":{"seo":{"title":"Get audits","description":"Gets an audit trail of user actions and configuration changes (to accounts, fees, and rates) on a RippleNet instance."}},"httpPath":"/audit"},{"label":"Get event trail for payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/auditing/geteventtrailforpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/auditing/geteventtrailforpayment","metadata":{"seo":{"title":"Get event trail for payment","description":"Gets an audit trail of a payment's state changes on a local RippleNet instance."}},"httpPath":"/audit/payment/{id}"}]},{"type":"group","label":"Balances and statements","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements","items":[{"label":"Get balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements/getbalances","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements/getbalances","metadata":{"seo":{"title":"Get balances","description":"Get balances for local and remote accounts owned by a RippleNet address."}},"httpPath":"/monitor/balances"},{"label":"Get ledger balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements/getledgerbalances","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements/getledgerbalances","metadata":{"seo":{"title":"Get ledger balances","description":"Get balances for ledger owned by a RippleNet address."}},"httpPath":"/monitor/ledger/balances"},{"label":"Get statement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements/getstatement","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements/getstatement","metadata":{"seo":{"title":"Get statement","description":"Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range."}},"httpPath":"/statement/{account_name_with_address}"},{"label":"Get statement by external account ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements/getstatementbyexternalaccountid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements/getstatementbyexternalaccountid","metadata":{"seo":{"title":"Get statement by external account ID","description":"Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range."}},"httpPath":"/statement/external_account_id/{external_account_id}"},{"label":"Get ledger account statement","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements/getledgeraccountstatement","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/balances-and-statements/getledgeraccountstatement","metadata":{"seo":{"title":"Get ledger account statement","description":"Get statement for a specified Ledger account."}},"httpPath":"/statement/ledger/{account_name_with_address}"}]},{"type":"group","label":"Beneficiary confirmation","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/beneficiary-confirmation","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/beneficiary-confirmation","items":[{"label":"Get account lookup by status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/beneficiary-confirmation/getaccountlookupbystatus","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/beneficiary-confirmation/getaccountlookupbystatus","metadata":{"seo":{"title":"Get account lookup by status","description":"Get Account Lookup entities by status and other filters. Status defaults to REQUESTED."}},"httpPath":"/account_lookups"},{"label":"Initiate account lookup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/beneficiary-confirmation/initiateaccountlookup","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/beneficiary-confirmation/initiateaccountlookup","metadata":{"seo":{"title":"Initiate account lookup","description":"Creates an Account Lookup request to validate a beneficiary's account details before sending a payment. Account lookups are not part of the payment flow and can be made at any time in the payment process."}},"httpPath":"/account_lookups/request"},{"label":"Complete account lookup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/beneficiary-confirmation/completeaccountlookup","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/beneficiary-confirmation/completeaccountlookup","metadata":{"seo":{"title":"Complete account lookup","description":"Posts an Account Lookup response to validate a beneficiary's account details before payment."}},"httpPath":"/account_lookups/response"},{"label":"Get account lookup by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/beneficiary-confirmation/getaccountlookupbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/beneficiary-confirmation/getaccountlookupbyid","metadata":{"seo":{"title":"Get account lookup by ID","description":"Gets an Account Lookup entity for its account_lookup_id value."}},"httpPath":"/account_lookups/{account_lookup_id}"}]},{"type":"group","label":"Diagnostics","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/diagnostics","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/diagnostics","items":[{"label":"Check health","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/diagnostics/checkhealth","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/diagnostics/checkhealth","metadata":{"seo":{"title":"Check health","description":"Gets the health status of the xCurrent server."}},"httpPath":"/health"},{"label":"Check heartbeat","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/diagnostics/checkheartbeat","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/diagnostics/checkheartbeat","metadata":{"seo":{"title":"Check heartbeat","description":"Gets the health status of the xCurrent server's peers. This request requires authorization. The timeout for this operation is 5 seconds."}},"httpPath":"/heartbeat"}]},{"type":"group","label":"Exchange transfers","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers","items":[{"label":"Get exchange transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers/getexchangetransfers","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers/getexchangetransfers","metadata":{"seo":{"title":"Get exchange transfers","description":"Gets all exchange transfers."}},"httpPath":"/exchange_transfers"},{"label":"Execute exchange transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers/executeexchangetransfer","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers/executeexchangetransfer","metadata":{"seo":{"title":"Execute exchange transfer","description":"Execute an exchange transfer to move funds from one of your accounts in one currency (USD, for example) to another one of your accounts in another currency (EUR, for example) at an exchange rate set by your peer who maintains both of your accounts on their ledger. An exchange transfer enables you to fund a foreign currency account from your domestic currency account in bulk."}},"httpPath":"/exchange_transfers/execute"},{"label":"Get exchange transfer quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers/getexchangetransferquote","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers/getexchangetransferquote","metadata":{"seo":{"title":"Get exchange transfer quote","description":"Requests a quote for an exchange transfer."}},"httpPath":"/exchange_transfers/quote"},{"label":"Complete exchange transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers/completeexchangetransfer","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers/completeexchangetransfer","metadata":{"seo":{"title":"Complete exchange transfer","description":"Updates the status of an exchange transfer to COMPLETED. Make this request once the exchange transfer has been made on both the ledger and on internal systems."}},"httpPath":"/exchange_transfers/{id}/complete"},{"label":"Get exchange transfer by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers/getexchangetransferbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange-transfers/getexchangetransferbyid","metadata":{"seo":{"title":"Get exchange transfer by ID","description":"Gets an exchange transfer by ID."}},"httpPath":"/exchange_transfers/{id}"}]},{"type":"group","label":"Fees","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/fees","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/fees","items":[{"label":"Get fees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/fees/getfees","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/fees/getfees","metadata":{"seo":{"title":"Get fees","description":"Gets a list of fees."}},"httpPath":"/config/fees"},{"label":"Create fee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/fees/createfee","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/fees/createfee","metadata":{"seo":{"title":"Create fee","description":"Creates a fee."}},"httpPath":"/config/fees"},{"label":"Get fee by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/fees/getfeebyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/fees/getfeebyid","metadata":{"seo":{"title":"Get fee by ID","description":"Gets a fee by ID."}},"httpPath":"/config/fees/{id}"},{"label":"Update fee","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/fees/updatefee","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/fees/updatefee","metadata":{"seo":{"title":"Update fee","description":"Updates an existing fee."}},"httpPath":"/config/fees/{id}"},{"label":"Delete fee","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/fees/deletefee","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/fees/deletefee","metadata":{"seo":{"title":"Delete fee","description":"Deletes a fee. Once deleted, a fee cannot be accessed."}},"httpPath":"/config/fees/{id}"}]},{"type":"group","label":"Non-orchestration payments","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments","items":[{"label":"Get payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/getpayments","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/getpayments","metadata":{"seo":{"title":"Get payments","description":"Retrieves all payments in an instance of xCurrent that meet the criteria defined by the query parameters. You can use the query parameters to filter payments. The default parameters are sort_field : MODIFIED_AT , sort_direction : DESC , page : 0 , size : 10"}},"httpPath":"/payments"},{"label":"Get payment by payment ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/getpaymentbypaymentid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/getpaymentbypaymentid","metadata":{"seo":{"title":"Get payment by payment ID","description":"Gets a payment by ID."}},"httpPath":"/payments/{payment_id}"},{"label":"Lock payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/lockpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/lockpayment","metadata":{"seo":{"title":"Lock payment","description":"Locks a payment. The beneficiary and all intermediary institutions agree to proceed with the payment by making successful Lock Payment requests. When the payment is still in a partially LOCKED state, the beneficiary and all intermediary institutions who have not locked, can reject lock payment or fail payment."}},"httpPath":"/payments/{payment_id}/lock"},{"label":"Reject lock payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/rejectlockpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/rejectlockpayment","metadata":{"seo":{"title":"Reject lock payment","description":"Rejects a payment from being locked."}},"httpPath":"/payments/{payment_id}/reject"},{"label":"Retry accept payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/retryacceptpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/retryacceptpayment","metadata":{"seo":{"title":"Retry accept payment","description":"Returns a rejected payment from the LOCK_DECLINED state to the ACCEPTED state. The payment sender must include repaired user_info in the request body."}},"httpPath":"/payments/{payment_id}/retry_accept"},{"label":"Fail payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/failpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/failpayment","metadata":{"seo":{"title":"Fail payment","description":"Fails a payment. Fail payment is a deliberate action that permanently stops the payment and puts it into a non-recoverable state."}},"httpPath":"/payments/{payment_id}/fail"},{"label":"Settle payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/settlepayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/settlepayment","metadata":{"seo":{"title":"Settle payment","description":"Executes a payment in the LOCKED state. Payment senders can also retry settling a payment in the SETTLEMENT_DECLINED state, after the error is corrected (and before the payment expires).Settle payment sends a prepare payment transfer message, which travels to all participants in the payment. This sets the payment state to PREPARED, which means that funds have been transferred to the hold account on that xCurrent ledger. The beneficiary institution then signs the execution_condition (creating a payload) and sends an execute payment transfer message, which travels to all participants in the payment). When the payment is fully executed, funds have been transferred from the hold account to the receiver account on all xCurrent ledgers and the payment state is set to EXECUTED."}},"httpPath":"/payments/{payment_id}/settle"},{"label":"Finalize payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/finalizepayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/finalizepayment","metadata":{"seo":{"title":"Finalize payment","description":"Marks a payment with finalized sub-states that reflect what is happening to the payment while it is in the EXECUTED state. The receiving institution can make this request multiple times to provide a log of each subsequent sub-state until it is ready to make the Complete payment request."}},"httpPath":"/payments/{payment_id}/finalize"},{"label":"Add payment sub state","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/addpaymentsubstate","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/addpaymentsubstate","metadata":{"seo":{"title":"Add payment sub state","description":"Adds a sub-state to a payment that reflects what is happening to the payment while it is in the EXECUTED state. All nodes on the payment chain can make this request multiple times to provide a log of each subsequent sub-state until the receiver is ready to make the Complete payment request.This operation is especially useful for completing cash payouts—sending institutions can add clarifying user information to a payment after it has been executed (and money has been moved). "}},"httpPath":"/payments/{payment_id}/sub_state"},{"label":"Complete payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/completepayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/completepayment","metadata":{"seo":{"title":"Complete payment","description":"Marks a payment as complete by placing it in the COMPLETED state. Typically, the receiving institution makes this request when it has delivered payment funds to the final beneficiary on its internal systems outside of xCurrent."}},"httpPath":"/payments/{payment_id}/complete"},{"label":"Add payment labels","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/addpaymentlabels","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/addpaymentlabels","metadata":{"seo":{"title":"Add payment labels","description":"Adds a list of labels to the payment. To retrieve payments by label, see Get payments."}},"httpPath":"/payments/{payment_id}/labels"},{"label":"Delete payment labels","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/deletepaymentlabels","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/deletepaymentlabels","metadata":{"seo":{"title":"Delete payment labels","description":"Deletes an existing label from a payment. The label you provide is deleted from the labels array in the Payment object."}},"httpPath":"/payments/{payment_id}/labels"},{"label":"Get payment node status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/getpaymentnodestatus","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/getpaymentnodestatus","metadata":{"seo":{"title":"Get payment node status","description":"Senders can query for the RippleNet instances (in a given payment chain) that have payments in the LOCKED state. This information is only stored on the sender's RippleNet instance."}},"httpPath":"/payments/{payment_id}/node-status"},{"label":"Get filtered payment by payment ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/getfilteredpaymentbypaymentid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/getfilteredpaymentbypaymentid","metadata":{"seo":{"title":"Get filtered payment by payment ID","description":"Returns a sanitized payment with sensitive content filtered from the user_info object. Filtering user_info is customizable in rnn.properties. Content that is denylisted by default: /Cdtr, /CdtrAcct, /Dbtr, /DbtrAcct, /InitgPty, /InstForCdtrAgt, /Purp, /RgltryRptg, /RltdRmtInf, /RmtInf, /UltmtCdtr, /UltmtDbtr, /outbound_instructions/beneficiary_info"}},"httpPath":"/payments/filtered/{payment_id}"},{"label":"Create quote to return payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/createquotetoreturnpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/createquotetoreturnpayment","metadata":{"seo":{"title":"Create quote to return payment","description":"Creates a collection of quotes that can be used to return a payment."}},"httpPath":"/quote_collections/return"},{"label":"Create quote to reverse payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/createquotetoreversepayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/non-orchestration-payments/createquotetoreversepayment","metadata":{"seo":{"title":"Create quote to reverse payment","description":"Creates a quote collection containing at most one quote that can be used to reverse a payment."}},"httpPath":"/quote_collections/reversal"}]},{"type":"group","label":"Orchestration payments","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments","items":[{"label":"Create orchestration payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/createorchestrationpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/createorchestrationpayment","metadata":{"seo":{"title":"Create orchestration payment","description":"Creates an orchestration payment."}},"httpPath":"/v4/orchestration/payment"},{"label":"Get orchestration payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/getorchestrationpayments","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/getorchestrationpayments","metadata":{"seo":{"title":"Get orchestration payments","description":"Gets a list of orchestration payments."}},"httpPath":"/v4/orchestration/payment"},{"label":"Get orchestration payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/getorchestrationpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/getorchestrationpayment","metadata":{"seo":{"title":"Get orchestration payment","description":"Gets orchestration payment by unique reference number."}},"httpPath":"/v4/orchestration/payment/{uniqueReferenceNumber}"},{"label":"Return orchestration payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/returnorchestrationpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/returnorchestrationpayment","metadata":{"seo":{"title":"Return orchestration payment","description":"Returns the orchestration payment with customer end-to-end ID."}},"httpPath":"/v4/orchestration/payment/return"},{"label":"Accept orchestration payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/acceptorchestrationpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/acceptorchestrationpayment","metadata":{"seo":{"title":"Accept orchestration payment","description":"Accepts the orchestration payment with customer end-to-end ID and Quote ID."}},"httpPath":"/v4/orchestration/payment/accept"},{"label":"Reverse orchestration payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/reverseorchestrationpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/reverseorchestrationpayment","metadata":{"seo":{"title":"Reverse orchestration payment","description":"Reverses the orchestration payment with customer end-to-end ID."}},"httpPath":"/v4/orchestration/payment/reversal"},{"label":"Get orchestration notifications by status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/getorchestrationpaymentnotifications","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/getorchestrationpaymentnotifications","metadata":{"seo":{"title":"Get orchestration notifications by status","description":"Gets a list of orchestration payment notifications with a given status."}},"httpPath":"/v4/orchestration/payment/notification"},{"label":"Get orchestration notifications by unique reference number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/getorchestrationpaymentnotificationsbyuniquereferencenumber","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/getorchestrationpaymentnotificationsbyuniquereferencenumber","metadata":{"seo":{"title":"Get orchestration notifications by unique reference number","description":"Gets orchestration payment notifications with a given unique reference number."}},"httpPath":"/v4/orchestration/payment/notification/urn/{uniqueReferenceNumber}"},{"label":"Get orchestration notification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/getorchestrationpaymentnotificationbyuuid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/getorchestrationpaymentnotificationbyuuid","metadata":{"seo":{"title":"Get orchestration notification","description":"Gets a given orchestration payment notification by UUID."}},"httpPath":"/v4/orchestration/payment/notification/{uuid}"},{"label":"Acknowledge orchestration notification","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/acknowledgeorchestrationpaymentnotificationbyuuid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/acknowledgeorchestrationpaymentnotificationbyuuid","metadata":{"seo":{"title":"Acknowledge orchestration notification","description":"Acknowledges an orchestration payment notification with a specified UUID."}},"httpPath":"/v4/orchestration/payment/notification/{uuid}/ack"},{"label":"Acknowledge orchestration notifications","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/acknowledgeorchestrationpaymentnotifications","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/acknowledgeorchestrationpaymentnotifications","metadata":{"seo":{"title":"Acknowledge orchestration notifications","description":"Acknowledges multiple orchestration payment notifications using a list of UUIDs."}},"httpPath":"/v4/orchestration/payment/notification/ack"},{"label":"Post action to orchestration payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/sendorchestrationpaymentaction","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/orchestration-payments/sendorchestrationpaymentaction","metadata":{"seo":{"title":"Post action to orchestration payment","description":"Posts action into the Orchestration service."}},"httpPath":"/v4/orchestration/payment/action"}]},{"type":"group","label":"Payment expiration","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration","items":[{"label":"Get payment expiry by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration/getpaymentexpirybyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration/getpaymentexpirybyid","metadata":{"seo":{"title":"Get payment expiry by ID","description":"Gets the time to live (ttl) of a payment expiry in seconds."}},"httpPath":"/config/payments/payment_expiries/{payment_expiry_id}"},{"label":"Update payment expiry","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration/updatepaymentexpiry","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration/updatepaymentexpiry","metadata":{"seo":{"title":"Update payment expiry","description":"Updates the time to live (ttl) of a payment expiry in seconds."}},"httpPath":"/config/payments/payment_expiries/{payment_expiry_id}"},{"label":"Delete payment expiry","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration/deletepaymentexpiry","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration/deletepaymentexpiry","metadata":{"seo":{"title":"Delete payment expiry","description":"Deletes a payment expiry."}},"httpPath":"/config/payments/payment_expiries/{payment_expiry_id}"},{"label":"Get payment expiries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration/getpaymentexpiries","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration/getpaymentexpiries","metadata":{"seo":{"title":"Get payment expiries","description":"Returns all configured payment expiries."}},"httpPath":"/config/payments/payment_expiries"},{"label":"Create payment expiry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration/createpaymentexpiry","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payment-expiration/createpaymentexpiry","metadata":{"seo":{"title":"Create payment expiry","description":"Creates a payment expiration window, or time to live (ttl), in seconds."}},"httpPath":"/config/payments/payment_expiries"}]},{"type":"group","label":"Payout method","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method","items":[{"label":"Create payout method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/createpayoutmethod","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/createpayoutmethod","metadata":{"seo":{"title":"Create payout method","description":"Creates a payout method (for example, LOCAL_RAILS). The Payout Method API lets receivers create and manage payout methods. Senders can generate quotes based on these receiver payout methods by enabling the flag enable_quote_per_payout_method in the body of the [Create quote collection] request. Caution: The existing quote parameter is named payment_method while elsewhere it is payout_method.Note: On-Demand Liquidity (ODL) receivers should set payment_method to the outlet_id or the string none (not an empty value) to keep funds at the destination exchange when paying out to a local rail."}},"httpPath":"/config/payout_methods"},{"label":"Get payout methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/getpayoutmethods","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/getpayoutmethods","metadata":{"seo":{"title":"Get payout methods","description":"Returns a list of payout methods created by a receiving partner."}},"httpPath":"/config/payout_methods"},{"label":"Get payout method by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/getpayoutmethodbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/getpayoutmethodbyid","metadata":{"seo":{"title":"Get payout method by ID","description":"Returns a payout method by its ID."}},"httpPath":"/config/payout_methods/{payout_method_id}"},{"label":"Update payout method","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/updatepayoutmethod","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/updatepayoutmethod","metadata":{"seo":{"title":"Update payout method","description":"Updates a payout method."}},"httpPath":"/config/payout_methods/{payout_method_id}"},{"label":"Delete payout method","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/deletepayoutmethod","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/deletepayoutmethod","metadata":{"seo":{"title":"Delete payout method","description":"Deletes a payout method."}},"httpPath":"/config/payout_methods/{payout_method_id}"},{"label":"Get all categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/getallcategories","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/payout-method/getallcategories","metadata":{"seo":{"title":"Get all categories","description":"Returns all the payout method categories."}},"httpPath":"/config/payout_methods/categories"}]},{"type":"group","label":"Platform accounts","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts","items":[{"label":"Create platform","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/createplatform","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/createplatform","metadata":{"seo":{"title":"Create platform","description":"Creates a RippleNet platform, which represents a financial entity that holds accounts in the real world (e.g. Bank, Exchange or Wallet provider). This operation creates a database record for a platform account on a RippleNet node."}},"httpPath":"/config/platforms"},{"label":"Get all platforms","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getallplatforms","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getallplatforms","metadata":{"seo":{"title":"Get all platforms","description":"Returns a list of all active RippleNet platforms."}},"httpPath":"/config/platforms"},{"label":"Get platform by platform ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getplatformbyplatformid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getplatformbyplatformid","metadata":{"seo":{"title":"Get platform by platform ID","description":"Get a RippleNet platform by its platform ID."}},"httpPath":"/config/platforms/{platform_id}"},{"label":"Update platform","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/updateplatform","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/updateplatform","metadata":{"seo":{"title":"Update platform","description":"Updates a RippleNet platform, which represents a financial entity that holds accounts in the real world (e.g. Bank, Exchange or Wallet provider). This operation creates a database record for a platform account on a RippleNet node."}},"httpPath":"/config/platforms/{platform_id}"},{"label":"Delete platform by platform ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/deleteplatformbyplatformid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/deleteplatformbyplatformid","metadata":{"seo":{"title":"Delete platform by platform ID","description":"Deletes a RippleNet platform by its platform ID."}},"httpPath":"/config/platforms/{platform_id}"},{"label":"Create platform account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/createplatformaccount","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/createplatformaccount","metadata":{"seo":{"title":"Create platform account","description":"Creates a RippleNet platform account, which represents a real-world account owned by a financial entity (e.g. Bank, Exchange or Wallet provider). This operation creates a database record for a platform account on a RippleNet node."}},"httpPath":"/config/platforms/accounts"},{"label":"Get platform accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getplatformaccounts","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getplatformaccounts","metadata":{"seo":{"title":"Get platform accounts","description":"Returns a paged list of all active RippleNet platform accounts."}},"httpPath":"/config/platforms/accounts"},{"label":"Get platform account by platform account ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getplatformaccountbyplatformaccountid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getplatformaccountbyplatformaccountid","metadata":{"seo":{"title":"Get platform account by platform account ID","description":"Gets a RippleNet platform account by its platform account ID."}},"httpPath":"/config/platforms/accounts/{platform_account_id}"},{"label":"Update platform account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/updateplatformaccount","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/updateplatformaccount","metadata":{"seo":{"title":"Update platform account","description":"Updates a RippleNet platform account, which represents a real-world account owned by a financial entity (e.g. Bank, Exchange or Wallet provider)."}},"httpPath":"/config/platforms/accounts/{platform_account_id}"},{"label":"Delete platform account by platform account ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/deleteplatformaccountbyplatformaccountid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/deleteplatformaccountbyplatformaccountid","metadata":{"seo":{"title":"Delete platform account by platform account ID","description":"Deletes a RippleNet platform account by its platform account ID."}},"httpPath":"/config/platforms/accounts/{platform_account_id}"},{"label":"Get platform accounts balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getplatformaccountsbalances","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getplatformaccountsbalances","metadata":{"seo":{"title":"Get platform accounts balances","description":"Get balances for local Platform Accounts"}},"httpPath":"/monitor/platform/accounts/balances"},{"label":"Get platform account statement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getplatformaccountstatement","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/platform-accounts/getplatformaccountstatement","metadata":{"seo":{"title":"Get platform account statement","description":"Get statement for a specified Platform Account"}},"httpPath":"/monitor/platform/accounts/{platformAccountId}/statement"}]},{"type":"group","label":"Pool accounts","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/pool-accounts","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/pool-accounts","items":[{"label":"Get all pool accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/pool-accounts/getallpoolaccounts","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/pool-accounts/getallpoolaccounts","metadata":{"seo":{"title":"Get all pool accounts","description":"Returns a list of all pool accounts on a RippleNet node."}},"httpPath":"/config/pool_accounts"},{"label":"Get pool account by pool account ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/pool-accounts/getpoolaccountbypoolaccountid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/pool-accounts/getpoolaccountbypoolaccountid","metadata":{"seo":{"title":"Get pool account by pool account ID","description":"Get a pool account by its pool account ID."}},"httpPath":"/config/pool_accounts/{pool_account_id}"}]},{"type":"group","label":"Quote expiration","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quote-expiration","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quote-expiration","items":[{"label":"List quote expiries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quote-expiration/getquoteexpiries","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quote-expiration/getquoteexpiries","metadata":{"seo":{"title":"List quote expiries","description":"Returns all configured quote expiries."}},"httpPath":"/config/payments/quote_expiries"},{"label":"Create quote expiry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quote-expiration/createquoteexpiry","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quote-expiration/createquoteexpiry","metadata":{"seo":{"title":"Create quote expiry","description":"Creates a quote expiration window, or time to live (ttl), in seconds."}},"httpPath":"/config/payments/quote_expiries"},{"label":"Get quote expiry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quote-expiration/getquoteexpirybyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quote-expiration/getquoteexpirybyid","metadata":{"seo":{"title":"Get quote expiry","description":"Gets the time to live (ttl) of a quote expiry in seconds."}},"httpPath":"/config/payments/quote_expiries/{quote_expiry_id}"},{"label":"Update quote expiry","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quote-expiration/updatequoteexpiry","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quote-expiration/updatequoteexpiry","metadata":{"seo":{"title":"Update quote expiry","description":"Updates the time to live (ttl) of a quote expiry in seconds."}},"httpPath":"/config/payments/quote_expiries/{quote_expiry_id}"}]},{"type":"group","label":"Quotes","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes","items":[{"label":"Accept quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes/acceptquote","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes/acceptquote","metadata":{"seo":{"title":"Accept quote","description":"Accepts a quote ID to start the payment process."}},"httpPath":"/payments/accept"},{"label":"Get quotes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes/getquotes","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes/getquotes","metadata":{"seo":{"title":"Get quotes","description":"Gets a list of quotes."}},"httpPath":"/quotes"},{"label":"Get quote by quote ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes/getquotebyquoteid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes/getquotebyquoteid","metadata":{"seo":{"title":"Get quote by quote ID","description":"Gets a quote by ID."}},"httpPath":"/quotes/{quote_id}"},{"label":"Create quote collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes/createquotecollection","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes/createquotecollection","metadata":{"seo":{"title":"Create quote collection","description":"Creates a collection of quotes for a proposed payment."}},"httpPath":"/quote_collections"},{"label":"Get quote collection by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes/getquotecollectionbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/quotes/getquotecollectionbyid","metadata":{"seo":{"title":"Get quote collection by ID","description":"Gets a quote collection that was created for a proposed payment."}},"httpPath":"/quote_collections/{quote_collection_id}"}]},{"type":"group","label":"Rates","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/rates","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/rates","items":[{"label":"Get rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/getrates","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/getrates","metadata":{"seo":{"title":"Get rates","description":"Gets a list of configured exchange rates."}},"httpPath":"/config/rates"},{"label":"Create rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/createrate","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/createrate","metadata":{"seo":{"title":"Create rate","description":"Creates an exchange rate for a specified currency pair."}},"httpPath":"/config/rates"},{"label":"Get rate by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/getratebyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/getratebyid","metadata":{"seo":{"title":"Get rate by ID","description":"Gets a configured exchange rate by ID."}},"httpPath":"/config/rates/{rate_id}"},{"label":"Update rate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/updaterate","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/updaterate","metadata":{"seo":{"title":"Update rate","description":"Updates an existing exchange rate. With this call, you can change value_type from RATE to MARGIN (and vice versa), change the actual rate value of the specified value type, or both."}},"httpPath":"/config/rates/{rate_id}"},{"label":"Delete rate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/deleterate","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/rates/deleterate","metadata":{"seo":{"title":"Delete rate","description":"Deletes an exchange rate. Once deleted, an exchange rate cannot be accessed."}},"httpPath":"/config/rates/{rate_id}"}]},{"type":"group","label":"Request for payment","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment","items":[{"label":"Get requests for payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment/getrequestsforpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment/getrequestsforpayment","metadata":{"seo":{"title":"Get requests for payment","description":"Gets requests for payment that match the query parameters."}},"httpPath":"/request_for_payment"},{"label":"Send request for payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment/sendrequestforpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment/sendrequestforpayment","metadata":{"seo":{"title":"Send request for payment","description":"Sends a new request for payment."}},"httpPath":"/request_for_payment"},{"label":"Get request for payment by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment/getrequestforpaymentbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment/getrequestforpaymentbyid","metadata":{"seo":{"title":"Get request for payment by ID","description":"Gets a request for payment by request for payment ID."}},"httpPath":"/request_for_payment/{request_for_payment_id}"},{"label":"Accept request for payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment/acceptrequestforpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment/acceptrequestforpayment","metadata":{"seo":{"title":"Accept request for payment","description":"Accepts a request for payment."}},"httpPath":"/request_for_payment/{request_for_payment_id}/accept"},{"label":"Fail request for payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment/failrequestforpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/request-for-payment/failrequestforpayment","metadata":{"seo":{"title":"Fail request for payment","description":"Fails a request for payment."}},"httpPath":"/request_for_payment/{request_for_payment_id}/fail"}]},{"type":"group","label":"Transfers","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers","items":[{"label":"Get transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/gettransfers","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/gettransfers","metadata":{"seo":{"title":"Get transfers","description":"Gets a list of transfers."}},"httpPath":"/transfers"},{"label":"Get transfer estimate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/gettransferestimate","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/gettransferestimate","metadata":{"seo":{"title":"Get transfer estimate","description":"Get an estimate of the fee to make an \"outbound\" transfer from an exchange (connected to xRapid) to an another account outside of RippleNet (such as a bank account). This operation is only available to xCurrent instances enabled as receivers of xRapid payments."}},"httpPath":"/transfers/estimate"},{"label":"Get transfer by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/gettransferbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/gettransferbyid","metadata":{"seo":{"title":"Get transfer by ID","description":"Gets a transfer by ID."}},"httpPath":"/transfers/{transfer_id}"},{"label":"Execute transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/executetransfer","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/executetransfer","metadata":{"seo":{"title":"Execute transfer","description":"Transfers funds between accounts. For example, use this request to fund a connector account by transferring funds from a transactional account to the connector account. You can also use this request to redeem funds to a transactional account by transferring funds from a connector account to the transactional account."}},"httpPath":"/transfers/execute"},{"label":"Complete transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/completetransfer","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/completetransfer","metadata":{"seo":{"title":"Complete transfer","description":"Updates the state of a transfer to COMPLETED. Make this request once the transfer has been made on both the ledger and on internal systems."}},"httpPath":"/transfers/{transfer_id}/complete"},{"label":"Add transfer labels","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/addtransferlabels","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/addtransferlabels","metadata":{"seo":{"title":"Add transfer labels","description":"Adds a list of labels to the transfer. To retrieve transfers by label, see [Get transfers][get-transfers]."}},"httpPath":"/transfers/{transfer_id}/labels"},{"label":"Delete transfer labels","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/deletetransferlabels","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/deletetransferlabels","metadata":{"seo":{"title":"Delete transfer labels","description":"Deletes one or more existing labels from the transfer."}},"httpPath":"/transfers/{transfer_id}/labels"}]}],"metadata":{"type":"openapi","title":"RippleNet Server API","version":"4.0.0","description":"The {% $env.PUBLIC_VAR_RNSERVER %} API provides you the ability to develop custom applications to manage or interact with your RippleNet instance.\n\nCheck out the [best practices](../../ripplenet/best-practices/) and [tutorials](../../ripplenet/tutorials/).\n\n### Authentication\n\nAll API operations require a bearer access token for your target environment.<br>Learn how to [request the access token](../best-practices/authentication/#request-the-access-token).\n\n### API environments\n\nThe RippleNet Server API creates a dynamic `[domainPrefix]` that consists of `{tenant}.{environment}`.\n\n**Note**: This example uses `aperture` as the tenant. Your tenant ID is different.\n\n| Environment  | Domaing Prefix | Domain | Base URL |\n| --- | --- | --- | --- |\n| Test | `aperture.test` | `ripplexcurrent.com`| `https://aperture.test.ripplexcurrent.com` |\n| UAT | `aperture.uat` | `ripplexcurrent.com`| `https://aperture.uat.ripplexcurrent.com` |\n| Production | `aperture.prod` | `ripplexcurrent.com`| `https://aperture.prod.ripplexcurrent.com` |"}},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/smart_liquidation/reference/openapi.yaml","link":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi","routeSlug":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi","label":"Smart Liquidation Service API","items":[{"type":"link","label":"Authentication","link":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/section/authentication","routeSlug":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/section/authentication"},{"type":"link","label":"API environments","link":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/section/api-environments","routeSlug":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/section/api-environments"},{"type":"group","label":"Liquidations","link":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations","routeSlug":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations","items":[{"type":"link","label":"Authentication with Smart Liquidation Service","link":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/authentication-with-smart-liquidation-service","routeSlug":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/authentication-with-smart-liquidation-service"},{"type":"link","label":"Domain prefixes with Smart Liquidation Service","link":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/domain-prefixes-with-smart-liquidation-service","routeSlug":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/domain-prefixes-with-smart-liquidation-service"},{"label":"Get liquidations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/getliquidations","routeSlug":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/getliquidations","metadata":{"seo":{"title":"Get liquidations","description":"List all liquidations by date range"}},"httpPath":"/liquidations"},{"label":"Get liquidation by Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/getliquidationbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/getliquidationbyid","metadata":{"seo":{"title":"Get liquidation by Id","description":"Get a specific liquidation by its unique Id value"}},"httpPath":"/liquidations/{id}"},{"label":"Get liquidations by payment Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/getliquidationsbyripplenetpaymentid","routeSlug":"/pt-br/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/getliquidationsbyripplenetpaymentid","metadata":{"seo":{"title":"Get liquidations by payment Id","description":"Get a list of liquidations associated with a ripplenet_payment_id"}},"httpPath":"/liquidations/ripplenet-payment-id/{ripplenet_payment_id}"}]}],"metadata":{"type":"openapi","title":"Smart Liquidation API","version":"1.0.0","description":"The {% $env.PUBLIC_VAR_SL %} service splits large XRP liquidations into smaller liquidations over a specified time period. For more information, see [Smart Liquidation](../../ripplenet/system-components/liquidation/smart-liquidation/).\n\nCheck out the [best practices](../../ripplenet/best-practices/) and [tutorials](../../ripplenet/tutorials/).\n\n### Authentication\n\nAll API operations require a bearer access token for your target environment.<br>Learn how to [request the access token](../../ripplenet/best-practices/authentication/).\n\n### API environments\n\nThe {% $env.PUBLIC_VAR_SLAPI %} assigns a `[domainPrefix]` based on the environment. Your tenant information is automatically derived from your API credentials. \n\n| Environment  | Domain Prefix |\tDomain | Base URL|\n| --- | --- | --- | --- |\n| Test | `liquidation-test.pub.prod` | `ripplenet.com` | <div style=\"font-size: 13px;font-family:'Red Hat Mono'; !important\">`liquidation-test.pub.prod.ripplenet.com`</div> |\n| Production | `liquidation.pub.prod` | `ripplenet.com` | `liquidation.pub.prod.ripplenet.com` |\n\nFor more information about base URLs, see [API base URLs](/products/payments-odl/api-docs/ripplenet/best-practices/baseurls/)."}},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/report_service/reference/openapi.yaml","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi","label":"Reports API","items":[{"type":"link","label":"Report types","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/report-types","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/report-types"},{"type":"link","label":"Basic payment report","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/basic-payment-report","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/basic-payment-report"},{"type":"link","label":"Reconciliation report","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/reconciliation-report","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/reconciliation-report"},{"type":"link","label":"Failure conversion & SSA report","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/failure-conversion-and-ssa-report","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/failure-conversion-and-ssa-report"},{"type":"link","label":"Report availability","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/report-availability","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/report-availability"},{"type":"link","label":"Example: Report availability","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/example:-report-availability","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/example:-report-availability"},{"type":"link","label":"API operations","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/api-operations","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/api-operations"},{"type":"link","label":"Authentication","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/authentication","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/authentication"},{"type":"link","label":"Environments","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/environments","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/section/environments"},{"type":"group","label":"Reports","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/reports","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/reports","items":[{"label":"List reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports","metadata":{"seo":{"title":"List reports","description":"Returns an array of reports available for download. Each array element represents an available report, and contains the reportId, reportType, and reportFormat fields associated with that report."}},"httpPath":"/v1/reports"},{"label":"Create report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/reports/postreport","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/reports/postreport","metadata":{"seo":{"title":"Create report","description":"Request the generation of a custom report based on the specified parameters."}},"httpPath":"/v1/reports"},{"label":"Get a report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport","metadata":{"seo":{"title":"Get a report","description":"Here, you apply the report-id from the List reports operation as the path parameter to get a downloadlink containing the report."}},"httpPath":"/v1/reports/{report-id}"},{"label":"Delete reports","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/reports/deletereport","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/reports/deletereport","metadata":{"seo":{"title":"Delete reports","description":"Delete a specific report with the report-id path parameter."}},"httpPath":"/v1/reports/{report-id}"},{"label":"Download a report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreportdownload","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreportdownload","metadata":{"seo":{"title":"Download a report","description":"Download a transaction report. Download the report by applying the report-id from the List reports operation as a path parameter."}},"httpPath":"/v1/reports/download/{report-id}"}]},{"type":"group","label":"Report data fields","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields","items":[{"type":"link","label":"Payment operations","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/paymentopsreporttransaction","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/paymentopsreporttransaction","httpVerb":"schema"},{"type":"link","label":"Reconciliation","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/reconciliationreporttransaction","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/reconciliationreporttransaction","httpVerb":"schema"},{"type":"link","label":"Failure conversion & SSA","link":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/failureconversionssatransaction","routeSlug":"/pt-br/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/failureconversionssatransaction","httpVerb":"schema"}]}],"metadata":{"type":"openapi","title":"Report Service API","description":"The Report Service API provides an efficient and secure way to download On-Demand Liquidity (ODL) payment transactions on the RippleNet network.\n\n## Report types\n\n  Three report types are available in either CSV or JSON format when performing a [List reports](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports) operation:\n\n  | Report type | Description |\n  | :--- | :--- |\n  | `PAYMENT_OPS` | This is a *Basic payment report* suitable for high-level payment investigation and reporting. |\n  | `RECON` | This is a *Reconciliation report* suitable for reconciliation and detailed state-by-state investigation. |\n  | `FAILURE_CONVERSION_SSA` | This is a *Failure conversion & SSA report* suitable for failed payments investigation. |\n\n**Note**: These On-Demand Liquidity (ODL) statement reports do not include data on fiat payments in RippleNet.\n\n### Basic payment report\n\nThe Basic payment report (`PAYMENT_OPS`) provides basic payment data, but not the transaction data within payments.\n\nView the [Payment operations reports data fields](/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/paymentopsreporttransaction).\n\n### Reconciliation report\n\nThe Reconciliation report (`RECON`) includes all basic payment data, and also includes trade and liquidation data that may be associated with a payment.\n\nA single payment with multiple transactions appears in multiple lines, one line per transaction. Each line includes data that has occurred during the transaction, and all subordinate transactions share the same Payment ID.\n\nView the [Reconciliation reports data fields](/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/reconciliationreporttransaction).\n\n### Failure conversion & SSA report\n\nThe Failure conversion & SSA report (`FAILURE_CONVERSION_SSA`) includes failed payments data.\n  \nView the [Failure conversion & SSA report data fields](/products/payments-odl/api-docs/report_service/reference/openapi/report-data-fields/failureconversionssatransaction).\n  \n### Report availability\n\nReports are available in pre-generated formats for the previous two months and the current month-to-date.\n\nThe month-to-date report is generated daily at 00:00 AM (UTC) and is generally available one minute later, at 00:01 AM.\n\n#### Example: Report availability\n\nOn October 16th, you can get:\n  * Full month reports for August and September.\n  * A month-to-date report from October 1st to October 16th.\n\n| Month | Example | Description |\n| --- | --- | --- |\n| Current | October 1, 2022 to<br/>October 16, 2022 at 00:00 AM | Includes ODL payment data from the first day of the current month up to 00:00 AM (UTC) of the current day. |\n| Previous  | September<br/>(If the current month is October) | Includes all ODL payment data for the month preceding the current month. |\n| Month Before Last| August<br/>(If the current month is October) | Includes all ODL payment data from the month preceding the last month.  |\n\n\n### API operations\n\nUse these operations to view a list of reports, or download a specific report.\n\n  | API operation | Description |\n  | --- | --- |\n  | [List reports](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreports) | View a list of available reports. |\n  | [Create a report](/products/payments-odl/api-docs/report_service/reference/openapi/reports/postreport) | Create a report. |\n  | [Get a report](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport) | View a specific report. |\n  | [Delete a report](/products/payments-odl/api-docs/report_service/reference/openapi/reports/deletereport) | Delete a specific report. |\n  | [Download a report](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreportdownload) | Download an individual report in JSON or CSV format. |\n\n## Authentication\n\nTo use any API operation you need a valid access token. You must include a valid access token in the `Authorization` header of each request.\n\nFor more information about getting an access token, see [Authentication](/products/payments-odl/api-docs/ripplenet/best-practices/authentication/#request-the-access-token).\n\n### Environments\n\nYou can use the Report Service API with the test and production environments by using different base URLs.\n\n<table style=\"table;table-layout: fixed; width: 100%\">\n<colgroup><col style=\"width: 15%\"><col style=\"width: 45%\"><col style=\"width: 45%\"></colgroup>\n<thead>\n  <tr>\n    <th>Environment</th>\n    <th>Base URL</th>\n    <th>Description</th>\n  </tr>\n</thead>\n<tbody>\n  <tr>\n    <td>Test</td>\n    <td><code>reporting-test.rnc.ripplenet.com</code></td>\n    <td>Test environment with simulated partners and simulated currency.</td>\n  </tr>\n  <tr>\n    <td>Production</td>\n    <td><code>reporting.rnc.ripplenet.com</code></td>\n    <td>Production environment with actual partners and actual currency.</td>\n  </tr>\n</tbody>\n</table>\n"}}]},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/best-practices.md","metadata":{"type":"markdown"},"label":"Best practices","link":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/best-practices/authentication.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/authentication","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/authentication"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/best-practices/webhooks.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/webhooks","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/webhooks"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/best-practices/polling-basic.md","metadata":{"type":"markdown"},"label":"Polling","link":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/polling-basic","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/polling-basic"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/best-practices/pagination.md","metadata":{"type":"markdown"},"label":"Pagination","link":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/pagination","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/pagination"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/best-practices/baseurls.md","metadata":{"type":"markdown"},"label":"API base URLs","link":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/baseurls","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/baseurls"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/best-practices/ip-allowlisting.md","metadata":{"type":"markdown"},"label":"IP allowlisting","link":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/ip-allowlisting","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/ip-allowlisting"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/best-practices/onward-forwarding.md","metadata":{"type":"markdown"},"label":"Onward forwarding","link":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/onward-forwarding","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/onward-forwarding"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/best-practices/payment-substates.md","metadata":{"type":"markdown"},"label":"Payment sub-states","link":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/payment-substates","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/payment-substates"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/best-practices/fees.md","metadata":{"type":"markdown"},"label":"Fees","link":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/fees","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/best-practices/fees/fees-charging-model.md","metadata":{"type":"markdown"},"label":"Fees charging model","link":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/fees/fees-charging-model","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/fees/fees-charging-model"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/best-practices/fees/fees-use-cases.md","metadata":{"type":"markdown"},"label":"Fees use cases","link":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/fees/fees-use-cases","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/fees/fees-use-cases"}],"routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/best-practices/fees"}]},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources.md","metadata":{"type":"markdown"},"label":"Developer Resources","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/error-handling.md","metadata":{"type":"markdown"},"label":"Error handling","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/error-handling","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/error-handling"},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/error-codes.md","metadata":{"type":"markdown"},"label":"Error codes","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/error-codes","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/error-codes","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/error-codes/ripplenet-server-error-codes.md","metadata":{"type":"markdown"},"label":"RippleNet Server error codes","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/error-codes/ripplenet-server-error-codes","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/error-codes/ripplenet-server-error-codes"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/error-codes/on-demand-liquidity-error-codes.md","metadata":{"type":"markdown"},"label":"On-Demand Liquidity error codes","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/error-codes/on-demand-liquidity-error-codes","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/error-codes/on-demand-liquidity-error-codes"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/error-codes/returns-and-error-codes.md","metadata":{"type":"markdown"},"label":"Returns and failure codes","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/error-codes/returns-and-error-codes","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/error-codes/returns-and-error-codes"}]},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/outbound-instructions.md","metadata":{"type":"markdown"},"label":"Outbound instructions","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/outbound-instructions","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/outbound-instructions","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/amend-outbound-instructions.md","metadata":{"type":"markdown"},"label":"Amend outbound instructions","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/amend-outbound-instructions","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/amend-outbound-instructions"}]},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object.md","metadata":{"type":"markdown"},"label":"Standard RippleNet Payment Object (SRPO)","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/use-cases.md","metadata":{"type":"markdown"},"label":"Use cases","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/use-cases","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/use-cases"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/user-info.md","metadata":{"type":"markdown"},"label":"User info section","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/user-info","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/user-info"},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties.md","metadata":{"type":"markdown"},"label":"Supporting info properties","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/cdtr.md","metadata":{"type":"markdown"},"label":"Cdtr","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/cdtr","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/cdtr"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/cdtracct.md","metadata":{"type":"markdown"},"label":"CdtrAcct","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/cdtracct","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/cdtracct"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/cdtragt.md","metadata":{"type":"markdown"},"label":"CdtrAgt","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/cdtragt","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/cdtragt"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/cdtrrefinf.md","metadata":{"type":"markdown"},"label":"CdtrRefInf","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/cdtrrefinf","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/cdtrrefinf"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/chrgbr.md","metadata":{"type":"markdown"},"label":"ChrgBr","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/chrgbr","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/chrgbr"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/dbtr.md","metadata":{"type":"markdown"},"label":"Dbtr","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/dbtr","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/dbtr"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/dbtracct.md","metadata":{"type":"markdown"},"label":"DbtrAcct","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/dbtracct","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/dbtracct"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/dbtragt.md","metadata":{"type":"markdown"},"label":"DbtrAgt","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/dbtragt","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/dbtragt"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/dbtragtacct.md","metadata":{"type":"markdown"},"label":"DbtrAgtAcct","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/dbtragtacct","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/dbtragtacct"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/grnshmtrmt.md","metadata":{"type":"markdown"},"label":"GrnshmtRmt","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/grnshmtrmt","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/grnshmtrmt"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/initgpty.md","metadata":{"type":"markdown"},"label":"InitgPty","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/initgpty","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/initgpty"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/instforcdtragt.md","metadata":{"type":"markdown"},"label":"InstForCdtrAgt","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/instforcdtragt","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/instforcdtragt"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/invcee.md","metadata":{"type":"markdown"},"label":"Invcee","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/invcee","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/invcee"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/invcr.md","metadata":{"type":"markdown"},"label":"Invcr","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/invcr","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/invcr"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/orgid.md","metadata":{"type":"markdown"},"label":"OrgId","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/orgid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/orgid"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/pmtid.md","metadata":{"type":"markdown"},"label":"PmtId","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/pmtid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/pmtid"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/pmttpinf.md","metadata":{"type":"markdown"},"label":"PmtTpInf","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/pmttpinf","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/pmttpinf"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/prvtid.md","metadata":{"type":"markdown"},"label":"PrvtId","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/prvtid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/prvtid"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/purp.md","metadata":{"type":"markdown"},"label":"Purp","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/purp","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/purp"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/return_reasons.md","metadata":{"type":"markdown"},"label":"return_reasons","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/return_reasons","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/return_reasons"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/rfrddocamt.md","metadata":{"type":"markdown"},"label":"RfrdDocAmt","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/rfrddocamt","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/rfrddocamt"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/rfrddocinf.md","metadata":{"type":"markdown"},"label":"RfrdDocInf","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/rfrddocinf","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/rfrddocinf"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/rgltryrptg.md","metadata":{"type":"markdown"},"label":"RgltryRptg","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/rgltryrptg","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/rgltryrptg"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/rltdrmtinf.md","metadata":{"type":"markdown"},"label":"RltdRmtInf","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/rltdrmtinf","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/rltdrmtinf"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/rmtinf.md","metadata":{"type":"markdown"},"label":"RmtInf","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/rmtinf","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/rmtinf"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/taxrmt.md","metadata":{"type":"markdown"},"label":"TaxRmt","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/taxrmt","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/taxrmt"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/ultmtcdtr.md","metadata":{"type":"markdown"},"label":"UltmtCdtr","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/ultmtcdtr","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/ultmtcdtr"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/ultmtdbtr.md","metadata":{"type":"markdown"},"label":"UltmtDbtr","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/ultmtdbtr","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-properties/ultmtdbtr"}]},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions.md","metadata":{"type":"markdown"},"label":"Supporting info definitions","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/account_id.md","metadata":{"type":"markdown"},"label":"account_id","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/account_id","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/account_id"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/account_name.md","metadata":{"type":"markdown"},"label":"account_name","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/account_name","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/account_name"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/account_type.md","metadata":{"type":"markdown"},"label":"account_type","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/account_type","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/account_type"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/address.md","metadata":{"type":"markdown"},"label":"address","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/address","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/address"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/bic.md","metadata":{"type":"markdown"},"label":"bic","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/bic","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/bic"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/branch_id.md","metadata":{"type":"markdown"},"label":"branch_id","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/branch_id","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/branch_id"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/contact_details.md","metadata":{"type":"markdown"},"label":"contact_details","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/contact_details","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/contact_details"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/country.md","metadata":{"type":"markdown"},"label":"country","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/country","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/country"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/currency.md","metadata":{"type":"markdown"},"label":"currency","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/currency","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/currency"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/external_account_id.md","metadata":{"type":"markdown"},"label":"external_account_id","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/external_account_id","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/external_account_id"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/externalcashaccount.md","metadata":{"type":"markdown"},"label":"externalcashaccount","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/externalcashaccount","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/externalcashaccount"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/externalclearingsystem.md","metadata":{"type":"markdown"},"label":"externalclearingsystem","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/externalclearingsystem","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/externalclearingsystem"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/financial_institution.md","metadata":{"type":"markdown"},"label":"financial_institution","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/financial_institution","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/financial_institution"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/fullname.md","metadata":{"type":"markdown"},"label":"fullname","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/fullname","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/fullname"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/iban.md","metadata":{"type":"markdown"},"label":"iban","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/iban","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/iban"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/id_section.md","metadata":{"type":"markdown"},"label":"id_section","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/id_section","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/id_section"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/levelofpurpose.md","metadata":{"type":"markdown"},"label":"levelofpurpose","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/levelofpurpose","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/levelofpurpose"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/name.md","metadata":{"type":"markdown"},"label":"name","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/name","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/name"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/phone_number.md","metadata":{"type":"markdown"},"label":"phone_number","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/phone_number","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/phone_number"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/sourceofcash.md","metadata":{"type":"markdown"},"label":"SourceOfCash","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/sourceofcash","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-definitions/sourceofcash"}]},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-full-json-schema.md","metadata":{"type":"markdown"},"label":"Supporting info full JSON schema","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-full-json-schema","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-full-json-schema"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/srpo/mt103-mapping.md","metadata":{"type":"markdown"},"label":"MT103 mapping","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/mt103-mapping","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/srpo/mt103-mapping"}]},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/resources/ripplenet-addressing-scheme.md","metadata":{"type":"markdown"},"label":"RippleNet addressing scheme","link":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/ripplenet-addressing-scheme","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/resources/ripplenet-addressing-scheme"}]},{"type":"separator","separatorLine":true},{"type":"separator","label":"Resources"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/change-history.md","metadata":{"type":"markdown"},"label":"Change history","link":"/pt-br/products/payments-odl/change-history","routeSlug":"/pt-br/products/payments-odl/change-history"},{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/glossary.md","metadata":{"type":"markdown"},"label":"Glossary","link":"/pt-br/products/payments-odl/glossary","routeSlug":"/pt-br/products/payments-odl/glossary"},{"type":"group","fsPath":"@l10n/pt-BR/products/payments-odl/user-interface/support.md","metadata":{"type":"markdown"},"label":"Support","link":"/pt-br/products/payments-odl/user-interface/support","routeSlug":"/pt-br/products/payments-odl/user-interface/support","items":[{"type":"link","fsPath":"@l10n/pt-BR/products/payments-odl/resources/pdf-downloads.md","metadata":{"type":"markdown"},"label":"PDF downloads","link":"/pt-br/products/payments-odl/resources/pdf-downloads","routeSlug":"/pt-br/products/payments-odl/resources/pdf-downloads"}]}]}