{"items":[{"type":"link","label":"RippleNet Server API","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","content":{"contentType":"overview","meta":{"name":"RippleNet Server API"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"RippleNet Server API (4.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":{"$$mdtype":"Variable","path":["env","PUBLIC_VAR_RNSERVER"]}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API provides you the ability to develop custom applications to manage or interact with your RippleNet instance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check out the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../ripplenet/best-practices/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"best practices"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../ripplenet/tutorials/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tutorials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet"}],"sectionId":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API operations require a bearer access token for your target environment."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn how to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../best-practices/authentication/#request-the-access-token"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request the access token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/api-environments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API environments"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RippleNet Server API creates a dynamic "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[domainPrefix]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that consists of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{tenant}.{environment}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This example uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aperture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the tenant. Your tenant ID is different."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domaing Prefix"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base URL"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aperture.test"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ripplexcurrent.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://aperture.test.ripplexcurrent.com"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UAT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aperture.uat"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ripplexcurrent.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://aperture.uat.ripplexcurrent.com"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aperture.prod"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ripplexcurrent.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://aperture.prod.ripplexcurrent.com"},"children":[]}]}]}]}]}]}]}],"sectionId":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/section/api-environments"}]}]}},{"type":"link","label":"Authentication","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/section/authentication","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/section/authentication","content":null},{"type":"link","label":"API environments","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/section/api-environments","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/section/api-environments","content":null},{"type":"group","label":"Account configuration","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/account-configuration","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/account-configuration","items":[{"label":"Get accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/account-configuration/getaccounts","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/account-configuration/getaccounts","metadata":{"seo":{"title":"Get accounts","description":"Gets a list of all accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccounts","name":"Get accounts","isWebhook":false,"pointer":"/paths/~1config~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of all accounts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"account_names","in":"query","schemaId":"schema_0","description":"List of account names provided as a search query."},{"name":"balance","in":"query","schemaId":"schema_1","description":"Balance value filter."},{"name":"balance_upper_limit","in":"query","schemaId":"schema_1","description":"Balance upper limit when using the BETWEEN range operator"},{"name":"balance_range_operator","in":"query","schemaId":"schema_2","description":"Operator to filter balance by range."},{"name":"disabled","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns disabled accounts by default. To hide disabled accounts, set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"owner","in":"query","schemaId":"schema_4","description":"Ripplenet address of the owner of the account."},{"name":"currency","in":"query","schemaId":"schema_4","description":"Currency filter to apply on accounts. Must be in uppercase."},{"name":"sort_field","in":"query","schemaId":"schema_5","description":"Attribute for how to sort the results."},{"name":"sort_direction","in":"query","schemaId":"schema_6","description":"Direction of sorted results."},{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of objects to return per page."},{"name":"external_account_ids","in":"query","schemaId":"schema_0","description":"List of external account IDs provided as a search query."}],"pointer":"/paths/~1config~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/accounts","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"account_names","in":"query","required":false,"schemaId":"schema_0","explode":true},{"name":"balance","in":"query","required":false,"schemaId":"schema_1"},{"name":"balance_upper_limit","in":"query","required":false,"schemaId":"schema_1"},{"name":"balance_range_operator","in":"query","required":false,"schemaId":"schema_2"},{"name":"disabled","in":"query","required":false,"schemaId":"schema_3"},{"name":"owner","in":"query","required":false,"schemaId":"schema_4"},{"name":"currency","in":"query","required":false,"schemaId":"schema_4"},{"name":"sort_field","in":"query","required":false,"schemaId":"schema_5"},{"name":"sort_direction","in":"query","required":false,"schemaId":"schema_6"},{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"},{"name":"external_account_ids","in":"query","required":false,"schemaId":"schema_0","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/accounts","href":"account-configuration/getaccounts","openApiOperationId":"getAccounts","summary":"Get accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfuly returned list of accounts.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Accounts"}},"schemaId":"components/schemas/Accounts"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Accounts","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Accounts"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-configuration/getaccounts"}],"panels":[]}]},"httpPath":"/config/accounts"},{"label":"Create account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/account-configuration/createaccount","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/account-configuration/createaccount","metadata":{"seo":{"title":"Create account","description":"Creates an account on the xCurrent ledger. An account stores balances and enables transfers between accounts on the ledger."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAccount","name":"Create account","isWebhook":false,"pointer":"/paths/~1config~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an account on the xCurrent ledger. An account stores balances and enables transfers between accounts on the ledger."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountRequest"}},"schemaId":"components/schemas/AccountRequest","pointer":"/paths/~1config~1accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/config/accounts","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountRequest"}},"responseCodes":["200","400","409"],"pointer":"/config/accounts","href":"account-configuration/createaccount","openApiOperationId":"createAccount","summary":"Create account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/AccountRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountResponse"}},"schemaId":"components/schemas/AccountResponse"},{"code":"400","description":"Bad request parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"409","description":"Account name is already in use.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"409","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-configuration/createaccount"}],"panels":[]}]},"httpPath":"/config/accounts"},{"label":"Get account by name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/account-configuration/getaccountbyname","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/account-configuration/getaccountbyname","metadata":{"seo":{"title":"Get account by name","description":"Gets one account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountByName","name":"Get account by name","isWebhook":false,"pointer":"/paths/~1config~1accounts~1{account_name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account by name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets one account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_name","in":"path","schemaId":"schema_4","description":"The name of the account you want returned. (To discover account names, make a Get accounts request.)","required":true}],"pointer":"/paths/~1config~1accounts~1{account_name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/accounts/{account_name}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"account_name","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/config/accounts/{account_name}","href":"account-configuration/getaccountbyname","openApiOperationId":"getAccountByName","summary":"Get account by name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned the named account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountResponse"}},"schemaId":"components/schemas/AccountResponse"},{"code":"404","description":"Account not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1accounts~1{account_name}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountResponse"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-configuration/getaccountbyname"}],"panels":[]}]},"httpPath":"/config/accounts/{account_name}"},{"label":"Update account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/account-configuration/updateaccount","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/account-configuration/updateaccount","metadata":{"seo":{"title":"Update account","description":"Updates the updatable fields for an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAccount","name":"Update account","isWebhook":false,"pointer":"/paths/~1config~1accounts~1{account_name}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the updatable fields for an account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_name","in":"path","schemaId":"schema_4","description":"The name of the account for which to set minimum and maximum balance limits. (To discover account names, make a Get accounts request.)","required":true}],"pointer":"/paths/~1config~1accounts~1{account_name}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountUpdateAllowedBalanceRequest"}},"schemaId":"components/schemas/AccountUpdateAllowedBalanceRequest","pointer":"/paths/~1config~1accounts~1{account_name}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/config/accounts/{account_name}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"account_name","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountUpdateAllowedBalanceRequest"}},"responseCodes":["200","400","404"],"pointer":"/config/accounts/{account_name}","href":"account-configuration/updateaccount","openApiOperationId":"updateAccount","summary":"Update account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/AccountUpdateAllowedBalanceRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountUpdateAllowedBalanceRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountResponse"}},"schemaId":"components/schemas/AccountResponse"},{"code":"400","description":"Account min/max balance is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Account not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1accounts~1{account_name}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-configuration/updateaccount"}],"panels":[]}]},"httpPath":"/config/accounts/{account_name}"},{"label":"Update nostro account balance limits","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/account-configuration/update-nostro-account-balance-limit","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/account-configuration/update-nostro-account-balance-limit","metadata":{"seo":{"title":"Update nostro account balance limits","description":"Updates minimum and maximum allowed balance limits on a nostro account owned by this financial institution on a ledger on a peered xCurrent instance. Allows owner of nostro account to restrict balance range to less than the account maximum and greater than the account minimum set by partner."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update-nostro-account-balance-limit","name":"Update nostro account balance limits","isWebhook":false,"pointer":"/paths/~1config~1accounts~1{nostroAccountAddress}~1nostro-account-update/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update nostro account balance limits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates minimum and maximum allowed balance limits on a nostro account owned by this financial institution on a ledger on a peered xCurrent instance. Allows owner of nostro account to restrict balance range to less than the account maximum and greater than the account minimum set by partner."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nostroAccountAddress","in":"path","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RippleNet address of the nostro account. Use the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the nostro account and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the the peered xCurrent instance that contains the nostro account. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sf-aus@rn.us.tx.austin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1config~1accounts~1{nostroAccountAddress}~1nostro-account-update/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountUpdateAllowedBalanceRequest"}},"schemaId":"components/schemas/AccountUpdateAllowedBalanceRequest","pointer":"/paths/~1config~1accounts~1{nostroAccountAddress}~1nostro-account-update/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/config/accounts/{nostroAccountAddress}/nostro-account-update","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"nostroAccountAddress","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountUpdateAllowedBalanceRequest"}},"responseCodes":["200","400"],"pointer":"/config/accounts/{nostroAccountAddress}/nostro-account-update","href":"account-configuration/update-nostro-account-balance-limit","openApiOperationId":"update-nostro-account-balance-limit","summary":"Update nostro account balance limits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/AccountUpdateAllowedBalanceRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountUpdateAllowedBalanceRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated balance limits for nostro account on a peered RippleNet node."},{"code":"400","description":"Nostro Account name is not specified.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1accounts~1{nostroAccountAddress}~1nostro-account-update/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-configuration/update-nostro-account-balance-limit"}],"panels":[]}]},"httpPath":"/config/accounts/{nostroAccountAddress}/nostro-account-update"},{"label":"Disable account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/account-configuration/disableaccount","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/account-configuration/disableaccount","metadata":{"seo":{"title":"Disable account","description":"Disables an account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"disableAccount","name":"Disable account","isWebhook":false,"pointer":"/paths/~1config~1accounts~1{account_name}~1disable/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disable account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Disables an account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_name","in":"path","schemaId":"schema_4","description":"The name of the account you want to disable. (To discover account names, make a Get accounts request.)","required":true}],"pointer":"/paths/~1config~1accounts~1{account_name}~1disable/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/config/accounts/{account_name}/disable","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"account_name","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/config/accounts/{account_name}/disable","href":"account-configuration/disableaccount","openApiOperationId":"disableAccount","summary":"Disable account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully disabled account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountResponse"}},"schemaId":"components/schemas/AccountResponse"},{"code":"404","description":"Account not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1accounts~1{account_name}~1disable/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountResponse"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-configuration/disableaccount"}],"panels":[]}]},"httpPath":"/config/accounts/{account_name}/disable"}],"content":{"contentType":"group","meta":{"name":"Account configuration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account configuration","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/config/accounts","summary":"Get accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-configuration/getaccounts","deprecated":false},{"title":"/config/accounts","summary":"Create account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-configuration/createaccount","deprecated":false},{"title":"/config/accounts/{account_name}","summary":"Get account by name","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-configuration/getaccountbyname","deprecated":false},{"title":"/config/accounts/{account_name}","summary":"Update account","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-configuration/updateaccount","deprecated":false},{"title":"/config/accounts/{nostroAccountAddress}/nostro-account-update","summary":"Update nostro account balance limits","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-configuration/update-nostro-account-balance-limit","deprecated":false},{"title":"/config/accounts/{account_name}/disable","summary":"Disable account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-configuration/disableaccount","deprecated":false}]}]}]}]}},{"type":"group","label":"Auditing","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/auditing","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/auditing","items":[{"label":"Get audits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/auditing/getaudits","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAudits","name":"Get audits","isWebhook":false,"pointer":"/paths/~1audit/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get audits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets an audit trail of user actions and configuration changes (to accounts, fees, and rates) on a RippleNet instance."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of payments to return per page."},{"name":"before","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters for audit events where the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is before this specified time stamp (not inclusive). You can also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a time range between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If before is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be specified."},"children":[]}]}]}]},{"name":"after","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters for audit events where the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is after this specified time stamp (not inclusive). You can also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a time range between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be specified."},"children":[]}]}]}]},{"name":"range_field","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters payments before/after/between created and modified timestamps ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MODIFIED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). For example, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you would specify a timestamp (in the 24-character ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ format used in payment objects) as the value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch audit events before, after, or between the specified time range(s) (not inclusive). If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be specified."},"children":[]}]}]}]},{"name":"actor","in":"query","schemaId":"schema_4","description":"Filters for audit events based upon actor."},{"name":"action","in":"query","schemaId":"schema_4","description":"Filters for audit events based upon action."},{"name":"level","in":"query","schemaId":"schema_9","description":"Filters for audit events based upon audit level."},{"name":"domain","in":"query","schemaId":"schema_10","description":"Filters for audit events based upon audit domain."}],"pointer":"/paths/~1audit/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/audit","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"},{"name":"before","in":"query","required":false,"schemaId":"schema_4"},{"name":"after","in":"query","required":false,"schemaId":"schema_4"},{"name":"range_field","in":"query","required":false,"schemaId":"schema_4"},{"name":"actor","in":"query","required":false,"schemaId":"schema_4"},{"name":"action","in":"query","required":false,"schemaId":"schema_4"},{"name":"level","in":"query","required":false,"schemaId":"schema_9"},{"name":"domain","in":"query","required":false,"schemaId":"schema_10"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/audit","href":"auditing/getaudits","openApiOperationId":"getAudits","summary":"Get audits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditEventResponse"}},"schemaId":"components/schemas/AuditEventResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1audit/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuditEventResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuditEventResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auditing/getaudits"}],"panels":[]}]},"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/ripplenet/auditing/geteventtrailforpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEventTrailForPayment","name":"Get event trail for payment","isWebhook":false,"pointer":"/paths/~1audit~1payment~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get event trail for payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets an audit trail of a payment's state changes on a local RippleNet instance."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","description":"Unique identifier of a payment.","required":true}],"pointer":"/paths/~1audit~1payment~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/audit/payment/{id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/audit/payment/{id}","href":"auditing/geteventtrailforpayment","openApiOperationId":"getEventTrailForPayment","summary":"Get event trail for payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment state change event trail.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1audit~1payment~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auditing/geteventtrailforpayment"}],"panels":[]}]},"httpPath":"/audit/payment/{id}"}],"content":{"contentType":"group","meta":{"name":"Auditing"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Auditing","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/audit","summary":"Get audits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/auditing/getaudits","deprecated":false},{"title":"/audit/payment/{id}","summary":"Get event trail for payment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/auditing/geteventtrailforpayment","deprecated":false}]}]}]}]}},{"type":"group","label":"Balances and statements","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/balances-and-statements","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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/ripplenet/balances-and-statements/getbalances","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/balances-and-statements/getbalances","metadata":{"seo":{"title":"Get balances","description":"Get balances for local and remote accounts owned by a RippleNet address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBalances","name":"Get balances","isWebhook":false,"pointer":"/paths/~1monitor~1balances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get balances for local and remote accounts owned by a RippleNet address."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitor/balances","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/monitor/balances","href":"balances-and-statements/getbalances","openApiOperationId":"getBalances","summary":"Get balances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned balances.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Balances"}},"schemaId":"components/schemas/Balances"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1monitor~1balances/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Balances","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Balances"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances-and-statements/getbalances"}],"panels":[]}]},"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/ripplenet/balances-and-statements/getledgerbalances","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/balances-and-statements/getledgerbalances","metadata":{"seo":{"title":"Get ledger balances","description":"Get balances for ledger owned by a RippleNet address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLedgerBalances","name":"Get ledger balances","isWebhook":false,"pointer":"/paths/~1monitor~1ledger~1balances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get ledger balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get balances for ledger owned by a RippleNet address."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitor/ledger/balances","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/monitor/ledger/balances","href":"balances-and-statements/getledgerbalances","openApiOperationId":"getLedgerBalances","summary":"Get ledger balances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned balances.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Balances"}},"schemaId":"components/schemas/Balances"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1monitor~1ledger~1balances/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Balances","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Balances"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances-and-statements/getledgerbalances"}],"panels":[]}]},"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/ripplenet/balances-and-statements/getstatement","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStatement","name":"Get statement","isWebhook":false,"pointer":"/paths/~1statement~1{account_name_with_address}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get statement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_name_with_address","in":"path","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RippleNet account name and address that you want to return a statement for. Use the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"san_francisco@rn.us.ca.san_francisco"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1statement~1{account_name_with_address}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start-date","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lower bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2018-08-06T23:13:55.997Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"end-date","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The upper bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2018-08-06T23:15:13.218Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of payment and transfer objects to return per page, with a limit of 100 per page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a query with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"size\": \"100\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"totalPages\": \"43\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the query result is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"totalElements\": \"4290\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1statement~1{account_name_with_address}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statement/{account_name_with_address}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"account_name_with_address","in":"path","required":true,"schemaId":"schema_4"}],"query":[{"name":"start-date","in":"query","required":true,"schemaId":"schema_4"},{"name":"end-date","in":"query","required":true,"schemaId":"schema_4"},{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/statement/{account_name_with_address}","href":"balances-and-statements/getstatement","openApiOperationId":"getStatement","summary":"Get statement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returns an account statement.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementResponse"}},"schemaId":"components/schemas/StatementResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Peer or Account not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1statement~1{account_name_with_address}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatementResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances-and-statements/getstatement"}],"panels":[]}]},"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/ripplenet/balances-and-statements/getstatementbyexternalaccountid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStatementByExternalAccountId","name":"Get statement by external account ID","isWebhook":false,"pointer":"/paths/~1statement~1external_account_id~1{external_account_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get statement by external account ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"external_account_id","in":"path","schemaId":"schema_4","description":"The external account ID associated with the account.","required":true}],"pointer":"/paths/~1statement~1external_account_id~1{external_account_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start-date","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lower bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2018-08-06T23:13:55.997Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"end-date","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The upper bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2018-08-06T23:15:13.218Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of payment and transfer objects to return per page."}],"pointer":"/paths/~1statement~1external_account_id~1{external_account_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statement/external_account_id/{external_account_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"external_account_id","in":"path","required":true,"schemaId":"schema_4"}],"query":[{"name":"start-date","in":"query","required":true,"schemaId":"schema_4"},{"name":"end-date","in":"query","required":true,"schemaId":"schema_4"},{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/statement/external_account_id/{external_account_id}","href":"balances-and-statements/getstatementbyexternalaccountid","openApiOperationId":"getStatementByExternalAccountId","summary":"Get statement by external account ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returns an account statement.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementResponse"}},"schemaId":"components/schemas/StatementResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Peer or Account not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1statement~1external_account_id~1{external_account_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatementResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances-and-statements/getstatementbyexternalaccountid"}],"panels":[]}]},"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/ripplenet/balances-and-statements/getledgeraccountstatement","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/balances-and-statements/getledgeraccountstatement","metadata":{"seo":{"title":"Get ledger account statement","description":"Get statement for a specified Ledger account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLedgerAccountStatement","name":"Get ledger account statement","deprecated":true,"isWebhook":false,"pointer":"/paths/~1statement~1ledger~1{account_name_with_address}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get ledger account statement","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get statement for a specified Ledger account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This operation is deprecated. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.ripple.com/payments-odl/api-docs/report_service/reference/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reports API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view your statements."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_name_with_address","in":"path","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RippleNet account name and address that you want to return a statement for. Use the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"san_francisco@rn.us.ca.san_francisco"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1statement~1ledger~1{account_name_with_address}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start-date","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lower bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2018-08-06T23:13:55.997Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"end-date","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The upper bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2018-08-06T23:15:13.218Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of payment and transfer objects to return per page."}],"pointer":"/paths/~1statement~1ledger~1{account_name_with_address}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statement/ledger/{account_name_with_address}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"account_name_with_address","in":"path","required":true,"schemaId":"schema_4"}],"query":[{"name":"start-date","in":"query","required":true,"schemaId":"schema_4"},{"name":"end-date","in":"query","required":true,"schemaId":"schema_4"},{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/statement/ledger/{account_name_with_address}","href":"balances-and-statements/getledgeraccountstatement","openApiOperationId":"getLedgerAccountStatement","summary":"Get ledger account statement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned statement for a specified ledger account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementResponse"}},"schemaId":"components/schemas/StatementResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Peer or Account not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1statement~1ledger~1{account_name_with_address}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatementResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances-and-statements/getledgeraccountstatement"}],"panels":[]}]},"httpPath":"/statement/ledger/{account_name_with_address}"}],"content":{"contentType":"group","meta":{"name":"Balances and statements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balances and statements","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/monitor/balances","summary":"Get balances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances-and-statements/getbalances","deprecated":false},{"title":"/monitor/ledger/balances","summary":"Get ledger balances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances-and-statements/getledgerbalances","deprecated":false},{"title":"/statement/{account_name_with_address}","summary":"Get statement","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances-and-statements/getstatement","deprecated":false},{"title":"/statement/external_account_id/{external_account_id}","summary":"Get statement by external account ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances-and-statements/getstatementbyexternalaccountid","deprecated":false},{"title":"/statement/ledger/{account_name_with_address}","summary":"Get ledger account statement","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/balances-and-statements/getledgeraccountstatement","deprecated":true}]}]}]}]}},{"type":"group","label":"Beneficiary confirmation","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/beneficiary-confirmation","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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/ripplenet/beneficiary-confirmation/getaccountlookupbystatus","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountLookupByStatus","name":"Get account lookup by status","isWebhook":false,"pointer":"/paths/~1account_lookups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account lookup by status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Account Lookup entities by status and other filters. Status defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUESTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of objects to return per page"},{"name":"account_lookup_status","in":"query","schemaId":"schema_13","description":"Account Lookup status"},{"name":"start-date","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lower bound of the date-time range you want to return account lookup for, as an ISO-8601 timestamp in UTC. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2018-08-06T23:13:55.997Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"end-date","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The upper bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2018-08-06T23:15:13.218Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort_field","in":"query","schemaId":"schema_14","description":"Attribute for how to sort the results"},{"name":"sort_direction","in":"query","schemaId":"schema_6","description":"Direction of sorted results."}],"pointer":"/paths/~1account_lookups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_lookups","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"},{"name":"account_lookup_status","in":"query","required":false,"schemaId":"schema_13","style":"form","explode":false},{"name":"start-date","in":"query","required":false,"schemaId":"schema_4"},{"name":"end-date","in":"query","required":false,"schemaId":"schema_4"},{"name":"sort_field","in":"query","required":false,"schemaId":"schema_14"},{"name":"sort_direction","in":"query","required":false,"schemaId":"schema_6"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/account_lookups","href":"beneficiary-confirmation/getaccountlookupbystatus","openApiOperationId":"getAccountLookupByStatus","summary":"Get account lookup by status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned response for Account Lookup","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountLookups"}},"schemaId":"components/schemas/AccountLookups"},{"code":"400","description":"Bad request problem","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Account Lookup Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"500","description":"Server Error - No valid network path to receiver. Account Lookup is not supported by a participant in the network path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1account_lookups/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountLookups","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountLookups"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"500","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/beneficiary-confirmation/getaccountlookupbystatus"}],"panels":[]}]},"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/ripplenet/beneficiary-confirmation/initiateaccountlookup","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initiateAccountLookup","name":"Initiate account lookup","isWebhook":false,"pointer":"/paths/~1account_lookups~1request/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiate account lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InitiateAccountLookupRequest"}},"schemaId":"components/schemas/InitiateAccountLookupRequest","pointer":"/paths/~1account_lookups~1request/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/account_lookups/request","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InitiateAccountLookupRequest"}},"responseCodes":["200","400","500"],"pointer":"/account_lookups/request","href":"beneficiary-confirmation/initiateaccountlookup","openApiOperationId":"initiateAccountLookup","summary":"Initiate account lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/InitiateAccountLookupRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InitiateAccountLookupRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned Account Lookup response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountLookup"}},"schemaId":"components/schemas/AccountLookup"},{"code":"400","description":"Bad Request Problem.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"500","description":"Server Error - No valid network path to receiver. Account Lookup is not supported by a participant in the network path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1account_lookups~1request/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountLookup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountLookup"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"500","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/beneficiary-confirmation/initiateaccountlookup"}],"panels":[]}]},"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/ripplenet/beneficiary-confirmation/completeaccountlookup","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/beneficiary-confirmation/completeaccountlookup","metadata":{"seo":{"title":"Complete account lookup","description":"Posts an Account Lookup response to validate a beneficiary's account details before payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"completeAccountLookup","name":"Complete account lookup","isWebhook":false,"pointer":"/paths/~1account_lookups~1response/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complete account lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Posts an Account Lookup response to validate a beneficiary's account details before payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompleteAccountLookupRequest"}},"schemaId":"components/schemas/CompleteAccountLookupRequest","pointer":"/paths/~1account_lookups~1response/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/account_lookups/response","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CompleteAccountLookupRequest"}},"responseCodes":["200","400","404","500"],"pointer":"/account_lookups/response","href":"beneficiary-confirmation/completeaccountlookup","openApiOperationId":"completeAccountLookup","summary":"Complete account lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/CompleteAccountLookupRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CompleteAccountLookupRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returns acknowledgement for Account Lookup response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountLookup"}},"schemaId":"components/schemas/AccountLookup"},{"code":"400","description":"Bad request problem","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Account Lookup Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"500","description":"Server Error - No valid network path to receiver. Account Lookup is not supported by a participant in the network path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1account_lookups~1response/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountLookup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountLookup"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"500","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/beneficiary-confirmation/completeaccountlookup"}],"panels":[]}]},"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/ripplenet/beneficiary-confirmation/getaccountlookupbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/beneficiary-confirmation/getaccountlookupbyid","metadata":{"seo":{"title":"Get account lookup by ID","description":"Gets an Account Lookup entity for its account_lookup_id value."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountLookupById","name":"Get account lookup by ID","isWebhook":false,"pointer":"/paths/~1account_lookups~1{account_lookup_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account lookup by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets an Account Lookup entity for its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_lookup_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_lookup_id","in":"path","schemaId":"schema_11","description":"AccountLookupId","required":true}],"pointer":"/paths/~1account_lookups~1{account_lookup_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/account_lookups/{account_lookup_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"account_lookup_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/account_lookups/{account_lookup_id}","href":"beneficiary-confirmation/getaccountlookupbyid","openApiOperationId":"getAccountLookupById","summary":"Get account lookup by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned Account Lookup response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountLookup"}},"schemaId":"components/schemas/AccountLookup"},{"code":"400","description":"Bad request problem","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Account Lookup Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"500","description":"Server Error - No valid network path to receiver. Account Lookup is not supported by a participant in the network path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1account_lookups~1{account_lookup_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountLookup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountLookup"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"500","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/beneficiary-confirmation/getaccountlookupbyid"}],"panels":[]}]},"httpPath":"/account_lookups/{account_lookup_id}"}],"content":{"contentType":"group","meta":{"name":"Beneficiary confirmation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Beneficiary confirmation","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/account_lookups","summary":"Get account lookup by status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/beneficiary-confirmation/getaccountlookupbystatus","deprecated":false},{"title":"/account_lookups/request","summary":"Initiate account lookup","prefix":{"name":"post","color":"post"},"badges":[],"link":"/beneficiary-confirmation/initiateaccountlookup","deprecated":false},{"title":"/account_lookups/response","summary":"Complete account lookup","prefix":{"name":"post","color":"post"},"badges":[],"link":"/beneficiary-confirmation/completeaccountlookup","deprecated":false},{"title":"/account_lookups/{account_lookup_id}","summary":"Get account lookup by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/beneficiary-confirmation/getaccountlookupbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Diagnostics","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/diagnostics","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/diagnostics","items":[{"label":"Check health","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/diagnostics/checkhealth","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/diagnostics/checkhealth","metadata":{"seo":{"title":"Check health","description":"Gets the health status of the xCurrent server."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkHealth","name":"Check health","isWebhook":false,"pointer":"/paths/~1health/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check health","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the health status of the xCurrent server."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/health","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/health","href":"diagnostics/checkhealth","openApiOperationId":"checkHealth","summary":"Check health"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Health"}},"schemaId":"components/schemas/Health"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1health/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Health","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Health"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/diagnostics/checkhealth"}],"panels":[]}]},"httpPath":"/health"},{"label":"Check heartbeat","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/diagnostics/checkheartbeat","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkHeartbeat","name":"Check heartbeat","isWebhook":false,"pointer":"/paths/~1heartbeat/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check heartbeat","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the health status of the xCurrent server's peers. This request requires authorization. The timeout for this operation is 5 seconds."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/heartbeat","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/heartbeat","href":"diagnostics/checkheartbeat","openApiOperationId":"checkHeartbeat","summary":"Check heartbeat"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Heartbeat"}},"schemaId":"components/schemas/Heartbeat"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1heartbeat/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Heartbeat","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Heartbeat"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/diagnostics/checkheartbeat"}],"panels":[]}]},"httpPath":"/heartbeat"}],"content":{"contentType":"group","meta":{"name":"Diagnostics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Diagnostics","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/health","summary":"Check health","prefix":{"name":"get","color":"get"},"badges":[],"link":"/diagnostics/checkhealth","deprecated":false},{"title":"/heartbeat","summary":"Check heartbeat","prefix":{"name":"get","color":"get"},"badges":[],"link":"/diagnostics/checkheartbeat","deprecated":false}]}]}]}]}},{"type":"group","label":"Exchange transfers","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/exchange-transfers","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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/ripplenet/exchange-transfers/getexchangetransfers","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/exchange-transfers/getexchangetransfers","metadata":{"seo":{"title":"Get exchange transfers","description":"Gets all exchange transfers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExchangeTransfers","name":"Get exchange transfers","isWebhook":false,"pointer":"/paths/~1exchange_transfers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get exchange transfers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets all exchange transfers."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_15","description":"Number of objects to return per page."}],"pointer":"/paths/~1exchange_transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/exchange_transfers","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_15"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/exchange_transfers","href":"exchange-transfers/getexchangetransfers","openApiOperationId":"getExchangeTransfers","summary":"Get exchange transfers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved exchange transfers.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeTransfers"}},"schemaId":"components/schemas/ExchangeTransfers"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1exchange_transfers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExchangeTransfers","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeTransfers"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exchange-transfers/getexchangetransfers"}],"panels":[]}]},"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/ripplenet/exchange-transfers/executeexchangetransfer","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeExchangeTransfer","name":"Execute exchange transfer","isWebhook":false,"pointer":"/paths/~1exchange_transfers~1execute/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute exchange transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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.\n\nBefore you make this request, you may want to use the Quote Exchange Transfer request to see a quote for the exchange transfer you want to make.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FiatExchangeTransferExecuteRequest"}},"schemaId":"components/schemas/FiatExchangeTransferExecuteRequest","pointer":"/paths/~1exchange_transfers~1execute/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/exchange_transfers/execute","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FiatExchangeTransferExecuteRequest"}},"responseCodes":["200","400"],"pointer":"/exchange_transfers/execute","href":"exchange-transfers/executeexchangetransfer","openApiOperationId":"executeExchangeTransfer","summary":"Execute exchange transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/FiatExchangeTransferExecuteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FiatExchangeTransferExecuteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully executed exchange transfer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiatExchangeTransferExecuteResponse"}},"schemaId":"components/schemas/FiatExchangeTransferExecuteResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1exchange_transfers~1execute/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FiatExchangeTransferExecuteResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiatExchangeTransferExecuteResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exchange-transfers/executeexchangetransfer"}],"panels":[]}]},"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/ripplenet/exchange-transfers/getexchangetransferquote","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/exchange-transfers/getexchangetransferquote","metadata":{"seo":{"title":"Get exchange transfer quote","description":"Requests a quote for an exchange transfer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExchangeTransferQuote","name":"Get exchange transfer quote","isWebhook":false,"pointer":"/paths/~1exchange_transfers~1quote/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get exchange transfer quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Requests a quote for an exchange transfer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FiatExchangeTransferQuoteRequest"}},"schemaId":"components/schemas/FiatExchangeTransferQuoteRequest","pointer":"/paths/~1exchange_transfers~1quote/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/exchange_transfers/quote","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FiatExchangeTransferQuoteRequest"}},"responseCodes":["200","400"],"pointer":"/exchange_transfers/quote","href":"exchange-transfers/getexchangetransferquote","openApiOperationId":"getExchangeTransferQuote","summary":"Get exchange transfer quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/FiatExchangeTransferQuoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FiatExchangeTransferQuoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully quoted exchange transfer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiatExchangeTransferQuoteResponse"}},"schemaId":"components/schemas/FiatExchangeTransferQuoteResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1exchange_transfers~1quote/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FiatExchangeTransferQuoteResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiatExchangeTransferQuoteResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exchange-transfers/getexchangetransferquote"}],"panels":[]}]},"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/ripplenet/exchange-transfers/completeexchangetransfer","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"completeExchangeTransfer","name":"Complete exchange transfer","isWebhook":false,"pointer":"/paths/~1exchange_transfers~1{id}~1complete/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complete exchange transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the status of an exchange transfer to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Make this request once the exchange transfer has been made on both the ledger and on internal systems."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","description":"Unique identifier of the exchange transfer to complete.","required":true}],"pointer":"/paths/~1exchange_transfers~1{id}~1complete/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/exchange_transfers/{id}/complete","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/exchange_transfers/{id}/complete","href":"exchange-transfers/completeexchangetransfer","openApiOperationId":"completeExchangeTransfer","summary":"Complete exchange transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully completed exchange transfer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiatExchangeTransferExecuteResponse"}},"schemaId":"components/schemas/FiatExchangeTransferExecuteResponse"},{"code":"404","description":"Exchange transfer not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1exchange_transfers~1{id}~1complete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FiatExchangeTransferExecuteResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiatExchangeTransferExecuteResponse"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exchange-transfers/completeexchangetransfer"}],"panels":[]}]},"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/ripplenet/exchange-transfers/getexchangetransferbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/exchange-transfers/getexchangetransferbyid","metadata":{"seo":{"title":"Get exchange transfer by ID","description":"Gets an exchange transfer by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExchangeTransferById","name":"Get exchange transfer by ID","isWebhook":false,"pointer":"/paths/~1exchange_transfers~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get exchange transfer by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets an exchange transfer by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","description":"Unique identifier of the exchange transfer you want to retrieve.","required":true}],"pointer":"/paths/~1exchange_transfers~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/exchange_transfers/{id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/exchange_transfers/{id}","href":"exchange-transfers/getexchangetransferbyid","openApiOperationId":"getExchangeTransferById","summary":"Get exchange transfer by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved exchange transfer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiatExchangeTransferExecuteResponse"}},"schemaId":"components/schemas/FiatExchangeTransferExecuteResponse"},{"code":"404","description":"Exchange transfer not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1exchange_transfers~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FiatExchangeTransferExecuteResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiatExchangeTransferExecuteResponse"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exchange-transfers/getexchangetransferbyid"}],"panels":[]}]},"httpPath":"/exchange_transfers/{id}"}],"content":{"contentType":"group","meta":{"name":"Exchange transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exchange transfers","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/exchange_transfers","summary":"Get exchange transfers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exchange-transfers/getexchangetransfers","deprecated":false},{"title":"/exchange_transfers/execute","summary":"Execute exchange transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exchange-transfers/executeexchangetransfer","deprecated":false},{"title":"/exchange_transfers/quote","summary":"Get exchange transfer quote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exchange-transfers/getexchangetransferquote","deprecated":false},{"title":"/exchange_transfers/{id}/complete","summary":"Complete exchange transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exchange-transfers/completeexchangetransfer","deprecated":false},{"title":"/exchange_transfers/{id}","summary":"Get exchange transfer by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exchange-transfers/getexchangetransferbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Fees","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/fees","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/fees","items":[{"label":"Get fees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/fees/getfees","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/fees/getfees","metadata":{"seo":{"title":"Get fees","description":"Gets a list of fees."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFees","name":"Get fees","isWebhook":false,"pointer":"/paths/~1config~1fees/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get fees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of fees."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of pages returned. Returns one page of results when set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_16","description":"Number of objects returned per page."}],"pointer":"/paths/~1config~1fees/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/fees","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_16"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/fees","href":"fees/getfees","openApiOperationId":"getFees","summary":"Get fees"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returns list of fees.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fees"}},"schemaId":"components/schemas/Fees"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1fees/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Fees","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fees"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/getfees"}],"panels":[]}]},"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/ripplenet/fees/createfee","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/fees/createfee","metadata":{"seo":{"title":"Create fee","description":"Creates a fee."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFee","name":"Create fee","isWebhook":false,"pointer":"/paths/~1config~1fees/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create fee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a fee."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FiatFeeRequest"}},"schemaId":"components/schemas/FiatFeeRequest","pointer":"/paths/~1config~1fees/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/config/fees","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FiatFeeRequest"}},"responseCodes":["200","400"],"pointer":"/config/fees","href":"fees/createfee","openApiOperationId":"createFee","summary":"Create fee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/FiatFeeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FiatFeeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created fee.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiatFee"}},"schemaId":"components/schemas/FiatFee"},{"code":"400","description":"Bad Request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1fees/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FiatFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiatFee"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/createfee"}],"panels":[]}]},"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/ripplenet/fees/getfeebyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/fees/getfeebyid","metadata":{"seo":{"title":"Get fee by ID","description":"Gets a fee by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFeeById","name":"Get fee by ID","isWebhook":false,"pointer":"/paths/~1config~1fees~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get fee by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a fee by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the fee you want to retrieve."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1config~1fees~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/fees/{id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/config/fees/{id}","href":"fees/getfeebyid","openApiOperationId":"getFeeById","summary":"Get fee by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved fee.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiatFee"}},"schemaId":"components/schemas/FiatFee"},{"code":"404","description":"Fee not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1fees~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FiatFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiatFee"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/getfeebyid"}],"panels":[]}]},"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/ripplenet/fees/updatefee","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/fees/updatefee","metadata":{"seo":{"title":"Update fee","description":"Updates an existing fee."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFee","name":"Update fee","isWebhook":false,"pointer":"/paths/~1config~1fees~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update fee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing fee."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the fee you want to update."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1config~1fees~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FiatFeeRequest"}},"schemaId":"components/schemas/FiatFeeRequest","pointer":"/paths/~1config~1fees~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/config/fees/{id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FiatFeeRequest"}},"responseCodes":["200","400"],"pointer":"/config/fees/{id}","href":"fees/updatefee","openApiOperationId":"updateFee","summary":"Update fee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/FiatFeeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FiatFeeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated fee.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiatFee"}},"schemaId":"components/schemas/FiatFee"},{"code":"400","description":"Bad Request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1fees~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FiatFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiatFee"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/updatefee"}],"panels":[]}]},"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/ripplenet/fees/deletefee","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/fees/deletefee","metadata":{"seo":{"title":"Delete fee","description":"Deletes a fee. Once deleted, a fee cannot be accessed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFee","name":"Delete fee","isWebhook":false,"pointer":"/paths/~1config~1fees~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete fee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a fee. Once deleted, a fee cannot be accessed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the fee you want to delete."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1config~1fees~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/config/fees/{id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/fees/{id}","href":"fees/deletefee","openApiOperationId":"deleteFee","summary":"Delete fee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted fee."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1fees~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/deletefee"}],"panels":[]}]},"httpPath":"/config/fees/{id}"}],"content":{"contentType":"group","meta":{"name":"Fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fees","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/config/fees","summary":"Get fees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fees/getfees","deprecated":false},{"title":"/config/fees","summary":"Create fee","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fees/createfee","deprecated":false},{"title":"/config/fees/{id}","summary":"Get fee by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fees/getfeebyid","deprecated":false},{"title":"/config/fees/{id}","summary":"Update fee","prefix":{"name":"put","color":"put"},"badges":[],"link":"/fees/updatefee","deprecated":false},{"title":"/config/fees/{id}","summary":"Delete fee","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/fees/deletefee","deprecated":false}]}]}]}]}},{"type":"group","label":"Liquidation configuration","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/liquidation-configuration","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/liquidation-configuration","items":[{"label":"Create liquidation configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/liquidation-configuration/createliquidationconfig","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/liquidation-configuration/createliquidationconfig","metadata":{"seo":{"title":"Create liquidation configuration","description":"Creates a new liquidation configuration. A liquidation configuration defines a transfer path between two RippleNet accounts for liquidating payments (when they arrive in a source account) to a destination account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createLiquidationConfig","name":"Create liquidation configuration","isWebhook":false,"pointer":"/paths/~1config~1liquidation_config/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create liquidation configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new liquidation configuration. A liquidation configuration defines a transfer path between two RippleNet accounts for liquidating payments (when they arrive in a source account) to a destination account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateLiquidationConfigRequest"}},"schemaId":"components/schemas/CreateLiquidationConfigRequest","pointer":"/paths/~1config~1liquidation_config/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/config/liquidation_config","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateLiquidationConfigRequest"}},"responseCodes":["200","400"],"pointer":"/config/liquidation_config","href":"liquidation-configuration/createliquidationconfig","openApiOperationId":"createLiquidationConfig","summary":"Create liquidation configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/CreateLiquidationConfigRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateLiquidationConfigRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created liquidation configuration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LiquidationConfigResponse"}},"schemaId":"components/schemas/LiquidationConfigResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1liquidation_config/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LiquidationConfigResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LiquidationConfigResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/liquidation-configuration/createliquidationconfig"}],"panels":[]}]},"httpPath":"/config/liquidation_config"},{"label":"Get all liquidation configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/liquidation-configuration/getallliquidationconfig","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/liquidation-configuration/getallliquidationconfig","metadata":{"seo":{"title":"Get all liquidation configurations","description":"Returns all liquidation configurations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllLiquidationConfig","name":"Get all liquidation configurations","isWebhook":false,"pointer":"/paths/~1config~1liquidation_config/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all liquidation configurations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all liquidation configurations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of payments to return per page."}],"pointer":"/paths/~1config~1liquidation_config/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/liquidation_config","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/liquidation_config","href":"liquidation-configuration/getallliquidationconfig","openApiOperationId":"getAllLiquidationConfig","summary":"Get all liquidation configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a paged list of liquidation configurations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LiquidationConfigsPage"}},"schemaId":"components/schemas/LiquidationConfigsPage"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1liquidation_config/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LiquidationConfigsPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LiquidationConfigsPage"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/liquidation-configuration/getallliquidationconfig"}],"panels":[]}]},"httpPath":"/config/liquidation_config"},{"label":"Get liquidation configuration by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/liquidation-configuration/getliquidationconfigbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/liquidation-configuration/getliquidationconfigbyid","metadata":{"seo":{"title":"Get liquidation configuration by ID","description":"Returns a liquidation configuration by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLiquidationConfigById","name":"Get liquidation configuration by ID","isWebhook":false,"pointer":"/paths/~1config~1liquidation_config~1{liquidation_config_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get liquidation configuration by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a liquidation configuration by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"liquidation_config_id","in":"path","schemaId":"schema_11","description":"ID of the liquidation configuration you want to retrieve.","required":true}],"pointer":"/paths/~1config~1liquidation_config~1{liquidation_config_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/liquidation_config/{liquidation_config_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"liquidation_config_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/liquidation_config/{liquidation_config_id}","href":"liquidation-configuration/getliquidationconfigbyid","openApiOperationId":"getLiquidationConfigById","summary":"Get liquidation configuration by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Liquidation Configuration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LiquidationConfigResponse"}},"schemaId":"components/schemas/LiquidationConfigResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1liquidation_config~1{liquidation_config_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LiquidationConfigResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LiquidationConfigResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/liquidation-configuration/getliquidationconfigbyid"}],"panels":[]}]},"httpPath":"/config/liquidation_config/{liquidation_config_id}"},{"label":"Update liquidation configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/liquidation-configuration/updateliquidationconfig","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/liquidation-configuration/updateliquidationconfig","metadata":{"seo":{"title":"Update liquidation configuration","description":"Updates an existing liquidation configuration. A liquidation configuration defines a transfer path between two RippleNet accounts for liquidating payments (when they arrive in a source account) to a destination account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLiquidationConfig","name":"Update liquidation configuration","isWebhook":false,"pointer":"/paths/~1config~1liquidation_config~1{liquidation_config_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update liquidation configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing liquidation configuration. A liquidation configuration defines a transfer path between two RippleNet accounts for liquidating payments (when they arrive in a source account) to a destination account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"liquidation_config_id","in":"path","schemaId":"schema_11","description":"ID of the liquidation configuration you want to update.","required":true}],"pointer":"/paths/~1config~1liquidation_config~1{liquidation_config_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateLiquidationConfigRequest"}},"schemaId":"components/schemas/UpdateLiquidationConfigRequest","pointer":"/paths/~1config~1liquidation_config~1{liquidation_config_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/config/liquidation_config/{liquidation_config_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"liquidation_config_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateLiquidationConfigRequest"}},"responseCodes":["200","400"],"pointer":"/config/liquidation_config/{liquidation_config_id}","href":"liquidation-configuration/updateliquidationconfig","openApiOperationId":"updateLiquidationConfig","summary":"Update liquidation configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/UpdateLiquidationConfigRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateLiquidationConfigRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Liquidation Configration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LiquidationConfigResponse"}},"schemaId":"components/schemas/LiquidationConfigResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1liquidation_config~1{liquidation_config_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LiquidationConfigResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LiquidationConfigResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/liquidation-configuration/updateliquidationconfig"}],"panels":[]}]},"httpPath":"/config/liquidation_config/{liquidation_config_id}"},{"label":"Delete liquidation configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/liquidation-configuration/deleteliquidationconfig","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/liquidation-configuration/deleteliquidationconfig","metadata":{"seo":{"title":"Delete liquidation configuration","description":"Deletes a liquidation configuration by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteLiquidationConfig","name":"Delete liquidation configuration","isWebhook":false,"pointer":"/paths/~1config~1liquidation_config~1{liquidation_config_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete liquidation configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a liquidation configuration by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"liquidation_config_id","in":"path","schemaId":"schema_11","description":"ID of the liquidation configuration you want to delete.","required":true}],"pointer":"/paths/~1config~1liquidation_config~1{liquidation_config_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/config/liquidation_config/{liquidation_config_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"liquidation_config_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/config/liquidation_config/{liquidation_config_id}","href":"liquidation-configuration/deleteliquidationconfig","openApiOperationId":"deleteLiquidationConfig","summary":"Delete liquidation configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted Liquidation Config successfully"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1liquidation_config~1{liquidation_config_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/liquidation-configuration/deleteliquidationconfig"}],"panels":[]}]},"httpPath":"/config/liquidation_config/{liquidation_config_id}"}],"content":{"contentType":"group","meta":{"name":"Liquidation configuration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Liquidation configuration","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/config/liquidation_config","summary":"Create liquidation configuration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/liquidation-configuration/createliquidationconfig","deprecated":false},{"title":"/config/liquidation_config","summary":"Get all liquidation configurations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/liquidation-configuration/getallliquidationconfig","deprecated":false},{"title":"/config/liquidation_config/{liquidation_config_id}","summary":"Get liquidation configuration by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/liquidation-configuration/getliquidationconfigbyid","deprecated":false},{"title":"/config/liquidation_config/{liquidation_config_id}","summary":"Update liquidation configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/liquidation-configuration/updateliquidationconfig","deprecated":false},{"title":"/config/liquidation_config/{liquidation_config_id}","summary":"Delete liquidation configuration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/liquidation-configuration/deleteliquidationconfig","deprecated":false}]}]}]}]}},{"type":"group","label":"Non-orchestration payments","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/non-orchestration-payments","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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/ripplenet/non-orchestration-payments/getpayments","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPayments","name":"Get payments","isWebhook":false,"pointer":"/paths/~1payments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_field : MODIFIED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_direction : DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page : 0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" , "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size : 10"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of payments to return per page."},{"name":"sending_host","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter for filtering "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"with sendingHost"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},{"name":"receiving_host","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter for filtering with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receivingHost"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},{"name":"sending_account","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter for filtering with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendingAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},{"name":"receiving_account","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter for filtering with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receivingAccount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},{"name":"sending_currency","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter for filtering with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sendingCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},{"name":"receiving_currency","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter for filtering with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receivingCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},{"name":"payment_id","in":"query","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter for filtering with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. This parameter is deprecated. Please use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead"},"children":[]}]}]}],"deprecated":true},{"name":"payment_type","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters for payments based on the type of payment. Valid types are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REGULAR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"internal_id","in":"query","schemaId":"schema_4","description":"Optional parameter for filtering with internalId."},{"name":"sender_end_to_end_id","in":"query","schemaId":"schema_4","description":"Optional parameter for filtering with senderEndToEndId."},{"name":"connector_role","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters for payments based on the role of the responding connector. Valid roles are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERMEDIARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role is meant for payments between RippleNet Cloud and RippleNet where the sender and receiver accounts are on the same RippleNet instance. Use role with state to find payments waiting on action from you as the sending or receiving (or internal) connector."},"children":[]}]}]}]},{"name":"state","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated, should use states parameter. Returns payments in the specified state. The following options are valid: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCK_DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PREPARED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLEMENT_DECLINED"},"children":[]}]}]}]},{"name":"states","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns payments in the specified states. The following options are valid: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCK_DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PREPARED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLEMENT_DECLINED"},"children":[]}]}]}]},{"name":"before","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters for payments where the payments "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column value is before this specified time stamp (not inclusive). You can also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a time range between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If before is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be specified."},"children":[]}]}]}]},{"name":"after","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters for payments where the payments "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column value is after this specified time stamp (not inclusive). You can also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a time range between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be specified."},"children":[]}]}]}]},{"name":"range_field","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Designates the column name of the payments database table that is used for filtering payments before/after/between time stamps. The following options are valid: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MODIFIED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCEPTED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCKED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPIRES_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MODIFIED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you would specify a time stamp (in the 24 character ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ format used in payment objects) as the value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch payments before, after, or between the specified time range(s) (not inclusive). If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be specified."},"children":[]}]}]}]},{"name":"amount_range_field","in":"query","schemaId":"schema_17","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Designates the column name of the payments database table that is used for filtering payments greater/less/between amounts. For example, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_range_field=SENDING_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you would specify an amount as the value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"greater"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"less"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch payments greater, less, or between the specified amounts (inclusive). If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be specified."},"children":[]}]}]}]},{"name":"min_amount","in":"query","schemaId":"schema_18","description":"Optional parameter for filtering with min sending/receiving amount."},{"name":"max_amount","in":"query","schemaId":"schema_18","description":"Optional parameter for filtering with max sending/receiving amount."},{"name":"with_labels","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns payments with the specified labels. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you apply "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"with_labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multiple"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" labels, the response returns payments with at least one of the specified labels."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the query, "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"?with_labels=string1,string2"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returns payments with either \"string1\" OR \"string2\"."},"children":[]}]}]}]}]},{"name":"without_labels","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns payments that do "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" have any of the specified labels. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you apply "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"without_labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multiple"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" labels, the response returns payments that do not have any of the specified labels."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the query,"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"?without_labels=string3,string4"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returns payments that are not labeled with either \"string3\" OR \"string4\"."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you apply both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"with_labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"without_labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters, the response returns payments that have at least one of the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"with_labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" strings but omits payments that also have any of the the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"without_labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" strings. "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the query, "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"?with_labels=string1&without_labels=string3"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returns payments with \"string1\" but not payments with \"string3\"."},"children":[]}]}]}]}]},{"name":"sort_field","in":"query","schemaId":"schema_19","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts results according to the specified field. Valid options are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPIRES_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MODIFIED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREATED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort_direction","in":"query","schemaId":"schema_20","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts result according to the specified direction. Valid options are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"load_additional_details","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This parameter can be used to exclude additional info being returned for each payment object. Additional info which will be excluded if the flag set to false include user_info, ripplenet_info, execution_results and internal_info.labels"},"children":[]}]}]}]},{"name":"payment_ids","in":"query","schemaId":"schema_21","description":"List of paymentIds to search for"}],"pointer":"/paths/~1payments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","schemaId":"schema_8"},{"name":"sending_host","in":"query","required":false,"schemaId":"schema_4"},{"name":"receiving_host","in":"query","required":false,"schemaId":"schema_4"},{"name":"sending_account","in":"query","required":false,"schemaId":"schema_4"},{"name":"receiving_account","in":"query","required":false,"schemaId":"schema_4"},{"name":"sending_currency","in":"query","required":false,"schemaId":"schema_4"},{"name":"receiving_currency","in":"query","required":false,"schemaId":"schema_4"},{"name":"payment_id","in":"query","required":false,"schemaId":"schema_11"},{"name":"payment_type","in":"query","required":false,"schemaId":"schema_4"},{"name":"internal_id","in":"query","required":false,"schemaId":"schema_4"},{"name":"sender_end_to_end_id","in":"query","required":false,"schemaId":"schema_4"},{"name":"connector_role","in":"query","required":false,"schemaId":"schema_4"},{"name":"state","in":"query","required":false,"schemaId":"schema_4"},{"name":"states","in":"query","required":false,"schemaId":"schema_0","style":"form","explode":false},{"name":"before","in":"query","required":false,"schemaId":"schema_4"},{"name":"after","in":"query","required":false,"schemaId":"schema_4"},{"name":"range_field","in":"query","required":false,"schemaId":"schema_4"},{"name":"amount_range_field","in":"query","required":false,"schemaId":"schema_17"},{"name":"min_amount","in":"query","required":false,"schemaId":"schema_18"},{"name":"max_amount","in":"query","required":false,"schemaId":"schema_18"},{"name":"with_labels","in":"query","required":false,"schemaId":"schema_0","style":"form","explode":false},{"name":"without_labels","in":"query","required":false,"schemaId":"schema_0","style":"form","explode":false},{"name":"sort_field","in":"query","required":false,"schemaId":"schema_19"},{"name":"sort_direction","in":"query","required":false,"schemaId":"schema_20"},{"name":"load_additional_details","in":"query","required":false,"schemaId":"schema_3"},{"name":"payment_ids","in":"query","required":false,"schemaId":"schema_21","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/payments","href":"non-orchestration-payments/getpayments","openApiOperationId":"getPayments","summary":"Get payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payments"},"text/csv":{"schemaId":"components/schemas/Payments"}},"schemaId":"components/schemas/Payments"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"},"text/csv":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1payments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payments","mediaTypes":["application/json","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payments"},"text/csv":{"schemaId":"components/schemas/Payments"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json","text/csv"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"},"text/csv":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/getpayments"}],"panels":[]}]},"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/ripplenet/non-orchestration-payments/getpaymentbypaymentid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/non-orchestration-payments/getpaymentbypaymentid","metadata":{"seo":{"title":"Get payment by payment ID","description":"Gets a payment by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentByPaymentId","name":"Get payment by payment ID","isWebhook":false,"pointer":"/paths/~1payments~1{payment_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payment by payment ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a payment by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_11","description":"Unique identifier of the payment you want to retrieve.","required":true}],"pointer":"/paths/~1payments~1{payment_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{payment_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/payments/{payment_id}","href":"non-orchestration-payments/getpaymentbypaymentid","openApiOperationId":"getPaymentByPaymentId","summary":"Get payment by payment ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1payments~1{payment_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/getpaymentbypaymentid"}],"panels":[]}]},"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/ripplenet/non-orchestration-payments/lockpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"lockPayment","name":"Lock payment","isWebhook":false,"pointer":"/paths/~1payments~1{payment_id}~1lock/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lock payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partially"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, the beneficiary and all intermediary institutions who have "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" locked, can "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/rejectLockPayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reject lock payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/failPayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fail payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once fully "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the originating institution can either "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/failPayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fail payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/settlePayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settle payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the originating institution sends a Settle payment request, one of three things will happen:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successful payments move to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PREPARED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments with insufficient liquidity automatically move into state "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLEMENT_DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments that are not settled before the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"crypto_transaction_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expires move to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Currently, when making a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/createQuoteToReturnPayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create quote to return payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to a RippleNet Cloud account on a RippleNet ledger, the RippleNet user must lock and complete the payment. This means that the RippleNet user takes all action on the return: Get and Accept Quote, Lock, Settle, and Complete payment."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_11","description":"Unique identifier of the payment to lock.","required":true}],"pointer":"/paths/~1payments~1{payment_id}~1lock/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentLockRequest"}},"schemaId":"components/schemas/PaymentLockRequest","pointer":"/paths/~1payments~1{payment_id}~1lock/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{payment_id}/lock","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentLockRequest"}},"responseCodes":["200","400","404"],"pointer":"/payments/{payment_id}/lock","href":"non-orchestration-payments/lockpayment","openApiOperationId":"lockPayment","summary":"Lock payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentLockRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentLockRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully locked payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1payments~1{payment_id}~1lock/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/lockpayment"}],"panels":[]}]},"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/ripplenet/non-orchestration-payments/rejectlockpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/non-orchestration-payments/rejectlockpayment","metadata":{"seo":{"title":"Reject lock payment","description":"Rejects a payment from being locked."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rejectLockPayment","name":"Reject lock payment","isWebhook":false,"pointer":"/paths/~1payments~1{payment_id}~1reject/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reject lock payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rejects a payment from being locked."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This temporarily stops the payment and keeps it in a recoverable state so that "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/resources/srpo/user-info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user_info"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be corrected. If the payment is incorrect for reasons outside of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_info"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/failPayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fail payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After a payment has been created by an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/acceptQuote"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accept quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, the beneficiary or an intermediary can choose to reject the payment, rather than "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/lockPayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lock payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with corrections to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_info"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the reasons array. A rejected payment moves the payment state to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCK_DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which it can be recovered by the originating institution with a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/retryAcceptPayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry accept payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If any one institution in the payment chain is configured to "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"auto-fail"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the payment automatically fails when the payment is rejected, moving to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state rather than the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCK_DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_11","description":"Unique identifier of a payment to reject a lock request.","required":true}],"pointer":"/paths/~1payments~1{payment_id}~1reject/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentDenyRequest"}},"schemaId":"components/schemas/PaymentDenyRequest","pointer":"/paths/~1payments~1{payment_id}~1reject/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{payment_id}/reject","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentDenyRequest"}},"responseCodes":["200","400","404"],"pointer":"/payments/{payment_id}/reject","href":"non-orchestration-payments/rejectlockpayment","openApiOperationId":"rejectLockPayment","summary":"Reject lock payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentDenyRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentDenyRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully rejected the request to lock a payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1payments~1{payment_id}~1reject/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/rejectlockpayment"}],"panels":[]}]},"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/ripplenet/non-orchestration-payments/retryacceptpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retryAcceptPayment","name":"Retry accept payment","isWebhook":false,"pointer":"/paths/~1payments~1{payment_id}~1retry_accept/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retry accept payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a rejected payment from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCK_DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state. The payment sender must include repaired "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/resources/srpo/user-info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user_info"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request body."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the payment to return to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payments~1{payment_id}~1retry_accept/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentRetryAcceptRequest"}},"schemaId":"components/schemas/PaymentRetryAcceptRequest","pointer":"/paths/~1payments~1{payment_id}~1retry_accept/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{payment_id}/retry_accept","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentRetryAcceptRequest"}},"responseCodes":["200","400","404"],"pointer":"/payments/{payment_id}/retry_accept","href":"non-orchestration-payments/retryacceptpayment","openApiOperationId":"retryAcceptPayment","summary":"Retry accept payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentRetryAcceptRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentRetryAcceptRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully resubmitted payment for locking.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1payments~1{payment_id}~1retry_accept/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/retryacceptpayment"}],"panels":[]}]},"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/ripplenet/non-orchestration-payments/failpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"failPayment","name":"Fail payment","isWebhook":false,"pointer":"/paths/~1payments~1{payment_id}~1fail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fail payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails a payment. Fail payment is a deliberate action that permanently stops the payment and puts it into a non-recoverable state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An institution "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rejects"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a payment to solicit changes to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/resources/srpo/user-info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user_info"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; it "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fails"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a payment to stop it altogether. After a payment has been created by an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/acceptQuote"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accept quote"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, you can fail the payment if it is your institution's turn to take an action on the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The originating institution can fail a payment in states "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCK_DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The beneficiary and intermediary institutions can fail a payment in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state. Beneficiary institutions can also fail a payment in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state. The general use case for failing an executed payment is to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/createQuoteToReturnPayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create quote to return payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the originating institution."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payments in states "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PREPARED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLEMENT_DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can fail "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatically"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"—"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PREPARED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the crypto-transaction expires and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLEMENT_DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the payment expires."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_11","description":"Unique identifier of the payment to fail.","required":true}],"pointer":"/paths/~1payments~1{payment_id}~1fail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentDenyRequest"}},"schemaId":"components/schemas/PaymentDenyRequest","pointer":"/paths/~1payments~1{payment_id}~1fail/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{payment_id}/fail","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentDenyRequest"}},"responseCodes":["200","400","404"],"pointer":"/payments/{payment_id}/fail","href":"non-orchestration-payments/failpayment","openApiOperationId":"failPayment","summary":"Fail payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentDenyRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentDenyRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully failed a payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1payments~1{payment_id}~1fail/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/failpayment"}],"panels":[]}]},"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/ripplenet/non-orchestration-payments/settlepayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"settlePayment","name":"Settle payment","isWebhook":false,"pointer":"/paths/~1payments~1{payment_id}~1settle/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settle payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Executes a payment in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state. Payment senders can also "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retry settling a payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SETTLEMENT_DECLINED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, after the error is corrected (and before the payment expires)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settle payment sends a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"prepare payment transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" message, which travels to all participants in the payment. This sets the payment state to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PREPARED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which means that funds have been transferred to the hold account on that xCurrent ledger."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The beneficiary institution then signs the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution_condition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (creating a payload) and sends an "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"execute payment transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXECUTED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_11","description":"Unique identifier of the payment to settle.","required":true}],"pointer":"/paths/~1payments~1{payment_id}~1settle/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentSettleRequest"}},"schemaId":"components/schemas/PaymentSettleRequest","pointer":"/paths/~1payments~1{payment_id}~1settle/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{payment_id}/settle","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentSettleRequest"}},"responseCodes":["200","400","404","409"],"pointer":"/payments/{payment_id}/settle","href":"non-orchestration-payments/settlepayment","openApiOperationId":"settlePayment","summary":"Settle payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentSettleRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentSettleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully prepared payment settlement. Execution is asynchronous.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"409","description":"Concurrent request already in progress. Any 200 response result is unchanged.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1payments~1{payment_id}~1settle/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"409","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/settlepayment"}],"panels":[]}]},"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/ripplenet/non-orchestration-payments/finalizepayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"finalizePayment","name":"Finalize payment","isWebhook":false,"pointer":"/paths/~1payments~1{payment_id}~1finalize/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Finalize payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Marks a payment with finalized sub-states that reflect what is happening to the payment while it is in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXECUTED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/completePayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complete payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_11","description":"Unique identifier of a payment for which to set a sub-state.","required":true}],"pointer":"/paths/~1payments~1{payment_id}~1finalize/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentFinalizeRequest"}},"schemaId":"components/schemas/PaymentFinalizeRequest","pointer":"/paths/~1payments~1{payment_id}~1finalize/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{payment_id}/finalize","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentFinalizeRequest"}},"responseCodes":["200","400","404"],"pointer":"/payments/{payment_id}/finalize","href":"non-orchestration-payments/finalizepayment","openApiOperationId":"finalizePayment","summary":"Finalize payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentFinalizeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentFinalizeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a payment with sub-states represented as labels.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1payments~1{payment_id}~1finalize/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/finalizepayment"}],"panels":[]}]},"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/ripplenet/non-orchestration-payments/addpaymentsubstate","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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). "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addPaymentSubState","name":"Add payment sub state","isWebhook":false,"pointer":"/paths/~1payments~1{payment_id}~1sub_state/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add payment sub state","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a sub-state to a payment that reflects what is happening to the payment while it is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/completePayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complete payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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). "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_11","description":"Unique identifier of a payment for which to set a sub-state.","required":true}],"pointer":"/paths/~1payments~1{payment_id}~1sub_state/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentSubStateRequest"}},"schemaId":"components/schemas/PaymentSubStateRequest","pointer":"/paths/~1payments~1{payment_id}~1sub_state/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{payment_id}/sub_state","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentSubStateRequest"}},"responseCodes":["200","400","404"],"pointer":"/payments/{payment_id}/sub_state","href":"non-orchestration-payments/addpaymentsubstate","openApiOperationId":"addPaymentSubState","summary":"Add payment sub state"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentSubStateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentSubStateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a payment with sub-states represented as labels.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1payments~1{payment_id}~1sub_state/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/addpaymentsubstate"}],"panels":[]}]},"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/ripplenet/non-orchestration-payments/completepayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"completePayment","name":"Complete payment","isWebhook":false,"pointer":"/paths/~1payments~1{payment_id}~1complete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complete payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Marks a payment as complete by placing it in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the payment to place in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payments~1{payment_id}~1complete/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentCompleteRequest"}},"schemaId":"components/schemas/PaymentCompleteRequest","pointer":"/paths/~1payments~1{payment_id}~1complete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{payment_id}/complete","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentCompleteRequest"}},"responseCodes":["200","400","404"],"pointer":"/payments/{payment_id}/complete","href":"non-orchestration-payments/completepayment","openApiOperationId":"completePayment","summary":"Complete payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentCompleteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentCompleteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a completed payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1payments~1{payment_id}~1complete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/completepayment"}],"panels":[]}]},"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/ripplenet/non-orchestration-payments/addpaymentlabels","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addPaymentLabels","name":"Add payment labels","isWebhook":false,"pointer":"/paths/~1payments~1{payment_id}~1labels/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add payment labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a list of labels to the payment. To retrieve payments by label, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getPayments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get payments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_11","description":"Unique identifier of the payment you want to label.","required":true}],"pointer":"/paths/~1payments~1{payment_id}~1labels/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"label","in":"query","schemaId":"schema_0","description":"Text of the label you want to add to the payment.","required":true}],"pointer":"/paths/~1payments~1{payment_id}~1labels/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/payments/{payment_id}/labels","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"label","in":"query","required":true,"schemaId":"schema_0","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/payments/{payment_id}/labels","href":"non-orchestration-payments/addpaymentlabels","openApiOperationId":"addPaymentLabels","summary":"Add payment labels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully added one or more labels to the payment."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1payments~1{payment_id}~1labels/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/addpaymentlabels"}],"panels":[]}]},"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/ripplenet/non-orchestration-payments/deletepaymentlabels","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePaymentLabels","name":"Delete payment labels","isWebhook":false,"pointer":"/paths/~1payments~1{payment_id}~1labels/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete payment labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an existing label from a payment. The label you provide is deleted from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array in the Payment object."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_11","description":"Unique identifier of the payment from which to delete a label.","required":true}],"pointer":"/paths/~1payments~1{payment_id}~1labels/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"label","in":"query","schemaId":"schema_0","description":"Text of the label you want to delete from the payment.","required":true}],"pointer":"/paths/~1payments~1{payment_id}~1labels/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/payments/{payment_id}/labels","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"label","in":"query","required":true,"schemaId":"schema_0","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/payments/{payment_id}/labels","href":"non-orchestration-payments/deletepaymentlabels","openApiOperationId":"deletePaymentLabels","summary":"Delete payment labels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted label from payment."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Labels to be deleted not found on the payment ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1payments~1{payment_id}~1labels/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/deletepaymentlabels"}],"panels":[]}]},"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/ripplenet/non-orchestration-payments/getpaymentnodestatus","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentNodeStatus","name":"Get payment node status","isWebhook":false,"pointer":"/paths/~1payments~1{payment_id}~1node-status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payment node status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Senders can query for the RippleNet instances (in a given payment chain) that have payments in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state. This information is only stored on the sender's RippleNet instance."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_11","description":"Unique identifier of the payment for which to get states on each node participating in the payment.","required":true}],"pointer":"/paths/~1payments~1{payment_id}~1node-status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{payment_id}/node-status","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/payments/{payment_id}/node-status","href":"non-orchestration-payments/getpaymentnodestatus","openApiOperationId":"getPaymentNodeStatus","summary":"Get payment node status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved payment states on each node participating in the payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1payments~1{payment_id}~1node-status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/getpaymentnodestatus"}],"panels":[]}]},"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/ripplenet/non-orchestration-payments/getfilteredpaymentbypaymentid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFilteredPaymentByPaymentId","name":"Get filtered payment by payment ID","isWebhook":false,"pointer":"/paths/~1payments~1filtered~1{payment_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get filtered payment by payment ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a sanitized payment with sensitive content filtered from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_info"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_info"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is customizable in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rnn.properties"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Content that is denylisted by default:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/Cdtr, /CdtrAcct, /Dbtr, /DbtrAcct, /InitgPty, /InstForCdtrAgt, /Purp, /RgltryRptg, /RltdRmtInf, /RmtInf, /UltmtCdtr, /UltmtDbtr, /outbound_instructions/beneficiary_info"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_11","description":"Unique identifier of the filtered payment you want to retrieve.","required":true}],"pointer":"/paths/~1payments~1filtered~1{payment_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/filtered/{payment_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/payments/filtered/{payment_id}","href":"non-orchestration-payments/getfilteredpaymentbypaymentid","openApiOperationId":"getFilteredPaymentByPaymentId","summary":"Get filtered payment by payment ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved filtered payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FilteredPayment"}},"schemaId":"components/schemas/FilteredPayment"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1payments~1filtered~1{payment_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FilteredPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FilteredPayment"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/getfilteredpaymentbypaymentid"}],"panels":[]}]},"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/ripplenet/non-orchestration-payments/createquotetoreturnpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createQuoteToReturnPayment","name":"Create quote to return payment","isWebhook":false,"pointer":"/paths/~1quote_collections~1return/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create quote to return payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a collection of quotes that can be used to return a payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The receiver can make this request while the payment is in states "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When the returned payment is successfully moved to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, the original payment is moved to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Currently, when making a Return Payment to a RippleNet Cloud account on a RippleNet ledger, the RippleNet user must lock and complete the payment. This means that the RippleNet user takes all action on the return: Get and Accept Quote, Lock, Settle, and Complete payment."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentReturnQuoteRequest"}},"schemaId":"components/schemas/PaymentReturnQuoteRequest","pointer":"/paths/~1quote_collections~1return/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quote_collections/return","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentReturnQuoteRequest"}},"responseCodes":["200","400","404","500"],"pointer":"/quote_collections/return","href":"non-orchestration-payments/createquotetoreturnpayment","openApiOperationId":"createQuoteToReturnPayment","summary":"Create quote to return payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentReturnQuoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentReturnQuoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned a collection of quotes to return a payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteCollection"}},"schemaId":"components/schemas/QuoteCollection"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Payment not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"500","description":"Server Error - an internal error occured while making Return Quote calls.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1quote_collections~1return/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteCollection"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"500","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/createquotetoreturnpayment"}],"panels":[]}]},"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/ripplenet/non-orchestration-payments/createquotetoreversepayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createQuoteToReversePayment","name":"Create quote to reverse payment","isWebhook":false,"pointer":"/paths/~1quote_collections~1reversal/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create quote to reverse payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a quote collection containing at most one quote that can be used to reverse a payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The receiver can make this request while the payment is in states "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When the returned payment is successfully moved to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, the original payment is moved to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Currently, when making a Reversal Payment to a RippleNet Cloud account on a RippleNet ledger, the RippleNet user must lock and complete the payment. This means that the RippleNet user takes all action on the reverse: Get and Accept Quote, Lock, Settle, and Complete payment."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentReversalQuoteRequest"}},"schemaId":"components/schemas/PaymentReversalQuoteRequest","pointer":"/paths/~1quote_collections~1reversal/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quote_collections/reversal","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentReversalQuoteRequest"}},"responseCodes":["200","400","404","500"],"pointer":"/quote_collections/reversal","href":"non-orchestration-payments/createquotetoreversepayment","openApiOperationId":"createQuoteToReversePayment","summary":"Create quote to reverse payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentReversalQuoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentReversalQuoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned a collection of quotes to return a payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteCollection"}},"schemaId":"components/schemas/QuoteCollection"},{"code":"400","description":"Original payment has previously been returned, reversed, or is in an invalid payment state for reversal.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Original payment was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"500","description":"Reversals are disabled on this instance.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1quote_collections~1reversal/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteCollection"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"500","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/non-orchestration-payments/createquotetoreversepayment"}],"panels":[]}]},"httpPath":"/quote_collections/reversal"}],"content":{"contentType":"group","meta":{"name":"Non-orchestration payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Non-orchestration payments","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payments","summary":"Get payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/non-orchestration-payments/getpayments","deprecated":false},{"title":"/payments/{payment_id}","summary":"Get payment by payment ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/non-orchestration-payments/getpaymentbypaymentid","deprecated":false},{"title":"/payments/{payment_id}/lock","summary":"Lock payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/non-orchestration-payments/lockpayment","deprecated":false},{"title":"/payments/{payment_id}/reject","summary":"Reject lock payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/non-orchestration-payments/rejectlockpayment","deprecated":false},{"title":"/payments/{payment_id}/retry_accept","summary":"Retry accept payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/non-orchestration-payments/retryacceptpayment","deprecated":false},{"title":"/payments/{payment_id}/fail","summary":"Fail payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/non-orchestration-payments/failpayment","deprecated":false},{"title":"/payments/{payment_id}/settle","summary":"Settle payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/non-orchestration-payments/settlepayment","deprecated":false},{"title":"/payments/{payment_id}/finalize","summary":"Finalize payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/non-orchestration-payments/finalizepayment","deprecated":false},{"title":"/payments/{payment_id}/sub_state","summary":"Add payment sub state","prefix":{"name":"post","color":"post"},"badges":[],"link":"/non-orchestration-payments/addpaymentsubstate","deprecated":false},{"title":"/payments/{payment_id}/complete","summary":"Complete payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/non-orchestration-payments/completepayment","deprecated":false},{"title":"/payments/{payment_id}/labels","summary":"Add payment labels","prefix":{"name":"put","color":"put"},"badges":[],"link":"/non-orchestration-payments/addpaymentlabels","deprecated":false},{"title":"/payments/{payment_id}/labels","summary":"Delete payment labels","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/non-orchestration-payments/deletepaymentlabels","deprecated":false},{"title":"/payments/{payment_id}/node-status","summary":"Get payment node status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/non-orchestration-payments/getpaymentnodestatus","deprecated":false},{"title":"/payments/filtered/{payment_id}","summary":"Get filtered payment by payment ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/non-orchestration-payments/getfilteredpaymentbypaymentid","deprecated":false},{"title":"/quote_collections/return","summary":"Create quote to return payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/non-orchestration-payments/createquotetoreturnpayment","deprecated":false},{"title":"/quote_collections/reversal","summary":"Create quote to reverse payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/non-orchestration-payments/createquotetoreversepayment","deprecated":false}]}]}]}]}},{"type":"group","label":"Notifications","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/notifications","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/notifications","items":[{"label":"Get notifications by status and priority","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/notifications/getnotificationsbystatusandpriority","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/notifications/getnotificationsbystatusandpriority","metadata":{"seo":{"title":"Get notifications by status and priority","description":"Get notification entities by notification status and priority"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNotificationsByStatusAndPriority","name":"Get notifications by status and priority","isWebhook":false,"pointer":"/paths/~1notifications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get notifications by status and priority","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get notification entities by notification status and priority"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of notification objects to return per page."},{"name":"notification_status","in":"query","schemaId":"schema_23","description":"Status of ripplenet notifications."},{"name":"notification_priority","in":"query","schemaId":"schema_24","description":"Priority of ripplenet notifications."},{"name":"sort_field","in":"query","schemaId":"schema_25","description":"describes how to sort the results."},{"name":"sort_direction","in":"query","schemaId":"schema_6","description":"Direction of sorted results."}],"pointer":"/paths/~1notifications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notifications","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"},{"name":"notification_status","in":"query","required":false,"schemaId":"schema_23"},{"name":"notification_priority","in":"query","required":false,"schemaId":"schema_24"},{"name":"sort_field","in":"query","required":false,"schemaId":"schema_25"},{"name":"sort_direction","in":"query","required":false,"schemaId":"schema_6"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/notifications","href":"notifications/getnotificationsbystatusandpriority","openApiOperationId":"getNotificationsByStatusAndPriority","summary":"Get notifications by status and priority"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned notifications for the request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationResponsePage"}},"schemaId":"components/schemas/NotificationResponsePage"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Notifications not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1notifications/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotificationResponsePage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationResponsePage"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/getnotificationsbystatusandpriority"}],"panels":[]}]},"httpPath":"/notifications"},{"label":"Get notification by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/notifications/getnotificationbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/notifications/getnotificationbyid","metadata":{"seo":{"title":"Get notification by ID","description":"Get Notification entity by notification id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNotificationById","name":"Get notification by ID","isWebhook":false,"pointer":"/paths/~1notifications~1{notification_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get notification by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Notification entity by notification id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"notification_id","in":"path","schemaId":"schema_11","description":"NotificationId","required":true}],"pointer":"/paths/~1notifications~1{notification_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notifications/{notification_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"notification_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/notifications/{notification_id}","href":"notifications/getnotificationbyid","openApiOperationId":"getNotificationById","summary":"Get notification by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned Notification for the request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationResponse"}},"schemaId":"components/schemas/NotificationResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"},{"code":"404","description":"Notification with provided Id not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1notifications~1{notification_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotificationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/getnotificationbyid"}],"panels":[]}]},"httpPath":"/notifications/{notification_id}"}],"content":{"contentType":"group","meta":{"name":"Notifications"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notifications","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/notifications","summary":"Get notifications by status and priority","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/getnotificationsbystatusandpriority","deprecated":false},{"title":"/notifications/{notification_id}","summary":"Get notification by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/getnotificationbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"ODL flags configuration","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/odl-flags-configuration","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/odl-flags-configuration","items":[{"label":"Create ODL flag configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/odl-flags-configuration/createodlflagconfig","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/odl-flags-configuration/createodlflagconfig","metadata":{"seo":{"title":"Create ODL flag configuration","description":"Create a new flag configuration to decide which flags will be passed to ODL"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createODLFlagConfig","name":"Create ODL flag configuration","isWebhook":false,"pointer":"/paths/~1config~1odl_flags_config/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create ODL flag configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new flag configuration to decide which flags will be passed to ODL"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateODLFlagConfigRequest"}},"schemaId":"components/schemas/CreateODLFlagConfigRequest","pointer":"/paths/~1config~1odl_flags_config/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/config/odl_flags_config","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateODLFlagConfigRequest"}},"responseCodes":["200","400"],"pointer":"/config/odl_flags_config","href":"odl-flags-configuration/createodlflagconfig","openApiOperationId":"createODLFlagConfig","summary":"Create ODL flag configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/CreateODLFlagConfigRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateODLFlagConfigRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created ODLFlag configuration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ODLFlagConfigResponse"}},"schemaId":"components/schemas/ODLFlagConfigResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1odl_flags_config/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ODLFlagConfigResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ODLFlagConfigResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/odl-flags-configuration/createodlflagconfig"}],"panels":[]}]},"httpPath":"/config/odl_flags_config"},{"label":"Get all ODL flag configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/odl-flags-configuration/getallodlflagconfigs","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/odl-flags-configuration/getallodlflagconfigs","metadata":{"seo":{"title":"Get all ODL flag configurations","description":"Returns all ODL Flag configurations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllODLFlagConfigs","name":"Get all ODL flag configurations","isWebhook":false,"pointer":"/paths/~1config~1odl_flags_config/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all ODL flag configurations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all ODL Flag configurations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of payments to return per page."},{"name":"flag","in":"query","schemaId":"schema_4","description":"Filter responses by flag"}],"pointer":"/paths/~1config~1odl_flags_config/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/odl_flags_config","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"},{"name":"flag","in":"query","required":false,"schemaId":"schema_4"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/odl_flags_config","href":"odl-flags-configuration/getallodlflagconfigs","openApiOperationId":"getAllODLFlagConfigs","summary":"Get all ODL flag configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a paged list of ODL FLag configurations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ODLFlagConfigsPage"}},"schemaId":"components/schemas/ODLFlagConfigsPage"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1odl_flags_config/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ODLFlagConfigsPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ODLFlagConfigsPage"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/odl-flags-configuration/getallodlflagconfigs"}],"panels":[]}]},"httpPath":"/config/odl_flags_config"},{"label":"Get ODL flag configuration by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/odl-flags-configuration/getodlflagconfigbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/odl-flags-configuration/getodlflagconfigbyid","metadata":{"seo":{"title":"Get ODL flag configuration by ID","description":"Returns a ODL Flag configuration by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getODLFlagConfigById","name":"Get ODL flag configuration by ID","isWebhook":false,"pointer":"/paths/~1config~1odl_flags_config~1{odl_flag_config_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get ODL flag configuration by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a ODL Flag configuration by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"odl_flag_config_id","in":"path","schemaId":"schema_11","description":"ID of the odl flag configuration you want to retrieve.","required":true}],"pointer":"/paths/~1config~1odl_flags_config~1{odl_flag_config_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/odl_flags_config/{odl_flag_config_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"odl_flag_config_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/odl_flags_config/{odl_flag_config_id}","href":"odl-flags-configuration/getodlflagconfigbyid","openApiOperationId":"getODLFlagConfigById","summary":"Get ODL flag configuration by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ODL Flag Configuration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ODLFlagConfigResponse"}},"schemaId":"components/schemas/ODLFlagConfigResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1odl_flags_config~1{odl_flag_config_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ODLFlagConfigResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ODLFlagConfigResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/odl-flags-configuration/getodlflagconfigbyid"}],"panels":[]}]},"httpPath":"/config/odl_flags_config/{odl_flag_config_id}"},{"label":"Update ODL flag configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/odl-flags-configuration/updateodlflagconfig","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/odl-flags-configuration/updateodlflagconfig","metadata":{"seo":{"title":"Update ODL flag configuration","description":"Updates an existing ODL Flag configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateODLFlagConfig","name":"Update ODL flag configuration","isWebhook":false,"pointer":"/paths/~1config~1odl_flags_config~1{odl_flag_config_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update ODL flag configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing ODL Flag configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"odl_flag_config_id","in":"path","schemaId":"schema_11","description":"ID of the odl flag configuration you want to retrieve.","required":true}],"pointer":"/paths/~1config~1odl_flags_config~1{odl_flag_config_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateODLFlagConfigRequest"}},"schemaId":"components/schemas/UpdateODLFlagConfigRequest","pointer":"/paths/~1config~1odl_flags_config~1{odl_flag_config_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/config/odl_flags_config/{odl_flag_config_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"odl_flag_config_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateODLFlagConfigRequest"}},"responseCodes":["200","400"],"pointer":"/config/odl_flags_config/{odl_flag_config_id}","href":"odl-flags-configuration/updateodlflagconfig","openApiOperationId":"updateODLFlagConfig","summary":"Update ODL flag configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/UpdateODLFlagConfigRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateODLFlagConfigRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated ODL Flag Configration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ODLFlagConfigResponse"}},"schemaId":"components/schemas/ODLFlagConfigResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1odl_flags_config~1{odl_flag_config_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ODLFlagConfigResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ODLFlagConfigResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/odl-flags-configuration/updateodlflagconfig"}],"panels":[]}]},"httpPath":"/config/odl_flags_config/{odl_flag_config_id}"},{"label":"Delete ODL flag configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/odl-flags-configuration/deleteodlflagconfig","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/odl-flags-configuration/deleteodlflagconfig","metadata":{"seo":{"title":"Delete ODL flag configuration","description":"Deletes an ODL Flag configuration by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteODLFlagConfig","name":"Delete ODL flag configuration","isWebhook":false,"pointer":"/paths/~1config~1odl_flags_config~1{odl_flag_config_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete ODL flag configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an ODL Flag  configuration by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"odl_flag_config_id","in":"path","schemaId":"schema_11","description":"ID of the odl flag configuration you want to retrieve.","required":true}],"pointer":"/paths/~1config~1odl_flags_config~1{odl_flag_config_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/config/odl_flags_config/{odl_flag_config_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"odl_flag_config_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/config/odl_flags_config/{odl_flag_config_id}","href":"odl-flags-configuration/deleteodlflagconfig","openApiOperationId":"deleteODLFlagConfig","summary":"Delete ODL flag configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted ODL Flag Config successfully"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1odl_flags_config~1{odl_flag_config_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/odl-flags-configuration/deleteodlflagconfig"}],"panels":[]}]},"httpPath":"/config/odl_flags_config/{odl_flag_config_id}"}],"content":{"contentType":"group","meta":{"name":"ODL flags configuration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ODL flags configuration","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/config/odl_flags_config","summary":"Create ODL flag configuration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/odl-flags-configuration/createodlflagconfig","deprecated":false},{"title":"/config/odl_flags_config","summary":"Get all ODL flag configurations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/odl-flags-configuration/getallodlflagconfigs","deprecated":false},{"title":"/config/odl_flags_config/{odl_flag_config_id}","summary":"Get ODL flag configuration by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/odl-flags-configuration/getodlflagconfigbyid","deprecated":false},{"title":"/config/odl_flags_config/{odl_flag_config_id}","summary":"Update ODL flag configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/odl-flags-configuration/updateodlflagconfig","deprecated":false},{"title":"/config/odl_flags_config/{odl_flag_config_id}","summary":"Delete ODL flag configuration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/odl-flags-configuration/deleteodlflagconfig","deprecated":false}]}]}]}]}},{"type":"group","label":"Orchestration payments","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-payments","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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/ripplenet/orchestration-payments/createorchestrationpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-payments/createorchestrationpayment","metadata":{"seo":{"title":"Create orchestration payment","description":"Creates an orchestration payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrchestrationPayment","name":"Create orchestration payment","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1payment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create orchestration payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an orchestration payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentRequest"}},"schemaId":"components/schemas/OrchestrationPaymentRequest","pointer":"/paths/~1v4~1orchestration~1payment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/orchestration/payment","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentRequest"}},"responseCodes":["201"],"pointer":"/v4/orchestration/payment","href":"orchestration-payments/createorchestrationpayment","openApiOperationId":"createOrchestrationPayment","summary":"Create orchestration payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/OrchestrationPaymentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created orchestration payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentSubmitResponse"}},"schemaId":"components/schemas/OrchestrationPaymentSubmitResponse"}],"pointer":"/paths/~1v4~1orchestration~1payment/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/OrchestrationPaymentSubmitResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentSubmitResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-payments/createorchestrationpayment"}],"panels":[]}]},"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/ripplenet/orchestration-payments/getorchestrationpayments","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-payments/getorchestrationpayments","metadata":{"seo":{"title":"Get orchestration payments","description":"Gets a list of orchestration payments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrchestrationPayments","name":"Get orchestration payments","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1payment/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get orchestration payments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of orchestration payments."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_26","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of objects to return per page."},{"name":"sort_field","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute to sort the results on."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum:"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort by"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREATED_AT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Created date-time"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MODIFIED_AT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modified date-time"},"children":[]}]}]}]}]}]}]},{"name":"sort_direction","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direction of sorted results based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum:"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort ascending"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort descending"},"children":[]}]}]}]}]}]}]},{"name":"unique_reference_number","in":"query","schemaId":"schema_4","description":"Parameter for filtering with unique reference number."},{"name":"orchestration_status","in":"query","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter for filtering with status of the orchestration payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INITIAL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by payments in the initial state"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RUNNING"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by payments in the running state"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by completed payments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAUSED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by paused payments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILURE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by payment failures"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DECLINED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by declined payments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RETRY"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by payments that have a retry status"},"children":[]}]}]}]}]}]}]},{"name":"range_field","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Range field"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Designates the column name of the payments database table that is used for filtering payments before/after/between time stamps."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following options are valid:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Range field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREATED_AT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by created date-time"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MODIFIED_AT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by modified date-time"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example usage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MODIFIED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you need to specify a time stamp (in the 24 character ISO 8601 format used in payment objects: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:mm:ss.sssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as the value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch payments before, after, or between the specified time range(s) (inclusive)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dependency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"before","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" time stamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters for payments where the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column value is before this specified time stamp (inclusive)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a time range between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dependency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2023-10-13T10:16:29.000Z"},"children":[]}]}]}]},{"name":"after","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" time stamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters for payments where the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column value is after this specified time stamp (inclusive)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a time range between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dependency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2023-10-13T10:16:29.000Z"},"children":[]}]}]}]}],"pointer":"/paths/~1v4~1orchestration~1payment/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/payment","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_26"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"},{"name":"sort_field","in":"query","required":false,"schemaId":"schema_27"},{"name":"sort_direction","in":"query","required":false,"schemaId":"schema_6"},{"name":"unique_reference_number","in":"query","required":false,"schemaId":"schema_4"},{"name":"orchestration_status","in":"query","required":false,"schemaId":"schema_28"},{"name":"range_field","in":"query","required":false,"schemaId":"schema_4"},{"name":"before","in":"query","required":false,"schemaId":"schema_4"},{"name":"after","in":"query","schemaId":"schema_4"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/payment","href":"orchestration-payments/getorchestrationpayments","openApiOperationId":"getOrchestrationPayments","summary":"Get orchestration payments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully fetched all orchestration payments.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationPayments"}},"schemaId":"components/schemas/OrchestrationPayments"}],"pointer":"/paths/~1v4~1orchestration~1payment/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrchestrationPayments","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationPayments"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-payments/getorchestrationpayments"}],"panels":[]}]},"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/ripplenet/orchestration-payments/getorchestrationpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-payments/getorchestrationpayment","metadata":{"seo":{"title":"Get orchestration payment","description":"Gets orchestration payment by unique reference number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrchestrationPayment","name":"Get orchestration payment","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1payment~1{uniqueReferenceNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get orchestration payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets orchestration payment by unique reference number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uniqueReferenceNumber","in":"path","schemaId":"schema_29","description":"Unique reference number of the orchestration payment to fetch.","required":true}],"pointer":"/paths/~1v4~1orchestration~1payment~1{uniqueReferenceNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/payment/{uniqueReferenceNumber}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"uniqueReferenceNumber","in":"path","required":true,"schemaId":"schema_29"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/payment/{uniqueReferenceNumber}","href":"orchestration-payments/getorchestrationpayment","openApiOperationId":"getOrchestrationPayment","summary":"Get orchestration payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned orchestration payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentResponse"}},"schemaId":"components/schemas/OrchestrationPaymentResponse"}],"pointer":"/paths/~1v4~1orchestration~1payment~1{uniqueReferenceNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrchestrationPaymentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-payments/getorchestrationpayment"}],"panels":[]}]},"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/ripplenet/orchestration-payments/returnorchestrationpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-payments/returnorchestrationpayment","metadata":{"seo":{"title":"Return orchestration payment","description":"Returns the orchestration payment with customer end-to-end ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"returnOrchestrationPayment","name":"Return orchestration payment","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1payment~1return/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return orchestration payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the orchestration payment with customer end-to-end ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentReturnRequest"}},"schemaId":"components/schemas/OrchestrationPaymentReturnRequest","pointer":"/paths/~1v4~1orchestration~1payment~1return/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/orchestration/payment/return","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentReturnRequest"}},"responseCodes":["201"],"pointer":"/v4/orchestration/payment/return","href":"orchestration-payments/returnorchestrationpayment","openApiOperationId":"returnOrchestrationPayment","summary":"Return orchestration payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/OrchestrationPaymentReturnRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentReturnRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully returned orchestration payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentSubmitResponse"}},"schemaId":"components/schemas/OrchestrationPaymentSubmitResponse"}],"pointer":"/paths/~1v4~1orchestration~1payment~1return/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/OrchestrationPaymentSubmitResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentSubmitResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-payments/returnorchestrationpayment"}],"panels":[]}]},"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/ripplenet/orchestration-payments/acceptorchestrationpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-payments/acceptorchestrationpayment","metadata":{"seo":{"title":"Accept orchestration payment","description":"Accepts the orchestration payment with customer end-to-end ID and Quote ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"acceptOrchestrationPayment","name":"Accept orchestration payment","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1payment~1accept/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept orchestration payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Accepts the orchestration payment with customer end-to-end ID and Quote ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentAcceptRequest"}},"schemaId":"components/schemas/OrchestrationPaymentAcceptRequest","pointer":"/paths/~1v4~1orchestration~1payment~1accept/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/orchestration/payment/accept","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentAcceptRequest"}},"responseCodes":["201"],"pointer":"/v4/orchestration/payment/accept","href":"orchestration-payments/acceptorchestrationpayment","openApiOperationId":"acceptOrchestrationPayment","summary":"Accept orchestration payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/OrchestrationPaymentAcceptRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentAcceptRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully accepted orchestration payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentSubmitResponse"}},"schemaId":"components/schemas/OrchestrationPaymentSubmitResponse"}],"pointer":"/paths/~1v4~1orchestration~1payment~1accept/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/OrchestrationPaymentSubmitResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentSubmitResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-payments/acceptorchestrationpayment"}],"panels":[]}]},"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/ripplenet/orchestration-payments/reverseorchestrationpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-payments/reverseorchestrationpayment","metadata":{"seo":{"title":"Reverse orchestration payment","description":"Reverses the orchestration payment with customer end-to-end ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reverseOrchestrationPayment","name":"Reverse orchestration payment","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1payment~1reversal/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reverse orchestration payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reverses the orchestration payment with customer end-to-end ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentReversalRequest"}},"schemaId":"components/schemas/OrchestrationPaymentReversalRequest","pointer":"/paths/~1v4~1orchestration~1payment~1reversal/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/orchestration/payment/reversal","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentReversalRequest"}},"responseCodes":["201"],"pointer":"/v4/orchestration/payment/reversal","href":"orchestration-payments/reverseorchestrationpayment","openApiOperationId":"reverseOrchestrationPayment","summary":"Reverse orchestration payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/OrchestrationPaymentReversalRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentReversalRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully returned orchestration payment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentSubmitResponse"}},"schemaId":"components/schemas/OrchestrationPaymentSubmitResponse"}],"pointer":"/paths/~1v4~1orchestration~1payment~1reversal/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/OrchestrationPaymentSubmitResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationPaymentSubmitResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-payments/reverseorchestrationpayment"}],"panels":[]}]},"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/ripplenet/orchestration-payments/getorchestrationpaymentnotifications","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-payments/getorchestrationpaymentnotifications","metadata":{"seo":{"title":"Get orchestration notifications by status","description":"Gets a list of orchestration payment notifications with a given status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrchestrationPaymentNotifications","name":"Get orchestration notifications by status","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1payment~1notification/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get orchestration notifications by status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of orchestration payment notifications with a given status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_30","description":"The 'status' of the notifications to retrieve.","required":true},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of objects to return per page."},{"name":"delay_time","in":"query","schemaId":"schema_31","description":"Delay time in minutes to retrieve the SENT notifications."},{"name":"range_field","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Range Field"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Designates the column name of the notifications database table that is used for filtering notifications before/after/between time stamps."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following options are valid:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Range field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CREATED_AT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by created date-time"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MODIFIED_AT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by modified date-time"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example usage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MODIFIED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you need to specify a time stamp (in the 24 character ISO 8601 format used in notifications objects: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:mm:ss.sssZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as the value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch notifications before, after, or between the specified time range(s) (inclusive)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dependency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be specified."},"children":[]}]}]}]},{"name":"before","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" time stamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters for notifications where the notifications "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column value is before this specified time stamp (inclusive)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a time range between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dependency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2023-10-13T10:16:29.000Z"},"children":[]}]}]}]},{"name":"after","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" time stamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters for notifications where the notifications "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column value is after this specified time stamp (inclusive)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a time range between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dependency"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2023-10-13T10:16:29.000Z"},"children":[]}]}]}]}],"pointer":"/paths/~1v4~1orchestration~1payment~1notification/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/payment/notification","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"status","in":"query","required":true,"schemaId":"schema_30"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"},{"name":"delay_time","in":"query","required":false,"schemaId":"schema_31"},{"name":"range_field","in":"query","required":false,"schemaId":"schema_4"},{"name":"before","in":"query","required":false,"schemaId":"schema_4"},{"name":"after","in":"query","schemaId":"schema_4"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/payment/notification","href":"orchestration-payments/getorchestrationpaymentnotifications","openApiOperationId":"getOrchestrationPaymentNotifications","summary":"Get orchestration notifications by status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully fetched orchestration payment notifications list.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationList"}},"schemaId":"components/schemas/NotificationList"}],"pointer":"/paths/~1v4~1orchestration~1payment~1notification/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotificationList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-payments/getorchestrationpaymentnotifications"}],"panels":[]}]},"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/ripplenet/orchestration-payments/getorchestrationpaymentnotificationsbyuniquereferencenumber","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-payments/getorchestrationpaymentnotificationsbyuniquereferencenumber","metadata":{"seo":{"title":"Get orchestration notifications by unique reference number","description":"Gets orchestration payment notifications with a given unique reference number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrchestrationPaymentNotificationsByUniqueReferenceNumber","name":"Get orchestration notifications by unique reference number","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1payment~1notification~1urn~1{uniqueReferenceNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get orchestration notifications by unique reference number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets orchestration payment notifications with a given unique reference number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uniqueReferenceNumber","in":"path","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_end_to_end_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the orchestration payment notification in case of sender and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in case of receiver."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v4~1orchestration~1payment~1notification~1urn~1{uniqueReferenceNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/payment/notification/urn/{uniqueReferenceNumber}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"uniqueReferenceNumber","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/payment/notification/urn/{uniqueReferenceNumber}","href":"orchestration-payments/getorchestrationpaymentnotificationsbyuniquereferencenumber","openApiOperationId":"getOrchestrationPaymentNotificationsByUniqueReferenceNumber","summary":"Get orchestration notifications by unique reference number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully fetched orchestration payment notifications.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationList"}},"schemaId":"components/schemas/NotificationList"}],"pointer":"/paths/~1v4~1orchestration~1payment~1notification~1urn~1{uniqueReferenceNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotificationList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-payments/getorchestrationpaymentnotificationsbyuniquereferencenumber"}],"panels":[]}]},"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/ripplenet/orchestration-payments/getorchestrationpaymentnotificationbyuuid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-payments/getorchestrationpaymentnotificationbyuuid","metadata":{"seo":{"title":"Get orchestration notification","description":"Gets a given orchestration payment notification by UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrchestrationPaymentNotificationByUUID","name":"Get orchestration notification","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1payment~1notification~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get orchestration notification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a given orchestration payment notification by UUID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_11","description":"The UUID of the orchestration payment notification.","required":true}],"pointer":"/paths/~1v4~1orchestration~1payment~1notification~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/payment/notification/{uuid}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/payment/notification/{uuid}","href":"orchestration-payments/getorchestrationpaymentnotificationbyuuid","openApiOperationId":"getOrchestrationPaymentNotificationByUUID","summary":"Get orchestration notification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully fetched orchestration paymnet notification.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationResponseRos"}},"schemaId":"components/schemas/NotificationResponseRos"}],"pointer":"/paths/~1v4~1orchestration~1payment~1notification~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotificationResponseRos","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationResponseRos"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-payments/getorchestrationpaymentnotificationbyuuid"}],"panels":[]}]},"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/ripplenet/orchestration-payments/acknowledgeorchestrationpaymentnotificationbyuuid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-payments/acknowledgeorchestrationpaymentnotificationbyuuid","metadata":{"seo":{"title":"Acknowledge orchestration notification","description":"Acknowledges an orchestration payment notification with a specified UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"acknowledgeOrchestrationPaymentNotificationByUUID","name":"Acknowledge orchestration notification","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1payment~1notification~1{uuid}~1ack/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Acknowledge orchestration notification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Acknowledges an orchestration payment notification with a specified UUID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_11","description":"The UUID of the orchestration payment notification.","required":true}],"pointer":"/paths/~1v4~1orchestration~1payment~1notification~1{uuid}~1ack/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/orchestration/payment/notification/{uuid}/ack","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/payment/notification/{uuid}/ack","href":"orchestration-payments/acknowledgeorchestrationpaymentnotificationbyuuid","openApiOperationId":"acknowledgeOrchestrationPaymentNotificationByUUID","summary":"Acknowledge orchestration notification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated orchestration payment notification status.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationResponseRos"}},"schemaId":"components/schemas/NotificationResponseRos"}],"pointer":"/paths/~1v4~1orchestration~1payment~1notification~1{uuid}~1ack/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotificationResponseRos","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationResponseRos"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-payments/acknowledgeorchestrationpaymentnotificationbyuuid"}],"panels":[]}]},"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/ripplenet/orchestration-payments/acknowledgeorchestrationpaymentnotifications","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-payments/acknowledgeorchestrationpaymentnotifications","metadata":{"seo":{"title":"Acknowledge orchestration notifications","description":"Acknowledges multiple orchestration payment notifications using a list of UUIDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"acknowledgeOrchestrationPaymentNotifications","name":"Acknowledge orchestration notifications","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1payment~1notification~1ack/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Acknowledge orchestration notifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Acknowledges multiple orchestration payment notifications using a list of UUIDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NotificationUUIDList"}},"schemaId":"components/schemas/NotificationUUIDList","pointer":"/paths/~1v4~1orchestration~1payment~1notification~1ack/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/orchestration/payment/notification/ack","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NotificationUUIDList"}},"responseCodes":["200"],"pointer":"/v4/orchestration/payment/notification/ack","href":"orchestration-payments/acknowledgeorchestrationpaymentnotifications","openApiOperationId":"acknowledgeOrchestrationPaymentNotifications","summary":"Acknowledge orchestration notifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/NotificationUUIDList","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NotificationUUIDList"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully acknowledged orchestration payment notifications.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationAckResponse"}},"schemaId":"components/schemas/NotificationAckResponse"}],"pointer":"/paths/~1v4~1orchestration~1payment~1notification~1ack/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotificationAckResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationAckResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-payments/acknowledgeorchestrationpaymentnotifications"}],"panels":[]}]},"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/ripplenet/orchestration-payments/sendorchestrationpaymentaction","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-payments/sendorchestrationpaymentaction","metadata":{"seo":{"title":"Post action to orchestration payment","description":"Posts action into the Orchestration service."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendOrchestrationPaymentAction","name":"Post action to orchestration payment","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1payment~1action/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post action to orchestration payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Posts action into the Orchestration service."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentActionRequest"}},"schemaId":"components/schemas/PaymentActionRequest","pointer":"/paths/~1v4~1orchestration~1payment~1action/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/orchestration/payment/action","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentActionRequest"}},"responseCodes":["201"],"pointer":"/v4/orchestration/payment/action","href":"orchestration-payments/sendorchestrationpaymentaction","openApiOperationId":"sendOrchestrationPaymentAction","summary":"Post action to orchestration payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentActionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentActionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully posted action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentActionResponse"}},"schemaId":"components/schemas/PaymentActionResponse"}],"pointer":"/paths/~1v4~1orchestration~1payment~1action/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/PaymentActionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentActionResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-payments/sendorchestrationpaymentaction"}],"panels":[]}]},"httpPath":"/v4/orchestration/payment/action"}],"content":{"contentType":"group","meta":{"name":"Orchestration payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orchestration payments","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/orchestration/payment","summary":"Create orchestration payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orchestration-payments/createorchestrationpayment","deprecated":false},{"title":"/v4/orchestration/payment","summary":"Get orchestration payments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orchestration-payments/getorchestrationpayments","deprecated":false},{"title":"/v4/orchestration/payment/{uniqueReferenceNumber}","summary":"Get orchestration payment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orchestration-payments/getorchestrationpayment","deprecated":false},{"title":"/v4/orchestration/payment/return","summary":"Return orchestration payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orchestration-payments/returnorchestrationpayment","deprecated":false},{"title":"/v4/orchestration/payment/accept","summary":"Accept orchestration payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orchestration-payments/acceptorchestrationpayment","deprecated":false},{"title":"/v4/orchestration/payment/reversal","summary":"Reverse orchestration payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orchestration-payments/reverseorchestrationpayment","deprecated":false},{"title":"/v4/orchestration/payment/notification","summary":"Get orchestration notifications by status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orchestration-payments/getorchestrationpaymentnotifications","deprecated":false},{"title":"/v4/orchestration/payment/notification/urn/{uniqueReferenceNumber}","summary":"Get orchestration notifications by unique reference number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orchestration-payments/getorchestrationpaymentnotificationsbyuniquereferencenumber","deprecated":false},{"title":"/v4/orchestration/payment/notification/{uuid}","summary":"Get orchestration notification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orchestration-payments/getorchestrationpaymentnotificationbyuuid","deprecated":false},{"title":"/v4/orchestration/payment/notification/{uuid}/ack","summary":"Acknowledge orchestration notification","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orchestration-payments/acknowledgeorchestrationpaymentnotificationbyuuid","deprecated":false},{"title":"/v4/orchestration/payment/notification/ack","summary":"Acknowledge orchestration notifications","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orchestration-payments/acknowledgeorchestrationpaymentnotifications","deprecated":false},{"title":"/v4/orchestration/payment/action","summary":"Post action to orchestration payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orchestration-payments/sendorchestrationpaymentaction","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment expiration","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payment-expiration","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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/ripplenet/payment-expiration/getpaymentexpirybyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payment-expiration/getpaymentexpirybyid","metadata":{"seo":{"title":"Get payment expiry by ID","description":"Gets the time to live (ttl) of a payment expiry in seconds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentExpiryById","name":"Get payment expiry by ID","isWebhook":false,"pointer":"/paths/~1config~1payments~1payment_expiries~1{payment_expiry_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payment expiry by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the time to live (ttl) of a payment expiry in seconds."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_expiry_id","in":"path","schemaId":"schema_11","description":"The ID of the payment expiry you want returned.","required":true}],"pointer":"/paths/~1config~1payments~1payment_expiries~1{payment_expiry_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/payments/payment_expiries/{payment_expiry_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_expiry_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/payments/payment_expiries/{payment_expiry_id}","href":"payment-expiration/getpaymentexpirybyid","openApiOperationId":"getPaymentExpiryById","summary":"Get payment expiry by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned a payment expiry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentExpiryResponse"}},"schemaId":"components/schemas/PaymentExpiryResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payments~1payment_expiries~1{payment_expiry_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentExpiryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentExpiryResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-expiration/getpaymentexpirybyid"}],"panels":[]}]},"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/ripplenet/payment-expiration/updatepaymentexpiry","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payment-expiration/updatepaymentexpiry","metadata":{"seo":{"title":"Update payment expiry","description":"Updates the time to live (ttl) of a payment expiry in seconds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePaymentExpiry","name":"Update payment expiry","isWebhook":false,"pointer":"/paths/~1config~1payments~1payment_expiries~1{payment_expiry_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update payment expiry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the time to live (ttl) of a payment expiry in seconds."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_expiry_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_expiry_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment expiry you want to update."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1config~1payments~1payment_expiries~1{payment_expiry_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentExpiry"}},"schemaId":"components/schemas/PaymentExpiry","pointer":"/paths/~1config~1payments~1payment_expiries~1{payment_expiry_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/config/payments/payment_expiries/{payment_expiry_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_expiry_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentExpiry"}},"responseCodes":["200","400"],"pointer":"/config/payments/payment_expiries/{payment_expiry_id}","href":"payment-expiration/updatepaymentexpiry","openApiOperationId":"updatePaymentExpiry","summary":"Update payment expiry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentExpiry","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentExpiry"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated payment expiry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentExpiryResponse"}},"schemaId":"components/schemas/PaymentExpiryResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payments~1payment_expiries~1{payment_expiry_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentExpiryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentExpiryResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-expiration/updatepaymentexpiry"}],"panels":[]}]},"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/ripplenet/payment-expiration/deletepaymentexpiry","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payment-expiration/deletepaymentexpiry","metadata":{"seo":{"title":"Delete payment expiry","description":"Deletes a payment expiry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePaymentExpiry","name":"Delete payment expiry","isWebhook":false,"pointer":"/paths/~1config~1payments~1payment_expiries~1{payment_expiry_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete payment expiry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a payment expiry."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_expiry_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_expiry_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment expiry you want to delete."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1config~1payments~1payment_expiries~1{payment_expiry_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/config/payments/payment_expiries/{payment_expiry_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payment_expiry_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/payments/payment_expiries/{payment_expiry_id}","href":"payment-expiration/deletepaymentexpiry","openApiOperationId":"deletePaymentExpiry","summary":"Delete payment expiry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted payment expiry."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payments~1payment_expiries~1{payment_expiry_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-expiration/deletepaymentexpiry"}],"panels":[]}]},"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/ripplenet/payment-expiration/getpaymentexpiries","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payment-expiration/getpaymentexpiries","metadata":{"seo":{"title":"Get payment expiries","description":"Returns all configured payment expiries."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentExpiries","name":"Get payment expiries","isWebhook":false,"pointer":"/paths/~1config~1payments~1payment_expiries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payment expiries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all configured payment expiries."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_7","description":"Zero-based index of the page number of results."},{"name":"size","in":"query","schemaId":"schema_16","description":"Number of payments returned per page."}],"pointer":"/paths/~1config~1payments~1payment_expiries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/payments/payment_expiries","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_16"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/payments/payment_expiries","href":"payment-expiration/getpaymentexpiries","openApiOperationId":"getPaymentExpiries","summary":"Get payment expiries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentExpiries"}},"schemaId":"components/schemas/PaymentExpiries"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payments~1payment_expiries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentExpiries","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentExpiries"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-expiration/getpaymentexpiries"}],"panels":[]}]},"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/ripplenet/payment-expiration/createpaymentexpiry","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payment-expiration/createpaymentexpiry","metadata":{"seo":{"title":"Create payment expiry","description":"Creates a payment expiration window, or time to live (ttl), in seconds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPaymentExpiry","name":"Create payment expiry","isWebhook":false,"pointer":"/paths/~1config~1payments~1payment_expiries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create payment expiry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a payment expiration window, or time to live (ttl), in seconds."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentExpiry"}},"schemaId":"components/schemas/PaymentExpiry","pointer":"/paths/~1config~1payments~1payment_expiries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/config/payments/payment_expiries","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentExpiry"}},"responseCodes":["200","400"],"pointer":"/config/payments/payment_expiries","href":"payment-expiration/createpaymentexpiry","openApiOperationId":"createPaymentExpiry","summary":"Create payment expiry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentExpiry","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentExpiry"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created the payment expiration window.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentExpiryResponse"}},"schemaId":"components/schemas/PaymentExpiryResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payments~1payment_expiries/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentExpiryResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentExpiryResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-expiration/createpaymentexpiry"}],"panels":[]}]},"httpPath":"/config/payments/payment_expiries"}],"content":{"contentType":"group","meta":{"name":"Payment expiration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment expiration","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/config/payments/payment_expiries/{payment_expiry_id}","summary":"Get payment expiry by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-expiration/getpaymentexpirybyid","deprecated":false},{"title":"/config/payments/payment_expiries/{payment_expiry_id}","summary":"Update payment expiry","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-expiration/updatepaymentexpiry","deprecated":false},{"title":"/config/payments/payment_expiries/{payment_expiry_id}","summary":"Delete payment expiry","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payment-expiration/deletepaymentexpiry","deprecated":false},{"title":"/config/payments/payment_expiries","summary":"Get payment expiries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-expiration/getpaymentexpiries","deprecated":false},{"title":"/config/payments/payment_expiries","summary":"Create payment expiry","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-expiration/createpaymentexpiry","deprecated":false}]}]}]}]}},{"type":"group","label":"Payout method","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payout-method","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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/ripplenet/payout-method/createpayoutmethod","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPayoutMethod","name":"Create payout method","isWebhook":false,"pointer":"/paths/~1config~1payout_methods/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create payout method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a payout method (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCAL_RAILS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enable_quote_per_payout_method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body of the [Create quote collection] request. "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Caution:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The existing quote parameter is named "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment_method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while elsewhere it is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payout_method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" On-Demand Liquidity (ODL) receivers should set "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment_method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outlet_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the string "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"none"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not an empty value) to keep funds at the destination exchange when paying out to a local rail."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutMethodRequest"}},"schemaId":"components/schemas/PayoutMethodRequest","pointer":"/paths/~1config~1payout_methods/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/config/payout_methods","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PayoutMethodRequest"}},"responseCodes":["200","400"],"pointer":"/config/payout_methods","href":"payout-method/createpayoutmethod","openApiOperationId":"createPayoutMethod","summary":"Create payout method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PayoutMethodRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutMethodRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created payout method.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutMethodResponse"}},"schemaId":"components/schemas/PayoutMethodResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payout_methods/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutMethodResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutMethodResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payout-method/createpayoutmethod"}],"panels":[]}]},"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/ripplenet/payout-method/getpayoutmethods","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payout-method/getpayoutmethods","metadata":{"seo":{"title":"Get payout methods","description":"Returns a list of payout methods created by a receiving partner."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPayoutMethods","name":"Get payout methods","isWebhook":false,"pointer":"/paths/~1config~1payout_methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payout methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of payout methods created by a receiving partner."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of payments to return per page."}],"pointer":"/paths/~1config~1payout_methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/payout_methods","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/payout_methods","href":"payout-method/getpayoutmethods","openApiOperationId":"getPayoutMethods","summary":"Get payout methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutMethods"}},"schemaId":"components/schemas/PayoutMethods"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payout_methods/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutMethods","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutMethods"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payout-method/getpayoutmethods"}],"panels":[]}]},"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/ripplenet/payout-method/getpayoutmethodbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payout-method/getpayoutmethodbyid","metadata":{"seo":{"title":"Get payout method by ID","description":"Returns a payout method by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPayoutMethodById","name":"Get payout method by ID","isWebhook":false,"pointer":"/paths/~1config~1payout_methods~1{payout_method_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payout method by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a payout method by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payout_method_id","in":"path","schemaId":"schema_11","description":"ID of the payout method you want to retrieve.","required":true}],"pointer":"/paths/~1config~1payout_methods~1{payout_method_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/payout_methods/{payout_method_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payout_method_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/payout_methods/{payout_method_id}","href":"payout-method/getpayoutmethodbyid","openApiOperationId":"getPayoutMethodById","summary":"Get payout method by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned Payout method","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutMethodResponse"}},"schemaId":"components/schemas/PayoutMethodResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payout_methods~1{payout_method_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutMethodResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutMethodResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payout-method/getpayoutmethodbyid"}],"panels":[]}]},"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/ripplenet/payout-method/updatepayoutmethod","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payout-method/updatepayoutmethod","metadata":{"seo":{"title":"Update payout method","description":"Updates a payout method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePayoutMethod","name":"Update payout method","isWebhook":false,"pointer":"/paths/~1config~1payout_methods~1{payout_method_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update payout method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a payout method."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payout_method_id","in":"path","schemaId":"schema_11","description":"ID of the payout method you want to retrieve.","required":true}],"pointer":"/paths/~1config~1payout_methods~1{payout_method_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutMethodRequest"}},"schemaId":"components/schemas/PayoutMethodRequest","pointer":"/paths/~1config~1payout_methods~1{payout_method_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/config/payout_methods/{payout_method_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payout_method_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PayoutMethodRequest"}},"responseCodes":["200","400"],"pointer":"/config/payout_methods/{payout_method_id}","href":"payout-method/updatepayoutmethod","openApiOperationId":"updatePayoutMethod","summary":"Update payout method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PayoutMethodRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayoutMethodRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully saved Payout method","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutMethodResponse"}},"schemaId":"components/schemas/PayoutMethodResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payout_methods~1{payout_method_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PayoutMethodResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PayoutMethodResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payout-method/updatepayoutmethod"}],"panels":[]}]},"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/ripplenet/payout-method/deletepayoutmethod","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payout-method/deletepayoutmethod","metadata":{"seo":{"title":"Delete payout method","description":"Deletes a payout method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePayoutMethod","name":"Delete payout method","isWebhook":false,"pointer":"/paths/~1config~1payout_methods~1{payout_method_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete payout method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a payout method."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payout_method_id","in":"path","schemaId":"schema_11","description":"ID of the payout method you want to retrieve.","required":true}],"pointer":"/paths/~1config~1payout_methods~1{payout_method_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/config/payout_methods/{payout_method_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"payout_method_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/payout_methods/{payout_method_id}","href":"payout-method/deletepayoutmethod","openApiOperationId":"deletePayoutMethod","summary":"Delete payout method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted payout method."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payout_methods~1{payout_method_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payout-method/deletepayoutmethod"}],"panels":[]}]},"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/ripplenet/payout-method/getallcategories","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payout-method/getallcategories","metadata":{"seo":{"title":"Get all categories","description":"Returns all the payout method categories."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllCategories","name":"Get all categories","isWebhook":false,"pointer":"/paths/~1config~1payout_methods~1categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all the payout method categories."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/payout_methods/categories","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/payout_methods/categories","href":"payout-method/getallcategories","openApiOperationId":"getAllCategories","summary":"Get all categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned Payout method Categories","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0"}},"schemaId":"schema_0"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payout_methods~1categories/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_0","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payout-method/getallcategories"}],"panels":[]}]},"httpPath":"/config/payout_methods/categories"}],"content":{"contentType":"group","meta":{"name":"Payout method"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payout method","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/config/payout_methods","summary":"Create payout method","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payout-method/createpayoutmethod","deprecated":false},{"title":"/config/payout_methods","summary":"Get payout methods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payout-method/getpayoutmethods","deprecated":false},{"title":"/config/payout_methods/{payout_method_id}","summary":"Get payout method by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payout-method/getpayoutmethodbyid","deprecated":false},{"title":"/config/payout_methods/{payout_method_id}","summary":"Update payout method","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payout-method/updatepayoutmethod","deprecated":false},{"title":"/config/payout_methods/{payout_method_id}","summary":"Delete payout method","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payout-method/deletepayoutmethod","deprecated":false},{"title":"/config/payout_methods/categories","summary":"Get all categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payout-method/getallcategories","deprecated":false}]}]}]}]}},{"type":"group","label":"Platform accounts","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/platform-accounts","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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/ripplenet/platform-accounts/createplatform","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPlatform","name":"Create platform","isWebhook":false,"pointer":"/paths/~1config~1platforms/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create platform","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePlatformRequest"}},"schemaId":"components/schemas/CreatePlatformRequest","pointer":"/paths/~1config~1platforms/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/config/platforms","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePlatformRequest"}},"responseCodes":["200","400"],"pointer":"/config/platforms","href":"platform-accounts/createplatform","openApiOperationId":"createPlatform","summary":"Create platform"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/CreatePlatformRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePlatformRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created RippleNet platform.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformResponse"}},"schemaId":"components/schemas/PlatformResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1platforms/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlatformResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/platform-accounts/createplatform"}],"panels":[]}]},"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/ripplenet/platform-accounts/getallplatforms","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/platform-accounts/getallplatforms","metadata":{"seo":{"title":"Get all platforms","description":"Returns a list of all active RippleNet platforms."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllPlatforms","name":"Get all platforms","isWebhook":false,"pointer":"/paths/~1config~1platforms/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all platforms","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all active RippleNet platforms."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/platforms","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/platforms","href":"platform-accounts/getallplatforms","openApiOperationId":"getAllPlatforms","summary":"Get all platforms"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of all active RippleNet platforms.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1platforms/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/platform-accounts/getallplatforms"}],"panels":[]}]},"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/ripplenet/platform-accounts/getplatformbyplatformid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/platform-accounts/getplatformbyplatformid","metadata":{"seo":{"title":"Get platform by platform ID","description":"Get a RippleNet platform by its platform ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPlatformByPlatformId","name":"Get platform by platform ID","isWebhook":false,"pointer":"/paths/~1config~1platforms~1{platform_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get platform by platform ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a RippleNet platform by its platform ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"platform_id","in":"path","schemaId":"schema_11","description":"ID of the platform you want to retrieve.","required":true}],"pointer":"/paths/~1config~1platforms~1{platform_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/platforms/{platform_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"platform_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/platforms/{platform_id}","href":"platform-accounts/getplatformbyplatformid","openApiOperationId":"getPlatformByPlatformId","summary":"Get platform by platform ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a RippleNet platform for the given platform ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformResponse"}},"schemaId":"components/schemas/PlatformResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1platforms~1{platform_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlatformResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/platform-accounts/getplatformbyplatformid"}],"panels":[]}]},"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/ripplenet/platform-accounts/updateplatform","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePlatform","name":"Update platform","isWebhook":false,"pointer":"/paths/~1config~1platforms~1{platform_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update platform","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"platform_id","in":"path","schemaId":"schema_11","description":"ID of the platform you want to update.","required":true}],"pointer":"/paths/~1config~1platforms~1{platform_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePlatformRequest"}},"schemaId":"components/schemas/UpdatePlatformRequest","pointer":"/paths/~1config~1platforms~1{platform_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/config/platforms/{platform_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"platform_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePlatformRequest"}},"responseCodes":["200","400"],"pointer":"/config/platforms/{platform_id}","href":"platform-accounts/updateplatform","openApiOperationId":"updatePlatform","summary":"Update platform"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/UpdatePlatformRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePlatformRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated RippleNet platform.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformResponse"}},"schemaId":"components/schemas/PlatformResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1platforms~1{platform_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlatformResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/platform-accounts/updateplatform"}],"panels":[]}]},"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/ripplenet/platform-accounts/deleteplatformbyplatformid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/platform-accounts/deleteplatformbyplatformid","metadata":{"seo":{"title":"Delete platform by platform ID","description":"Deletes a RippleNet platform by its platform ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePlatformByPlatformId","name":"Delete platform by platform ID","isWebhook":false,"pointer":"/paths/~1config~1platforms~1{platform_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete platform by platform ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a RippleNet platform by its platform ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"platform_id","in":"path","schemaId":"schema_11","description":"ID of the platform you want to delete.","required":true}],"pointer":"/paths/~1config~1platforms~1{platform_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/config/platforms/{platform_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"platform_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/config/platforms/{platform_id}","href":"platform-accounts/deleteplatformbyplatformid","openApiOperationId":"deletePlatformByPlatformId","summary":"Delete platform by platform ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted platform successfully."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1platforms~1{platform_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/platform-accounts/deleteplatformbyplatformid"}],"panels":[]}]},"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/ripplenet/platform-accounts/createplatformaccount","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPlatformAccount","name":"Create platform account","isWebhook":false,"pointer":"/paths/~1config~1platforms~1accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create platform account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePlatformAccountRequest"}},"schemaId":"components/schemas/CreatePlatformAccountRequest","pointer":"/paths/~1config~1platforms~1accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/config/platforms/accounts","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePlatformAccountRequest"}},"responseCodes":["200","400"],"pointer":"/config/platforms/accounts","href":"platform-accounts/createplatformaccount","openApiOperationId":"createPlatformAccount","summary":"Create platform account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/CreatePlatformAccountRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePlatformAccountRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created RippleNet platform account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformAccountResponse"}},"schemaId":"components/schemas/PlatformAccountResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1platforms~1accounts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlatformAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformAccountResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/platform-accounts/createplatformaccount"}],"panels":[]}]},"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/ripplenet/platform-accounts/getplatformaccounts","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/platform-accounts/getplatformaccounts","metadata":{"seo":{"title":"Get platform accounts","description":"Returns a paged list of all active RippleNet platform accounts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPlatformAccounts","name":"Get platform accounts","isWebhook":false,"pointer":"/paths/~1config~1platforms~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get platform accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paged list of all active RippleNet platform accounts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of objects to return per page."}],"pointer":"/paths/~1config~1platforms~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/platforms/accounts","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/platforms/accounts","href":"platform-accounts/getplatformaccounts","openApiOperationId":"getPlatformAccounts","summary":"Get platform accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paged list of all active RippleNet platform accounts.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformAccountsPage"}},"schemaId":"components/schemas/PlatformAccountsPage"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1platforms~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlatformAccountsPage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformAccountsPage"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/platform-accounts/getplatformaccounts"}],"panels":[]}]},"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/ripplenet/platform-accounts/getplatformaccountbyplatformaccountid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/platform-accounts/getplatformaccountbyplatformaccountid","metadata":{"seo":{"title":"Get platform account by platform account ID","description":"Gets a RippleNet platform account by its platform account ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPlatformAccountByPlatformAccountId","name":"Get platform account by platform account ID","isWebhook":false,"pointer":"/paths/~1config~1platforms~1accounts~1{platform_account_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get platform account by platform account ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a RippleNet platform account by its platform account ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"platform_account_id","in":"path","schemaId":"schema_11","description":"ID of the platform account you want to retrieve.","required":true}],"pointer":"/paths/~1config~1platforms~1accounts~1{platform_account_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/platforms/accounts/{platform_account_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"platform_account_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/platforms/accounts/{platform_account_id}","href":"platform-accounts/getplatformaccountbyplatformaccountid","openApiOperationId":"getPlatformAccountByPlatformAccountId","summary":"Get platform account by platform account ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a RippleNet platform account for the given platform account ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformAccountResponse"}},"schemaId":"components/schemas/PlatformAccountResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1platforms~1accounts~1{platform_account_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlatformAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformAccountResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/platform-accounts/getplatformaccountbyplatformaccountid"}],"panels":[]}]},"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/ripplenet/platform-accounts/updateplatformaccount","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePlatformAccount","name":"Update platform account","isWebhook":false,"pointer":"/paths/~1config~1platforms~1accounts~1{platform_account_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update platform account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a RippleNet platform account, which represents a real-world account owned by a financial entity (e.g. Bank, Exchange or Wallet provider)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"platform_account_id","in":"path","schemaId":"schema_11","description":"ID of the platform account you want to update.","required":true}],"pointer":"/paths/~1config~1platforms~1accounts~1{platform_account_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePlatformAccountRequest"}},"schemaId":"components/schemas/UpdatePlatformAccountRequest","pointer":"/paths/~1config~1platforms~1accounts~1{platform_account_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/config/platforms/accounts/{platform_account_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"platform_account_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePlatformAccountRequest"}},"responseCodes":["200","400"],"pointer":"/config/platforms/accounts/{platform_account_id}","href":"platform-accounts/updateplatformaccount","openApiOperationId":"updatePlatformAccount","summary":"Update platform account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/UpdatePlatformAccountRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePlatformAccountRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated RippleNet platform account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformAccountResponse"}},"schemaId":"components/schemas/PlatformAccountResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1platforms~1accounts~1{platform_account_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlatformAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformAccountResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/platform-accounts/updateplatformaccount"}],"panels":[]}]},"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/ripplenet/platform-accounts/deleteplatformaccountbyplatformaccountid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/platform-accounts/deleteplatformaccountbyplatformaccountid","metadata":{"seo":{"title":"Delete platform account by platform account ID","description":"Deletes a RippleNet platform account by its platform account ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePlatformAccountByPlatformAccountId","name":"Delete platform account by platform account ID","isWebhook":false,"pointer":"/paths/~1config~1platforms~1accounts~1{platform_account_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete platform account by platform account ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a RippleNet platform account by its platform account ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"platform_account_id","in":"path","schemaId":"schema_11","description":"ID of the platform account you want to delete.","required":true}],"pointer":"/paths/~1config~1platforms~1accounts~1{platform_account_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/config/platforms/accounts/{platform_account_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"platform_account_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/config/platforms/accounts/{platform_account_id}","href":"platform-accounts/deleteplatformaccountbyplatformaccountid","openApiOperationId":"deletePlatformAccountByPlatformAccountId","summary":"Delete platform account by platform account ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted platform account successfully."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1platforms~1accounts~1{platform_account_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/platform-accounts/deleteplatformaccountbyplatformaccountid"}],"panels":[]}]},"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/ripplenet/platform-accounts/getplatformaccountsbalances","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/platform-accounts/getplatformaccountsbalances","metadata":{"seo":{"title":"Get platform accounts balances","description":"Get balances for local Platform Accounts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPlatformAccountsBalances","name":"Get platform accounts balances","isWebhook":false,"pointer":"/paths/~1monitor~1platform~1accounts~1balances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get platform accounts balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get balances for local Platform Accounts"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitor/platform/accounts/balances","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/monitor/platform/accounts/balances","href":"platform-accounts/getplatformaccountsbalances","openApiOperationId":"getPlatformAccountsBalances","summary":"Get platform accounts balances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned balances for all platform accounts.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformAccountsBalances"}},"schemaId":"components/schemas/PlatformAccountsBalances"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1monitor~1platform~1accounts~1balances/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlatformAccountsBalances","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformAccountsBalances"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/platform-accounts/getplatformaccountsbalances"}],"panels":[]}]},"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/ripplenet/platform-accounts/getplatformaccountstatement","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/platform-accounts/getplatformaccountstatement","metadata":{"seo":{"title":"Get platform account statement","description":"Get statement for a specified Platform Account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPlatformAccountStatement","name":"Get platform account statement","isWebhook":false,"pointer":"/paths/~1monitor~1platform~1accounts~1{platformAccountId}~1statement/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get platform account statement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get statement for a specified Platform Account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"platformAccountId","in":"path","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The RippleNet platform account ID that you want to get a statement for. Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bitso"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1monitor~1platform~1accounts~1{platformAccountId}~1statement/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start-date","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lower bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2018-08-06T23:13:55.997Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"end-date","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The upper bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2018-08-06T23:15:13.218Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of payment and transfer objects to return per page."}],"pointer":"/paths/~1monitor~1platform~1accounts~1{platformAccountId}~1statement/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/monitor/platform/accounts/{platformAccountId}/statement","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"platformAccountId","in":"path","required":true,"schemaId":"schema_4"}],"query":[{"name":"start-date","in":"query","required":true,"schemaId":"schema_4"},{"name":"end-date","in":"query","required":true,"schemaId":"schema_4"},{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/monitor/platform/accounts/{platformAccountId}/statement","href":"platform-accounts/getplatformaccountstatement","openApiOperationId":"getPlatformAccountStatement","summary":"Get platform account statement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned statement for a specified platform account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementResponse"}},"schemaId":"components/schemas/StatementResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1monitor~1platform~1accounts~1{platformAccountId}~1statement/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatementResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/platform-accounts/getplatformaccountstatement"}],"panels":[]}]},"httpPath":"/monitor/platform/accounts/{platformAccountId}/statement"}],"content":{"contentType":"group","meta":{"name":"Platform accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Platform accounts","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/config/platforms","summary":"Create platform","prefix":{"name":"post","color":"post"},"badges":[],"link":"/platform-accounts/createplatform","deprecated":false},{"title":"/config/platforms","summary":"Get all platforms","prefix":{"name":"get","color":"get"},"badges":[],"link":"/platform-accounts/getallplatforms","deprecated":false},{"title":"/config/platforms/{platform_id}","summary":"Get platform by platform ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/platform-accounts/getplatformbyplatformid","deprecated":false},{"title":"/config/platforms/{platform_id}","summary":"Update platform","prefix":{"name":"put","color":"put"},"badges":[],"link":"/platform-accounts/updateplatform","deprecated":false},{"title":"/config/platforms/{platform_id}","summary":"Delete platform by platform ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/platform-accounts/deleteplatformbyplatformid","deprecated":false},{"title":"/config/platforms/accounts","summary":"Create platform account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/platform-accounts/createplatformaccount","deprecated":false},{"title":"/config/platforms/accounts","summary":"Get platform accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/platform-accounts/getplatformaccounts","deprecated":false},{"title":"/config/platforms/accounts/{platform_account_id}","summary":"Get platform account by platform account ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/platform-accounts/getplatformaccountbyplatformaccountid","deprecated":false},{"title":"/config/platforms/accounts/{platform_account_id}","summary":"Update platform account","prefix":{"name":"put","color":"put"},"badges":[],"link":"/platform-accounts/updateplatformaccount","deprecated":false},{"title":"/config/platforms/accounts/{platform_account_id}","summary":"Delete platform account by platform account ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/platform-accounts/deleteplatformaccountbyplatformaccountid","deprecated":false},{"title":"/monitor/platform/accounts/balances","summary":"Get platform accounts balances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/platform-accounts/getplatformaccountsbalances","deprecated":false},{"title":"/monitor/platform/accounts/{platformAccountId}/statement","summary":"Get platform account statement","prefix":{"name":"get","color":"get"},"badges":[],"link":"/platform-accounts/getplatformaccountstatement","deprecated":false}]}]}]}]}},{"type":"group","label":"Pool accounts","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/pool-accounts","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/pool-accounts","items":[{"label":"Create pool account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/pool-accounts/createpoolaccount","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/pool-accounts/createpoolaccount","metadata":{"seo":{"title":"Create pool account","description":"Creates a Ripplenet pool account, which points to one or more RippleNet accounts using the same currency. With pool accounts, you can view the combined balance of all RippleNet accounts within the pool."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPoolAccount","name":"Create pool account","isWebhook":false,"pointer":"/paths/~1config~1pool_accounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create pool account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a Ripplenet pool account, which points to one or more RippleNet accounts using the same currency. With pool accounts, you can view the combined balance of all RippleNet accounts within the pool."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePoolAccountRequest"}},"schemaId":"components/schemas/CreatePoolAccountRequest","pointer":"/paths/~1config~1pool_accounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/config/pool_accounts","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePoolAccountRequest"}},"responseCodes":["200","400"],"pointer":"/config/pool_accounts","href":"pool-accounts/createpoolaccount","openApiOperationId":"createPoolAccount","summary":"Create pool account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/CreatePoolAccountRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePoolAccountRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created pool account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PoolAccountResponse"}},"schemaId":"components/schemas/PoolAccountResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1pool_accounts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PoolAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PoolAccountResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool-accounts/createpoolaccount"}],"panels":[]}]},"httpPath":"/config/pool_accounts"},{"label":"Get all pool accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/pool-accounts/getallpoolaccounts","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/pool-accounts/getallpoolaccounts","metadata":{"seo":{"title":"Get all pool accounts","description":"Returns a list of all pool accounts on a RippleNet node."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllPoolAccounts","name":"Get all pool accounts","isWebhook":false,"pointer":"/paths/~1config~1pool_accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all pool accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all pool accounts on a RippleNet node."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/pool_accounts","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/pool_accounts","href":"pool-accounts/getallpoolaccounts","openApiOperationId":"getAllPoolAccounts","summary":"Get all pool accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of all pool accounts.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1pool_accounts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool-accounts/getallpoolaccounts"}],"panels":[]}]},"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/ripplenet/pool-accounts/getpoolaccountbypoolaccountid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/pool-accounts/getpoolaccountbypoolaccountid","metadata":{"seo":{"title":"Get pool account by pool account ID","description":"Get a pool account by its pool account ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPoolAccountByPoolAccountId","name":"Get pool account by pool account ID","isWebhook":false,"pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get pool account by pool account ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a pool account by its pool account ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pool_account_id","in":"path","schemaId":"schema_11","description":"Unique name to identify the pool account.","required":true}],"pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/pool_accounts/{pool_account_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"pool_account_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/pool_accounts/{pool_account_id}","href":"pool-accounts/getpoolaccountbypoolaccountid","openApiOperationId":"getPoolAccountByPoolAccountId","summary":"Get pool account by pool account ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns pool account for the given pool account ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PoolAccountResponse"}},"schemaId":"components/schemas/PoolAccountResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PoolAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PoolAccountResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool-accounts/getpoolaccountbypoolaccountid"}],"panels":[]}]},"httpPath":"/config/pool_accounts/{pool_account_id}"},{"label":"Update pool account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/pool-accounts/updatepoolaccount","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/pool-accounts/updatepoolaccount","metadata":{"seo":{"title":"Update pool account","description":"Updates a pool account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePoolAccount","name":"Update pool account","isWebhook":false,"pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update pool account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a pool account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pool_account_id","in":"path","schemaId":"schema_11","description":"Unique name to identify the pool account.","required":true}],"pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePoolAccountRequest"}},"schemaId":"components/schemas/UpdatePoolAccountRequest","pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/config/pool_accounts/{pool_account_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"pool_account_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePoolAccountRequest"}},"responseCodes":["200","400"],"pointer":"/config/pool_accounts/{pool_account_id}","href":"pool-accounts/updatepoolaccount","openApiOperationId":"updatePoolAccount","summary":"Update pool account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/UpdatePoolAccountRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePoolAccountRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated pool account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PoolAccountResponse"}},"schemaId":"components/schemas/PoolAccountResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PoolAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PoolAccountResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool-accounts/updatepoolaccount"}],"panels":[]}]},"httpPath":"/config/pool_accounts/{pool_account_id}"},{"label":"Delete pool account by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/pool-accounts/deletepoolaccountbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/pool-accounts/deletepoolaccountbyid","metadata":{"seo":{"title":"Delete pool account by ID","description":"Deletes a pool account by its pool account ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePoolAccountById","name":"Delete pool account by ID","isWebhook":false,"pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete pool account by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a pool account by its pool account ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pool_account_id","in":"path","schemaId":"schema_11","description":"Unique name to identify the pool account.","required":true}],"pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/config/pool_accounts/{pool_account_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"pool_account_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/pool_accounts/{pool_account_id}","href":"pool-accounts/deletepoolaccountbyid","openApiOperationId":"deletePoolAccountById","summary":"Delete pool account by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Deleted pool account successfully."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool-accounts/deletepoolaccountbyid"}],"panels":[]}]},"httpPath":"/config/pool_accounts/{pool_account_id}"},{"label":"Link accounts to pool account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/pool-accounts/linkaccountstopoolaccount","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/pool-accounts/linkaccountstopoolaccount","metadata":{"seo":{"title":"Link accounts to pool account","description":"Links accounts to the pool account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"linkAccountsToPoolAccount","name":"Link accounts to pool account","isWebhook":false,"pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}~1linked_accounts/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Link accounts to pool account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Links accounts to the pool account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pool_account_id","in":"path","schemaId":"schema_11","description":"Unique name to identify the pool account.","required":true}],"pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}~1linked_accounts/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkAccountsToPoolAccountRequest"}},"schemaId":"components/schemas/LinkAccountsToPoolAccountRequest","pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}~1linked_accounts/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/config/pool_accounts/{pool_account_id}/linked_accounts","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"pool_account_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LinkAccountsToPoolAccountRequest"}},"responseCodes":["200","400"],"pointer":"/config/pool_accounts/{pool_account_id}/linked_accounts","href":"pool-accounts/linkaccountstopoolaccount","openApiOperationId":"linkAccountsToPoolAccount","summary":"Link accounts to pool account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/LinkAccountsToPoolAccountRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkAccountsToPoolAccountRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully linked accounts to the pool account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PoolAccountResponse"}},"schemaId":"components/schemas/PoolAccountResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}~1linked_accounts/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PoolAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PoolAccountResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool-accounts/linkaccountstopoolaccount"}],"panels":[]}]},"httpPath":"/config/pool_accounts/{pool_account_id}/linked_accounts"},{"label":"Unlink accounts from pool account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/pool-accounts/unlinkaccountsfrompoolaccount","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/pool-accounts/unlinkaccountsfrompoolaccount","metadata":{"seo":{"title":"Unlink accounts from pool account","description":"Unlinks accounts from the pool account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unlinkAccountsFromPoolAccount","name":"Unlink accounts from pool account","isWebhook":false,"pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}~1linked_accounts/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unlink accounts from pool account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Unlinks accounts from the pool account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pool_account_id","in":"path","schemaId":"schema_11","description":"Unique name to identify the pool account.","required":true}],"pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}~1linked_accounts/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UnlinkAccountsFromPoolAccountRequest"}},"schemaId":"components/schemas/UnlinkAccountsFromPoolAccountRequest","pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}~1linked_accounts/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/config/pool_accounts/{pool_account_id}/linked_accounts","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"pool_account_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UnlinkAccountsFromPoolAccountRequest"}},"responseCodes":["200","400"],"pointer":"/config/pool_accounts/{pool_account_id}/linked_accounts","href":"pool-accounts/unlinkaccountsfrompoolaccount","openApiOperationId":"unlinkAccountsFromPoolAccount","summary":"Unlink accounts from pool account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/UnlinkAccountsFromPoolAccountRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UnlinkAccountsFromPoolAccountRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully unlinked accounts from the pool account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PoolAccountResponse"}},"schemaId":"components/schemas/PoolAccountResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1pool_accounts~1{pool_account_id}~1linked_accounts/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PoolAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PoolAccountResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pool-accounts/unlinkaccountsfrompoolaccount"}],"panels":[]}]},"httpPath":"/config/pool_accounts/{pool_account_id}/linked_accounts"}],"content":{"contentType":"group","meta":{"name":"Pool accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pool accounts","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/config/pool_accounts","summary":"Create pool account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pool-accounts/createpoolaccount","deprecated":false},{"title":"/config/pool_accounts","summary":"Get all pool accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pool-accounts/getallpoolaccounts","deprecated":false},{"title":"/config/pool_accounts/{pool_account_id}","summary":"Get pool account by pool account ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pool-accounts/getpoolaccountbypoolaccountid","deprecated":false},{"title":"/config/pool_accounts/{pool_account_id}","summary":"Update pool account","prefix":{"name":"put","color":"put"},"badges":[],"link":"/pool-accounts/updatepoolaccount","deprecated":false},{"title":"/config/pool_accounts/{pool_account_id}","summary":"Delete pool account by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pool-accounts/deletepoolaccountbyid","deprecated":false},{"title":"/config/pool_accounts/{pool_account_id}/linked_accounts","summary":"Link accounts to pool account","prefix":{"name":"put","color":"put"},"badges":[],"link":"/pool-accounts/linkaccountstopoolaccount","deprecated":false},{"title":"/config/pool_accounts/{pool_account_id}/linked_accounts","summary":"Unlink accounts from pool account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pool-accounts/unlinkaccountsfrompoolaccount","deprecated":false}]}]}]}]}},{"type":"group","label":"Quote expiration","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quote-expiration","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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/ripplenet/quote-expiration/getquoteexpiries","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quote-expiration/getquoteexpiries","metadata":{"seo":{"title":"List quote expiries","description":"Returns all configured quote expiries."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQuoteExpiries","name":"List quote expiries","isWebhook":false,"pointer":"/paths/~1config~1payments~1quote_expiries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List quote expiries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all configured quote expiries."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_7","description":"Zero-based index of the page number of results."},{"name":"size","in":"query","schemaId":"schema_16","description":"Number of payments returned per page."}],"pointer":"/paths/~1config~1payments~1quote_expiries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/payments/quote_expiries","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_16"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/payments/quote_expiries","href":"quote-expiration/getquoteexpiries","openApiOperationId":"getQuoteExpiries","summary":"List quote expiries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteExpiries"}},"schemaId":"components/schemas/QuoteExpiries"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payments~1quote_expiries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteExpiries","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteExpiries"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quote-expiration/getquoteexpiries"}],"panels":[]}]},"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/ripplenet/quote-expiration/createquoteexpiry","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quote-expiration/createquoteexpiry","metadata":{"seo":{"title":"Create quote expiry","description":"Creates a quote expiration window, or time to live (ttl), in seconds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createQuoteExpiry","name":"Create quote expiry","isWebhook":false,"pointer":"/paths/~1config~1payments~1quote_expiries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create quote expiry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a quote expiration window, or time to live (ttl), in seconds."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}},"schemaId":"components/schemas/QuoteExpiry","pointer":"/paths/~1config~1payments~1quote_expiries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/config/payments/quote_expiries","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}},"responseCodes":["200","400"],"pointer":"/config/payments/quote_expiries","href":"quote-expiration/createquoteexpiry","openApiOperationId":"createQuoteExpiry","summary":"Create quote expiry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/QuoteExpiry","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created the quote expiration window.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}},"schemaId":"components/schemas/QuoteExpiry"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payments~1quote_expiries/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteExpiry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quote-expiration/createquoteexpiry"}],"panels":[]}]},"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/ripplenet/quote-expiration/getquoteexpirybyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quote-expiration/getquoteexpirybyid","metadata":{"seo":{"title":"Get quote expiry","description":"Gets the time to live (ttl) of a quote expiry in seconds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQuoteExpiryById","name":"Get quote expiry","isWebhook":false,"pointer":"/paths/~1config~1payments~1quote_expiries~1{quote_expiry_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get quote expiry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the time to live (ttl) of a quote expiry in seconds."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"quote_expiry_id","in":"path","schemaId":"schema_35","description":"The ID of the quote expiry you want returned.","required":true}],"pointer":"/paths/~1config~1payments~1quote_expiries~1{quote_expiry_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/payments/quote_expiries/{quote_expiry_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"quote_expiry_id","in":"path","required":true,"schemaId":"schema_35"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/payments/quote_expiries/{quote_expiry_id}","href":"quote-expiration/getquoteexpirybyid","openApiOperationId":"getQuoteExpiryById","summary":"Get quote expiry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned a quote expiry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}},"schemaId":"components/schemas/QuoteExpiry"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payments~1quote_expiries~1{quote_expiry_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteExpiry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quote-expiration/getquoteexpirybyid"}],"panels":[]}]},"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/ripplenet/quote-expiration/updatequoteexpiry","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quote-expiration/updatequoteexpiry","metadata":{"seo":{"title":"Update quote expiry","description":"Updates the time to live (ttl) of a quote expiry in seconds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateQuoteExpiry","name":"Update quote expiry","isWebhook":false,"pointer":"/paths/~1config~1payments~1quote_expiries~1{quote_expiry_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update quote expiry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the time to live (ttl) of a quote expiry in seconds."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"quote_expiry_id","in":"path","schemaId":"schema_35","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_expiry_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the quote expiry you want to update."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1config~1payments~1quote_expiries~1{quote_expiry_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}},"schemaId":"components/schemas/QuoteExpiry","pointer":"/paths/~1config~1payments~1quote_expiries~1{quote_expiry_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/config/payments/quote_expiries/{quote_expiry_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"quote_expiry_id","in":"path","required":true,"schemaId":"schema_35"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}},"responseCodes":["200","400"],"pointer":"/config/payments/quote_expiries/{quote_expiry_id}","href":"quote-expiration/updatequoteexpiry","openApiOperationId":"updateQuoteExpiry","summary":"Update quote expiry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/QuoteExpiry","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated quote expiry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}},"schemaId":"components/schemas/QuoteExpiry"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payments~1quote_expiries~1{quote_expiry_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteExpiry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quote-expiration/updatequoteexpiry"}],"panels":[]}]},"httpPath":"/config/payments/quote_expiries/{quote_expiry_id}"},{"label":"Delete quote expiry","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quote-expiration/deletequoteexpiry","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quote-expiration/deletequoteexpiry","metadata":{"seo":{"title":"Delete quote expiry","description":"Deletes a quote expiry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteQuoteExpiry","name":"Delete quote expiry","isWebhook":false,"pointer":"/paths/~1config~1payments~1quote_expiries~1{quote_expiry_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete quote expiry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a quote expiry."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"quote_expiry_id","in":"path","schemaId":"schema_35","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_expiry_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the quote expiry you want to delete."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1config~1payments~1quote_expiries~1{quote_expiry_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/config/payments/quote_expiries/{quote_expiry_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"quote_expiry_id","in":"path","required":true,"schemaId":"schema_35"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/payments/quote_expiries/{quote_expiry_id}","href":"quote-expiration/deletequoteexpiry","openApiOperationId":"deleteQuoteExpiry","summary":"Delete quote expiry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted quote expiry."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payments~1quote_expiries~1{quote_expiry_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quote-expiration/deletequoteexpiry"}],"panels":[]}]},"httpPath":"/config/payments/quote_expiries/{quote_expiry_id}"},{"label":"Get quote expiration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quote-expiration/getquoteexpiration","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quote-expiration/getquoteexpiration","metadata":{"seo":{"title":"Get quote expiration","description":"Gets the configured quote expiration window, or time to live (ttl), in seconds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQuoteExpiration","name":"Get quote expiration","isWebhook":false,"pointer":"/paths/~1config~1payments~1quote_expiry/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get quote expiration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the configured quote expiration window, or time to live (ttl), in seconds."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/payments/quote_expiry","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/payments/quote_expiry","href":"quote-expiration/getquoteexpiration","openApiOperationId":"getQuoteExpiration","summary":"Get quote expiration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned the quote expiration window.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}},"schemaId":"components/schemas/QuoteExpiry"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payments~1quote_expiry/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteExpiry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quote-expiration/getquoteexpiration"}],"panels":[]}]},"httpPath":"/config/payments/quote_expiry"},{"label":"Set quote expiration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quote-expiration/setquoteexpiration","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quote-expiration/setquoteexpiration","metadata":{"seo":{"title":"Set quote expiration","description":"Sets a quote expiration window, or time to live (ttl), in seconds. To calculate the quote expiration date, xCurrent adds this value to the quote creation timestamp."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setQuoteExpiration","name":"Set quote expiration","isWebhook":false,"pointer":"/paths/~1config~1payments~1quote_expiry/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set quote expiration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sets a quote expiration window, or time to live (ttl), in seconds. To calculate the quote expiration date, xCurrent adds this value to the quote creation timestamp."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}},"schemaId":"components/schemas/QuoteExpiry","pointer":"/paths/~1config~1payments~1quote_expiry/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/config/payments/quote_expiry","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}},"responseCodes":["200","400"],"pointer":"/config/payments/quote_expiry","href":"quote-expiration/setquoteexpiration","openApiOperationId":"setQuoteExpiration","summary":"Set quote expiration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/QuoteExpiry","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the quote expiration window.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}},"schemaId":"components/schemas/QuoteExpiry"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1payments~1quote_expiry/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteExpiry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteExpiry"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quote-expiration/setquoteexpiration"}],"panels":[]}]},"httpPath":"/config/payments/quote_expiry"}],"content":{"contentType":"group","meta":{"name":"Quote expiration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quote expiration","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/config/payments/quote_expiries","summary":"List quote expiries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/quote-expiration/getquoteexpiries","deprecated":false},{"title":"/config/payments/quote_expiries","summary":"Create quote expiry","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quote-expiration/createquoteexpiry","deprecated":false},{"title":"/config/payments/quote_expiries/{quote_expiry_id}","summary":"Get quote expiry","prefix":{"name":"get","color":"get"},"badges":[],"link":"/quote-expiration/getquoteexpirybyid","deprecated":false},{"title":"/config/payments/quote_expiries/{quote_expiry_id}","summary":"Update quote expiry","prefix":{"name":"put","color":"put"},"badges":[],"link":"/quote-expiration/updatequoteexpiry","deprecated":false},{"title":"/config/payments/quote_expiries/{quote_expiry_id}","summary":"Delete quote expiry","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/quote-expiration/deletequoteexpiry","deprecated":false},{"title":"/config/payments/quote_expiry","summary":"Get quote expiration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/quote-expiration/getquoteexpiration","deprecated":false},{"title":"/config/payments/quote_expiry","summary":"Set quote expiration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/quote-expiration/setquoteexpiration","deprecated":false}]}]}]}]}},{"type":"group","label":"Quotes","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quotes","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quotes","items":[{"label":"Accept quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quotes/acceptquote","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quotes/acceptquote","metadata":{"seo":{"title":"Accept quote","description":"Accepts a quote ID to start the payment process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"acceptQuote","name":"Accept quote","isWebhook":false,"pointer":"/paths/~1payments~1accept/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Accepts a quote ID to start the payment process."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentAcceptRequest"}},"schemaId":"components/schemas/PaymentAcceptRequest","pointer":"/paths/~1payments~1accept/post/requestBody","description":"The JSON object to include in your request to accept a quote that you want to advance as a payment."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/accept","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentAcceptRequest"}},"responseCodes":["200","412"],"pointer":"/payments/accept","href":"quotes/acceptquote","openApiOperationId":"acceptQuote","summary":"Accept quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentAcceptRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentAcceptRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successfully accepted quote resulting in a payment object in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment"},{"code":"412","description":"Quote expiry has passed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1payments~1accept/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"412","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/acceptquote"}],"panels":[]}]},"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/ripplenet/quotes/getquotes","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quotes/getquotes","metadata":{"seo":{"title":"Get quotes","description":"Gets a list of quotes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQuotes","name":"Get quotes","isWebhook":false,"pointer":"/paths/~1quotes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get quotes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of quotes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_15","description":"Number of objects to return per page."}],"pointer":"/paths/~1quotes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/quotes","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_15"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/quotes","href":"quotes/getquotes","openApiOperationId":"getQuotes","summary":"Get quotes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned array of quotes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1quotes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/getquotes"}],"panels":[]}]},"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/ripplenet/quotes/getquotebyquoteid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quotes/getquotebyquoteid","metadata":{"seo":{"title":"Get quote by quote ID","description":"Gets a quote by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQuoteByQuoteId","name":"Get quote by quote ID","isWebhook":false,"pointer":"/paths/~1quotes~1{quote_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get quote by quote ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a quote by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"quote_id","in":"path","schemaId":"schema_11","description":"Unique identifier of the quote you want to retrieve.","required":true}],"pointer":"/paths/~1quotes~1{quote_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/quotes/{quote_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"quote_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/quotes/{quote_id}","href":"quotes/getquotebyquoteid","openApiOperationId":"getQuoteByQuoteId","summary":"Get quote by quote ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved quote.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}},"schemaId":"components/schemas/Quote"},{"code":"400","description":"Bad request. Quote ID is either invalid or not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1quotes~1{quote_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Quote","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Quote"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/getquotebyquoteid"}],"panels":[]}]},"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/ripplenet/quotes/createquotecollection","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quotes/createquotecollection","metadata":{"seo":{"title":"Create quote collection","description":"Creates a collection of quotes for a proposed payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createQuoteCollection","name":"Create quote collection","isWebhook":false,"pointer":"/paths/~1quote_collections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create quote collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a collection of quotes for a proposed payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentQuoteRequest"}},"schemaId":"components/schemas/PaymentQuoteRequest","pointer":"/paths/~1quote_collections/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/quote_collections","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentQuoteRequest"}},"responseCodes":["200","400"],"pointer":"/quote_collections","href":"quotes/createquotecollection","openApiOperationId":"createQuoteCollection","summary":"Create quote collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentQuoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentQuoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned quote collection.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteCollection"}},"schemaId":"components/schemas/QuoteCollection"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1quote_collections/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteCollection"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/createquotecollection"}],"panels":[]}]},"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/ripplenet/quotes/getquotecollectionbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/quotes/getquotecollectionbyid","metadata":{"seo":{"title":"Get quote collection by ID","description":"Gets a quote collection that was created for a proposed payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQuoteCollectionById","name":"Get quote collection by ID","isWebhook":false,"pointer":"/paths/~1quote_collections~1{quote_collection_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get quote collection by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a quote collection that was created for a proposed payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"quote_collection_id","in":"path","schemaId":"schema_11","description":"The ID of the quote collection you want returned.","required":true}],"pointer":"/paths/~1quote_collections~1{quote_collection_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/quote_collections/{quote_collection_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"quote_collection_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/quote_collections/{quote_collection_id}","href":"quotes/getquotecollectionbyid","openApiOperationId":"getQuoteCollectionById","summary":"Get quote collection by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned a quote collection.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteCollection"}},"schemaId":"components/schemas/QuoteCollection"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1quote_collections~1{quote_collection_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteCollection"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quotes/getquotecollectionbyid"}],"panels":[]}]},"httpPath":"/quote_collections/{quote_collection_id}"}],"content":{"contentType":"group","meta":{"name":"Quotes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quotes","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payments/accept","summary":"Accept quote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quotes/acceptquote","deprecated":false},{"title":"/quotes","summary":"Get quotes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/quotes/getquotes","deprecated":false},{"title":"/quotes/{quote_id}","summary":"Get quote by quote ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/quotes/getquotebyquoteid","deprecated":false},{"title":"/quote_collections","summary":"Create quote collection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/quotes/createquotecollection","deprecated":false},{"title":"/quote_collections/{quote_collection_id}","summary":"Get quote collection by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/quotes/getquotecollectionbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Rates","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/rates","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/rates","items":[{"label":"Get rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/rates/getrates","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/rates/getrates","metadata":{"seo":{"title":"Get rates","description":"Gets a list of configured exchange rates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRates","name":"Get rates","isWebhook":false,"pointer":"/paths/~1config~1rates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get rates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of configured exchange rates."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_15","description":"Number of objects to return per page."}],"pointer":"/paths/~1config~1rates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/rates","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_15"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/rates","href":"rates/getrates","openApiOperationId":"getRates","summary":"Get rates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned list of rates.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Rates"}},"schemaId":"components/schemas/Rates"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1rates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Rates","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Rates"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rates/getrates"}],"panels":[]}]},"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/ripplenet/rates/createrate","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/rates/createrate","metadata":{"seo":{"title":"Create rate","description":"Creates an exchange rate for a specified currency pair."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRate","name":"Create rate","isWebhook":false,"pointer":"/paths/~1config~1rates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an exchange rate for a specified currency pair."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Applying a margin to the live FX rate:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A USD-GBP live FX rate of 0.80 is provided by a third-party rate provider and you want to reduce that rate by 20 BPS. In this API call, you would set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"value_type\": \"MARGIN\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"margin_type\": \"BPS\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"rate\": \"20\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". After that, during the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get quotes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call, the final FX rate will be calculated as 0.80*(1-(20/10000))="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.7984"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then applied during quote creation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RateRequest"}},"schemaId":"components/schemas/RateRequest","pointer":"/paths/~1config~1rates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/config/rates","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RateRequest"}},"responseCodes":["200","400"],"pointer":"/config/rates","href":"rates/createrate","openApiOperationId":"createRate","summary":"Create rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/RateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created rate.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateResponse"}},"schemaId":"components/schemas/RateResponse"},{"code":"400","description":"Request error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1rates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rates/createrate"}],"panels":[]}]},"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/ripplenet/rates/getratebyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/rates/getratebyid","metadata":{"seo":{"title":"Get rate by ID","description":"Gets a configured exchange rate by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRateById","name":"Get rate by ID","isWebhook":false,"pointer":"/paths/~1config~1rates~1{rate_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get rate by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a configured exchange rate by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rate_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the exchange rate you want to return."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1config~1rates~1{rate_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/rates/{rate_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"rate_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/config/rates/{rate_id}","href":"rates/getratebyid","openApiOperationId":"getRateById","summary":"Get rate by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Sucessfully returned rate.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateResponse"}},"schemaId":"components/schemas/RateResponse"},{"code":"404","description":"Rate not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1rates~1{rate_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateResponse"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rates/getratebyid"}],"panels":[]}]},"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/ripplenet/rates/updaterate","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRate","name":"Update rate","isWebhook":false,"pointer":"/paths/~1config~1rates~1{rate_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing exchange rate. With this call, you can change "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MARGIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (and vice versa), change the actual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of the specified value type, or both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Updating an existing margin applied to the live FX rate:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A USD-GBP live FX rate of 0.80 is provided by a third-party rate provider and you currently reduce that rate by 20 BPS. You now want to change it and reduce it by 10 BPS instead. To do so, set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"rate\": \"10\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request. Once the change is applied, the final FX rate is calculated as 0.80*(1-(10/10000))="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.7992"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" during the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Get quotes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call, and then applied during quote creation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rate_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the exchange rate you want to update."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1config~1rates~1{rate_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RateRequest"}},"schemaId":"components/schemas/RateRequest","pointer":"/paths/~1config~1rates~1{rate_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/config/rates/{rate_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"rate_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RateRequest"}},"responseCodes":["200","400"],"pointer":"/config/rates/{rate_id}","href":"rates/updaterate","openApiOperationId":"updateRate","summary":"Update rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/RateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated rate.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateResponse"}},"schemaId":"components/schemas/RateResponse"},{"code":"400","description":"Request error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1rates~1{rate_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rates/updaterate"}],"panels":[]}]},"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/ripplenet/rates/deleterate","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/rates/deleterate","metadata":{"seo":{"title":"Delete rate","description":"Deletes an exchange rate. Once deleted, an exchange rate cannot be accessed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRate","name":"Delete rate","isWebhook":false,"pointer":"/paths/~1config~1rates~1{rate_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete rate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an exchange rate. Once deleted, an exchange rate cannot be accessed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rate_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the exchange rate you want to delete."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1config~1rates~1{rate_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/config/rates/{rate_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"rate_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/rates/{rate_id}","href":"rates/deleterate","openApiOperationId":"deleteRate","summary":"Delete rate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted rate."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1rates~1{rate_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rates/deleterate"}],"panels":[]}]},"httpPath":"/config/rates/{rate_id}"}],"content":{"contentType":"group","meta":{"name":"Rates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rates","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/config/rates","summary":"Get rates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rates/getrates","deprecated":false},{"title":"/config/rates","summary":"Create rate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rates/createrate","deprecated":false},{"title":"/config/rates/{rate_id}","summary":"Get rate by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/rates/getratebyid","deprecated":false},{"title":"/config/rates/{rate_id}","summary":"Update rate","prefix":{"name":"put","color":"put"},"badges":[],"link":"/rates/updaterate","deprecated":false},{"title":"/config/rates/{rate_id}","summary":"Delete rate","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/rates/deleterate","deprecated":false}]}]}]}]}},{"type":"group","label":"Request for payment","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/request-for-payment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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/ripplenet/request-for-payment/getrequestsforpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/request-for-payment/getrequestsforpayment","metadata":{"seo":{"title":"Get requests for payment","description":"Gets requests for payment that match the query parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRequestsForPayment","name":"Get requests for payment","isWebhook":false,"pointer":"/paths/~1request_for_payment/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get requests for payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets requests for payment that match the query parameters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"end_to_end_id","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter to filter results matching this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endToEndId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},{"name":"state","in":"query","schemaId":"schema_37","description":"State by which to filter results."},{"name":"sender_address","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to filter results matching this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"senderAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},{"name":"receiver_address","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to filter results matching this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receiverAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},{"name":"payment_id","in":"query","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to filter results matching this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},{"name":"before","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters for requests for payment whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column value is before this specified time stamp (not inclusive). You can also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a time range between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If before is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be specified"},"children":[]}]}]}]},{"name":"after","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters for requests for payment whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column value is after this specified time stamp (not inclusive). You can also specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create a time range between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be specified."},"children":[]}]}]}]},{"name":"range_field","in":"query","schemaId":"schema_38","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Designates the column name of the requests for payment database table that is used for filtering payments before/after/between time stamps. For example, if you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MODIFIED_AT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you would specify a time stamp (in the 24 character ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ format used in request for payment objects) as the value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch request for payment before, after, or between the specified time range(s) (not inclusive). If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"range_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be specified."},"children":[]}]}]}]},{"name":"sort_field","in":"query","schemaId":"schema_38","description":"Field to use to sort results."},{"name":"sort_direction","in":"query","schemaId":"schema_39","description":"Sorts result according to the specified direction."},{"name":"page","in":"query","schemaId":"schema_7","description":"Zero-based index of the page number of results."},{"name":"size","in":"query","schemaId":"schema_16","description":"The number of payments per page."}],"pointer":"/paths/~1request_for_payment/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/request_for_payment","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"end_to_end_id","in":"query","required":false,"schemaId":"schema_4"},{"name":"state","in":"query","required":false,"schemaId":"schema_37"},{"name":"sender_address","in":"query","required":false,"schemaId":"schema_4"},{"name":"receiver_address","in":"query","required":false,"schemaId":"schema_4"},{"name":"payment_id","in":"query","required":false,"schemaId":"schema_11"},{"name":"before","in":"query","required":false,"schemaId":"schema_4"},{"name":"after","in":"query","required":false,"schemaId":"schema_4"},{"name":"range_field","in":"query","required":false,"schemaId":"schema_38"},{"name":"sort_field","in":"query","required":false,"schemaId":"schema_38"},{"name":"sort_direction","in":"query","required":false,"schemaId":"schema_39"},{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_16"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/request_for_payment","href":"request-for-payment/getrequestsforpayment","openApiOperationId":"getRequestsForPayment","summary":"Get requests for payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieves requests for payment matching query parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetNodeRequestsForPayment"}},"schemaId":"components/schemas/RippleNetNodeRequestsForPayment"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1request_for_payment/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RippleNetNodeRequestsForPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetNodeRequestsForPayment"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-for-payment/getrequestsforpayment"}],"panels":[]}]},"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/ripplenet/request-for-payment/sendrequestforpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/request-for-payment/sendrequestforpayment","metadata":{"seo":{"title":"Send request for payment","description":"Sends a new request for payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendRequestForPayment","name":"Send request for payment","isWebhook":false,"pointer":"/paths/~1request_for_payment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send request for payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends a new request for payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RippleNetNodeRequestForPaymentRequest"}},"schemaId":"components/schemas/RippleNetNodeRequestForPaymentRequest","pointer":"/paths/~1request_for_payment/post/requestBody","description":"The request object to initiate a new request for payment."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/request_for_payment","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RippleNetNodeRequestForPaymentRequest"}},"responseCodes":["200","400"],"pointer":"/request_for_payment","href":"request-for-payment/sendrequestforpayment","openApiOperationId":"sendRequestForPayment","summary":"Send request for payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/RippleNetNodeRequestForPaymentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RippleNetNodeRequestForPaymentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successfully sent a request for payment resulting in a request for payment object in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUESTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetNodeRequestForPayment"}},"schemaId":"components/schemas/RippleNetNodeRequestForPayment"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1request_for_payment/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RippleNetNodeRequestForPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetNodeRequestForPayment"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-for-payment/sendrequestforpayment"}],"panels":[]}]},"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/ripplenet/request-for-payment/getrequestforpaymentbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/request-for-payment/getrequestforpaymentbyid","metadata":{"seo":{"title":"Get request for payment by ID","description":"Gets a request for payment by request for payment ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRequestForPaymentById","name":"Get request for payment by ID","isWebhook":false,"pointer":"/paths/~1request_for_payment~1{request_for_payment_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get request for payment by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a request for payment by request for payment ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"request_for_payment_id","in":"path","schemaId":"schema_11","description":"Unique identifier of the request for payment to retrieve.","required":true}],"pointer":"/paths/~1request_for_payment~1{request_for_payment_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/request_for_payment/{request_for_payment_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"request_for_payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/request_for_payment/{request_for_payment_id}","href":"request-for-payment/getrequestforpaymentbyid","openApiOperationId":"getRequestForPaymentById","summary":"Get request for payment by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieves a request for payment by its ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetNodeRequestForPayment"}},"schemaId":"components/schemas/RippleNetNodeRequestForPayment"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1request_for_payment~1{request_for_payment_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RippleNetNodeRequestForPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetNodeRequestForPayment"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-for-payment/getrequestforpaymentbyid"}],"panels":[]}]},"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/ripplenet/request-for-payment/acceptrequestforpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/request-for-payment/acceptrequestforpayment","metadata":{"seo":{"title":"Accept request for payment","description":"Accepts a request for payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"acceptRequestForPayment","name":"Accept request for payment","isWebhook":false,"pointer":"/paths/~1request_for_payment~1{request_for_payment_id}~1accept/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept request for payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Accepts a request for payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"request_for_payment_id","in":"path","schemaId":"schema_11","description":"Unique identifier of the request for payment to accept.","required":true}],"pointer":"/paths/~1request_for_payment~1{request_for_payment_id}~1accept/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AcceptRequestForPaymentRequest"}},"schemaId":"components/schemas/AcceptRequestForPaymentRequest","pointer":"/paths/~1request_for_payment~1{request_for_payment_id}~1accept/post/requestBody","description":"The request object to accept a request for payment."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/request_for_payment/{request_for_payment_id}/accept","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"request_for_payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AcceptRequestForPaymentRequest"}},"responseCodes":["200","400"],"pointer":"/request_for_payment/{request_for_payment_id}/accept","href":"request-for-payment/acceptrequestforpayment","openApiOperationId":"acceptRequestForPayment","summary":"Accept request for payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/AcceptRequestForPaymentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AcceptRequestForPaymentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successfully accepts a request for payment resulting in a request for payment object in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetNodeRequestForPayment"}},"schemaId":"components/schemas/RippleNetNodeRequestForPayment"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1request_for_payment~1{request_for_payment_id}~1accept/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RippleNetNodeRequestForPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetNodeRequestForPayment"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-for-payment/acceptrequestforpayment"}],"panels":[]}]},"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/ripplenet/request-for-payment/failrequestforpayment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/request-for-payment/failrequestforpayment","metadata":{"seo":{"title":"Fail request for payment","description":"Fails a request for payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"failRequestForPayment","name":"Fail request for payment","isWebhook":false,"pointer":"/paths/~1request_for_payment~1{request_for_payment_id}~1fail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fail request for payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fails a request for payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"request_for_payment_id","in":"path","schemaId":"schema_11","description":"Unique identifier of the request for payment to fail.","required":true}],"pointer":"/paths/~1request_for_payment~1{request_for_payment_id}~1fail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FailRequestForPaymentRequest"}},"schemaId":"components/schemas/FailRequestForPaymentRequest","pointer":"/paths/~1request_for_payment~1{request_for_payment_id}~1fail/post/requestBody","description":"The request object to fail a request for payment."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/request_for_payment/{request_for_payment_id}/fail","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"request_for_payment_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FailRequestForPaymentRequest"}},"responseCodes":["200","400"],"pointer":"/request_for_payment/{request_for_payment_id}/fail","href":"request-for-payment/failrequestforpayment","openApiOperationId":"failRequestForPayment","summary":"Fail request for payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/FailRequestForPaymentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FailRequestForPaymentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Successfully fails a request for payment resulting in a request for payment object in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetNodeRequestForPayment"}},"schemaId":"components/schemas/RippleNetNodeRequestForPayment"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1request_for_payment~1{request_for_payment_id}~1fail/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RippleNetNodeRequestForPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetNodeRequestForPayment"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/request-for-payment/failrequestforpayment"}],"panels":[]}]},"httpPath":"/request_for_payment/{request_for_payment_id}/fail"}],"content":{"contentType":"group","meta":{"name":"Request for payment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request for payment","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/request_for_payment","summary":"Get requests for payment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/request-for-payment/getrequestsforpayment","deprecated":false},{"title":"/request_for_payment","summary":"Send request for payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/request-for-payment/sendrequestforpayment","deprecated":false},{"title":"/request_for_payment/{request_for_payment_id}","summary":"Get request for payment by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/request-for-payment/getrequestforpaymentbyid","deprecated":false},{"title":"/request_for_payment/{request_for_payment_id}/accept","summary":"Accept request for payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/request-for-payment/acceptrequestforpayment","deprecated":false},{"title":"/request_for_payment/{request_for_payment_id}/fail","summary":"Fail request for payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/request-for-payment/failrequestforpayment","deprecated":false}]}]}]}]}},{"type":"group","label":"Sender segregated account configuration","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/sender-segregated-account-configuration","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/sender-segregated-account-configuration","items":[{"label":"Create SSA configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/sender-segregated-account-configuration/createssaconfig","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/sender-segregated-account-configuration/createssaconfig","metadata":{"seo":{"title":"Create SSA configuration","description":"Creates a Sender Segregated Account (SSA) configuration. A SSA configuration contains funds from returns and failed payments that have been pushed forward."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSSAConfig","name":"Create SSA configuration","isWebhook":false,"pointer":"/paths/~1config~1ssa_config/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create SSA configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a Sender Segregated Account (SSA) configuration. A SSA configuration contains funds from returns and failed payments that have been pushed forward."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSSAConfigRequest"}},"schemaId":"components/schemas/CreateSSAConfigRequest","pointer":"/paths/~1config~1ssa_config/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/config/ssa_config","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateSSAConfigRequest"}},"responseCodes":["200","400"],"pointer":"/config/ssa_config","href":"sender-segregated-account-configuration/createssaconfig","openApiOperationId":"createSSAConfig","summary":"Create SSA configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/CreateSSAConfigRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSSAConfigRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created Sender Segregated Account (SSA) configuration.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SSAConfigResponse"}},"schemaId":"components/schemas/SSAConfigResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1ssa_config/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SSAConfigResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SSAConfigResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sender-segregated-account-configuration/createssaconfig"}],"panels":[]}]},"httpPath":"/config/ssa_config"},{"label":"Get all SSA configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/sender-segregated-account-configuration/getallssaconfig","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/sender-segregated-account-configuration/getallssaconfig","metadata":{"seo":{"title":"Get all SSA configurations","description":"Returns all Sender Segregated (SSA) configurations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllSSAConfig","name":"Get all SSA configurations","isWebhook":false,"pointer":"/paths/~1config~1ssa_config/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all SSA configurations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all Sender Segregated (SSA) configurations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/ssa_config","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/ssa_config","href":"sender-segregated-account-configuration/getallssaconfig","openApiOperationId":"getAllSSAConfig","summary":"Get all SSA configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a list of Sender Segregated Account (SSA) configurations.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1ssa_config/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sender-segregated-account-configuration/getallssaconfig"}],"panels":[]}]},"httpPath":"/config/ssa_config"},{"label":"Get SSA configuration by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/sender-segregated-account-configuration/getssaconfigbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/sender-segregated-account-configuration/getssaconfigbyid","metadata":{"seo":{"title":"Get SSA configuration by ID","description":"Returns a Sender Segregated Account (SSA) configuration by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSSAConfigById","name":"Get SSA configuration by ID","isWebhook":false,"pointer":"/paths/~1config~1ssa_config~1{ssa_config_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get SSA configuration by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a Sender Segregated Account (SSA) configuration by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ssa_config_id","in":"path","schemaId":"schema_11","description":"The ID of the SSA configuration you want returned.","required":true}],"pointer":"/paths/~1config~1ssa_config~1{ssa_config_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/config/ssa_config/{ssa_config_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"ssa_config_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/config/ssa_config/{ssa_config_id}","href":"sender-segregated-account-configuration/getssaconfigbyid","openApiOperationId":"getSSAConfigById","summary":"Get SSA configuration by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns a Sender Segregated Account (SSA) configuration by its ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SSAConfigResponse"}},"schemaId":"components/schemas/SSAConfigResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1ssa_config~1{ssa_config_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SSAConfigResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SSAConfigResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sender-segregated-account-configuration/getssaconfigbyid"}],"panels":[]}]},"httpPath":"/config/ssa_config/{ssa_config_id}"},{"label":"Update SSA configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/sender-segregated-account-configuration/updatessaconfig","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/sender-segregated-account-configuration/updatessaconfig","metadata":{"seo":{"title":"Update SSA configuration","description":"Updates an existing Sender Segregated Account (SSA) configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSSAConfig","name":"Update SSA configuration","isWebhook":false,"pointer":"/paths/~1config~1ssa_config~1{ssa_config_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update SSA configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing Sender Segregated Account (SSA) configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ssa_config_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssa_config_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the SSA configuration you want to update."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1config~1ssa_config~1{ssa_config_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSSAConfigRequest"}},"schemaId":"components/schemas/UpdateSSAConfigRequest","pointer":"/paths/~1config~1ssa_config~1{ssa_config_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/config/ssa_config/{ssa_config_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"ssa_config_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateSSAConfigRequest"}},"responseCodes":["200","400"],"pointer":"/config/ssa_config/{ssa_config_id}","href":"sender-segregated-account-configuration/updatessaconfig","openApiOperationId":"updateSSAConfig","summary":"Update SSA configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/UpdateSSAConfigRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSSAConfigRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated Sender Segregated Account (SSA) configuration.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SSAConfigResponse"}},"schemaId":"components/schemas/SSAConfigResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1ssa_config~1{ssa_config_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SSAConfigResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SSAConfigResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sender-segregated-account-configuration/updatessaconfig"}],"panels":[]}]},"httpPath":"/config/ssa_config/{ssa_config_id}"},{"label":"Delete SSA configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/sender-segregated-account-configuration/deletessaconfig","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/sender-segregated-account-configuration/deletessaconfig","metadata":{"seo":{"title":"Delete SSA configuration","description":"Deletes a Sender Segregated Account (SSA) configuration by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSSAConfig","name":"Delete SSA configuration","isWebhook":false,"pointer":"/paths/~1config~1ssa_config~1{ssa_config_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete SSA configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a Sender Segregated Account (SSA) configuration by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ssa_config_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssa_config_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the SSA configuration you want to delete."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1config~1ssa_config~1{ssa_config_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/config/ssa_config/{ssa_config_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"ssa_config_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400"],"pointer":"/config/ssa_config/{ssa_config_id}","href":"sender-segregated-account-configuration/deletessaconfig","openApiOperationId":"deleteSSAConfig","summary":"Delete SSA configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successfully deleted Sender Segregated Account (SSA) configuration."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1config~1ssa_config~1{ssa_config_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sender-segregated-account-configuration/deletessaconfig"}],"panels":[]}]},"httpPath":"/config/ssa_config/{ssa_config_id}"}],"content":{"contentType":"group","meta":{"name":"Sender segregated account configuration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sender segregated account configuration","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/config/ssa_config","summary":"Create SSA configuration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sender-segregated-account-configuration/createssaconfig","deprecated":false},{"title":"/config/ssa_config","summary":"Get all SSA configurations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sender-segregated-account-configuration/getallssaconfig","deprecated":false},{"title":"/config/ssa_config/{ssa_config_id}","summary":"Get SSA configuration by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sender-segregated-account-configuration/getssaconfigbyid","deprecated":false},{"title":"/config/ssa_config/{ssa_config_id}","summary":"Update SSA configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/sender-segregated-account-configuration/updatessaconfig","deprecated":false},{"title":"/config/ssa_config/{ssa_config_id}","summary":"Delete SSA configuration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sender-segregated-account-configuration/deletessaconfig","deprecated":false}]}]}]}]}},{"type":"group","label":"Transfers","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/transfers","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/transfers","items":[{"label":"Get transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/transfers/gettransfers","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/transfers/gettransfers","metadata":{"seo":{"title":"Get transfers","description":"Gets a list of transfers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTransfers","name":"Get transfers","isWebhook":false,"pointer":"/paths/~1transfers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get transfers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of transfers."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_15","description":"Number of objects to return per page."},{"name":"with_labels","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns transfers that contain any of the specified labels."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?with_labels=LABEL1,LABEL2"},"children":[]}]}]}]}]},{"name":"without_labels","in":"query","schemaId":"schema_0","description":"Returns transfers that do not contain any of the specified labels."},{"name":"include_labels","in":"query","schemaId":"schema_41","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns labels added to each Transfer object. By default labels are not returned. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?with_labels=LABEL1&include_labels=true"},"children":[]}]}]}]}]},{"name":"state","in":"query","schemaId":"schema_42","description":"Filter by transfer states."},{"name":"internal_id","in":"query","schemaId":"schema_4","description":"Optional parameter for filtering with internalId."},{"name":"sender_end_to_end_id","in":"query","schemaId":"schema_4","description":"Optional parameter for filtering with sender end to end id."},{"name":"sort_field","in":"query","schemaId":"schema_38","description":"Field used to sort the results."},{"name":"sort_direction","in":"query","schemaId":"schema_43","description":"Sort direction."},{"name":"account","in":"query","schemaId":"schema_4","description":"RippleNet account which is involved in transfer"},{"name":"transfer_account_role","in":"query","schemaId":"schema_44","description":"by default account parameter would search both sender and receiver of transfer and bring the results. This is to restrict the account search to sender or receiver of a transfer"}],"pointer":"/paths/~1transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_7"},{"name":"size","in":"query","required":false,"schemaId":"schema_15"},{"name":"with_labels","in":"query","required":false,"schemaId":"schema_0","style":"form","explode":false},{"name":"without_labels","in":"query","required":false,"schemaId":"schema_0","style":"form","explode":false},{"name":"include_labels","in":"query","required":false,"schemaId":"schema_41"},{"name":"state","in":"query","required":false,"schemaId":"schema_42"},{"name":"internal_id","in":"query","required":false,"schemaId":"schema_4"},{"name":"sender_end_to_end_id","in":"query","required":false,"schemaId":"schema_4"},{"name":"sort_field","in":"query","required":false,"schemaId":"schema_38"},{"name":"sort_direction","in":"query","required":false,"schemaId":"schema_43"},{"name":"account","in":"query","required":false,"schemaId":"schema_4"},{"name":"transfer_account_role","in":"query","required":false,"schemaId":"schema_44"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/transfers","href":"transfers/gettransfers","openApiOperationId":"getTransfers","summary":"Get transfers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned transfers.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transfers"}},"schemaId":"components/schemas/Transfers"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1transfers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transfers","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transfers"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/gettransfers"}],"panels":[]}]},"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/ripplenet/transfers/gettransferestimate","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTransferEstimate","name":"Get transfer estimate","isWebhook":false,"pointer":"/paths/~1transfers~1estimate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get transfer estimate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sender_address","in":"query","schemaId":"schema_45","description":"RippleNet address of the xRapid account from which the transfer is funded"},{"name":"receiver_address","in":"query","schemaId":"schema_45","description":"RippleNet address representing an account outside of RippleNet to which the transfer amount is sent."},{"name":"amount","in":"query","schemaId":"schema_18","description":"The amount to be transferred"}],"pointer":"/paths/~1transfers~1estimate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers/estimate","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"sender_address","in":"query","schemaId":"schema_45"},{"name":"receiver_address","in":"query","schemaId":"schema_45"},{"name":"amount","in":"query","schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/transfers/estimate","href":"transfers/gettransferestimate","openApiOperationId":"getTransferEstimate","summary":"Get transfer estimate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved estimate of transfer sending fee","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferResponse"}},"schemaId":"components/schemas/TransferResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1transfers~1estimate/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransferResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/gettransferestimate"}],"panels":[]}]},"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/ripplenet/transfers/gettransferbyid","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/transfers/gettransferbyid","metadata":{"seo":{"title":"Get transfer by ID","description":"Gets a transfer by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTransferById","name":"Get transfer by ID","isWebhook":false,"pointer":"/paths/~1transfers~1{transfer_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get transfer by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a transfer by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_id","in":"path","schemaId":"schema_11","description":"Unique identifier of the transfer you want to retrieve.","required":true}],"pointer":"/paths/~1transfers~1{transfer_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_labels","in":"query","schemaId":"schema_41","description":"Returns labels added to each Transfer object. By default labels are not returned."}],"pointer":"/paths/~1transfers~1{transfer_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers/{transfer_id}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"transfer_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"include_labels","in":"query","required":false,"schemaId":"schema_41"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/transfers/{transfer_id}","href":"transfers/gettransferbyid","openApiOperationId":"getTransferById","summary":"Get transfer by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved transfer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferResponse"}},"schemaId":"components/schemas/TransferResponse"},{"code":"404","description":"Transfer not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1transfers~1{transfer_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransferResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferResponse"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/gettransferbyid"}],"panels":[]}]},"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/ripplenet/transfers/executetransfer","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeTransfer","name":"Execute transfer","isWebhook":false,"pointer":"/paths/~1transfers~1execute/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransferRequest"}},"schemaId":"components/schemas/TransferRequest","pointer":"/paths/~1transfers~1execute/post/requestBody","description":"See Transfer Request Object."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transfers/execute","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransferRequest"}},"responseCodes":["200","400"],"pointer":"/transfers/execute","href":"transfers/executetransfer","openApiOperationId":"executeTransfer","summary":"Execute transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/TransferRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransferRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully executed transfer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferResponse"}},"schemaId":"components/schemas/TransferResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1transfers~1execute/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransferResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferResponse"}}},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/executetransfer"}],"panels":[]}]},"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/ripplenet/transfers/completetransfer","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"completeTransfer","name":"Complete transfer","isWebhook":false,"pointer":"/paths/~1transfers~1{transfer_id}~1complete/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complete transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the state of a transfer to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Make this request once the transfer has been made on both the ledger and on internal systems."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_id","in":"path","schemaId":"schema_11","description":"Unique identifier of the transfer you want to complete.","required":true}],"pointer":"/paths/~1transfers~1{transfer_id}~1complete/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transfers/{transfer_id}/complete","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"transfer_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/transfers/{transfer_id}/complete","href":"transfers/completetransfer","openApiOperationId":"completeTransfer","summary":"Complete transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully completed transfer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferResponse"}},"schemaId":"components/schemas/TransferResponse"},{"code":"404","description":"Transfer not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1transfers~1{transfer_id}~1complete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransferResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferResponse"}}},{"code":"404","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/completetransfer"}],"panels":[]}]},"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/ripplenet/transfers/addtransferlabels","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/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]."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addTransferLabels","name":"Add transfer labels","isWebhook":false,"pointer":"/paths/~1transfers~1{transfer_id}~1labels/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add transfer labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a list of labels to the transfer. To retrieve transfers by label, see [Get transfers][get-transfers]."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_id","in":"path","schemaId":"schema_11","description":"Transfer ID for the label being added.","required":true}],"pointer":"/paths/~1transfers~1{transfer_id}~1labels/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"label","in":"query","schemaId":"schema_0","description":"Text of the label you want to add to the payment.","required":true}],"pointer":"/paths/~1transfers~1{transfer_id}~1labels/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/transfers/{transfer_id}/labels","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"transfer_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"label","in":"query","required":true,"schemaId":"schema_0","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/transfers/{transfer_id}/labels","href":"transfers/addtransferlabels","openApiOperationId":"addTransferLabels","summary":"Add transfer labels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully added one or more labels to the transfer."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1transfers~1{transfer_id}~1labels/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/addtransferlabels"}],"panels":[]}]},"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/ripplenet/transfers/deletetransferlabels","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/transfers/deletetransferlabels","metadata":{"seo":{"title":"Delete transfer labels","description":"Deletes one or more existing labels from the transfer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTransferLabels","name":"Delete transfer labels","isWebhook":false,"pointer":"/paths/~1transfers~1{transfer_id}~1labels/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete transfer labels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes one or more existing labels from the transfer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_id","in":"path","schemaId":"schema_11","description":"Transfer ID for the label being removed.","required":true}],"pointer":"/paths/~1transfers~1{transfer_id}~1labels/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"label","in":"query","schemaId":"schema_0","description":"Labels to be removed.","required":true}],"pointer":"/paths/~1transfers~1{transfer_id}~1labels/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/transfers/{transfer_id}/labels","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"transfer_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"label","in":"query","required":true,"schemaId":"schema_0","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/transfers/{transfer_id}/labels","href":"transfers/deletetransferlabels","openApiOperationId":"deleteTransferLabels","summary":"Delete transfer labels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted one or more labels of the transfer."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}},"schemaId":"components/schemas/RippleNetProblem"}],"pointer":"/paths/~1transfers~1{transfer_id}~1labels/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/RippleNetProblem","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RippleNetProblem"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/deletetransferlabels"}],"panels":[]}]},"httpPath":"/transfers/{transfer_id}/labels"}],"content":{"contentType":"group","meta":{"name":"Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfers","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transfers","summary":"Get transfers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfers/gettransfers","deprecated":false},{"title":"/transfers/estimate","summary":"Get transfer estimate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfers/gettransferestimate","deprecated":false},{"title":"/transfers/{transfer_id}","summary":"Get transfer by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfers/gettransferbyid","deprecated":false},{"title":"/transfers/execute","summary":"Execute transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfers/executetransfer","deprecated":false},{"title":"/transfers/{transfer_id}/complete","summary":"Complete transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfers/completetransfer","deprecated":false},{"title":"/transfers/{transfer_id}/labels","summary":"Add transfer labels","prefix":{"name":"put","color":"put"},"badges":[],"link":"/transfers/addtransferlabels","deprecated":false},{"title":"/transfers/{transfer_id}/labels","summary":"Delete transfer labels","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/transfers/deletetransferlabels","deprecated":false}]}]}]}]}},{"type":"group","label":"schema","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/schema","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/schema","items":[{"label":"Add RPO Schema","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/schema/addrposchema","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/schema/addrposchema","metadata":{"seo":{"title":"Add RPO Schema","description":"Adds a schema to a receiver address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addRpoSchema","name":"Add RPO Schema","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1schema/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add RPO Schema","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a schema to a receiver address."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RpoSchemaRequest"}},"schemaId":"components/schemas/RpoSchemaRequest","pointer":"/paths/~1v4~1orchestration~1config~1schema/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/orchestration/config/schema","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RpoSchemaRequest"}},"responseCodes":["200"],"pointer":"/v4/orchestration/config/schema","href":"schema/addrposchema","openApiOperationId":"addRpoSchema","summary":"Add RPO Schema"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/RpoSchemaRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RpoSchemaRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created RPO schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RpoSchemaResponse"}},"schemaId":"components/schemas/RpoSchemaResponse"}],"pointer":"/paths/~1v4~1orchestration~1config~1schema/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RpoSchemaResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RpoSchemaResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schema/addrposchema"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/schema"},{"label":"Get All RPO Schemas","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/schema/getrposchemas","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/schema/getrposchemas","metadata":{"seo":{"title":"Get All RPO Schemas","description":"Gets a list of configured RPO schemas."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRpoSchemas","name":"Get All RPO Schemas","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1schema/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get All RPO Schemas","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of configured RPO schemas."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/config/schema","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/config/schema","href":"schema/getrposchemas","openApiOperationId":"getRpoSchemas","summary":"Get All RPO Schemas"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned list of RPO schemas.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RpoSchemasAddresses"}},"schemaId":"components/schemas/RpoSchemasAddresses"}],"pointer":"/paths/~1v4~1orchestration~1config~1schema/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RpoSchemasAddresses","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RpoSchemasAddresses"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schema/getrposchemas"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/schema"},{"label":"Update RPO Schemas by schema_uuid","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/schema/updaterposchema","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/schema/updaterposchema","metadata":{"seo":{"title":"Update RPO Schemas by schema_uuid","description":"Updates an existing RPO Schemas by schema_uuid."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRpoSchema","name":"Update RPO Schemas by schema_uuid","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1schema~1{schema_uuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update RPO Schemas by schema_uuid","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing RPO Schemas by schema_uuid."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"schema_uuid","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the RPO Schema."},"children":[]}]}]}],"required":true,"example":"328b3e50-7983-46d5-94a0-ef004d78db1d"}],"pointer":"/paths/~1v4~1orchestration~1config~1schema~1{schema_uuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RpoSchemaRequest"}},"schemaId":"components/schemas/RpoSchemaRequest","pointer":"/paths/~1v4~1orchestration~1config~1schema~1{schema_uuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/orchestration/config/schema/{schema_uuid}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"schema_uuid","in":"path","required":true,"example":"328b3e50-7983-46d5-94a0-ef004d78db1d","schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RpoSchemaRequest"}},"responseCodes":["200"],"pointer":"/v4/orchestration/config/schema/{schema_uuid}","href":"schema/updaterposchema","openApiOperationId":"updateRpoSchema","summary":"Update RPO Schemas by schema_uuid"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/RpoSchemaRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RpoSchemaRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated RPO Schema.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RpoSchemaResponse"}},"schemaId":"components/schemas/RpoSchemaResponse"}],"pointer":"/paths/~1v4~1orchestration~1config~1schema~1{schema_uuid}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RpoSchemaResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RpoSchemaResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schema/updaterposchema"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/schema/{schema_uuid}"},{"label":"Delete RPO Schemas by 'schema_uuid'","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/schema/deleterposchema","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/schema/deleterposchema","metadata":{"seo":{"title":"Delete RPO Schemas by 'schema_uuid'","description":"Deletes an existing RPO Schema by 'schema_uuid'."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRpoSchema","name":"Delete RPO Schemas by 'schema_uuid'","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1schema~1{schema_uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete RPO Schemas by 'schema_uuid'","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an existing RPO Schema by 'schema_uuid'."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"schema_uuid","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schema_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the rposchRpo Schema."},"children":[]}]}]}],"required":true,"example":"328b3e50-7983-46d5-94a0-ef004d78db1d"}],"pointer":"/paths/~1v4~1orchestration~1config~1schema~1{schema_uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v4/orchestration/config/schema/{schema_uuid}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"schema_uuid","in":"path","required":true,"example":"328b3e50-7983-46d5-94a0-ef004d78db1d","schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/config/schema/{schema_uuid}","href":"schema/deleterposchema","openApiOperationId":"deleteRpoSchema","summary":"Delete RPO Schemas by 'schema_uuid'"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully deleted RPO Schema."}],"pointer":"/paths/~1v4~1orchestration~1config~1schema~1{schema_uuid}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schema/deleterposchema"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/schema/{schema_uuid}"},{"label":"Get RPO Schemas by Address","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/schema/getrposchemasbyreceiveraddress","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/schema/getrposchemasbyreceiveraddress","metadata":{"seo":{"title":"Get RPO Schemas by Address","description":"Gets a list of configured RPO schemas by RippleNet Receiver Address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRpoSchemasByReceiverAddress","name":"Get RPO Schemas by Address","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1schema~1{receiverAddress}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get RPO Schemas by Address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of configured RPO schemas by RippleNet Receiver Address."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"receiverAddress","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receiverAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the schema you want to retrieve."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v4~1orchestration~1config~1schema~1{receiverAddress}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/config/schema/{receiverAddress}/","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"receiverAddress","in":"path","required":true,"schemaId":"schema_46"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/config/schema/{receiverAddress}/","href":"schema/getrposchemasbyreceiveraddress","openApiOperationId":"getRpoSchemasByReceiverAddress","summary":"Get RPO Schemas by Address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned list of RPO schemas.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RpoSchemasAddressResponse"}},"schemaId":"components/schemas/RpoSchemasAddressResponse"}],"pointer":"/paths/~1v4~1orchestration~1config~1schema~1{receiverAddress}~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RpoSchemasAddressResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RpoSchemasAddressResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schema/getrposchemasbyreceiveraddress"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/schema/{receiverAddress}/"},{"label":"Get RPO Schemas by Address and Currency","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/schema/getrposchemasbyreceiveraddressandreceivercurrency","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/schema/getrposchemasbyreceiveraddressandreceivercurrency","metadata":{"seo":{"title":"Get RPO Schemas by Address and Currency","description":"Gets a list of configured RPO schemas by RippleNet Receiver Address and Currency."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRpoSchemasByReceiverAddressAndReceiverCurrency","name":"Get RPO Schemas by Address and Currency","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1schema~1{receiverAddress}~1{receiverCurrency}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get RPO Schemas by Address and Currency","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of configured RPO schemas by RippleNet Receiver Address and Currency."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"receiverAddress","in":"path","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receiverAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the schema you want to retrieve."},"children":[]}]}]}],"required":true},{"name":"receiverCurrency","in":"path","schemaId":"schema_48","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receiverCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the schema you want to retrieve."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v4~1orchestration~1config~1schema~1{receiverAddress}~1{receiverCurrency}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/config/schema/{receiverAddress}/{receiverCurrency}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"receiverAddress","in":"path","required":true,"schemaId":"schema_47"},{"name":"receiverCurrency","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/config/schema/{receiverAddress}/{receiverCurrency}","href":"schema/getrposchemasbyreceiveraddressandreceivercurrency","openApiOperationId":"getRpoSchemasByReceiverAddressAndReceiverCurrency","summary":"Get RPO Schemas by Address and Currency"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned list of RPO schemas.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RpoSchemasAddressResponse"}},"schemaId":"components/schemas/RpoSchemasAddressResponse"}],"pointer":"/paths/~1v4~1orchestration~1config~1schema~1{receiverAddress}~1{receiverCurrency}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RpoSchemasAddressResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RpoSchemasAddressResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schema/getrposchemasbyreceiveraddressandreceivercurrency"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/schema/{receiverAddress}/{receiverCurrency}"}],"content":{"contentType":"group","meta":{"name":"schema"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"schema","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/orchestration/config/schema","summary":"Add RPO Schema","prefix":{"name":"post","color":"post"},"badges":[],"link":"/schema/addrposchema","deprecated":false},{"title":"/v4/orchestration/config/schema","summary":"Get All RPO Schemas","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schema/getrposchemas","deprecated":false},{"title":"/v4/orchestration/config/schema/{schema_uuid}","summary":"Update RPO Schemas by schema_uuid","prefix":{"name":"put","color":"put"},"badges":[],"link":"/schema/updaterposchema","deprecated":false},{"title":"/v4/orchestration/config/schema/{schema_uuid}","summary":"Delete RPO Schemas by 'schema_uuid'","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/schema/deleterposchema","deprecated":false},{"title":"/v4/orchestration/config/schema/{receiverAddress}/","summary":"Get RPO Schemas by Address","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schema/getrposchemasbyreceiveraddress","deprecated":false},{"title":"/v4/orchestration/config/schema/{receiverAddress}/{receiverCurrency}","summary":"Get RPO Schemas by Address and Currency","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schema/getrposchemasbyreceiveraddressandreceivercurrency","deprecated":false}]}]}]}]}},{"type":"group","label":"activity","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/activity","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/activity","items":[{"label":"Create an activity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/activity/createactivity","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/activity/createactivity","metadata":{"seo":{"title":"Create an activity","description":"Creates an activity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createActivity","name":"Create an activity","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1activity/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an activity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates an activity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActivityRequest"}},"schemaId":"components/schemas/ActivityRequest","pointer":"/paths/~1v4~1orchestration~1config~1activity/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/orchestration/config/activity","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ActivityRequest"}},"responseCodes":["201"],"pointer":"/v4/orchestration/config/activity","href":"activity/createactivity","openApiOperationId":"createActivity","summary":"Create an activity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/ActivityRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActivityRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created activity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityResponse"}},"schemaId":"components/schemas/ActivityResponse"}],"pointer":"/paths/~1v4~1orchestration~1config~1activity/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ActivityResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity/createactivity"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/activity"},{"label":"Get all activities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/activity/getactivities","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/activity/getactivities","metadata":{"seo":{"title":"Get all activities","description":"Gets a list of activities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActivities","name":"Get all activities","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1activity/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all activities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of activities."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_26","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of objects to return per page."},{"name":"sort","in":"query","schemaId":"schema_4","description":"Name of the property on which you want to sort the results. Add diection by appending a comma (,) to the the property name plus either asc or desc."}],"pointer":"/paths/~1v4~1orchestration~1config~1activity/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/config/activity","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_26"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"},{"name":"sort","in":"query","required":false,"schemaId":"schema_4"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/config/activity","href":"activity/getactivities","openApiOperationId":"getActivities","summary":"Get all activities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully fetched all activities.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Activities"}},"schemaId":"components/schemas/Activities"}],"pointer":"/paths/~1v4~1orchestration~1config~1activity/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Activities","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Activities"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity/getactivities"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/activity"},{"label":"Get activity by name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/activity/getactivity","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/activity/getactivity","metadata":{"seo":{"title":"Get activity by name","description":"Gets activity by name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActivity","name":"Get activity by name","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1activity~1{name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get activity by name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets activity by name."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"schema_49","description":"Name of the activity to fetch.","required":true}],"pointer":"/paths/~1v4~1orchestration~1config~1activity~1{name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/config/activity/{name}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/config/activity/{name}","href":"activity/getactivity","openApiOperationId":"getActivity","summary":"Get activity by name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully fetched activity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityResponse"}},"schemaId":"components/schemas/ActivityResponse"}],"pointer":"/paths/~1v4~1orchestration~1config~1activity~1{name}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActivityResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity/getactivity"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/activity/{name}"},{"label":"update activity for retry interval change","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/activity/updateactivitybyname","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/activity/updateactivitybyname","metadata":{"seo":{"title":"update activity for retry interval change","description":"Updates activity for retry interval change."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateActivityByName","name":"update activity for retry interval change","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1activity~1{name}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"update activity for retry interval change","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates activity for retry interval change."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"schema_49","description":"Name of the activity to fetch.","required":true}],"pointer":"/paths/~1v4~1orchestration~1config~1activity~1{name}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActivityUpdateRequest"}},"schemaId":"components/schemas/ActivityUpdateRequest","pointer":"/paths/~1v4~1orchestration~1config~1activity~1{name}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/orchestration/config/activity/{name}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ActivityUpdateRequest"}},"responseCodes":["200"],"pointer":"/v4/orchestration/config/activity/{name}","href":"activity/updateactivitybyname","openApiOperationId":"updateActivityByName","summary":"update activity for retry interval change"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/ActivityUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActivityUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully fetched activity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityResponse"}},"schemaId":"components/schemas/ActivityResponse"}],"pointer":"/paths/~1v4~1orchestration~1config~1activity~1{name}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActivityResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity/updateactivitybyname"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/activity/{name}"},{"label":"Get tenant by tenant ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/activity/gettenant","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/activity/gettenant","metadata":{"seo":{"title":"Get tenant by tenant ID","description":"Gets tenant by tenant ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTenant","name":"Get tenant by tenant ID","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1tenant~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tenant by tenant ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets tenant by tenant ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_4","description":"Tenant ID of the tenant.","required":true}],"pointer":"/paths/~1v4~1orchestration~1config~1tenant~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/config/tenant/{tenantId}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/config/tenant/{tenantId}","href":"activity/gettenant","openApiOperationId":"getTenant","summary":"Get tenant by tenant ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully fetched tenant.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TenantResponse"}},"schemaId":"components/schemas/TenantResponse"}],"pointer":"/paths/~1v4~1orchestration~1config~1tenant~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TenantResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TenantResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity/gettenant"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/tenant/{tenantId}"}],"content":{"contentType":"group","meta":{"name":"activity"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"activity","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/orchestration/config/activity","summary":"Create an activity","prefix":{"name":"post","color":"post"},"badges":[],"link":"/activity/createactivity","deprecated":false},{"title":"/v4/orchestration/config/activity","summary":"Get all activities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activity/getactivities","deprecated":false},{"title":"/v4/orchestration/config/activity/{name}","summary":"Get activity by name","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activity/getactivity","deprecated":false},{"title":"/v4/orchestration/config/activity/{name}","summary":"update activity for retry interval change","prefix":{"name":"put","color":"put"},"badges":[],"link":"/activity/updateactivitybyname","deprecated":false},{"title":"/v4/orchestration/config/tenant/{tenantId}","summary":"Get tenant by tenant ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activity/gettenant","deprecated":false}]}]}]}]}},{"type":"group","label":"Orchestration Template","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-template","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-template","items":[{"label":"Add an orchestration template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-template/addorchestrationtemplate","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-template/addorchestrationtemplate","metadata":{"seo":{"title":"Add an orchestration template","description":"Adds an orchestration template with a unique name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addOrchestrationTemplate","name":"Add an orchestration template","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1template/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add an orchestration template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds an orchestration template with a unique name."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrchestrationTemplateRequest"}},"schemaId":"components/schemas/OrchestrationTemplateRequest","pointer":"/paths/~1v4~1orchestration~1config~1template/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/orchestration/config/template","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrchestrationTemplateRequest"}},"responseCodes":["200"],"pointer":"/v4/orchestration/config/template","href":"orchestration-template/addorchestrationtemplate","openApiOperationId":"addOrchestrationTemplate","summary":"Add an orchestration template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/OrchestrationTemplateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrchestrationTemplateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created orchestration template.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationTemplateResponse"}},"schemaId":"components/schemas/OrchestrationTemplateResponse"}],"pointer":"/paths/~1v4~1orchestration~1config~1template/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrchestrationTemplateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationTemplateResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-template/addorchestrationtemplate"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/template"},{"label":"Get all orchestration templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-template/getallorchestrationtemplate","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-template/getallorchestrationtemplate","metadata":{"seo":{"title":"Get all orchestration templates","description":"Gets a list of configured orchestration templates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllOrchestrationTemplate","name":"Get all orchestration templates","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1template/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all orchestration templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of configured orchestration templates."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/config/template","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/config/template","href":"orchestration-template/getallorchestrationtemplate","openApiOperationId":"getAllOrchestrationTemplate","summary":"Get all orchestration templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned list of orchestration templates.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationTemplateList"}},"schemaId":"components/schemas/OrchestrationTemplateList"}],"pointer":"/paths/~1v4~1orchestration~1config~1template/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrchestrationTemplateList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationTemplateList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-template/getallorchestrationtemplate"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/template"},{"label":"Get orchestration template by Name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-template/getorchestrationtemplatebyname","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-template/getorchestrationtemplatebyname","metadata":{"seo":{"title":"Get orchestration template by Name","description":"Gets a configured orchestration template by its name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrchestrationTemplateByName","name":"Get orchestration template by Name","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1template~1{name}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get orchestration template by Name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a configured orchestration template by its name."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the orchestration template you want to retrieve."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v4~1orchestration~1config~1template~1{name}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/config/template/{name}/","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/config/template/{name}/","href":"orchestration-template/getorchestrationtemplatebyname","openApiOperationId":"getOrchestrationTemplateByName","summary":"Get orchestration template by Name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned orchestration template.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationTemplateResponse"}},"schemaId":"components/schemas/OrchestrationTemplateResponse"}],"pointer":"/paths/~1v4~1orchestration~1config~1template~1{name}~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrchestrationTemplateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationTemplateResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-template/getorchestrationtemplatebyname"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/template/{name}/"},{"label":"Change default_template value of the orchestration template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-template/updatedefaultorchestrationtemplatebyname","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-template/updatedefaultorchestrationtemplatebyname","metadata":{"seo":{"title":"Change default_template value of the orchestration template","description":"Changes default_template value of the orchestration template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDefaultOrchestrationTemplateByName","name":"Change default_template value of the orchestration template","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1template~1{name}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change default_template value of the orchestration template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changes default_template value of the orchestration template."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the orchestration template you want to retrieve."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v4~1orchestration~1config~1template~1{name}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrchestrationTemplateUpdateRequest"}},"schemaId":"components/schemas/OrchestrationTemplateUpdateRequest","pointer":"/paths/~1v4~1orchestration~1config~1template~1{name}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/orchestration/config/template/{name}/","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrchestrationTemplateUpdateRequest"}},"responseCodes":["200"],"pointer":"/v4/orchestration/config/template/{name}/","href":"orchestration-template/updatedefaultorchestrationtemplatebyname","openApiOperationId":"updateDefaultOrchestrationTemplateByName","summary":"Change default_template value of the orchestration template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/OrchestrationTemplateUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrchestrationTemplateUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully created orchestration template.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationTemplateResponse"}},"schemaId":"components/schemas/OrchestrationTemplateResponse"}],"pointer":"/paths/~1v4~1orchestration~1config~1template~1{name}~1/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrchestrationTemplateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrchestrationTemplateResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-template/updatedefaultorchestrationtemplatebyname"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/template/{name}/"}],"content":{"contentType":"group","meta":{"name":"Orchestration Template"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orchestration Template","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/orchestration/config/template","summary":"Add an orchestration template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orchestration-template/addorchestrationtemplate","deprecated":false},{"title":"/v4/orchestration/config/template","summary":"Get all orchestration templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orchestration-template/getallorchestrationtemplate","deprecated":false},{"title":"/v4/orchestration/config/template/{name}/","summary":"Get orchestration template by Name","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orchestration-template/getorchestrationtemplatebyname","deprecated":false},{"title":"/v4/orchestration/config/template/{name}/","summary":"Change default_template value of the orchestration template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orchestration-template/updatedefaultorchestrationtemplatebyname","deprecated":false}]}]}]}]}},{"type":"group","label":"diagnostics","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/diagnostics","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/diagnostics","items":[{"label":"Check Health","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/diagnostics/checkhealth","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/diagnostics/checkhealth","metadata":{"seo":{"title":"Check Health","description":"Gets the health status of the ros server."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkHealth","name":"Check Health","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1health/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check Health","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the health status of the ros server."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/health","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/health","href":"diagnostics/checkhealth","openApiOperationId":"checkHealth","summary":"Check Health"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HealthRos"}},"schemaId":"components/schemas/HealthRos"}],"pointer":"/paths/~1v4~1orchestration~1health/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/HealthRos","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HealthRos"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/diagnostics/checkhealth"}],"panels":[]}]},"httpPath":"/v4/orchestration/health"}],"content":{"contentType":"group","meta":{"name":"diagnostics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"diagnostics","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/orchestration/health","summary":"Check Health","prefix":{"name":"get","color":"get"},"badges":[],"link":"/diagnostics/checkhealth","deprecated":false}]}]}]}]}},{"type":"group","label":"payment","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payment","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payment","items":[{"label":"Create Quote Collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payment/createquotecollection","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/payment/createquotecollection","metadata":{"seo":{"title":"Create Quote Collection","description":"Creates a collection of quotes for a proposed payment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createQuoteCollection","name":"Create Quote Collection","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1payment~1quote_collections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Quote Collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a collection of quotes for a proposed payment."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentQuoteRequest"}},"schemaId":"components/schemas/PaymentQuoteRequest","pointer":"/paths/~1v4~1orchestration~1payment~1quote_collections/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/orchestration/payment/quote_collections","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentQuoteRequest"}},"responseCodes":["200"],"pointer":"/v4/orchestration/payment/quote_collections","href":"payment/createquotecollection","openApiOperationId":"createQuoteCollection","summary":"Create Quote Collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentQuoteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentQuoteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned quote collection.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteCollectionRos"}},"schemaId":"components/schemas/QuoteCollectionRos"}],"pointer":"/paths/~1v4~1orchestration~1payment~1quote_collections/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QuoteCollectionRos","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QuoteCollectionRos"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment/createquotecollection"}],"panels":[]}]},"httpPath":"/v4/orchestration/payment/quote_collections"}],"content":{"contentType":"group","meta":{"name":"payment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"payment","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/orchestration/payment/quote_collections","summary":"Create Quote Collection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment/createquotecollection","deprecated":false}]}]}]}]}},{"type":"group","label":"tenant","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/tenant","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/tenant","items":[{"label":"Create a new tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/tenant/createtenant","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/tenant/createtenant","metadata":{"seo":{"title":"Create a new tenant","description":"Creates a new tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTenant","name":"Create a new tenant","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1tenant/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new tenant."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TenantRequest"}},"schemaId":"components/schemas/TenantRequest","pointer":"/paths/~1v4~1orchestration~1config~1tenant/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/orchestration/config/tenant","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TenantRequest"}},"responseCodes":["201"],"pointer":"/v4/orchestration/config/tenant","href":"tenant/createtenant","openApiOperationId":"createTenant","summary":"Create a new tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/TenantRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TenantRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully created tenant.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TenantResponse"}},"schemaId":"components/schemas/TenantResponse"}],"pointer":"/paths/~1v4~1orchestration~1config~1tenant/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/TenantResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TenantResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tenant/createtenant"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/tenant"},{"label":"Get all tenants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/tenant/gettenants","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/tenant/gettenants","metadata":{"seo":{"title":"Get all tenants","description":"Gets a list of tenants."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTenants","name":"Get all tenants","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1tenant/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all tenants","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of tenants."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_26","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/pagination/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paginated results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value is zero-based, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the first page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page of results."},"children":[]}]}]}]},{"name":"size","in":"query","schemaId":"schema_8","description":"Number of objects to return per page."},{"name":"sort","in":"query","schemaId":"schema_4","description":"Name of the property on which you want to sort the results. Add diection by appending a comma (,) to the the property name plus either asc or desc."}],"pointer":"/paths/~1v4~1orchestration~1config~1tenant/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/config/tenant","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_26"},{"name":"size","in":"query","required":false,"schemaId":"schema_8"},{"name":"sort","in":"query","required":false,"schemaId":"schema_4"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/config/tenant","href":"tenant/gettenants","openApiOperationId":"getTenants","summary":"Get all tenants"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully fetched all tenants.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Tenants"}},"schemaId":"components/schemas/Tenants"}],"pointer":"/paths/~1v4~1orchestration~1config~1tenant/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Tenants","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Tenants"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tenant/gettenants"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/tenant"},{"label":"Update a tenant","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/tenant/updatetenant","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/tenant/updatetenant","metadata":{"seo":{"title":"Update a tenant","description":"Updates a tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTenant","name":"Update a tenant","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1config~1tenant~1{tenantId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a tenant."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_4","description":"Tenant ID of the tenant.","required":true}],"pointer":"/paths/~1v4~1orchestration~1config~1tenant~1{tenantId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TenantUpdateRequest"}},"schemaId":"components/schemas/TenantUpdateRequest","pointer":"/paths/~1v4~1orchestration~1config~1tenant~1{tenantId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/orchestration/config/tenant/{tenantId}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_4"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TenantUpdateRequest"}},"responseCodes":["201"],"pointer":"/v4/orchestration/config/tenant/{tenantId}","href":"tenant/updatetenant","openApiOperationId":"updateTenant","summary":"Update a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/TenantUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TenantUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully updated tenant.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TenantResponse"}},"schemaId":"components/schemas/TenantResponse"}],"pointer":"/paths/~1v4~1orchestration~1config~1tenant~1{tenantId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/TenantResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TenantResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tenant/updatetenant"}],"panels":[]}]},"httpPath":"/v4/orchestration/config/tenant/{tenantId}"}],"content":{"contentType":"group","meta":{"name":"tenant"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"tenant","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/orchestration/config/tenant","summary":"Create a new tenant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tenant/createtenant","deprecated":false},{"title":"/v4/orchestration/config/tenant","summary":"Get all tenants","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tenant/gettenants","deprecated":false},{"title":"/v4/orchestration/config/tenant/{tenantId}","summary":"Update a tenant","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tenant/updatetenant","deprecated":false}]}]}]}]}},{"type":"group","label":"Orchestration internal action","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-internal-action","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-internal-action","items":[{"label":"Post action to orchestration internal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-internal-action/sendorchestrationpaymentinternalaction","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-internal-action/sendorchestrationpaymentinternalaction","metadata":{"seo":{"title":"Post action to orchestration internal","description":"Posts internal action the Orchestration internal service."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendOrchestrationPaymentInternalAction","name":"Post action to orchestration internal","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1internal~1action/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post action to orchestration internal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Posts internal action the Orchestration internal service."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentInternalActionRequest"}},"schemaId":"components/schemas/PaymentInternalActionRequest","pointer":"/paths/~1v4~1orchestration~1internal~1action/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/orchestration/internal/action","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentInternalActionRequest"}},"responseCodes":["201"],"pointer":"/v4/orchestration/internal/action","href":"orchestration-internal-action/sendorchestrationpaymentinternalaction","openApiOperationId":"sendOrchestrationPaymentInternalAction","summary":"Post action to orchestration internal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"schemaId":"components/schemas/PaymentInternalActionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentInternalActionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully posted internal action.","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/PaymentActionResponse"}},"schemaId":"components/schemas/PaymentActionResponse"}],"pointer":"/paths/~1v4~1orchestration~1internal~1action/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/PaymentActionResponse","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/PaymentActionResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-internal-action/sendorchestrationpaymentinternalaction"}],"panels":[]}]},"httpPath":"/v4/orchestration/internal/action"}],"content":{"contentType":"group","meta":{"name":"Orchestration internal action"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orchestration internal action","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/orchestration/internal/action","summary":"Post action to orchestration internal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orchestration-internal-action/sendorchestrationpaymentinternalaction","deprecated":false}]}]}]}]}},{"type":"group","label":"Orchestration internal payments","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-internal-payments","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-internal-payments","items":[{"label":"Get orchestration payment without user info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-internal-payments/getorchestrationpaymentwithoutuserinfo","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-internal-payments/getorchestrationpaymentwithoutuserinfo","metadata":{"seo":{"title":"Get orchestration payment without user info","description":"Gets orchestration payment without user info by unique reference number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrchestrationPaymentWithoutUserInfo","name":"Get orchestration payment without user info","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1internal~1payment~1{uniqueReferenceNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get orchestration payment without user info","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets orchestration payment without user info  by unique reference number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uniqueReferenceNumber","in":"path","schemaId":"schema_29","description":"Unique reference number of the orchestration payment to fetch.","required":true}],"pointer":"/paths/~1v4~1orchestration~1internal~1payment~1{uniqueReferenceNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/internal/payment/{uniqueReferenceNumber}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"uniqueReferenceNumber","in":"path","required":true,"schemaId":"schema_29"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/internal/payment/{uniqueReferenceNumber}","href":"orchestration-internal-payments/getorchestrationpaymentwithoutuserinfo","openApiOperationId":"getOrchestrationPaymentWithoutUserInfo","summary":"Get orchestration payment without user info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully returned orchestration payment.","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/OrchestrationPaymentResponse"}},"schemaId":"components/schemas/OrchestrationPaymentResponse"}],"pointer":"/paths/~1v4~1orchestration~1internal~1payment~1{uniqueReferenceNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrchestrationPaymentResponse","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/OrchestrationPaymentResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-internal-payments/getorchestrationpaymentwithoutuserinfo"}],"panels":[]}]},"httpPath":"/v4/orchestration/internal/payment/{uniqueReferenceNumber}"}],"content":{"contentType":"group","meta":{"name":"Orchestration internal payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orchestration internal payments","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/orchestration/internal/payment/{uniqueReferenceNumber}","summary":"Get orchestration payment without user info","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orchestration-internal-payments/getorchestrationpaymentwithoutuserinfo","deprecated":false}]}]}]}]}},{"type":"group","label":"Orchestration internal notifications","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-internal-notifications","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-internal-notifications","items":[{"label":"Get orchestration notifications by unique reference number for internal","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-internal-notifications/getorchestrationpaymentnotificationsbyuniquereferencenumberforinternal","routeSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/orchestration-internal-notifications/getorchestrationpaymentnotificationsbyuniquereferencenumberforinternal","metadata":{"seo":{"title":"Get orchestration notifications by unique reference number for internal","description":"Gets orchestration payment notifications with a given unique reference number for internal"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrchestrationPaymentNotificationsByUniqueReferenceNumberForInternal","name":"Get orchestration notifications by unique reference number for internal","isWebhook":false,"pointer":"/paths/~1v4~1orchestration~1internal~1payment~1notification~1urn~1{uniqueReferenceNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get orchestration notifications by unique reference number for internal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets orchestration payment notifications with a given unique reference number for internal"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uniqueReferenceNumber","in":"path","schemaId":"schema_32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_end_to_end_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the orchestration payment notification in case of sender and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in case of receiver."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v4~1orchestration~1internal~1payment~1notification~1urn~1{uniqueReferenceNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/orchestration/internal/payment/notification/urn/{uniqueReferenceNumber}","servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"parameters":{"path":[{"name":"uniqueReferenceNumber","in":"path","required":true,"schemaId":"schema_32"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/orchestration/internal/payment/notification/urn/{uniqueReferenceNumber}","href":"orchestration-internal-notifications/getorchestrationpaymentnotificationsbyuniquereferencenumberforinternal","openApiOperationId":"getOrchestrationPaymentNotificationsByUniqueReferenceNumberForInternal","summary":"Get orchestration notifications by unique reference number for internal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","description":"Mock server","isMockServer":true},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully fetched orchestration payment notifications.","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/NotificationList"}},"schemaId":"components/schemas/NotificationList"}],"pointer":"/paths/~1v4~1orchestration~1internal~1payment~1notification~1urn~1{uniqueReferenceNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotificationList","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/NotificationList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orchestration-internal-notifications/getorchestrationpaymentnotificationsbyuniquereferencenumberforinternal"}],"panels":[]}]},"httpPath":"/v4/orchestration/internal/payment/notification/urn/{uniqueReferenceNumber}"}],"content":{"contentType":"group","meta":{"name":"Orchestration internal notifications"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orchestration internal notifications","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/orchestration/internal/payment/notification/urn/{uniqueReferenceNumber}","summary":"Get orchestration notifications by unique reference number for internal","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orchestration-internal-notifications/getorchestrationpaymentnotificationsbyuniquereferencenumberforinternal","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/NotificationResponsePage":{"id":"components/schemas/NotificationResponsePage","kind":"json-schema","title":"NotificationResponsePage","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/NotificationResponse"}}}}],"description":"Paged response for notifications requested"}},"components/schemas/NotificationResponse":{"id":"components/schemas/NotificationResponse","kind":"json-schema","title":"NotificationResponse","data":{"type":"object","description":"Notification details","required":["notification_id","notification_type","notification_status","notification_priority","created_at","entity_type","entity_id","message_details"],"properties":{"notification_id":{"type":"string","format":"uuid","description":"Notification Id"},"notification_type":{"type":"string","enum":["HEARTBEAT_EVENT","NEW_PEERING_EVENT","NEW_LIQUIDITY_RELATIONSHIP_EVENT","LOW_BALANCE_EVENT"],"description":"Context in which the notification is generated"},"notification_status":{"type":"string","enum":["CREATED","DELIVERED","READ","DELETED"],"description":"Status of the notification"},"notification_priority":{"type":"string","enum":["ERROR","INFO","WARN"],"description":"Priority of the notification"},"created_at":{"type":"string","format":"date-time","description":"Date and time at which the notification was created, as an ISO-8601 timestamp in UTC."},"entity_type":{"type":"string","enum":["QUOTE","PAYMENT","TRANSFER","EXCHANGE"],"description":"RippleNet entity for which the notification has been generated"},"entity_id":{"type":"string","format":"uuid","description":"Entity id of the RippleNet entity for which the notification has been generated"},"message_details":{"type":"string","description":"Summary description of the notification"},"source_address":{"type":"string","description":"RippleNet address of the host that has created the notification"},"destination_address":{"type":"string","description":"RippleNet address of the host that needs to receive the notification"},"notification_details":{"type":"string","description":"Payload of the notification object"}}}},"components/schemas/Accounts":{"id":"components/schemas/Accounts","kind":"json-schema","title":"Accounts","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/AccountResponse"}}}}],"description":"Paged response for accounts includes:"}},"components/schemas/AccountRequest":{"id":"components/schemas/AccountRequest","kind":"json-schema","title":"AccountRequest","data":{"type":"object","required":["currency","name","owner"],"properties":{"name":{"type":"string","example":"conct_usd_sf","description":"Provide the name of the account. This value must be unique within the xCurrent instance."},"owner":{"type":"string","example":"rn.us.ca.san_francisco","description":"Provide the RippleNet address of the owner of the account."},"currency":{"type":"string","example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the currency of the account. Ripple recommends using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency codes, although no formal constraint is enforced."},"children":[]}]}]}]},"core_ledger_ref":{"type":"string","example":"bitso","description":"Core ledger reference key. This could be a bank account number for fiat, exchange name for exchange accounts, or a ledger reference for digital accounts. This field is required for exchange accounts"},"rounding_mode":{"type":"string","description":"Set to determine whether calculations for this account should be rounded up or down to maintain precision.","enum":["HALF_UP","HALF_DOWN","DOWN"],"default":"HALF_UP"},"scale":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to the number of decimal places to be used when calculating rounding for this account. The allowable range is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0-9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":2},"low_liquidity_threshold":{"type":"number","example":1000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the balance of a sender account meets or goes below this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"low_liquidity_threshold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value after settlement execution, a low-liquidity message is logged at the INFO level."},"children":[]}]}]}]},"minimum_allowed_balance":{"type":"number","description":"Set to the minimum balance allowed for the account.","default":-100000},"maximum_allowed_balance":{"type":"number","description":"Set to the maximum balance allowed for the account.","default":72036854775},"platform_account_id":{"type":"string","format":"uuid","description":"Platform account ID associated with this RippleNet account."},"external_account_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to link a customer’s account ID on their systems to their RippleNet account."},"children":[]}]}]}]},"account_description":{"type":"string","description":"Description associated with this RippleNet account."}},"description":"Use this JSON request object to create an account in the xCurrent ledger."}},"components/schemas/AccountResponse":{"id":"components/schemas/AccountResponse","kind":"json-schema","title":"AccountResponse","data":{"type":"object","required":["balance","currency","disabled","low_liquidity_threshold","maximum_allowed_balance","minimum_allowed_balance","name","owner","owner_max_allowed_balance","owner_min_allowed_balance","rounding_mode","scale"],"properties":{"name":{"type":"string","example":"conct_usd_sf","description":"Account name and unique identifier on RippleNet."},"balance":{"type":"number","example":0,"description":"Balance available in the account."},"owner":{"type":"string","example":"rn.us.ca.san_francisco","description":"RippleNet address of the owner of the account."},"currency":{"type":"string","example":"USD","description":"Currency supported by the account."},"disabled":{"type":"boolean","example":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the account is disabled ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or active ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"minimum_allowed_balance":{"type":"number","example":-1000000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum balance allowed for the account. For nostro accounts, RippleNet Server uses the greater of this value and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owner_min_allowed_balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set the account balance minimum."},"children":[]}]}]}]},"maximum_allowed_balance":{"type":"number","example":9999999999999900000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum balance allowed for the account. For nostro accounts, RippleNet Server uses the lesser of this value and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owner_max_allowed_balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set the account balance maximum."},"children":[]}]}]}]},"core_ledger_ref":{"type":"string","example":"bitso","description":"Core ledger reference key. This could be a bank account number for fiat, exchange name for exchange accounts, or a ledger reference for digital accounts. This field is required for exchange accounts"},"rounding_mode":{"type":"string","example":"HALF_UP","description":"Determines whether calculations for this account are rounded up or down to maintain precision.","enum":["HALF_UP","HALF_DOWN","DOWN"],"default":"HALF_UP"},"scale":{"type":"integer","example":2,"description":"Number of decimal places used when calculating rounding for this account."},"low_liquidity_threshold":{"type":"number","example":1000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the sender's account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is less than or equal to this amount, after payment settlement execution, a low-liquidity message is logged at the INFO level."},"children":[]}]}]}]},"owner_min_allowed_balance":{"type":"number","example":-100000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum balance allowed by the owner of a nostro account. RippleNet Server uses the greater of this value and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum_allowed_balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set the account balance minimum."},"children":[]}]}]}]},"owner_max_allowed_balance":{"type":"number","example":72036854775,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum balance allowed by the owner of a nostro account. RippleNet Server uses the lesser of this value and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maximum_allowed_balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set the account balance maximum."},"children":[]}]}]}]},"platform_account_id":{"type":"string","format":"uuid","description":"Platform account ID associated with this RippleNet account."},"external_account_id":{"type":"string","description":"Customer's account ID on their systems associated with this RippleNet account."},"account_description":{"type":"string","description":"Description associated with this RippleNet account."}},"description":"Represents an account on the xCurrent ledger."}},"components/schemas/AccountUpdateAllowedBalanceRequest":{"id":"components/schemas/AccountUpdateAllowedBalanceRequest","kind":"json-schema","title":"AccountUpdateAllowedBalanceRequest","data":{"type":"object","properties":{"minimum_allowed_balance":{"type":"number","example":-1000000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to the minimum balance allowed for the account. Updates the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum_allowed_balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the account."},"children":[]}]}]}]},"maximum_allowed_balance":{"type":"number","example":9999999999999900000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to the maximum balance allowed for the account. Updates the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maximum_allowed_balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the account."},"children":[]}]}]}]},"core_ledger_ref":{"type":"string","example":"bitso","description":"Core ledger reference key. This could be a bank account number for fiat, exchange name for exchange accounts, or a ledger reference for digital accounts. This field is required for exchange accounts"},"enable":{"type":"boolean","example":true,"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the account should be disabled ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or active ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"platform_account_id":{"type":"string","format":"uuid","description":"Platform account ID associated with this RippleNet account."},"external_account_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to link a customer’s account ID on their systems to their RippleNet account."},"children":[]}]}]}]},"account_description":{"type":"string","description":"Description associated with this RippleNet account."}},"description":"Use this JSON request object to update the minimum and maximum balance limits for an account."}},"components/schemas/NostroAccountUpdateAllowedBalanceRequest":{"id":"components/schemas/NostroAccountUpdateAllowedBalanceRequest","kind":"json-schema","title":"NostroAccountUpdateAllowedBalanceRequest","data":{"type":"object","properties":{"minimum_allowed_balance":{"type":"number","example":-1250000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to the minimum balance allowed for the nostro account. Updates the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum_allowed_balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the account. Allows owner of nostro account to increase the account minimum and override the value set by partner."},"children":[]}]}]}]},"maximum_allowed_balance":{"type":"number","example":1000000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to the maximum balance allowed for the nostro account. Updates the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maximum_allowed_balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the account. Allows owner of nostro account to decrease the account maximum and override the value set by partner."},"children":[]}]}]}]},"core_ledger_ref":{"type":"string","example":"bitso","description":"Core ledger reference key. This could be a bank account number for fiat, exchange name for exchange accounts, or a ledger reference for digital accounts. This field is required for exchange accounts"},"enable":{"type":"boolean","example":true,"default":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the account should be disabled ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or active ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"description":"Use this JSON request object to update the minimum and maximum balance. limits for an account."}},"components/schemas/PaymentQuoteRequest":{"id":"components/schemas/PaymentQuoteRequest","kind":"json-schema","title":"PaymentQuoteRequest","data":{"type":"object","required":["amount","currency","quote_type","receiving_address","sending_address"],"properties":{"sending_address":{"type":"string","example":"sf@rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]}]}]}]},"receiving_address":{"type":"string","example":"sf_gbp@rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the receiver."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]}]}]}]},"amount":{"type":"string","minimum":1,"example":"1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to be sent or received, depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this table to determine what "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to assign."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"1\""},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quote type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SENDER_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to be sent by the payment originator"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SENDER_INSTITUTION_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to calculate the quote based on the amount to be sent, plus any fees collected by the sending institution"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECEIVER_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to be received by the payment beneficiary"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECEIVER_INSTITUTION_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to calculate the quote based on the amount to be received, minus any fees collected by the receiving institution"},"children":[]}]}]}]}]}]}]},"currency":{"type":"string","example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code of the amount to be sent or received, depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this table to determine what "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code to assign."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quote type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SENDER_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the currency code for the sending currency, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SENDER_INSTITUTION_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the currency code for the sending currency, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECEIVER_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the currency code for the receiving currency, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECEIVER_INSTITUTION_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the currency code for the receiving currency, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]}]}]}]}]}]}]},"quote_type":{"type":"string","example":"SENDER_AMOUNT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to calculate the quote."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_AMOUNT"},"children":[]}]}]}],"enum":["SENDER_AMOUNT","RECEIVER_AMOUNT","SENDER_INSTITUTION_AMOUNT","RECEIVER_INSTITUTION_AMOUNT"],"x-enumDescriptions":{"SENDER_AMOUNT":"Quote based on the amount the payment originator or originating institution wants to send","SENDER_INSTITUTION_AMOUNT":"Quote based on the amount (to debit the originator) is `amount` plus any fees to be collected by the sending institution","RECEIVER_AMOUNT":"Quote based on the amount the payment beneficiary or beneficiary institution should receive","RECEIVER_INSTITUTION_AMOUNT":"The amount (to credit the beneficiary) is `amount` minus any fees to be collected by the receiving institution"}},"sender_or_receiver_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code of the sender or receiver based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If provided, you can use this to filter the options for quotes."},"children":[]}]}]}],"example":"USD"},"custom_fee":{"type":"number","description":"Custom fee for the sending account.\n\nSetting this field overrides all fees configured on the sender's RippleNet instance.\n"},"custom_rate":{"description":"Custom rate that quotes must use. The request returns only quotes that are able to provide this custom rate.","$ref":"#/components/schemas/PaymentQuoteCustomRateRequest"},"quote_route":{"type":"array","example":["rn.us.ca.san_francisco","rn.us.tx.austin","rn.us.ny.new_york"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom route that quote must follow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide an array of RippleNet address strings that convey the route the quote must follow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"g.us.ca.san_francisco"},"children":[]}]}]}],"items":{"type":"string"}},"payment_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout method for the quote."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Senders can use this field to define the payout method that the receiver should use to deliver the payment to end"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On-Demand Liquidity (ODL) receivers should set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outlet_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not an empty value)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to keep funds at the destination exchange when paying out to a local rail."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Caution"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The existing quote parameter is named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while elsewhere it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payout_method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"enable_quote_per_payout_method":{"type":"boolean","example":true,"description":"Enable this flag to generate quotes using payout methods configured by the receiver."},"digital_asset_origination":{"type":"boolean","description":"When true, this flag tells RippleNet to provide a full quote as if the payment originates in the specified source fiat currency.\n\nThe quote for the source exchange excludes trading fees.\n\nOn execution, the source exchange trade is skipped, and XRP is withdrawn from the source exchange as the first step.\n","example":false},"force_path_finding_and_liquidity_path_finding":{"type":"boolean","description":"When true, this flag tells RippleNet to ignore cached value for path finding and liquidity path finding.\n\nForce performing new path finding and liquidity path finding.\n","example":false,"default":false},"payout_method_category":{"type":"string","example":"BOOK_TRANSFER","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category the payout method will be associated with. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OTHER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not specified."},"children":[]}]}]}],"enum":["REAL_TIME_GROSS_SETTLEMENT_SYSTEM","REAL_TIME_NET_SETTLEMENT_SYSTEM","MASS_NET_PAYMENT_SYSTEM","BOOK_TRANSFER","CASH_PAYOUT","WALLET_PAYMENT","OTHER"],"x-enumDescriptions":{"REAL_TIME_GROSS_SETTLEMENT_SYSTEM":"Real-time gross settlement system","REAL_TIME_NET_SETTLEMENT_SYSTEM":"Real-time net settlement system","MASS_NET_PAYMENT_SYSTEM":"Mass net payment system","BOOK_TRANSFER":"Book transfer","CASH_PAYOUT":"Cash payout","WALLET_PAYMENT":"Wallet payment","OTHER":"Other"}},"sender_segregated_account":{"type":"string","maxLength":254,"example":"conct_php_receiver_coins_sender@receiver","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender owned account at receiver to be used for failure conversion (in case of payment failure)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]}]}]}]},"quote_limit":{"type":"integer","description":"Flag for truncating the total amount of quotes to a maximum amount after sorting and filters are applied. Optional."},"quote_filter_types":{"type":"array","description":"Filter on a type of quote.","items":{"type":"string","enum":["LIQUIDITY_WARNINGS","QUOTE_ERRORS"],"x-enumDescriptions":{"LIQUIDITY_WARNINGS":"Filter for liquidity warnings","QUOTE_ERRORS":"Filter for quote errors"}}}},"description":"JSON request object to generate a quote collection."}},"components/schemas/PaymentQuoteCustomRateRequest":{"id":"components/schemas/PaymentQuoteCustomRateRequest","kind":"json-schema","title":"PaymentQuoteCustomRateRequest","data":{"type":"object","required":["base_currency","counter_currency","rate","rate_type"],"properties":{"rate":{"type":"number","description":"Exchange rate for a base and counter currency."},"base_currency":{"type":"string","description":"Base currency of the exchange rate."},"counter_currency":{"type":"string","description":"Counter currency of the exchange rate."},"rate_type":{"type":"string","enum":["buy","sell"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order type for the exchange rate. Valid values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sell"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When rate_type = buy, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is source ccy and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"counter_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is destination ccy."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When rate_type = sell, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"base_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is destination ccy and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"counter_currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is source ccy."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[]}]}]}]}},"description":"JSON request object to specify a custom exchange rate during quote collection generation."}},"components/schemas/QuoteCollection":{"id":"components/schemas/QuoteCollection","kind":"json-schema","title":"QuoteCollection","data":{"type":"object","required":["quote_collection_id","quotes"],"properties":{"quote_collection_id":{"type":"string","format":"uuid","example":"4711728c-cd35-49ec-96a5-72732b4333ec","description":"Unique identifier of the quote collection."},"quotes":{"type":"array","items":{"$ref":"#/components/schemas/Quote"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information on quote elements, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/tutorials/configure-fees#create-quote-collections"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create quote collections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"quote_errors":{"type":"array","items":{"$ref":"#/components/schemas/QuoteError"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided as a response to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/createQuoteCollection"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create quote collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, provides a JSON object representing quotes for a proposed payment. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided as a response to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/createQuoteToReturnPayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create quote to return payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  request, provides a JSON object representing quotes for a proposed return payment."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided as a response to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/createQuoteToReversePayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reverse Payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, provides a JSON object representing a quote for a proposed reverse payment."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided as a response to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/createQuoteCollection"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get quote collection by ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request, provides the requested quote collection."},"children":[]}]}]}]}]}},"components/schemas/QuoteError":{"id":"components/schemas/QuoteError","kind":"json-schema","title":"QuoteError","data":{"type":"object","required":["failed_path","error_message"],"properties":{"failed_path":{"type":"array","description":"Quote path that failed.","items":{"$ref":"#/components/schemas/QuotePathRos"}},"error_origin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet address of where the error originated. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"error_message":{"type":"string","description":"Message that describes the error."}},"description":"Object that describes an error that happened during quote collection.","x-docs-model-object":{"object-name":"Quote Error Object","nested-objects-array":[{"property-name":"failed_path","object":"quote-path","docs-name":"Quote Path Array","data-type":"Array","has-nested-display":true}]}}},"components/schemas/QuotePath":{"id":"components/schemas/QuotePath","kind":"json-schema","title":"QuotePath","data":{"type":"object","required":["source","destination","source_currency","destination_currency"],"properties":{"source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the source account, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"destination":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the destination account, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source_currency":{"type":"string","description":"Currency associated with the source account."},"destination_currency":{"type":"string","description":"Currency associated with the destination account."},"account_liquidity_relationship_id":{"type":"string","format":"uuid","example":"480e3a6f-3bcd-48cd-9ce9-9d940aa3c9c6","description":"Unique identifier for an account liquidity relationship."},"peer_liquidity_relationship_id":{"type":"string","format":"uuid","example":"480e3a6f-3bcd-48cd-9ce9-9d940aa3c9c6","description":"Unique identifier for a peer liquidity relationship."},"quote_path_order":{"type":"integer","example":1,"description":"Order of each quote path."}},"description":"Object that describes a liquidity path used to generate a quote."}},"components/schemas/Quote":{"id":"components/schemas/Quote","kind":"json-schema","title":"Quote","data":{"type":"object","required":["amount","created_at","currency_code","currency_code_filter","expires_at","liquidity_warning","price_guarantee","quote_elements","quote_id","receiver_address","sender_address","service_type","type"],"properties":{"quote_id":{"type":"string","format":"uuid","example":"2a547e56-4aac-4375-86a8-8b3e7014801d","description":"Unique identifier for the quote."},"created_at":{"type":"string","format":"date-time","example":"2020-01-29T20:59:44.925Z","description":"Date and time at which the quote was created, as an ISO-8601 timestamp in UTC."},"expires_at":{"type":"string","format":"date-time","example":"2020-01-29T21:29:44.925Z","description":"Date and time after which the quote and its pricing expire, as an ISO-8601 timestamp in UTC.","default":"300s/300000ms"},"type":{"type":"string","example":"SENDER_AMOUNT","description":"Indicates how the amount field should be treated for calculating quote values.","enum":["SENDER_AMOUNT","RECEIVER_AMOUNT","SENDER_INSTITUTION_AMOUNT","RECEIVER_INSTITUTION_AMOUNT","REVERSAL_AMOUNT"]},"price_guarantee":{"type":"string","example":"FIRM","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether a quote's pricing is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INDICATIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIRM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INDICATIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" quote allows for price movements between quote issuance and payment execution, such that the quoted amount and delivered amount may differ. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIRM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" quote ensures that the quoted and delivered payment amounts are equal."},"children":[]}]}]}],"default":"FIRM"},"sender_address":{"type":"string","example":"sf@rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiver_address":{"type":"string","example":"sf_gbp@rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the receiver, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"amount":{"type":"string","example":"1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to be sent or received, depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"currency_code":{"type":"string","example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"currency_code_filter":{"type":"string","example":"EUR","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code that can be used to filter quotes at the opposite end of the quote request. For example, you can filter by this currency code to find the receiving currency for a quote with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" quote_type. If not sent in the request, this field value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"service_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"quote_elements":{"type":"array","description":"Transfer and exchange elements. A transfer element represents a movement of funds between two accounts. An exchange element represents the exchange of currencies between two accounts.","items":{"$ref":"#/components/schemas/QuoteElement"}},"liquidity_warning":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when a quote causes an account to go below its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum_allowed_balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, this field value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"payment_method":{"type":"string","example":"LOCAL_RAILS","description":"Payout method for the quote."},"payment_method_fields":{"type":"string","example":"{\"category_id\":\"bank\",\"required_originator_fields\":[{\"field_name\":\"sender_address\",\"field_label\":\"Sender address\"}]}","description":"JSON object containing payment method metadata."},"payout_method_info":{"type":"object","description":"Details about the payout method.","properties":{"payout_method_name":{"type":"string","example":"Cash Payout","description":"Payout method for the quote."},"payout_method_category":{"type":"string","example":"BOOK_TRANSFER","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of the payout method. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not specified."},"children":[]}]}]}],"enum":["REAL_TIME_GROSS_SETTLEMENT_SYSTEM","REAL_TIME_NET_SETTLEMENT_SYSTEM","MASS_NET_PAYMENT_SYSTEM","BOOK_TRANSFER","CASH_PAYOUT","WALLET_PAYMENT","OTHER"]},"description":{"type":"string","example":"local rails","description":"User defined description of the payout method."},"estimated_time_to_credit":{"type":"string","example":"3 days","description":"The estimated time to credit the beneficiary using this payout method."}}}},"description":"JSON response object that represents a quote for a proposed payment or return payment."}},"components/schemas/QuoteElement":{"id":"components/schemas/QuoteElement","kind":"json-schema","title":"QuoteElement","data":{"type":"object","required":["quote_element_id","quote_element_order","quote_element_type","receiver_address","receiving_amount","receiving_fee","sender_address","sending_amount","sending_fee"],"properties":{"quote_element_id":{"type":"string","format":"uuid","example":"259189e7-cb14-42e7-99ef-375f3285e356","description":"Unique identifier for the quote element."},"quote_element_type":{"type":"string","example":"EXCHANGE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of quote element."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the movement of funds between two accounts."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the exchange of currencies between two accounts."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE_TRADE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the exchange of fiat to digital currency on a digital exchange."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRYPTO_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the movement of digital funds between two digital exchanges."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[]}]}]}],"enum":["TRANSFER","EXCHANGE","EXCHANGE_TRADE","CRYPTO_TRANSFER"]},"quote_element_order":{"type":"string","example":"1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order of each quote element along the liquidity path. If a quote includes five quote elements, each one is enacted according to its quote_element_order number to make the proposed payment."},"children":[]}]}]}]},"sender_address":{"type":"string","example":"sf@rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiver_address":{"type":"string","example":"sf_gbp@rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the receiver, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"sending_amount":{"type":"number","example":1,"description":"Amount the sender is sending."},"receiving_amount":{"type":"number","example":355,"description":"Amount the receiver is receiving."},"sending_fee":{"type":"number","example":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fees the sender is charging. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_element_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field value is always set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiving_fee":{"type":"number","example":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fees the receiver is charging. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_element_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field value is always set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"sending_currency_code":{"type":"string","example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code of the sending amount. Included in quote elements with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_element_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiving_currency_code":{"type":"string","example":"GBP","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code of the receiving amount. Included in quote elements with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_element_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fx_rate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange rate details. Included in quote elements with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_element_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/FXRate"},"transfer_currency_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code of the transfer. Included in quote elements with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_element_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"description":"JSON object that provides transfer and exchange elements used to provide the quote. A transfer element represents the transfer of currency between two accounts. An exchange element represents the exchange of currencies between two accounts."}},"components/schemas/FXRate":{"id":"components/schemas/FXRate","kind":"json-schema","title":"FXRate","data":{"type":"object","required":["base_currency_code","counter_currency_code","rate","type"],"properties":{"rate":{"type":"number","example":3.25,"description":"Exchange rate between a base and counter currency."},"base_currency_code":{"type":"string","example":"USD","description":"Currency code of the base currency."},"counter_currency_code":{"type":"string","example":"GBP","description":"Currency code of the counter currency."},"type":{"type":"string","example":"buy","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order type of the exchange rate. Valid values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sell"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"description":"The details of an FX Rate for a quote or payment."}},"components/schemas/PaymentReturnQuoteRequest":{"id":"components/schemas/PaymentReturnQuoteRequest","kind":"json-schema","title":"PaymentReturnQuoteRequest","data":{"type":"object","required":["original_payment_id"],"properties":{"original_payment_id":{"type":"string","format":"uuid","example":"d485f100-2af7-4e48-9ab1-3c7e28775691","description":"ID of the original payment to be returned."},"return_reasons":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pairs that describe the reason the payment is being returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields should contain the following "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These values are included in a payment created from a quote in the response. They are included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_info.returned"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for the node sending the return payment."},"children":[]}]}]}],"properties":{},"example":{"REASON":"Wrong receiving amount","TYPE":"Account Error","CODE":"A-999"}},"return_amount_type":{"type":"string","example":"TOTAL_RECEIVED_MINUS_FEES","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount type of the return payment."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To indicate that the sender of the return payment will send the amount it received, set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOTAL_RECEIVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To indicate that the sender of the return payment will send the amount it received minus its receiving fees, set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOTAL_RECEIVED_MINUS_FEES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["TOTAL_RECEIVED","TOTAL_RECEIVED_MINUS_FEES"],"default":"TOTAL_RECEIVED"},"custom_fee":{"type":"number","description":"Custom fee charged and collected by the sending account. Setting this field overrides all applicable fees configured on the sender's RippleNet instance."},"custom_rate":{"description":"Custom rate that the return payment quotes must use. The request returns only quotes that are able to provide this custom rate.","$ref":"#/components/schemas/PaymentQuoteCustomRateRequest"},"force_path_finding_and_liquidity_path_finding":{"type":"boolean","description":"When true, this flag tells RippleNet to ignore cached value for path finding and liquidity path finding and perform new path finding and liquidity path finding.","example":false,"default":false},"receiver_address":{"type":"string","example":"sf@rn.us.ca.san_francisco","description":"The desired receiving account for the return payment as a RippleNet address. This account must be owned by the original payment's sender."}},"description":"Use this JSON request object to generate a collection of quotes that can be used to return a payment."}},"components/schemas/PaymentReversalQuoteRequest":{"id":"components/schemas/PaymentReversalQuoteRequest","kind":"json-schema","title":"PaymentReversalQuoteRequest","data":{"type":"object","required":["original_payment_id","reversal_reason"],"properties":{"original_payment_id":{"type":"string","format":"uuid","example":"d485f100-2af7-4e48-9ab1-3c7e28775691","description":"ID of the original payment to be reversed."},"reversal_reason":{"description":"Object with reversal code and description.","$ref":"#/components/schemas/PaymentReversalReason"}},"description":"Use this JSON request object to generate a collection of quotes that can be used to reverse a payment."}},"components/schemas/PaymentReversalReason":{"id":"components/schemas/PaymentReversalReason","kind":"json-schema","title":"PaymentReversalReason","data":{"type":"object","required":["code"],"properties":{"code":{"type":"string","example":"RB001","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code indicating the reason for payment reversal. For code descriptions and error handling information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/resources/error-codes/returns-and-error-codes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns and failure codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["RB001","RB002","RB003","RB004","RB005","RB008","RB009","RB010","RB011","RB012","RB013","RB017","RB018","RB023","RB024","RB026","RB027","RB028","RB029","RB030","RB031","RB032","RB033","RB034","RB035","RB036","RB037","AC01","AC03","AC04","AC06","AC08","AC09","AC11","AC12","AC13","AC14","AC15","AG01","AG02","AG03","AG05","AG06","AM02","AM03","AM04","AM11","AM13","AM14","AM15","AM21","AM22","BE01","BE04","BE05","BE06","BE07","BE08","BE09","BE10","BE11","BE12","BE13","BE14","BE15","BE16","BE17","BE18","BE19","BE20","BE21","BE22","CERI","CH11","CH12","CH13","CH14","CH21","CNOR","CUST","DS24","DU05","DUPL","ED06","FF03","FF04","FF05","FF06","FF07","FF08","FF10","MD06","MD07","MS02","MS03","NARR","RC01","RC02","RC04","RC05","RC07","RC08","RC10","RC12","RF01","RR01","RR02","RR03","RR04","RR05","RR06","RR07","RR10"]},"description":{"type":"string","example":"No account / Unable to locate account","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional. User-defined string describing the reason for payment reversal. When using the reversal reason code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NARR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Narrative), you must specify the reason for the return in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversal_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute."},"children":[]}]}]}]}},"description":"A structured object detailing reasons for a payment reversal."}},"components/schemas/PaymentAcceptRequest":{"id":"components/schemas/PaymentAcceptRequest","kind":"json-schema","title":"PaymentAcceptRequest","data":{"type":"object","required":["quote_id"],"properties":{"quote_id":{"type":"string","format":"uuid","example":"9bb53b3b-a774-43e2-9a1b-f18fbc3640f7","description":"ID of the quote to accept and continue as a payment."},"sender_end_to_end_id":{"type":"string","maxLength":128,"description":"ID that the sender can specify. Persisted on all RippleNet instances that participate in the payment."},"internal_id":{"type":"string","maxLength":128,"description":"Internal ID that the sender can specify. Only visible to the sender. Only the sending RippleNet instance stores this ID."},"user_info":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your receiver defines the required "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/resources/srpo/user-info"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User info"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" structure. Provide the structure as required by your use case."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout Service (SLS) customers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use the ISO20022 descriptions used with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/resources/srpo/supporting-info-full-json-schema"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet Payment Object (RPO)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" structure."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One-to-one liquidation customers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/resources/outbound-instructions/#payout-examples"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outbound instructions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"properties":{}}},"description":"Use this JSON request object to accept a quote ID to start the payment process."}},"components/schemas/FilteredPayment":{"id":"components/schemas/FilteredPayment","kind":"json-schema","title":"FilteredPayment","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sanitized payment with sensitive content filtered from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_info"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/BasePayment"},{"type":"object"},{"$ref":"#/components/schemas/UserInfoArray"}]}},"components/schemas/UserInfoArray":{"id":"components/schemas/UserInfoArray","kind":"json-schema","title":"UserInfoArray","data":{"properties":{"user_info":{"type":"array","description":"Collection of user-provided data whose keys are filtered based on a configurable denylist.","items":{"$ref":"#/components/schemas/UserInfo"}}}}},"components/schemas/BasePayment":{"id":"components/schemas/BasePayment","kind":"json-schema","title":"BasePayment","data":{"type":"object","required":["contract","contract_hash","crypto_transaction_id","execution_condition","execution_results","modified_at","payment_id","payment_state","payment_type","returned_by_payment_with_id","returns_payment_with_id","validator"],"properties":{"payment_id":{"type":"string","format":"uuid","example":"d485f100-2af7-4e48-9ab1-3c7e28775691","description":"Unique identifier of a payment."},"contract_hash":{"type":"string","example":"ccb23bd87f13cc13b9d616a9723f76e112aeac8628b2082e0f8bf3b8c670b103","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash of all values in the Contract object used to ensure immutability. Once a payment transitions to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, the values in this object cannot change."},"children":[]}]}]}]},"payment_state":{"type":"string","example":"COMPLETED","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of the payment. For details about payment states, see "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment States"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet Developer Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["ACCEPTED","AWAITING_COLLECTION","COMPLETED","EXECUTED","FAILED","FORWARDED","LOCK_DECLINED","LOCKED","PREPARED","RETURNED","SETTLEMENT_DECLINED"]},"modified_at":{"type":"string","format":"date-time","example":"2019-10-01T18:25:47.347Z","description":"Date and time at which the payment was last modified, as an ISO-8601 timestamp in UTC."},"contract":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents all immutable parts of a payment agreed upon by all participants as a part of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/lockPayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lock payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flow. Once a payment transitions to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, the values in this object cannot change."},"children":[]}]}]}],"$ref":"#/components/schemas/PaymentContract"},"ripplenet_info":{"type":"array","description":"Application-provided data explaining actions taken by RippleNet applications.","items":{"$ref":"#/components/schemas/RippleNetInfo"}},"execution_condition":{"type":"string","example":"PrefixSha256Condition{subtypes=[ED25519-SHA-256], type=PREFIX-SHA-256, fingerprint=sfGGHCrkyaMsLQNB62w_4zarlPChHKm47JkXVQbs1z0, cost=132360}","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Base64-encoded execution condition for this payment, the fulfillment of which will be presented to the validator to complete this payment. This value must match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution_condition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the associated crypto transaction."},"children":[]}]}]}]},"crypto_transaction_id":{"type":"string","example":"4e05da26-7872-4a1f-b9b7-db7604757c37","description":"Unique identifier of the crypto transaction associated with this payment."},"validator":{"type":"string","example":"rn.us.ca.san_francisco","description":"Address of the validator that validated the payment."},"payment_type":{"type":"string","example":"REGULAR","description":"Payment type.","enum":["REGULAR","RETURN"]},"returns_payment_with_id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", provides the payment ID of the original payment that this payment returns. Otherwise, this field value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"returned_by_payment_with_id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REGULAR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the payment has an associated return payment, provides the payment ID of the return payment. Otherwise, this field value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"execution_results":{"type":"array","description":"Represents the actual movement of funds in a payment. Each execution result corresponds to a quote element and represents its execution in a payment.","items":{"$ref":"#/components/schemas/ExecutionResult"}},"liquidation_execution_results":{"type":"array","description":"Represents the actual movement of funds in a payment as part of liquidation of a Wallet Receive payment.","items":{"$ref":"#/components/schemas/ExecutionResult"}},"liquidation_details":{"type":"object","description":"Contains details of liquidation if applicable.","$ref":"#/components/schemas/LiquidationDetails"},"push_forward_execution_results":{"type":"array","description":"Represents the movement of funds after an On-Demand Liquidity payment fails at intermediary transfer or destination exchange.","items":{"$ref":"#/components/schemas/ExecutionResult"}}},"description":"JSON response object that represents a payment. A payment is the movement of value across accounts on potentially different RippleNet instances involving one or more currencies."}},"components/schemas/Payment":{"id":"components/schemas/Payment","kind":"json-schema","title":"Payment","data":{"description":"JSON response object that represents a payment. A payment is the movement of value across accounts on potentially different RippleNet instances involving one or more currencies.","required":["user_info","internal_info","accepted_at"],"allOf":[{"$ref":"#/components/schemas/BasePayment"},{"type":"object","properties":{"accepted_at":{"type":"string","format":"date-time","example":"2019-10-01T18:25:47.347Z","description":"Date and time at which the payment was last accepted, as an ISO-8601 timestamp in UTC."},"locked_at":{"type":"string","format":"date-time","example":"2019-10-01T18:25:47.347Z","description":"Date and time at which the payment was last locked, as an ISO-8601 timestamp in UTC."},"executed_at":{"type":"string","format":"date-time","example":"2019-10-01T18:25:47.347Z","description":"Date and time at which the payment was last executed, as an ISO-8601 timestamp in UTC."},"completed_at":{"type":"string","format":"date-time","example":"2019-10-01T18:25:47.347Z","description":"Date and time at which the payment was last completed, as an ISO-8601 timestamp in UTC."},"returned_at":{"type":"string","format":"date-time","example":"2019-10-01T18:25:47.347Z","description":"Date and time at which the payment was returned, as an ISO-8601 timestamp in UTC."},"internal_info":{"description":"JSON object containing information that only the RippleNet instance that set it can view. This value can be set by the sender when accepting a payment and by an intermediary or receiver when locking the payment.","$ref":"#/components/schemas/InternalInfo"},"user_info":{"type":"array","description":"User-provided data with arbitrary key/value pairs.","items":{"$ref":"#/components/schemas/UserInfo"}}}}]}},"components/schemas/InternalInfo":{"id":"components/schemas/InternalInfo","kind":"json-schema","title":"InternalInfo","data":{"required":["connector_role","internal_id","labels"],"properties":{"connector_role":{"type":"string","example":"RECEIVING","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role of the RippleNet node that sets one or more values in the Internal Info object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Sending account in the payment resides on this RippleNet instance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Receiving account in the payment resides on this RippleNet instance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERMEDIARY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Neither sending nor receiving accounts in the payment reside on this RippleNet instance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERNAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Both sending and receiving accounts in the payment (usually between RippleNet Cloud and RippleNet) reside on this RippleNet instance."},"children":[]}]}]}]}],"enum":["SENDING","RECEIVING","INTERMEDIARY","INTERNAL"]},"labels":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of objects that provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values that are set by including the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field at any stage of the payment's lifecycle. Labels can used as a filtering mechanism when searching for payments. Labels are visible only to the node that added them to this copy of a payment. If the values that populate this array are not set in the request or if the values set in the request are not viewable by your node, this array is empty."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/Label"}},"internal_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID that is viewable only to the node that set it. This value can be set by the sender when accepting a payment. This value can also be set by any intermediary and the receiver when locking the payment. If this value is not set in the request or if the value set in the request is not viewable by your node, this field value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"description":"JSON object containing information that only the RippleNet instance that set it can view. These values can be set by the sender when accepting a payment and by an intermediary or receiver when locking the payment."}},"components/schemas/Label":{"id":"components/schemas/Label","kind":"json-schema","title":"Label","data":{"properties":{"label":{"type":"string","description":"Label to be attached"}},"description":"Label object"}},"components/schemas/PaymentContract":{"id":"components/schemas/PaymentContract","kind":"json-schema","title":"PaymentContract","data":{"type":"object","required":["created_at","expires_at","quote","sender_end_to_end_id"],"properties":{"sender_end_to_end_id":{"type":"string","description":"ID that the sender can specify. Persisted on all RippleNet instances that participate in the payment.","maxLength":128,"minLength":1},"created_at":{"type":"string","format":"date-time","example":"2019-10-01T18:18:13.665Z","description":"Date and time at which this payment contract was created, as an ISO-8601 timestamp in UTC."},"expires_at":{"type":"string","format":"date-time","example":"2019-10-01T18:55:22.824Z","description":"Date and time after which this payment contract expires, as an ISO-8601 timestamp in UTC.","default":"300s/300000ms"},"quote":{"description":"Quote for a proposed payment.","$ref":"#/components/schemas/Quote"},"fee_info":{"description":"Breakdown of all fees charged in the payment.","$ref":"#/components/schemas/FeeInfo"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents all immutable parts of a payment agreed upon by all participants as a part of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/lockPayment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lock payment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flow. Once a payment transitions to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, the values in this object cannot change."},"children":[]}]}]}]}},"components/schemas/FeeInfo":{"id":"components/schemas/FeeInfo","kind":"json-schema","title":"FeeInfo","data":{"type":"object","required":["nodes","total_fees"],"properties":{"nodes":{"type":"object","description":"Fees charged by each node participating in the payment.","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/FeeDetails"}}},"total_fees":{"type":"array","description":"Total fees charged in the payment, separated by currency.","items":{"$ref":"#/components/schemas/TotalFees"}}},"description":"Itemized list of fees charged by each node."}},"components/schemas/FeeDetails":{"id":"components/schemas/FeeDetails","kind":"json-schema","title":"FeeDetails","data":{"type":"object","required":["fee_value","fee_currency","category"],"properties":{"fee_value":{"type":"number","description":"value of the fee"},"fee_currency":{"type":"string","description":"currency of the fee charged"},"category":{"type":"string","description":"category of the fee"},"fee_description":{"type":"string","description":"optional description of the fee"}}}},"components/schemas/TotalFees":{"id":"components/schemas/TotalFees","kind":"json-schema","title":"TotalFees","data":{"type":"object","required":["total_fee","fee_currency"],"properties":{"total_fee":{"type":"number","description":"total value of fee"},"fee_currency":{"type":"string","description":"currency of the fee charged"}}}},"components/schemas/UserInfo":{"id":"components/schemas/UserInfo","kind":"json-schema","title":"UserInfo","data":{"type":"object","required":["accepted","completed","executed","failed","forwarded","lock_declined","locked","node_address","retry_accept","retry_settlement","returned","settlement","settlement_declined"],"properties":{"node_address":{"type":"string","example":"rn.us.ca.san_francisco","description":"RippleNet address of the node that provided the user information."},"accepted":{"type":"array","description":"User information optionally provided when accepting the payment.","items":{"$ref":"#/components/schemas/UserInfoEntry"}},"locked":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User information optionally provided when locking the payment. For more information, see [User Info Entry Object][user-info-entry]."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/UserInfoEntry"}},"lock_declined":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User information optionally provided when declining to lock the payment. For more information, see [User Info Entry Object][user-info-entry]."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/UserInfoEntry"}},"retry_accept":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User information optionally provided when retrying acceptance of the payment. For more information, see [User Info Entry Object][user-info-entry]."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/UserInfoEntry"}},"retry_settlement":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User information optionally provided when retrying settlement of the payment. For more information, see [User Info Entry Object][user-info-entry]."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/UserInfoEntry"}},"settlement":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User information optionally provided when settling the payment. For more information, see [User Info Entry Object][user-info-entry]."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/UserInfoEntry"}},"settlement_declined":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User information optionally provided when settlement for the payment is declined. For more information, see [User Info Entry Object][user-info-entry]."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/UserInfoEntry"}},"failed":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User information optionally provided when failing the payment. For more information, see [User Info Entry Object][user-info-entry]."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/UserInfoEntry"}},"executed":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment sub-state information provided using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields when finalizing the payment. For more information, see [User Info Entry Object][user-info-entry]."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/UserInfoEntry"}},"completed":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User information optionally provided when completing the payment. For more information, see [User Info Entry Object][user-info-entry]."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/UserInfoEntry"}},"forwarded":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If applicable, user information optionally provided when forwarding the payment. For more information, see [User Info Entry Object][user-info-entry]."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/UserInfoEntry"}},"returned":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If applicable, information optionally provided using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"return_reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when returning the payment. For more information, see [User Info Entry Object][user-info-entry]."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/UserInfoEntry"}}},"description":"User information provided across the payment lifecycle."}},"components/schemas/UserInfoEntry":{"id":"components/schemas/UserInfoEntry","kind":"json-schema","title":"UserInfoEntry","data":{"type":"object","required":["created_at","json"],"properties":{"json":{"type":"object","description":"User information provided across the payment lifecycle stored as arbitrary JSON key/value pairs.","properties":{}},"created_at":{"type":"string","format":"date-time","description":"Date and time at which the user information was added to the payment, as an ISO-8601 timestamp in UTC."},"subState":{"type":"string","example":"EXECUTING","description":"If provided, this parameter descibes payment state more granularly."}},"description":"User information provided as arbitrary key/value pairs."}},"components/schemas/RippleNetInfo":{"id":"components/schemas/RippleNetInfo","kind":"json-schema","title":"RippleNetInfo","data":{"type":"object","required":["node_address","settlement_declined"],"properties":{"node_address":{"type":"string","example":"rn.us.ny.new_york","description":"RippleNet address of the node from which the RippleNetInfo originated."},"settlement_declined":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If applicable, provides an array of RippleNetInfoEntry's explaining transitions into the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLEMENT_DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/RippleNetInfoEntry"}}},"description":"Application-generated information explaining actions taken by RippleNet applications."}},"components/schemas/RippleNetInfoEntry":{"id":"components/schemas/RippleNetInfoEntry","kind":"json-schema","title":"RippleNetInfoEntry","data":{"type":"object","properties":{"info":{"type":"string","example":"L001","description":"Information explaining the action taken by a RippleNet application. Could be a RippleNet error code, or a written explanation of the action taken"},"created_at":{"type":"string","format":"date-time","example":"2018-04-06T20:33:35Z","description":"The DateTime that this quote was created, as an ISO-8601 timestamp in UTC."}},"description":"Application-generated information explaining an action taken by a RippleNet application"}},"components/schemas/ExecutionResult":{"id":"components/schemas/ExecutionResult","kind":"json-schema","title":"ExecutionResult","data":{"type":"object","required":["execution_result_id","execution_result_order","execution_result_type","execution_timestamp","receiver_address","receiving_amount","receiving_fee","sender_address","sending_amount","sending_fee"],"properties":{"execution_result_id":{"type":"string","format":"uuid","example":"06f6d4e2-3523-4d17-92fd-53192a06207f","description":"Unique identifier for this payment result."},"execution_timestamp":{"type":"string","format":"date-time","example":"2019-10-01T18:24:29.867Z","description":"Date and time at which this portion of the payment was executed, as an ISO-8601 timestamp in UTC."},"execution_result_type":{"type":"string","example":"TRANSFER","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of payment execution result."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the movement of funds between two accounts."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the exchange of currencies between two accounts."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE_TRADE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the exchange of fiat to digital currency on a digital exchange."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRYPTO_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the movement of digital funds between two digital exchanges."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[]}]}]}],"enum":["TRANSFER","EXCHANGE","EXCHANGE_TRADE","CRYPTO_TRANSFER"]},"execution_result_order":{"type":"integer","example":1,"description":"Order in which the payment execution action was taken along the liquidity path. For example, a payment may include five execution results along the liquidity path. Each execution result has an order number that indicates the order in which the execution result was achieved to make the payment."},"sender_address":{"type":"string","example":"trans_usd_sf@rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiver_address":{"type":"string","example":"conct_usd_sf@rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the receiver, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"sending_amount":{"type":"number","example":498,"description":"Amount the sender is sending."},"receiving_amount":{"type":"number","example":498,"description":"Amount the receiver is receiving."},"sending_fee":{"type":"number","example":2,"description":"Fees the sender is charging."},"receiving_fee":{"type":"number","example":0,"description":"Fees the receiver is charging."},"sending_currency_code":{"type":"string","example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code of the sending amount. Included in execution results with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution_result_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiving_currency_code":{"type":"string","example":"GBP","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency of the receiving amount. Included in execution results with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution_result_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fx_rate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange rate details. Included in execution results with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execution_result_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/FXRate"},"transfer_currency_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency of the transfer. Returned in execution results with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"execute_result_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"intermediary_delta":{"type":"number","example":0.2,"description":"Amount of XRP representing the difference in FX rate between the moment of quoting and the moment of execution. A positive value is the amount taken out of the incentive pool. A negative value is the amount returned to the incentive pool. (Soon to be deprecated)"},"incentive_type":{"type":"string","example":"firm","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration of the incentive pool on the xRapid side. Two values are supported, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", xRapid guarantees that the FX rate at the moment of execution is the same as at the moment of quoting. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", xRapid guaratees a predefined FX rate."},"children":[]}]}]}]},"incentive_value":{"type":"number","example":0.2,"description":"Amount of XRP representing the difference in FX rate between the moment of quoting and the moment of execution. A positive value is the amount taken out of the incentive pool. A negative value is the amount returned to the incentive pool."},"transaction_hash":{"type":"string","example":5.5467794184785867e+76,"description":"Hash representing the unique identifier for the transfer of funds in the XRP ledger."},"venue_id":{"type":"string","example":"nz7RpAujYgnQtjEM","description":"The id from an exchange associated with a transaction involving an exchange account."},"fiat_adjusted_value":{"type":"number","example":0.02,"description":"Represents the delta between quoted and received executed amounts, for exchange trades."},"odl_payment_id":{"type":"string","description":"Payment ID in On-Demand Liquidity (ODL) for an executed ODL payment containing the transaction represented by this execution result."}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the actual movement of funds in a payment. Each execution result corresponds to a quote element and represents its execution in a payment. Included once the payment is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}]}},"components/schemas/PaymentLockRequest":{"id":"components/schemas/PaymentLockRequest","kind":"json-schema","title":"PaymentLockRequest","data":{"type":"object","properties":{"internal_id":{"type":"string","maxLength":128,"description":"ID that intermediaries and the receiver can set when locking a payment. The ID is viewable only by the node that set it."},"user_info":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide one or more arbitrary key/value pairs. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Caution:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Ripple recommends that you always include this object, even when empty, to ensure that the RippleNet Payment Object includes the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_at"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp, which records when the payment was locked. To add an empty object, include: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{\"user_info\":[]}"},"children":[]}]}]}]}]}],"properties":{}}},"description":"Use this JSON request object to lock a payment."}},"components/schemas/PaymentDenyRequest":{"id":"components/schemas/PaymentDenyRequest","kind":"json-schema","title":"PaymentDenyRequest","data":{"type":"object","required":["reasons"],"properties":{"reasons":{"type":"object","description":"Provide one or more arbitrary key/value pairs.","properties":{},"example":{"type":"RECEIVER_DATA_VALIDATION","code":"AC03","reason":"Creditor account number invalid or missing"}}},"description":"Use this JSON request object to fail a payment or reject a request to lock a payment."}},"components/schemas/PaymentRetryAcceptRequest":{"id":"components/schemas/PaymentRetryAcceptRequest","kind":"json-schema","title":"PaymentRetryAcceptRequest","data":{"type":"object","properties":{"user_info":{"type":"object","description":"Provide one or more arbitrary key/value pairs.","properties":{},"example":{"SF ACCEPTED":"Payment to NY","last_name":"Gonzalez","first_name":"Elle"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this JSON request object to move a payment from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOCK_DENIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, making it available for locking by intermediaries and the receiver."},"children":[]}]}]}]}},"components/schemas/PaymentSettleRequest":{"id":"components/schemas/PaymentSettleRequest","kind":"json-schema","title":"PaymentSettleRequest","data":{"type":"object","properties":{"user_info":{"type":"object","description":"Provide one or more arbitrary key/value pairs.","properties":{}}},"description":"Use this JSON request object to begin payment settlement."}},"components/schemas/PaymentFinalizeRequest":{"id":"components/schemas/PaymentFinalizeRequest","kind":"json-schema","title":"PaymentFinalizeRequest","data":{"type":"object","required":["memo","sub_state"],"properties":{"sub_state":{"type":"string","minLength":1,"maxLength":128,"example":"FORWARDED","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-form string that describes a sub-state of the payment while it is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FORWARDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_COLLECTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Displays as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array. Also displays as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the receiving node's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_info.executed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}]},"memo":{"type":"string","example":"Heading to payout location","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-form details that describe the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"with courier heading to payout location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Displays as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the receiving node's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_info.executed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}]}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this JSON request object to mark a payment with finalized sub-states that reflect what is happening to the payment while it is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}]}},"components/schemas/PaymentSubStateRequest":{"id":"components/schemas/PaymentSubStateRequest","kind":"json-schema","title":"PaymentSubStateRequest","data":{"type":"object","required":["memo","sub_state"],"properties":{"sub_state":{"type":"string","minLength":1,"maxLength":128,"example":"AMENDED","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-form string that describes a sub-state of the payment while it is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FORWARDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_COLLECTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Displays as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array. Also displays as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the receiving node's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_info.executed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}]},"memo":{"type":"string","example":"Last name must be corrected","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-form details that describe the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"with courier heading to payout location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Displays as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the receiving node's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_info.executed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}]},"info":{"type":"object","description":"Provide one or more arbitrary key/value pairs.","properties":{},"example":{"last_name":"Gonzales"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this JSON request object to mark a payment with finalized sub-states that reflect what is happening to the payment while it is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}]}},"components/schemas/PaymentCompleteRequest":{"id":"components/schemas/PaymentCompleteRequest","kind":"json-schema","title":"PaymentCompleteRequest","data":{"type":"object","properties":{"user_info":{"type":"object","description":"Provide one or more arbitrary key/value pairs.","properties":{}}},"description":"Use this JSON request object to complete a payment"}},"components/schemas/Payments":{"id":"components/schemas/Payments","kind":"json-schema","title":"Payments","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}}}}],"description":"Paged response for payments includes:"}},"components/schemas/NodeStatus":{"id":"components/schemas/NodeStatus","kind":"json-schema","title":"NodeStatus","data":{"type":"object","required":["nodeAddress","pathOrder","paymentId","paymentState"],"properties":{"paymentId":{"type":"string","format":"uuid","example":"efdf213c-9f64-43f7-80ab-15e7b4d139ae","description":"Unique identifier of the payment."},"paymentState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of the payment. This API only recognizes payments in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOCKED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state. For more on payment states, see "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment States"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet Developer Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[]}]}]}],"example":"LOCKED","enum":["QUOTED","ACCEPTED","AWAITING_COLLECTION","COMPLETED","EXECUTED","FAILED","FORWARDED","LOCK_DECLINED","LOCKED","PREPARED","RETURNED","SETTLEMENT_DECLINED"]},"nodeAddress":{"type":"string","example":"rn.eur.uk.london","description":"RippleNet address of the participating node reporting the payment state."},"pathOrder":{"type":"integer","format":"int32","example":3,"description":"Each node in the payment chain participates in sequence. Provides the order in the sequence in which this node participates."}},"description":"An array of objects that provide the following field values describing the state of a payment on each node participating in the payment."}},"components/schemas/Transfers":{"id":"components/schemas/Transfers","kind":"json-schema","title":"Transfers","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","description":"Provides an array of transfer objects.","items":{"$ref":"#/components/schemas/TransferResponse"}}}}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array of transfer objects and a set of pagination information fields."},"children":[]}]}]}]}},"components/schemas/TransferResponse":{"id":"components/schemas/TransferResponse","kind":"json-schema","title":"TransferResponse","data":{"type":"object","required":["amount","owner_address","receiver_address","sender_address","state","transfer_id","user_info"],"properties":{"transfer_id":{"type":"string","format":"uuid","example":"9eca588f-e89d-4629-82fa-da9c4646310f","description":"Unique identifier of the transfer."},"state":{"type":"string","example":"EXECUTED","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of the transfer."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only apply when RippleNet is enabled to receive payments from xRapid. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents an outbound transfer fee estimate. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the state of an outbound transfer executed by RippleNet (via xRapid) but not yet paid out by the digital exchange. If successfully paid out, the state becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If not successfully paid out by the digital exchange, the state becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]}]}]}]}],"enum":["PREPARED","EXECUTED","COMPLETED","CANCELLED","FAILED","QUOTED","PENDING","OTHER"]},"owner_address":{"type":"string","example":"rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Owner RippleNet address, if different from the RippleNet address of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receiver_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"sender_address":{"type":"string","example":"trans_usd_sf@rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiver_address":{"type":"string","example":"conct_usd_sf@rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"amount":{"type":"number","example":15,"description":"Amount transferred, expressed in the account's currency."},"internal_id":{"type":"string","example":"9cf5aa4b-1e44-436a-ab7c-d399aec905da","description":"Internal ID that the sender can optionally specify. Only visible to the sender. Only the sending RippleNet instance stores this ID."},"end_to_end_id":{"type":"string","example":"fd7559be-aa85-433f-a283-0cd58681cdf0","description":"ID that the sender can optionally specify. Persisted on all RippleNet instances that participated in the transfer."},"sending_fee":{"type":"number","description":"Optional sending fee charged by a digital asset exchange for initiating an outbound transfer."},"created_at":{"type":"string","format":"date-time","example":"2019-10-01T21:28:28.354Z","description":"The time when this transfer is created."},"user_info":{"type":"array","description":"Custom information set by a RippleNet address involved in the transfer.","items":{"$ref":"#/components/schemas/TransferUserInfo"}},"labels":{"type":"array","example":["label1","label2","label3"],"description":"List of labels associated with this transfer","items":{"type":"string"}}},"description":"JSON response object representing a transfer."}},"components/schemas/TransferUserInfo":{"id":"components/schemas/TransferUserInfo","kind":"json-schema","title":"TransferUserInfo","data":{"type":"object","description":"Custom information about a transfer provided by a RippleNet address involved in the transfer.","required":["json","node_address","state"],"properties":{"node_address":{"type":"string","example":"rn.us.ca.san_francisco","description":"RippleNet address of the xCurrent instance that set the user information."},"state":{"type":"string","example":"EXECUTED","description":"State of the transfer set when the RippleNet address set the user information.","enum":["PREPARED","EXECUTED","COMPLETED","CANCELLED","FAILED","QUOTED"]},"json":{"type":"object","description":"One or more arbitrary key/value pairs.","properties":{}},"created_at":{"type":"string","format":"date-time","example":"2019-10-01T21:28:28.357Z","description":"timestamp of when this user info was created"}}}},"components/schemas/TransferRequest":{"id":"components/schemas/TransferRequest","kind":"json-schema","title":"TransferRequest","data":{"type":"object","required":["amount","receiver_address","sender_address"],"properties":{"sender_address":{"type":"string","example":"trans_usd_sf@rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiver_address":{"type":"string","example":"conct_usd_sf@rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"amount":{"type":"number","minimum":0,"example":15,"description":"Amount transferred, expressed in the account's currency."},"owner_address":{"type":"string","example":"rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Owner RippleNet address, if different from the RippleNet address of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receiver_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"end_to_end_id":{"type":"string","maxLength":128,"example":"b09dd632-660e-48c8-907f-a4f3a7d12c18","description":"ID set by the sender that is persisted on all xCurrent instances that participated in the transfer."},"internal_id":{"type":"string","maxLength":128,"example":"9ad3c119-1379-443b-9c0e-fa82c54ae78d","description":"ID set by the sender that is persisted on the sending xCurrent instance only."},"user_info":{"type":"object","description":"Provide one or more arbitrary key/value pairs.","properties":{}}},"description":"Use this JSON request body to execute a transfer."}},"components/schemas/StatementResponse":{"id":"components/schemas/StatementResponse","kind":"json-schema","title":"StatementResponse","data":{"type":"object","required":["account_name","closing_balance","currency","end_datetime","generated_at","opening_balance","owner","start_datetime","transactions"],"properties":{"account_name":{"type":"string","example":"trans_usd_sf","description":"Name of the account the statement covers."},"start_datetime":{"type":"string","format":"date-time","example":"2018-08-06T23:13:55.997Z","description":"Lower bound of the date-time range the statement covers, as an ISO-8601 timestamp in UTC."},"end_datetime":{"type":"string","format":"date-time","example":"2020-08-06T23:13:55.997Z","description":"Upper bound of the date-time range the statement covers, as an ISO-8601 timestamp in UTC."},"generated_at":{"type":"string","format":"date-time","example":"2019-10-01T21:58:23.621Z","description":"Time at which the statement was generated, as an ISO-8601 timestamp in UTC."},"currency":{"type":"string","example":"USD","description":"Currency supported by the account."},"owner":{"type":"string","example":"rn.us.ca.san_francisco","description":"Owner of the account"},"opening_balance":{"type":"number","example":0,"description":"Opening balance of the account for the given date range."},"closing_balance":{"type":"number","example":-909,"description":"Closing balance of the account for the given date range."},"transactions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array and a set of pagination information fields."},"children":[]}]}]}],"$ref":"#/components/schemas/Transactions"}},"description":"Provides a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range."}},"components/schemas/Transactions":{"id":"components/schemas/Transactions","kind":"json-schema","title":"Transactions","data":{"type":"object","required":["content","first","last","number","numberOfElements","size","sort","totalPages","total_elements"],"properties":{"content":{"type":"array","description":"Provides an array of statement record objects.","items":{"$ref":"#/components/schemas/StatementRecord"}},"total_elements":{"type":"integer","format":"int64","example":1,"description":"total elements in paginated response"},"sort":{"type":"string","description":"retained for backward compatibility"},"first":{"type":"boolean","example":true,"description":"true if  this is the first page."},"last":{"type":"boolean","example":true,"description":"true if  this is the last page."},"number":{"type":"integer","example":0,"description":"page number"},"numberOfElements":{"type":"integer","example":1,"description":"Number Of elements in this request"},"size":{"type":"integer","example":10,"description":"page size"},"totalPages":{"type":"integer","example":1,"description":"Total number of pages for the given request"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array of statement record objects and a set of pagination information fields."},"children":[]}]}]}]}},"components/schemas/StatementRecord":{"id":"components/schemas/StatementRecord","kind":"json-schema","title":"StatementRecord","data":{"type":"object","required":["balance_change","balance_result","created_at","end_to_end_id","internal_id","returned_by_payment_with_id","returns_payment_with_id","transaction_id","transaction_state","transaction_type","sender_address","receiver_address"],"properties":{"transaction_id":{"type":"string","format":"uuid","example":"9eca588f-e89d-4629-82fa-da9c4646310f","description":"ID of the payment or transfer that caused an account balance change."},"transaction_type":{"type":"string","example":"PAYMENT","description":"Type of transaction that caused an account balance change.","enum":["PAYMENT","TRANSFER","EXCHANGE_TRANSFER"]},"transaction_state":{"type":"string","example":"COMPLETED","description":"Current state of the payment or transfer."},"balance_change":{"type":"number","example":-15,"description":"Account balance change caused by the transaction."},"balance_result":{"type":"number","example":-909,"description":"Account balance after the transaction."},"created_at":{"type":"string","format":"date-time","example":"2019-10-01T21:28:28.354Z","description":"Time at which the transaction was created, as an ISO-8601 timestamp in UTC."},"end_to_end_id":{"type":"string","example":"91ecb6bd-4dd8-4b53-a900-72b79f3064e4","description":"ID that the sender of a transaction can specify. Persisted on all xCurrent instances that participated in the transaction."},"internal_id":{"type":"string","example":"8afd8e99-4ad4-4f4e-9bb7-018ad8c3a89c","description":"Internal identifier that the sender can optionally specify. Only visible to the sender. Only the sending xCurrent instance stores this ID."},"venue_id":{"type":"string","example":"nz7RpAujYgnQtjEM","description":"The id from an exchange associated with a transaction involving an exchange account."},"transaction_hash":{"type":"string","example":"DB0AFC09E0A94FC1D11F8CBABA48A184E27094F8DD32FCBC46F316E98011E2A6","description":"Hash representing the unique identifier for the transfer of funds in the XRP ledger."},"returns_payment_with_id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the original payment that this payment returns, if this is a returned payment. Always set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"returned_by_payment_with_id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the return payment that returned this payment, if this is a returned payment. Always set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"balance_change_created_at":{"type":"string","format":"date-time","example":"2019-10-01T21:28:28.354Z","description":"Timestamp of when the balance change was created"},"sender_address":{"type":"string","example":"rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet address of the sending account. Always set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiver_address":{"type":"string","example":"rn.mx.mexico","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet address of the recieving account. Always set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"description":"Provides details about a transaction included in an account statement."}},"components/schemas/Balances":{"id":"components/schemas/Balances","kind":"json-schema","title":"Balances","data":{"type":"object","required":["errors","local_balance","remote_balances"],"properties":{"local_balance":{"description":"Provides balance details for accounts owned by a RippleNet address.","items":{"$ref":"#/components/schemas/InstitutionBalance"}},"remote_balances":{"type":"array","description":"Provides balance details for accounts owned by a RippleNet address.","items":{"$ref":"#/components/schemas/InstitutionBalance"}},"errors":{"type":"array","description":"Lists any errors encountered when returning balance details.","items":{"type":"string"}}},"description":"Provides balances for all accounts owned by a RippleNet address."}},"components/schemas/InstitutionBalance":{"id":"components/schemas/InstitutionBalance","kind":"json-schema","title":"InstitutionBalance","data":{"type":"object","required":["currency_balances","institution","institution_address"],"properties":{"institution":{"type":"string","example":"rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet unique internal ID of the institution that owns the balances provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency_balances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}]},"institution_address":{"type":"string","example":"rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet address of the institution that owns the balances provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency_balances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}]},"currency_balances":{"type":"array","description":"Provides balance details for accounts owned by a RippleNet address. The response does not guarantee a fixed number of elements, or a fixed order of elements, in the returned list.","items":{"$ref":"#/components/schemas/CurrencyBalance"}},"pool_account_balances":{"type":"array","description":"Provides balance details of pool accounts, along with RippleNet accounts linked to those pool accounts.","items":{"$ref":"#/components/schemas/PoolAccountBalance"}}},"description":"Provides balance details for accounts owned by a RippleNet address."}},"components/schemas/CurrencyBalance":{"id":"components/schemas/CurrencyBalance","kind":"json-schema","title":"CurrencyBalance","data":{"type":"object","required":["account_balances","aggregate_balance","currency"],"properties":{"currency":{"type":"string","example":"USD","description":"Currency of the balances provided."},"aggregate_balance":{"type":"number","example":0,"description":"Aggregated balance for the given currrency."},"account_balances":{"type":"array","description":"Provides balance details for accounts that support the given currency.","items":{"$ref":"#/components/schemas/AccountBalance"}}},"description":"Provides balance details for accounts owned by a RippleNet address."}},"components/schemas/AccountBalance":{"id":"components/schemas/AccountBalance","kind":"json-schema","title":"AccountBalance","data":{"type":"object","properties":{"account_name":{"type":"string","example":"trans_usd_sf","description":"Name of the account, which acts as the account's unique identifier on RippleNet."},"balance":{"type":"number","example":-909,"description":"Balance available in the account."},"owner":{"type":"string","example":"rn.us.ca.san_francisco","description":"RippleNet address of the owner of the account."},"currency":{"type":"string","example":"USD","description":"Currency supported by the account."},"minimum_allowed_balance":{"type":"number","example":-1500000,"description":"Minimum balance allowed for the account."},"maximum_allowed_balance":{"type":"number","example":1000000,"description":"Maximum balance allowed for the account."},"low_liquidity_threshold":{"type":"number","example":1000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value for a sender account meets or is less than this amount after payment settlement execution, a low-liquidity message is logged at the INFO level."},"children":[]}]}]}]},"owner_min_allowed_balance":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum balance allowed by the owner of a nostro account. RippleNet Server uses the greater of this value and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum_allowed_balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set the account balance minimum."},"children":[]}]}]}]},"owner_max_allowed_balance":{"type":"number","example":1000000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum balance allowed by the owner of a nostro account. RippleNet Server uses the lesser of this value and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maximum_allowed_balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set the account balance maximum."},"children":[]}]}]}]}},"description":"Provides balance details for each account owned by a RippleNet address."}},"components/schemas/PoolAccountBalance":{"id":"components/schemas/PoolAccountBalance","kind":"json-schema","title":"PoolAccountBalance","data":{"type":"object","properties":{"pool_account_name":{"type":"string","description":"Name of the pool account."},"balance":{"type":"number","description":"Aggregated balance of linked accounts which form this pool account."},"owner":{"type":"string","description":"The RippleNet peer who owns this pool account."},"currency":{"type":"string","description":"The currency of pool account."},"linked_accounts":{"type":"array","description":"Accounts linked to this pool account.","items":{"type":"string"}}}}},"components/schemas/Heartbeat":{"id":"components/schemas/Heartbeat","kind":"json-schema","title":"Heartbeat","data":{"type":"object","required":["errors","peer_heartbeat_results","time_checked","xcurrent_node"],"properties":{"time_checked":{"type":"string","format":"date","example":"2019-10-01","description":"Time at which the heartbeat was checked, as an ISO-8601 timestamp in UTC."},"xcurrent_node":{"type":"string","example":"rn.us.ny.new_york","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet address of the RippleNet server for which the heartbeat was checked. (Deprecated in favor of 'ripplenet_node' field, has exactly the same value)."},"children":[]}]}]}]},"ripplenet_node":{"type":"string","example":"rn.us.ny.new_york","description":"RippleNet address of the RippleNet server for which the heartbeat was checked."},"peer_heartbeat_results":{"type":"object","description":"Provides a list of peer RippleNet addresses and their health statuses.","additionalProperties":{"type":"string","enum":["HEALTHY","UNHEALTHY"]}},"errors":{"type":"array","description":"If applicable, provides one or more messages describing the error.","items":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides the health status of the xCurrent server’s peers."},"children":[]}]}]}]}},"components/schemas/Health":{"id":"components/schemas/Health","kind":"json-schema","title":"Health","data":{"type":"object","required":["healthy"],"properties":{"healthy":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the xCurrent server is up and running. If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the xCurrent server is down."},"children":[]}]}]}]},"services":{"type":"array","description":"List of services and their statuses returned by the health check.","items":{"$ref":"#/components/schemas/HealthCheck"}},"detail":{"type":"string","example":"Failed to perform health check","description":"Reason for health check failure, if any."}},"description":"Provides a high-level status of the health of the xCurrent server."}},"components/schemas/HealthCheck":{"id":"components/schemas/HealthCheck","kind":"json-schema","title":"HealthCheck","data":{"type":"object","properties":{"service":{"type":"string","example":"database","description":"Name of the service."},"healthy":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the service is up and running, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it is down or unreachable."},"children":[]}]}]}]},"detail":{"type":"string","example":"Message queue unreachable.","description":"Reason for health check failure, if any."}},"description":"Health check information for a single component."}},"components/schemas/Page":{"id":"components/schemas/Page","kind":"json-schema","title":"Page","data":{"type":"object","properties":{"first":{"type":"boolean","description":"true if  this is the first page."},"last":{"type":"boolean","description":"true if  this is the last page."},"number":{"type":"integer","description":"page number"},"numberOfElements":{"type":"integer","description":"Number Of elements in this request"},"size":{"type":"integer","description":"page size"},"totalElements":{"type":"integer","description":"Total number of elements for the given request","format":"int64"},"totalPages":{"type":"integer","description":"Total number of pages for the given request"},"sort":{"type":"array","description":"Sort details of this page","items":{"$ref":"#/components/schemas/Sort"}}},"description":"Paginated response base object."}},"components/schemas/Sort":{"id":"components/schemas/Sort","kind":"json-schema","title":"Sort","data":{"type":"object","properties":{"direction":{"type":"string","description":"Direction of the sort","example":"ASC"},"property":{"type":"string"},"ignoreCase":{"type":"boolean"},"nullHandling":{"type":"string","example":"NULLS_FIRST"},"ascending":{"type":"boolean","example":true},"descending":{"type":"boolean","example":false}}}},"components/schemas/AuditEvent":{"id":"components/schemas/AuditEvent","kind":"json-schema","title":"AuditEvent","data":{"type":"object","description":"Represents an audit trail of user actions and configuration changes (to accounts, fees, and rates) on RippleNet.","properties":{"actor":{"type":"string","example":"super_user_client","description":"Person or middleware who took the action."},"action":{"type":"string","example":"KEY_UPDATE","description":"Action that triggered the event."},"eventId":{"type":"string","format":"uuid","example":"3d5d0831-762c-4e0c-980c-635b38fd9caf","description":"UUID representing the event."},"message":{"type":"string","example":"Added public key class PublicKeyRecord {\n    publicKey: MCowBQYDK2VwAyEAb8Q2YzrbTIwrUn7u5Q6hJimp7jBFHx500MfDM4XVNJ0=\n    keyIntent: SIGNING_PUBLIC_KEY\n    keyType: ED_25519\n    keyVersion: 1\n    expiryDateTime: 2089-09-23T17:27:50.331Z\n} for RippleNet address rn.us.ny.new_york","description":"Message describing the audit event."},"metadata":{"type":"string","example":"{\"ip\":\"0:0:0:0:0:0:0:1\",\"uri\":\"/internal/key_service/addresses/rn.us.ny.new_york/keys\"}","description":"Information about the event, such as IP Address and URI."},"domain":{"type":"string","example":"CONFIG_MANAGEMENT","enum":["USER_MANAGEMENT","CONFIG_MANAGEMENT","OTHER"],"description":"Represents the audit event domain."},"level":{"type":"string","example":"INFO","enum":["INFO","WARN","ERROR"],"description":"Represents the audit event level."},"timeStamp":{"type":"string","example":"2019-09-30T22:55:41.365000Z","description":"Timestamp of the audit event."}}}},"components/schemas/AuditEventResponse":{"id":"components/schemas/AuditEventResponse","kind":"json-schema","title":"AuditEventResponse","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/AuditEvent"}}}}],"description":"Paged response for AuditEvent"}},"components/schemas/EventTrailEvent":{"id":"components/schemas/EventTrailEvent","kind":"json-schema","title":"EventTrailEvent","data":{"type":"object","description":"Represents a single event along the audit trail of a payment on RippleNet.","properties":{"featureName":{"type":"string","example":"payment","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feature name associated with the entityId. Possible values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"eventDetail":{"type":"string","example":"Updated Payment to state PREPARED","description":"Detailed description of the event."},"entityId":{"type":"string","format":"uuid","example":"d485f100-2af7-4e48-9ab1-3c7e28775691","description":"UUID representing an event."},"messageAction":{"type":"string","example":"STATE_CHANGE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representation of the action being taken, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = downstream and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = upstream in the messaging processing pipeline."},"children":[]}]}]}],"enum":["DS_STARTED","DS_COMPLETED","US_STARTED","US_COMPLETED","STATE_CHANGE","FAILURE"]},"createdAt":{"type":"string","example":"2019-10-01T18:24:28.040000Z","description":"Timestamp of the audit event."},"messageSender":{"type":"string","format":"RippleNetAddress","example":"default","description":"The RippleNetAddress of the originator of the message that triggered the creation of this event."},"messageType":{"type":"string","example":"SETTLEMENT_PREPARE","description":"The type of message that was being processed that triggered the creation of this event."}}}},"components/schemas/QueuePaymentMessage":{"id":"components/schemas/QueuePaymentMessage","kind":"json-schema","title":"QueuePaymentMessage","data":{"type":"object","description":"Represents a payment message sent to a configured queue during payment processing","required":["payment_id","payment_state"],"properties":{"payment_id":{"type":"string","format":"uuid","description":"Unique identifier of the payment."},"payment_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of the payment. For details, see "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment States"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the RippleNet documentation."},"children":[]}]}]}],"enum":["QUOTED","ACCEPTED","AWAITING_COLLECTION","COMPLETED","EXECUTED","FAILED","FORWARDED","LOCK_DECLINED","LOCKED","PREPARED","RETURNED","SETTLEMENT_DECLINED"]},"payment_substate":{"type":"string","description":"Arbitrary string attached to a payment to track its state between Executed and Completed."},"sending_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiving_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the receiver, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"payment_type":{"type":"string","example":"RETURN","description":"Payment type.","enum":["REGULAR","RETURN"]},"external_id":{"type":"string","maxLength":128,"description":"ID that the sender can specify. Persisted on all xCurrent instances that participate in the payment."},"created_at":{"type":"string","format":"date-time","example":"2018-04-06T20:33:35Z","description":"Date and time at which this payment contract was created, as an ISO-8601 timestamp in UTC."},"expires_at":{"type":"string","format":"date-time","example":"2019-04-06T20:33:35Z","description":"Date and time after which this payment contract expires, as an ISO-8601 timestamp in UTC."},"modified_date":{"type":"string","format":"date-time","example":"2018-04-06T20:33:35Z","description":"Date and time at which the payment was last modified, as an ISO-8601 timestamp in UTC."},"message_type":{"type":"string","description":"Constant string representing the type of message.","enum":["PAYMENT_STATE_CHANGE"]}}}},"components/schemas/QueueRequestForPaymentMessage":{"id":"components/schemas/QueueRequestForPaymentMessage","kind":"json-schema","title":"QueueRequestForPaymentMessage","data":{"type":"object","description":"Represents a payment message sent to a configured queue during payment processing","required":["created_at","request_for_payment_id","request_for_payment_state"],"properties":{"request_for_payment_id":{"type":"string","format":"uuid","example":"5492648d-2132-4e70-9ded-2fc86f22b321","description":"Unique identifier of a request for payment."},"request_for_payment_state":{"type":"string","description":"State of the request for payment.","enum":["REQUESTED","ACCEPTED","FAILED"]},"created_at":{"type":"string","format":"date-time","example":"2018-12-13T20:13:41.708Z","description":"Date and time at which the request for payment was created, as an ISO-8601 timestamp in UTC."},"payment_id":{"type":"string","format":"uuid","example":"5492648d-2132-4e70-9ded-2fc86f22b321","description":"Unique identifier of a payment associated to request for payment."},"message_type":{"type":"string","description":"Constant string representing the type of message.","enum":["REQUEST_FOR_PAYMENT_STATE_CHANGE"]}}}},"components/schemas/QueueTransferMessage":{"id":"components/schemas/QueueTransferMessage","kind":"json-schema","title":"QueueTransferMessage","data":{"type":"object","description":"Represents a transfer message sent to a configured queue during tranfer API calls","required":["transfer_id","transfer_state"],"properties":{"transfer_id":{"type":"string","format":"uuid","description":"Unique identifier of the payment."},"transfer_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of the transfer."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only apply when xCurrent is enabled to receive payments from xRapid. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUOTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents an outbound transfer fee estimate. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the state of an outbound transfer executed by xCurrent (via xRapid) but not yet paid out by the digital exchange. If successfully paid out, the state becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If not successfully paid out by the digital exchange, the state becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]}]}]}]}],"enum":["PREPARED","EXECUTED","COMPLETED","FAILED","QUOTED","PENDING","OTHER"]},"internal_id":{"type":"string","description":"Internal ID that the sender can optionally specify. Only visible to the sender. Only the sending xCurrent instance stores this ID."},"end_to_end_id":{"type":"string","description":"ID that the sender can optionally specify. Persisted on all xCurrent instances that participated in the transfer."},"created_at":{"type":"string","format":"date-time","example":"2018-12-13T20:13:41.708Z","description":"Date and time at which the request for transfer was created, as an ISO-8601 timestamp in UTC."},"message_type":{"type":"string","description":"Constant string representing the type of message.","enum":["TRANSFER_STATE_CHANGE"]}}}},"components/schemas/QueueExchangeTransferMessage":{"id":"components/schemas/QueueExchangeTransferMessage","kind":"json-schema","title":"QueueExchangeTransferMessage","data":{"type":"object","description":"Represents a transfer message sent to a configured queue during tranfer API calls","required":["exchange_transfer_id","exchange_transfer_state"],"properties":{"exchange_transfer_id":{"type":"string","format":"uuid","description":"Unique identifier of the payment."},"exchange_transfer_state":{"type":"string","description":"State of the exchange transfer.","enum":["EXECUTED","COMPLETED","FAILED"]},"end_to_end_id":{"type":"string","description":"ID set by the sender that is persisted on all xCurrent instances that participated in the transfer."},"internal_id":{"type":"string","description":"Internal ID that the sender can optionally specify. Only visible to the sender. Only the sending xCurrent instance stores this ID."},"created_at":{"type":"string","format":"date-time","example":"2018-12-13T20:13:41.708Z","description":"Date and time at which the request for transfer was created, as an ISO-8601 timestamp in UTC."},"message_type":{"type":"string","description":"Constant string representing the type of message.","enum":["EXCHANGE_TRANSFER_STATE_CHANGE"]}}}},"components/schemas/QueuePaymentLabelMessage":{"id":"components/schemas/QueuePaymentLabelMessage","kind":"json-schema","title":"QueuePaymentLabelMessage","data":{"type":"object","description":"Represents a payment label message sent to a configured queue when adding or removing labels","required":["payment_id","payment_state"],"properties":{"payment_id":{"type":"string","format":"uuid","description":"Unique identifier of the payment."},"added_labels":{"type":"array","items":{"type":"string"},"description":"List of labels added to the payment."},"deleted_labels":{"type":"array","items":{"type":"string"},"description":"List of labels removed from the payment."},"message_type":{"type":"string","description":"Constant string representing the type of message.","enum":["PAYMENT_MANAGEMENT"]}}}},"components/schemas/AccountLookupMessage":{"id":"components/schemas/AccountLookupMessage","kind":"json-schema","title":"AccountLookupMessage","data":{"type":"object","description":"Represents an Account Lookup message that is sent to a configured queue when an Account Lookup request is requested or responded to.","required":["account_lookup_id","account_lookup_status"],"properties":{"account_lookup_id":{"type":"string","format":"uuid","description":"Unique identifier of the account lookup."},"account_lookup_status":{"type":"string","description":"State of the Account Lookup object.","enum":["REQUESTED","PROCESSED","EXPIRED","FAILED"]}}}},"components/schemas/PayoutMethodRequest":{"id":"components/schemas/PayoutMethodRequest","kind":"json-schema","title":"PayoutMethodRequest","data":{"type":"object","description":"Represents a request to create and update a payout method record.","required":["payout_method"],"properties":{"payout_method":{"type":"string","example":"LOCAL_RAILS","description":"Unique string used in the quote to identify the payout method."},"description":{"type":"string","example":"local rails","description":"User defined description of a payout method."},"is_default":{"type":"boolean","description":"Flag to set this payout method as the default payout method."},"payout_method_category":{"type":"string","example":"BOOK_TRANSFER","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of the payout method. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not specified."},"children":[]}]}]}],"enum":["REAL_TIME_GROSS_SETTLEMENT_SYSTEM","REAL_TIME_NET_SETTLEMENT_SYSTEM","MASS_NET_PAYMENT_SYSTEM","BOOK_TRANSFER","CASH_PAYOUT","WALLET_PAYMENT","OTHER"]},"estimated_time_to_credit":{"type":"object","description":"The estimated time to credit the beneficiary using this payout method.","properties":{"time_value":{"type":"integer","format":"int64","example":5,"description":"The amount of estimated time to credit."},"time_unit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of the estimated time to credit: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECONDS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MINUTES"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOURS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAYS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["SECONDS","MINUTES","HOURS","DAYS"]}},"required":["time_value","time_unit"]}}}},"components/schemas/PayoutMethods":{"id":"components/schemas/PayoutMethods","kind":"json-schema","title":"PayoutMethods","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/PayoutMethodResponse"}}}}]}},"components/schemas/PayoutMethodResponse":{"id":"components/schemas/PayoutMethodResponse","kind":"json-schema","title":"PayoutMethodResponse","data":{"type":"object","description":"Represents a request to create and update a payout method record.","properties":{"payout_method_id":{"type":"string","format":"uuid","example":"a6dbe002-ca7f-4ec7-89e4-f44a1971a0c0","description":"Unique identifier of a payout method."},"payout_method":{"type":"string","example":"LOCAL_RAILS","description":"Unique string to identify the payout method."},"description":{"type":"string","example":"local rails","description":"User defined description of a payout method."},"is_default":{"type":"boolean","description":"Flag to set this payout method as the default payout method."},"payout_method_category":{"type":"string","example":"BOOK_TRANSFER","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of the payout method. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not specified."},"children":[]}]}]}],"enum":["REAL_TIME_GROSS_SETTLEMENT_SYSTEM","REAL_TIME_NET_SETTLEMENT_SYSTEM","MASS_NET_PAYMENT_SYSTEM","BOOK_TRANSFER","CASH_PAYOUT","WALLET_PAYMENT","OTHER"]},"estimated_time_to_credit":{"type":"object","description":"The estimated time to credit the beneficiary using this payout method.","properties":{"time_value":{"type":"integer","format":"int64","example":5,"description":"The amount of estimated time to credit."},"time_unit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unit of the estimated time to credit: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SECONDS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MINUTES"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HOURS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAYS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["SECONDS","MINUTES","HOURS","DAYS"]}},"required":["time_value","time_unit"]}}}},"components/schemas/RippleNetProblem":{"id":"components/schemas/RippleNetProblem","kind":"json-schema","title":"RippleNetProblem","data":{"type":"object","description":"Represents a request to create and update a payout method record.","properties":{"type":{"type":"string","example":"https://errors.ripplenet.ripple.com/error/json-processing-error","description":"URL to the error documentation."},"title":{"type":"string","example":"Invalid Request Object","description":"Summary of the returned problem."},"detail":{"type":"string","example":"The request parameter [account_id] is not in the correct format.","description":"Description of the returned problem."},"status":{"type":"number","example":400,"description":"HTTP error code."},"ripplenet_error_code":{"type":"string","example":"E0104","description":"RippleNet specific error code."},"finality":{"type":"string","example":"PERMANENT","description":"Specifies if the request can be retried for a successful response."}}}},"components/schemas/InitiateAccountLookupRequest":{"id":"components/schemas/InitiateAccountLookupRequest","kind":"json-schema","title":"InitiateAccountLookupRequest","data":{"type":"object","description":"Initiate account lookup request to validate a beneficiary's account details before sending a payment.","required":["destination_address","country_code","account_id","account_id_type"],"properties":{"account_currency":{"type":"string","description":"The 3 character currency code for the account as per ISO-4217 standards"},"clearing_system_code":{"type":"string","maxLength":50,"description":"Clearing system code"},"destination_address":{"type":"string","description":"RippleNet address of the receiver."},"first_name":{"type":"string","maxLength":40,"description":"First name of the beneficiary."},"middle_name":{"type":"string","maxLength":40,"description":"Middle name of the beneficiary."},"last_name":{"type":"string","maxLength":40,"description":"Last name of the beneficiary."},"org_name":{"type":"string","maxLength":140,"description":"Name of the organization."},"country_code":{"type":"string","maxLength":2,"description":"Country of the beneficiary. Alpha-2 Code format per ISO 3166-1."},"account_id":{"type":"string","maxLength":40,"description":"Identifier for the Account, e.g account number."},"account_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account ID type. Possible values are"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AIIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (default) Account Issue Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BBAN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Basic Bank Account Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - PAN of the card identifying the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - CHIPS Universal Identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Universal Payment Identification Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EMail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email Address"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MSISDN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DMST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Domestic"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Other identifier (e.g., PayID)"},"children":[]}]}]}]}],"enum":["AIIN","BBAN","CARD","CUID","UPIC","EMAIL","MSISDN","DMST","OTHER"]}}}},"components/schemas/CompleteAccountLookupRequest":{"id":"components/schemas/CompleteAccountLookupRequest","kind":"json-schema","title":"CompleteAccountLookupRequest","data":{"type":"object","description":"Complete account lookup request to validate the Beneficiary before initiating the payment.","required":["account_lookup_id","result_code","result_status","result_description"],"properties":{"account_lookup_id":{"type":"string","description":"UUID that links Account Lookup request and response.","format":"uuid"},"result_code":{"type":"string","pattern":"^RNCB\\d{4}","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result code of the Account Lookup response. Possible values are"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RNCB0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Pass- Name and Identifier are correct and linked"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RNCB0001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fail- Name and Identifier not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RNCB0002"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fail- Name and Identifier do not match"},"children":[]}]}]}]}]},"result_status":{"type":"string","description":"Result status of Account Lookup response","enum":["PASS","FAIL"]},"result_description":{"type":"string","description":"Result description of Account Lookup response"},"redacted_first_name":{"type":"string","maxLength":40,"description":"First name of the beneficiary."},"redacted_middle_name":{"type":"string","maxLength":40,"description":"Middle name of the beneficiary."},"redacted_last_name":{"type":"string","maxLength":40,"description":"Last name of the beneficiary."},"redacted_org_name":{"type":"string","maxLength":140,"description":"Name of the organization."},"redacted_country_code":{"type":"string","description":"Country of the beneficiary. Alpha-2 Code format per ISO 3166-1."},"redacted_account_id":{"type":"string","maxLength":40,"description":"Identifier for the Account, e.g account number."},"redacted_account_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account ID type, redacted by the receiver. Possible values are"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AIIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (default) Account Issue Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BBAN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Basic Bank Account Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - PAN of the card identifying the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - CHIPS Universal Identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Universal Payment Identification Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EMail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email Address"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MSISDN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DMST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Domestic"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Other identifier (e.g., PayID)"},"children":[]}]}]}]}],"enum":["AIIN","BBAN","CARD","CUID","UPIC","EMAIL","MSISDN","DMST","OTHER"]},"redacted_clearing_system_code":{"type":"string","description":"Clearing system code"},"redacted_branch_code":{"type":"string","description":"The Branch code (e.g., routing code) that the receiver has on their system."},"redacted_account_currency":{"type":"string","description":"The 3 character currency code for the account as per ISO-4217 standards"}}}},"components/schemas/AccountLookup":{"id":"components/schemas/AccountLookup","kind":"json-schema","title":"AccountLookup","data":{"type":"object","description":"Response to the sender/receiver for Account Lookup.","required":["account_lookup_id","account_lookup_status"],"properties":{"account_lookup_id":{"type":"string","description":"UUID that links Account lookup request and response.","format":"uuid"},"account_lookup_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of the Account Lookup object. Should be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUESTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROCESSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["REQUESTED","PROCESSED","FAILED","EXPIRED"]},"first_name":{"type":"string","maxLength":40,"description":"First name of the beneficiary."},"middle_name":{"type":"string","maxLength":40,"description":"Middle name of the beneficiary."},"last_name":{"type":"string","maxLength":40,"description":"Last name of the beneficiary."},"org_name":{"type":"string","maxLength":140,"description":"Name of the organization."},"country_code":{"type":"string","description":"Country of the beneficiary. Alpha-2 Code format per ISO 3166-1."},"account_currency":{"type":"string","description":"The 3 character currency code for the account as per ISO-4217 standards"},"account_id":{"type":"string","maxLength":40,"description":"Identifier for the Account, e.g account number."},"account_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account ID type. Possible values are"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AIIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (default) Account Issue Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BBAN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Basic Bank Account Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - PAN of the card identifying the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - CHIPS Universal Identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Universal Payment Identification Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EMail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email Address"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MSISDN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DMST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Domestic"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Other identifier (e.g., PayID)"},"children":[]}]}]}]}],"enum":["AIIN","BBAN","CARD","CUID","UPIC","EMAIL","MSISDN","DMST","OTHER"]},"result_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result code of the Account Lookup response. Possible values are"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RNCB0000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Pass- Name and Identifier are correct and linked"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RNCB0001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fail- Name and Identifier not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RNCB0002"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Fail- Name and Identifier do not match"},"children":[]}]}]}]}]},"result_status":{"type":"string","description":"Result status of Account Lookup response.","enum":["PASS","FAIL"]},"result_description":{"type":"string","description":"Result description of Account Lookup response."},"redacted_first_name":{"type":"string","maxLength":40,"description":"First name of the beneficiary redacted by the receiver."},"redacted_middle_name":{"type":"string","maxLength":40,"description":"Middle name of the beneficiary redacted by the receiver."},"redacted_last_name":{"type":"string","maxLength":40,"description":"Last name of the beneficiary redacted by the receiver."},"redacted_org_name":{"type":"string","maxLength":140,"description":"Name of the organization redacted by the receiver."},"redacted_country_code":{"type":"string","description":"Country of the beneficiary redacted by the receiver."},"redacted_account_id":{"type":"string","maxLength":40,"description":"Identifier for the Account, e.g account number, redacted by the receiver."},"redacted_account_id_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account ID type, redacted by the receiver. Possible values are"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AIIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (default) Account Issue Identification Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BBAN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Basic Bank Account Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - PAN of the card identifying the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - CHIPS Universal Identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Universal Payment Identification Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EMail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email Address"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MSISDN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DMST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Domestic"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Other"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Other identifier (e.g., PayID)"},"children":[]}]}]}]}],"enum":["AIIN","BBAN","CARD","CUID","UPIC","EMAIL","MSISDN","DMST","OTHER"]},"redacted_account_currency":{"type":"string","description":"The 3 character currency code for the account as per ISO-4217 standards"},"clearing_system_code":{"type":"string","description":"Clearing system code"},"branch_code":{"type":"string","description":"The Branch code (e.g., routing code) that the receiver has on their system."}}}},"components/schemas/AccountLookups":{"id":"components/schemas/AccountLookups","kind":"json-schema","title":"AccountLookups","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/AccountLookup"}}}}],"description":"Paged response for account lookups"}},"components/schemas/CreatePlatformRequest":{"id":"components/schemas/CreatePlatformRequest","kind":"json-schema","title":"CreatePlatformRequest","data":{"type":"object","description":"Request object for creating a RippleNet platform, which maps to a real world financial institution.","required":["name","platform_type","institution","servicer_code"],"properties":{"name":{"type":"string","description":"Name of the platform."},"platform_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of institution this platform represents (WALLET_PROVIDER, FIAT_INSTITUTION, or DIGITAL_EXCHANGE)."},"children":[]}]}]}],"enum":["WALLET_PROVIDER","FIAT_INSTITUTION","DIGITAL_EXCHANGE"]},"description":{"type":"string","maxLength":512,"description":"A short description of the platform."},"institution":{"type":"string","description":"Name of the institution this platform represents."},"servicer_code":{"type":"string","description":"Akin to the routing number (US), Sort Code (UK), or IFSC code (India)."}}}},"components/schemas/UpdatePlatformRequest":{"id":"components/schemas/UpdatePlatformRequest","kind":"json-schema","title":"UpdatePlatformRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request object for updating a RippleNet platform, which maps to a real world financial institution. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"platform_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set on the creation of the platform and cannot be updated."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":"Name of the platform."},"platform_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of institution this platform represents (WALLET_PROVIDER, FIAT_INSTITUTION, or DIGITAL_EXCHANGE)."},"children":[]}]}]}],"enum":["WALLET_PROVIDER","FIAT_INSTITUTION","DIGITAL_EXCHANGE"]},"description":{"type":"string","maxLength":512,"description":"A short description of the platform."},"institution":{"type":"string","description":"Name of the institution this platform represents."},"servicer_code":{"type":"string","description":"Akin to the routing number (US), Sort Code (UK), or IFSC code (India)."}}}},"components/schemas/PlatformResponse":{"id":"components/schemas/PlatformResponse","kind":"json-schema","title":"PlatformResponse","data":{"type":"object","description":"Response object for creating a Ripplenet platform, which maps to a real world financial institution.","properties":{"platform_id":{"type":"string","format":"uuid","description":"Unique identifier for the RippleNet platform."},"name":{"type":"string","description":"Name of the RippleNet platform."},"platform_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of institution this RippleNet platform represents (WALLET_PROVIDER, FIAT_INSTITUTION, or DIGITAL_EXCHANGE)."},"children":[]}]}]}],"enum":["WALLET_PROVIDER","FIAT_INSTITUTION","DIGITAL_EXCHANGE"]},"description":{"type":"string","maxLength":512,"description":"A short description of the RippleNet platform."},"institution":{"type":"string","description":"Name of the institution this RippleNet platform represents."},"servicer_code":{"type":"string","description":"Akin to the routing number (US), Sort Code (UK), or IFSC code (India)."}}}},"components/schemas/CreatePlatformAccountRequest":{"id":"components/schemas/CreatePlatformAccountRequest","kind":"json-schema","title":"CreatePlatformAccountRequest","data":{"type":"object","description":"Request object for creating a Ripplenet platform account.","required":["name","platform_id","external_account_id","currency"],"properties":{"name":{"type":"string","description":"Name of the platform account."},"platform_id":{"type":"string","format":"uuid","description":"The unique identifier for the RippleNet platform where this account is defined."},"description":{"type":"string","maxLength":512,"description":"A short description of the platform account."},"external_account_id":{"type":"string","description":"Unique reference identifier for the real world account which is represented by this platform account."},"currency":{"type":"string","maxLength":3,"description":"The currency of the account. Ripple recommends using ISO-4217 currency codes."}}}},"components/schemas/UpdatePlatformAccountRequest":{"id":"components/schemas/UpdatePlatformAccountRequest","kind":"json-schema","title":"UpdatePlatformAccountRequest","data":{"type":"object","description":"Request object for updating a Ripplenet platform account.","properties":{"name":{"type":"string","description":"Name of the platform account."},"platform_id":{"type":"string","format":"uuid","description":"The unique identifier for the RippleNet platform where this account is defined."},"description":{"type":"string","maxLength":512,"description":"A short description of the platform account."},"external_account_id":{"type":"string","description":"Unique reference identifier for the real world account which is represented by this platform account."},"currency":{"type":"string","maxLength":3,"description":"The currency of the account. Ripple recommends using ISO-4217 currency codes."}}}},"components/schemas/PlatformAccountResponse":{"id":"components/schemas/PlatformAccountResponse","kind":"json-schema","title":"PlatformAccountResponse","data":{"type":"object","description":"Response object for creating a Ripplenet platform account.","properties":{"platform_account_id":{"type":"string","format":"uuid","description":"Unique identifier for the platform account."},"name":{"type":"string","description":"Name of the platform account."},"platform_id":{"type":"string","format":"uuid","description":"The unique identifier for the RippleNet platform where this account is defined."},"description":{"type":"string","maxLength":512,"description":"A short description of the platform account."},"external_account_id":{"type":"string","description":"Unique reference identifier for the real world account which is represented by this platform account."},"currency":{"type":"string","description":"The currency of the account. Ripple recommends using ISO-4217 currency codes."},"balance":{"type":"number","description":"Real world account balance of the platform account (if available)"}}}},"components/schemas/PlatformAccountsPage":{"id":"components/schemas/PlatformAccountsPage","kind":"json-schema","title":"PlatformAccountsPage","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/PlatformAccountResponse"}}}}],"description":"Paged response for account lookups"}},"components/schemas/CreatePoolAccountRequest":{"id":"components/schemas/CreatePoolAccountRequest","kind":"json-schema","title":"CreatePoolAccountRequest","data":{"type":"object","description":"Request object for creating a pool account.","required":["pool_account_name","currency","owner"],"properties":{"pool_account_name":{"type":"string","description":"The name of the pool account."},"currency":{"type":"string","example":"USD","description":"The currency of the pool account."},"owner":{"type":"string","example":"rn.us.ca.san_francisco","description":"The RippleNet address of the owner of the pool account."},"description":{"type":"string","maxLength":512,"description":"The description of the pool account."}}}},"components/schemas/UpdatePoolAccountRequest":{"id":"components/schemas/UpdatePoolAccountRequest","kind":"json-schema","title":"UpdatePoolAccountRequest","data":{"type":"object","description":"Request object for updating a pool account.","properties":{"description":{"type":"string","maxLength":512,"description":"The description of the pool account."}}}},"components/schemas/LinkAccountsToPoolAccountRequest":{"id":"components/schemas/LinkAccountsToPoolAccountRequest","kind":"json-schema","title":"LinkAccountsToPoolAccountRequest","data":{"type":"object","description":"Request object for linking accounts to a pool account.","required":["account_names_to_link"],"properties":{"account_names_to_link":{"type":"array","items":{"type":"string"},"description":"Provide the RippleNet accounts to be linked to this pool account."}}}},"components/schemas/UnlinkAccountsFromPoolAccountRequest":{"id":"components/schemas/UnlinkAccountsFromPoolAccountRequest","kind":"json-schema","title":"UnlinkAccountsFromPoolAccountRequest","data":{"type":"object","description":"Request object for unlinking accounts from a pool account.","required":["account_names_to_unlink"],"properties":{"account_names_to_unlink":{"type":"array","items":{"type":"string"},"description":"Provide the RippleNet accounts to be unlinked from this pool account."}}}},"components/schemas/PoolAccountResponse":{"id":"components/schemas/PoolAccountResponse","kind":"json-schema","title":"PoolAccountResponse","data":{"type":"object","description":"Pool Account object returned to the user.","properties":{"pool_account_id":{"type":"string","format":"uuid","description":"The Account ID of the pool account."},"pool_account_name":{"type":"string","description":"The name of the pool account."},"currency":{"type":"string","description":"Currency of the pool account."},"description":{"type":"string","description":"Description of the pool account."},"owner":{"type":"string","example":"rn.us.ca.san_francisco","description":"RippleNet address of the owner of the pool account."},"linkedAccountNames":{"type":"array","items":{"type":"string"},"description":"RippleNet accounts linked to the pool account."}}}},"components/schemas/CreateLiquidationConfigRequest":{"id":"components/schemas/CreateLiquidationConfigRequest","kind":"json-schema","title":"CreateLiquidationConfigRequest","data":{"type":"object","description":"Request object for creating a Liquidation Configuration.","required":["source_address","destination_address","liquidation_mode","price_guarantee","liquidation_type"],"properties":{"name":{"type":"string","description":"Display name for this Liquidaton Configuration."},"source_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full RippleNet address of the source account in the form acccountname@host."},"children":[]}]}]}]},"destination_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full RippleNet address of the destination account in the form acccountname@host."},"children":[]}]}]}]},"liquidation_mode":{"type":"string","description":"Mode in which this Liquidation Configuration operates.","enum":["PER_PAYMENT","SMART_LIQUIDATION_PER_PAYMENT"]},"price_guarantee":{"type":"string","description":"Price guarantee for the Liquidation quote.","enum":["FIRM","INDICATIVE"]},"liquidation_type":{"type":"string","description":"Indicates the amount the liquidation is based on.","enum":["SENDER","RECEIVER","XRP"]}}}},"components/schemas/UpdateLiquidationConfigRequest":{"id":"components/schemas/UpdateLiquidationConfigRequest","kind":"json-schema","title":"UpdateLiquidationConfigRequest","data":{"type":"object","description":"Request object for updating a Liquidation Configuration.","properties":{"name":{"type":"string","description":"Display name for this Liquidaton Configuration."},"source_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full RippleNet address of the source account in the form accountname@host."},"children":[]}]}]}]},"destination_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full RippleNet address of the destination account in the form accountname@host."},"children":[]}]}]}]},"liquidation_mode":{"type":"string","description":"Mode in which this Liquidation Configuration operates.","enum":["PER_PAYMENT","SMART_LIQUIDATION_PER_PAYMENT"]},"price_guarantee":{"type":"string","description":"Price guarantee for the Liquidation quote.","enum":["FIRM","INDICATIVE"]},"liquidation_type":{"type":"string","description":"Indicates the amount the liquidation is based on.","enum":["SENDER","RECEIVER","XRP"]}}}},"components/schemas/LiquidationConfigResponse":{"id":"components/schemas/LiquidationConfigResponse","kind":"json-schema","title":"LiquidationConfigResponse","data":{"type":"object","description":"Response object for Liquidation Configuration","properties":{"liquidation_config_id":{"type":"string","format":"uuid","description":"The unique identifier for this Liquidation Configuration."},"name":{"type":"string","description":"Display name for this Liquidaton Configuration."},"source_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full RippleNet address of the source account in the form accountname@host."},"children":[]}]}]}]},"destination_address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full RippleNet address of the destination account in the form accountname@host."},"children":[]}]}]}]},"liquidation_mode":{"type":"string","description":"Mode in which this Liquidation Configuration operates.","enum":["PER_PAYMENT","SMART_LIQUIDATION_PER_PAYMENT"]},"price_guarantee":{"type":"string","description":"Price guarantee for the Liquidation quote.","enum":["FIRM","INDICATIVE"]},"liquidation_type":{"type":"string","description":"Indicates the amount the liquidation is based on","enum":["SENDER","RECEIVER","XRP"]}}}},"components/schemas/LiquidationConfigsPage":{"id":"components/schemas/LiquidationConfigsPage","kind":"json-schema","title":"LiquidationConfigsPage","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/LiquidationConfigResponse"}}}}],"description":"Paged response for Liquidation Configurations"}},"components/schemas/PlatformAccountsBalances":{"id":"components/schemas/PlatformAccountsBalances","kind":"json-schema","title":"PlatformAccountsBalances","data":{"type":"object","description":"Object representing list of platforms, their accounts and their respective balances","properties":{"platforms":{"type":"array","description":"List of platforms","items":{"$ref":"#/components/schemas/PlatformItem"}}}}},"components/schemas/PlatformItem":{"id":"components/schemas/PlatformItem","kind":"json-schema","title":"PlatformItem","data":{"type":"object","description":"Represents a Platform","properties":{"platform_id":{"description":"Platform ID","type":"string","format":"uuid"},"name":{"description":"Identifier representing the name of the platform","type":"string"},"institution":{"description":"Institution being represented by this platform","type":"string"},"type":{"description":"Type of the platform","type":"string"},"servicer_code":{"description":"Account servicer code, if applicable of the real world platform","type":"string"},"accounts":{"type":"array","description":"List of Platform Accounts a Platform","items":{"$ref":"#/components/schemas/PlatformAccountItem"}}}}},"components/schemas/PlatformAccountItem":{"id":"components/schemas/PlatformAccountItem","kind":"json-schema","title":"PlatformAccountItem","data":{"type":"object","description":"Represents a Platform Account","properties":{"platform_account_id":{"description":"Platform Account ID (UUID)","type":"string","format":"uuid"},"name":{"description":"Name of the Platform Account","type":"string"},"external_account_id":{"description":"External ID of the real world account that is represented by this Platform Account","type":"string"},"currency":{"description":"Platform account currency","type":"string"},"total_balance":{"description":"Total balance amount","type":"number"},"available_balance":{"description":"Available balance amount","type":"number"},"errors":{"description":"List of error messages, if any","type":"array","items":{"type":"string"}}}}},"components/schemas/LiquidationDetails":{"id":"components/schemas/LiquidationDetails","kind":"json-schema","title":"LiquidationDetails","data":{"type":"object","description":"Payment liquidation details","properties":{"id":{"type":"string","format":"uuid","description":"Liquidation ID, unique to the liquidation process of this payment"},"status":{"type":"string","description":"Liquidation status"},"failure_reason":{"type":"string","description":"Reason behind failure of the liquidation, only applicable if the status is failure"},"failure_count":{"type":"integer","description":"Number of times the liquidation failed. Irrelevant if status is successful."}}}},"components/schemas/CreateSSAConfigRequest":{"id":"components/schemas/CreateSSAConfigRequest","kind":"json-schema","title":"CreateSSAConfigRequest","data":{"type":"object","description":"Use this JSON request object to create a SSA Configuration.","required":["ssa_account","source_account","ssa_currency"],"properties":{"ssa_account":{"type":"string","description":"RippleNet address of the SSA account"},"source_account":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet address of the host used to fund the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssa_account"},"children":[]}]}]}]},"ssa_currency":{"type":"string","description":"Currency code of the SSA account"},"payment_sender_host":{"type":"string","description":"RippleNet host address of the payment sender for which this SSA config should apply. This field is marked optional but is mandatory if you have multiple senders requiring ssa config for same currency"}}}},"components/schemas/SSAConfigResponse":{"id":"components/schemas/SSAConfigResponse","kind":"json-schema","title":"SSAConfigResponse","data":{"type":"object","description":"Response object for creating a Sender Segregated Account (SSA) Configuration.","properties":{"ssa_account":{"type":"string","description":"RippleNet address of the SSA account"},"source_account":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet address of the host used to fund the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssa_account"},"children":[]}]}]}]},"ssa_currency":{"type":"string","description":"Currency code of the SSA account"},"ssa_config_id":{"type":"string","format":"uuid","description":"Unique identifier for the SSA configuration record"},"payment_sender_host":{"type":"string","description":"RippleNet host address of the payment sender for which this SSA config should apply"}}}},"components/schemas/UpdateSSAConfigRequest":{"id":"components/schemas/UpdateSSAConfigRequest","kind":"json-schema","title":"UpdateSSAConfigRequest","data":{"type":"object","description":"Use this JSON request object to update the SSA Configuration.","properties":{"ssa_account":{"type":"string","description":"RippleNet address of SSA account"},"source_account":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet address of the host used to fund the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssa_account"},"children":[]}]}]}]},"ssa_currency":{"type":"string","description":"Currency code of the SSA account"},"payment_sender_host":{"type":"string","description":"RippleNet host address of the payment sender for which this SSA config should apply"}}}},"components/schemas/Fees":{"id":"components/schemas/Fees","kind":"json-schema","title":"Fees","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","description":"Provides an array of fee objects.","items":{"$ref":"#/components/schemas/FiatFee"}}}}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array of fee objects and a set of pagination information fields."},"children":[]}]}]}]}},"components/schemas/FiatFee":{"id":"components/schemas/FiatFee","kind":"json-schema","title":"FiatFee","data":{"type":"object","required":["currency_code","feeId","fee_type","node_type","payment_type","role_type","value"],"properties":{"value":{"type":"number","example":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the fee to be applied. fiat node uses this value and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fee_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to calculate the fee."},"children":[]}]}]}]},"currency_code":{"type":"string","example":"USD","description":"Currency this fee applies to."},"role_type":{"type":"string","example":"SENDING","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role of the party to which the fee applies."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the fee is charged to the originator of the payment."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the fee is charged to the beneficiary of the payment."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INSTITUTION_SENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the fee is charged to the financial institution that is sending the payment."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INSTITUTION_RECEIVING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the fee is charged to the financial institution that is receiving the payment."},"children":[]}]}]}]}],"enum":["SENDING","RECEIVING","INSTITUTION_SENDING","INSTITUTION_RECEIVING"]},"payment_type":{"type":"string","example":"REGULAR","description":"Payment type the fee applies to.","enum":["REGULAR","RETURN"]},"node_type":{"type":"string","example":"INITIAL","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fiat node to which the fee applies."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INITIAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the fee is charged to the first fiat instance in the payment chain."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INTERMEDIATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the fee is charged to each fiat instance in the payment chain that is not the first or last fiat instance."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TERMINAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the fee is charged to the last fiat instance in the payment chain."},"children":[]}]}]}]}],"enum":["INITIAL","INTERMEDIATE","TERMINAL"]},"fee_type":{"type":"string","example":"FLAT_RATE","description":"Method used to calculate the fee.","enum":["PERCENTAGE","FLAT_RATE"]},"partner_name":{"type":"string","example":"rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Owner of the account involved in the payment, in RippleNet Address format. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rn.us.ca.san_francisco"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"account_name":{"type":"string","example":"conct_usd_sf","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a fee that applies to a specific account, provides the account name. Used in combination with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"upper_limit":{"type":"number","example":1000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a slab-based fee, provides the upper limit of the slab. Used in combination with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lower_limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"lower_limit":{"type":"number","example":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a slab-based fee, provides the lower limit of the slab. Used in combination wtih the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upper_limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"feeId":{"type":"string","format":"uuid","example":"7740f31c-ca03-4414-b491-b285aef71eb1","description":"Unique identifier of the fee."},"payout_method":{"type":"string","example":"LOCAL_RAILS","description":"The payout method for this fee."},"fee_category":{"type":"string","example":"BENEFICIARY_BANK_CHARGE","description":"Category that describes the purpose of the fee.","default":"NONE","enum":["NONE","OVERSEAS_DELIVERY_CHARGES","BENEFICIARY_BANK_CHARGE","PROCESSING_HANDLING_CHARGE","LOCAL_GOVERNMENT_CHARGE","OTHER"]},"fee_description":{"type":"string","description":"Optional free-form description for the fee."}},"description":"Represents a fee to be applied based on various criteria."}},"components/schemas/FiatFeeRequest":{"id":"components/schemas/FiatFeeRequest","kind":"json-schema","title":"FiatFeeRequest","data":{"type":"object","required":["currency_code","fee_type","node_type","payment_type","role_type","value"],"properties":{"value":{"type":"number","example":0.025,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value of the fee to apply."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the value of this parameter according to the fee type you are using:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/createFee!path=fee_type&t=request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fee_type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Corresponding value to use"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERCENTAGE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be >"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and <"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FLAT_RATE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be negative."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The final amount of the fee is applied either as a percentage or a flat rate depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you specify for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fee_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]},"currency_code":{"type":"string","example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency the fee is applied in. Ripple recommends using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.iso.org/iso-4217-currency-codes.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-4217"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" currency codes, although no formal constraint is enforced."},"children":[]}]}]}]},"role_type":{"type":"string","example":"SENDING","description":"Role of the party to which the fee applies.","enum":["SENDING","RECEIVING","INSTITUTION_SENDING","INSTITUTION_RECEIVING"],"x-enumDescriptions":{"SENDING":"Charge the originator of the payment.","RECEIVING":"Charge the beneficiary of the payment.","INSTITUTION_SENDING":"Charge the financial institution sending the payment.","INSTITUTION_RECEIVING":"Charge the financial institution receiving the payment."}},"payment_type":{"type":"string","example":"REGULAR","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of payment to which the fee applies."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[]}]}]}],"enum":["REGULAR","RETURN"],"x-enumDescriptions":{"REGULAR":"Apply the fee to a regular payment.","RETURN":"Apply the fee to a return payment."}},"node_type":{"type":"string","example":"INITIAL","description":"Fiat instance to which the fee applies.","enum":["INITIAL","INTERMEDIATE","TERMINAL"],"x-enumDescriptions":{"INITIAL":"Apply the fee to the first fiat instance in the payment chain.","INTERMEDIATE":"Apply the fee to each fiat instance in the payment chain that is not the first or last.","TERMINAL":"Apply the fee to the last fiat instance in the payment chain."}},"fee_type":{"type":"string","example":"FLAT_RATE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of fee to apply. This is used with fee "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/createFee!path=value&t=request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to calculate the fee."},"children":[]}]}]}],"enum":["PERCENTAGE","FLAT_RATE"],"x-enumDescriptions":{"PERCENTAGE":"Apply the fee `value` as a percentage.","FLAT_RATE":"Apply the fee `value` as a flat rate."}},"partner_name":{"type":"string","example":"rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Owner of the account involved in the payment, in RippleNet Address format. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rn.us.ca.san_francisco"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"account_name":{"type":"string","example":"conct_usd_sf","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account to apply the fee to. Specify the account name. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conct_usd_sf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If specified, you must also specify a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"upper_limit":{"type":"number","example":1000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum amount for the range of a slab-based fee. If specified, you must also specify a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lower_limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"lower_limit":{"type":"number","example":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum amount for the range of a slab-based fee. If specified, you must also specify an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upper_limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"payout_method":{"type":"string","example":"LOCAL_RAILS","description":"The payout method by which the receiving institution delivers the funds to the end customer."},"fee_category":{"type":"string","example":"BENEFICIARY_BANK_CHARGE","description":"Category that describes the purpose of the fee.","default":"NONE","enum":["NONE","OVERSEAS_DELIVERY_CHARGES","BENEFICIARY_BANK_CHARGE","PROCESSING_HANDLING_CHARGE","LOCAL_GOVERNMENT_CHARGE","OTHER"],"x-enumDescriptions":{"NONE":"None","OVERSEAS_DELIVERY_CHARGES":"Overseas delivery charges.","BENEFICIARY_BANK_CHARGE":"Charge from beneficiary bank.","PROCESSING_HANDLING_CHARGE":"Processing and handling charge.","LOCAL_GOVERNMENT_CHARGE":"Local government charge.","OTHER":"Other charges."}},"fee_description":{"type":"string","description":"Optional free-form description for the fee."}},"description":"Use this JSON request object to create a fee that can be applied to payments."}},"components/schemas/Rates":{"id":"components/schemas/Rates","kind":"json-schema","title":"Rates","data":{"type":"object","required":["content"],"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"description":"Provides an array of rate objects.","type":"array","items":{"$ref":"#/components/schemas/RateResponse"}}}}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array of rate objects and a set of pagination information fields."},"children":[]}]}]}]}},"components/schemas/RateResponse":{"id":"components/schemas/RateResponse","kind":"json-schema","title":"RateResponse","data":{"type":"object","required":["base_currency","counter_currency","created_date","destination_currency","destination_ledger","destination_ledger_account","expiration_offset","lower_limit","order_type","rate","rate_id","rate_scale","source_currency","source_ledger","source_ledger_account","upper_limit","value_type","margin_type"],"properties":{"rate_id":{"type":"string","format":"uuid","example":"328b3e50-7983-46d5-94a0-ef004d78db1d","description":"Unique identifier of the exchange rate."},"expiration_offset":{"type":"integer","example":95000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(DEPRECATED)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This property is deprecated. Refer to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine rate expiration. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of time in milliseconds that the rate is valid for after the rate's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. For example, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiration_offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" milliseconds, the rate expires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" milliseconds after this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the rate does not expire."},"children":[]}]}]}]}]},"order_type":{"type":"string","example":"buy","description":"Order type for the exchange rate.","enum":["buy","sell"]},"rate_scale":{"type":"integer","example":9,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of decimal places to which the exchange rate is calculated. For example, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_scale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.25"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the scaled value of the rate is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.250000000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":9},"rate":{"type":"number","example":0.89,"description":"Exchange rate for the specified base and counter currency."},"base_currency":{"type":"string","example":"USD","description":"Base currency of the exchange rate."},"counter_currency":{"type":"string","example":"GBP","description":"Counter currency of the exchange rate."},"source_currency":{"type":"string","example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is set to the base currency. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sell"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is set to the counter currency."},"children":[]}]}]}]},"destination_currency":{"type":"string","example":"GBP","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is set to the counter currency. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sell"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is set to the base currency."},"children":[]}]}]}]},"source_ledger":{"type":"string","example":"rn.eur.uk.london","description":"Source ledger associated with the exchange rate."},"destination_ledger":{"type":"string","example":"rn.eur.uk.london","description":"Destination ledger associated with the exchange rate."},"source_ledger_account":{"type":"string","example":"alias_usd_lon","description":"Account on the source ledger associated with rate."},"destination_ledger_account":{"type":"string","example":"conct_gbp_lon","description":"Account on the destination ledger associated with rate."},"created_date":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time at which the exchange rate was created, as an ISO-8601 timestamp in UTC. Fiat determines a rate's expiration date and time based on this value and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiration_offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. For example, if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiration_offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" milliseconds, the rate expires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" milliseconds after this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"expires_at":{"type":"string","format":"date-time","description":"The time in which this rate expires in system local timezone"},"lower_limit":{"type":"number","example":0,"description":"For a slab-based exchange rate, indicates the lower limit of the slab."},"upper_limit":{"type":"number","example":1000,"description":"For a slab-based exchange rate, indicates the upper limit of the slab."},"payout_method":{"type":"string","example":"LOCAL_RAILS","description":"The payout method for the rate."},"value_type":{"type":"string","example":"MARGIN","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the rate is a live exchange rate ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MARGIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or an exchange rate manually configured by Ripple ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). If this value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MARGIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"margin_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will show a value."},"children":[]}]}]}],"enum":["MARGIN","RATE"]},"margin_type":{"type":"string","example":"BPS","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the unit of margin applied in addition to the rate provided by Ripple. This field has a value only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MARGIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["BPS"]}},"description":"JSON response object that represents an exchange rate."}},"components/schemas/RateRequest":{"id":"components/schemas/RateRequest","kind":"json-schema","title":"RateRequest","data":{"type":"object","required":["base_currency","counter_currency","expiration_offset","order_type","rate"],"properties":{"expiration_offset":{"type":"integer","example":95000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to the amount of time in milliseconds that the rate is valid for after the rate's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate that the rate does not expire. The value returned in the response object for this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Refer to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the response object to verify your expiration offset timing."},"children":[]}]}]}]},"order_type":{"type":"string","example":"buy","description":"Set to the order type for the exchange rate.","enum":["buy","sell"]},"rate":{"type":"number","example":0.89,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value of this field represents either rate or margin based on what you specify in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value_type=rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", set the value of this field to the exchange rate for a base and counter currency. The rate can use up to 6 decimal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"places."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value_type=margin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", set the value of this field depending on the unit of margin you specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"margin_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"base_currency":{"type":"string","example":"USD","description":"Set to the base currency of the exchange rate."},"counter_currency":{"type":"string","example":"GBP","description":"Set to the counter currency of the exchange rate."},"ledger":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ledger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object to create an exchange rate that applies to exchanges between a specific source ledger and destination ledger. You can provide either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ledger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, but not both."},"children":[]}]}]}],"$ref":"#/components/schemas/RatePerLedgerRequest"},"account":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object to create an exchange rate that applies to exchanges between a specific source ledger account and destination ledger account. You can provide either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ledger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, but not both."},"children":[]}]}]}],"$ref":"#/components/schemas/RatePerAccountRequest"},"lower_limit":{"type":"number","example":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a slab-based exchange rate, provide the lower limit of the slab. You must also provide an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upper_limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"upper_limit":{"type":"number","example":1000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a slab-based exchange rate, provide the upper limit of the slab. You must also provide a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lower_limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"payout_method":{"type":"string","example":"LOCAL_RAILS","description":"The payout method for the rate."},"value_type":{"type":"string","example":"MARGIN","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify whether you want to use a live exchange rate ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MARGIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or an exchange rate manually configured by Ripple ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). If you set this value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MARGIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must also provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"margin_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["MARGIN","RATE"]},"margin_type":{"type":"string","example":"BPS","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the unit of margin to be applied (BPS) in addition to the rate provided by Ripple. Specify this field only if you set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MARGIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["BPS"]}},"description":"Use this JSON request body to create an exchange rate for a base and counter currency."}},"components/schemas/RatePerLedgerRequest":{"id":"components/schemas/RatePerLedgerRequest","kind":"json-schema","title":"RatePerLedgerRequest","data":{"type":"object","required":["destination_ledger","source_ledger"],"properties":{"source_ledger":{"type":"string","example":"rn.eur.uk.london","description":"Set to the source ledger associated with the exchange rate."},"destination_ledger":{"type":"string","example":"rn.eur.uk.london","description":"Set to the destination ledger associated with the exchange rate."}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ledger"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request object to create an exchange rate that applies to exchanges between a specific source ledger and destination ledger."},"children":[]}]}]}]}},"components/schemas/RatePerAccountRequest":{"id":"components/schemas/RatePerAccountRequest","kind":"json-schema","title":"RatePerAccountRequest","data":{"type":"object","required":["destination_ledger","destination_ledger_account","source_ledger","source_ledger_account"],"properties":{"source_ledger":{"type":"string","example":"rn.eur.uk.london","description":"Set to the source ledger associated with the exchange rate."},"destination_ledger":{"type":"string","example":"rn.eur.uk.london","description":"Set to the destination ledger associated with the exchange rate."},"source_ledger_account":{"type":"string","example":"alias_usd_lon","description":"Set to the account on the source ledger associated with the rate."},"destination_ledger_account":{"type":"string","example":"conct_gbp_lon","description":"Set to the account on the destination ledger associated with the rate."}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request object to create an exchange rate that applies to exchanges between a specific source ledger account and destination ledger account."},"children":[]}]}]}]}},"components/schemas/RippleNetNodeRequestsForPayment":{"id":"components/schemas/RippleNetNodeRequestsForPayment","kind":"json-schema","title":"RippleNetNodeRequestsForPayment","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/RippleNetNodeRequestForPayment"}}}}],"description":"Paged response for requests for payment includes:"}},"components/schemas/RippleNetNodeRequestForPaymentRequest":{"id":"components/schemas/RippleNetNodeRequestForPaymentRequest","kind":"json-schema","title":"RippleNetNodeRequestForPaymentRequest","data":{"type":"object","required":["amount","currency","quote_type","receiver_address","sender_address"],"properties":{"sender_address":{"type":"string","example":"trans_usd_sf@rn.us.ca.san_francisco","description":"RippleNet address of the node that is receiving the request for payment, or the eventual sender of the payment."},"receiver_address":{"type":"string","example":"trans_gbp_lon@rn.eur.uk.london","description":"RippleNet address of the node that is sending the request for payment, or the eventual receiver of the payment."},"amount":{"type":"number","example":100.01,"description":"Amount requested to be paid."},"currency":{"type":"string","example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"quote_type":{"type":"string","example":"SENDER_AMOUNT","description":"Indicates how the amount field should be treated for calculating quote values.","enum":["SENDER_AMOUNT","RECEIVER_AMOUNT","SENDER_INSTITUTION_AMOUNT","RECEIVER_INSTITUTION_AMOUNT"]},"end_to_end_id":{"type":"string","description":"ID that the eventual payment receiver can specify. Persisted on all rippleNet node instances (namely, the sender and receiver of the payment) that participate in the request for payment."},"user_info":{"type":"object","description":"User-provided data with arbitrary key/value pairs.","properties":{}}},"description":"Use this JSON object to request a request for payment."}},"components/schemas/RippleNetNodeRequestForPayment":{"id":"components/schemas/RippleNetNodeRequestForPayment","kind":"json-schema","title":"RippleNetNodeRequestForPayment","data":{"type":"object","required":["amount","created_at","currency","quote_type","receiver_address","request_for_payment_id","request_for_payment_state","sender_address","user_info"],"properties":{"request_for_payment_id":{"type":"string","format":"uuid","example":"1bf93760-ef69-4697-b2b4-47d9e1c42aa7","description":"Unique identifier of a request for payment."},"request_for_payment_state":{"type":"string","example":"REQUESTED","description":"State of the request for payment.","enum":["REQUESTED","ACCEPTED","FAILED"]},"sender_address":{"type":"string","example":"trans_usd_sf@rn.us.ca.san_francisco","description":"RippleNet address of the node that is receiving the request for payment, or the eventual sender of the payment."},"receiver_address":{"type":"string","example":"trans_gbp_lon@rn.eur.uk.london","description":"RippleNet address of the node that is sending the request for payment, or the eventual receiver of the payment."},"amount":{"type":"number","example":100.01,"description":"Amount requested to be paid."},"currency":{"type":"string","example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"quote_type":{"type":"string","example":"SENDER_AMOUNT","description":"Indicates how the amount field should be treated for calculating quote values.","enum":["SENDER_AMOUNT","RECEIVER_AMOUNT","SENDER_INSTITUTION_AMOUNT","RECEIVER_INSTITUTION_AMOUNT"]},"end_to_end_id":{"type":"string","description":"ID that the eventual payment receiver can specify. Persisted on all rippleNet Node instances (namely, the sender and receiver of the payment) that participate in the request for payment."},"user_info":{"type":"array","description":"User-provided data with arbitrary key/value pairs.","items":{"$ref":"#/components/schemas/RippleNetNodeRequestForPaymentUserInfo"}},"created_at":{"type":"string","format":"date-time","description":"Date and time at which the request for payment was created, as an ISO-8601 timestamp in UTC."},"payment_id":{"type":"string","format":"uuid","example":"5492648d-2132-4e70-9ded-2fc86f22b321","description":"Unique identifier of a payment associated to request for payment."}},"description":"Use this JSON object represent a request for payment."}},"components/schemas/RippleNetNodeRequestForPaymentUserInfo":{"id":"components/schemas/RippleNetNodeRequestForPaymentUserInfo","kind":"json-schema","title":"RippleNetNodeRequestForPaymentUserInfo","data":{"type":"object","required":["node_address"],"properties":{"node_address":{"type":"string","description":"RippleNet address of the node that provided the user information."},"requested":{"type":"array","description":"User information optionally provided when sending the request for payment.","items":{"$ref":"#/components/schemas/UserInfoEntry"}},"accepted":{"type":"array","description":"User information optionally provided when accepting the request for payment.","items":{"$ref":"#/components/schemas/UserInfoEntry"}},"failed":{"type":"array","description":"User information optionally provided when failing the request payment.","items":{"$ref":"#/components/schemas/UserInfoEntry"}}},"description":"User information provided across the payment lifecycle."}},"components/schemas/AcceptRequestForPaymentRequest":{"id":"components/schemas/AcceptRequestForPaymentRequest","kind":"json-schema","title":"AcceptRequestForPaymentRequest","data":{"type":"object","required":["payment_id"],"properties":{"payment_id":{"type":"string","format":"uuid","example":"1bf93760-ef69-4697-b2b4-47d9e1c42aa7","description":"Unique identifier of payment associated with the request for payment."},"user_info":{"type":"object","description":"User-provided data with arbitrary key/value pairs.","properties":{}}},"description":"Use this JSON object to accept a request for payment."}},"components/schemas/FailRequestForPaymentRequest":{"id":"components/schemas/FailRequestForPaymentRequest","kind":"json-schema","title":"FailRequestForPaymentRequest","data":{"type":"object","properties":{"user_info":{"type":"object","description":"User-provided data with arbitrary key/value pairs.","properties":{}}},"description":"Use this JSON object to fail a request for payment."}},"components/schemas/QuoteExpiries":{"id":"components/schemas/QuoteExpiries","kind":"json-schema","title":"QuoteExpiries","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/QuoteExpiry"}}}}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array of quote expiry objects and a set of pagination information fields."},"children":[]}]}]}]}},"components/schemas/QuoteExpiry":{"id":"components/schemas/QuoteExpiry","kind":"json-schema","title":"QuoteExpiry","data":{"type":"object","properties":{"quote_ttl":{"type":"number","example":5900,"description":"Quote expiration window, or time to live (ttl), in seconds. To calculate the quote expiration date, xCurrent adds this value to the quote creation timestamp."},"sending_partner":{"type":"string","example":"rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet address of the sender, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rn.us.sf.san_francisco"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiving_partner":{"type":"string","example":"rn.us.tx.austin","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet address of the receiver, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"currency":{"type":"string","example":"USD","description":"currency of the exchange rate."},"id":{"type":"integer","example":2,"description":"id of quote expiry object"}},"description":"Use this JSON request object to update the quote time to live represented in seconds."}},"components/schemas/PaymentExpiries":{"id":"components/schemas/PaymentExpiries","kind":"json-schema","title":"PaymentExpiries","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/PaymentExpiryResponse"}}}}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array of payment expiry objects and a set of pagination information fields."},"children":[]}]}]}]}},"components/schemas/PaymentExpiry":{"id":"components/schemas/PaymentExpiry","kind":"json-schema","title":"PaymentExpiry","data":{"type":"object","properties":{"payment_ttl":{"type":"number","example":5900,"description":"Payment expiration window, or time to live (ttl), in seconds. To calculate the payment expiration date, xCurrent adds this value to the payment creation timestamp."},"sending_partner":{"type":"string","example":"rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet address of the sender, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rn.us.sf.san_francisco"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiving_partner":{"type":"string","example":"rn.us.tx.austin","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet address of the receiver, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"currency":{"type":"string","example":"USD","description":"currency of the exchange rate."}},"description":"Use this JSON request object to update the payment time to live represented in seconds."}},"components/schemas/PaymentExpiryResponse":{"id":"components/schemas/PaymentExpiryResponse","kind":"json-schema","title":"PaymentExpiryResponse","data":{"type":"object","properties":{"payment_ttl":{"type":"number","example":5900,"description":"Payment expiration window, or time to live (ttl), in seconds. To calculate the payment expiration date, xCurrent adds this value to the payment creation timestamp."},"sending_partner":{"type":"string","example":"rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet address of the sender, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rn.us.sf.san_francisco"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiving_partner":{"type":"string","example":"rn.us.tx.austin","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet address of the receiver, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"currency":{"type":"string","example":"USD","description":"currency of the exchange rate."},"expiry_id":{"type":"string","format":"uuid","example":"4711728c-cd35-49ec-96a5-72732b4333ec","description":"id of payment expiry object"}},"description":"Use this JSON request object to update the payment time to live represented in seconds."}},"components/schemas/ExchangeTransfers":{"id":"components/schemas/ExchangeTransfers","kind":"json-schema","title":"ExchangeTransfers","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","description":"Provides an array of exchange transfer objects.","items":{"$ref":"#/components/schemas/FiatExchangeTransferExecuteResponse"}}}}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array of exchange transfer objects and a set of pagination information fields."},"children":[]}]}]}]}},"components/schemas/FiatExchangeTransferExecuteResponse":{"id":"components/schemas/FiatExchangeTransferExecuteResponse","kind":"json-schema","title":"FiatExchangeTransferExecuteResponse","data":{"type":"object","required":["destination_amount","destination_currency","end_to_end_id","exchange_transfer_id","fx_transfer_rate","internal_id","receiver_address","sender_address","source_amount","source_currency","state","type","user_info"],"properties":{"exchange_transfer_id":{"type":"string","format":"uuid","example":"e3b20ba4-28ed-4752-990d-e67887bb331e","description":"Unique identifier of the exchange transfer."},"state":{"type":"string","example":"EXECUTED","description":"State of the exchange transfer.","enum":["EXECUTED","COMPLETED","FAILED"]},"type":{"type":"string","example":"INDICATIVE","description":"Indicates the exchange transfer's quoted FX rate type.\n","enum":["FIRM","INDICATIVE"],"x-enumDescriptions":{"FIRM":"A firm exchange rate ensures that the quoted and delivered transfer amounts are equal.","INDICATIVE":"An indicative exchange rate allows for movement between quoted rate and transfer execution, such that the quoted amount and delivered amount may differ."},"default":"FIRM"},"sender_address":{"type":"string","example":"sf@rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiver_address":{"type":"string","example":"sf_gbp@rn.us.ca.san_francisco","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the receiver, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source_amount":{"type":"number","example":1,"description":"Sending amount of the exchange transfer."},"destination_amount":{"type":"number","example":355,"description":"Receiving amount of the exchange transfer."},"source_currency":{"type":"string","example":"USD","description":"Sending currency of the exchange transfer."},"destination_currency":{"type":"string","example":"GBP","description":"Receiving currency of the exchange transfer."},"fx_transfer_rate":{"description":"Rate used to make the exchange transfer.","$ref":"#/components/schemas/ExchangeTransferRate"},"end_to_end_id":{"type":"string","description":"ID set by the sender that is persisted on all fiat node instances that participated in the transfer."},"internal_id":{"type":"string","description":"Internal ID that the sender can optionally specify. Only visible to the sender. Only the sending fiat node instance stores this ID."},"user_info":{"type":"array","description":"Custom information set by a RippleNet address involved in the exchange transfer.","items":{"$ref":"#/components/schemas/FiatExchangeTransferUserInfo"}}},"description":"JSON response object that represents an exchange transfer."}},"components/schemas/ExchangeTransferRate":{"id":"components/schemas/ExchangeTransferRate","kind":"json-schema","title":"ExchangeTransferRate","data":{"type":"object","required":["base_currency","counter_currency","rate","rate_type"],"properties":{"rate":{"type":"number","example":0.89,"description":"Exchange rate used to make the exchange transfer."},"base_currency":{"type":"string","example":"USD","description":"Base currency for custom rate for the sending account."},"counter_currency":{"type":"string","example":"GBP","description":"Counter currency for custom rate for the sending account."},"rate_type":{"type":"string","example":"BUY","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate type used to make the exchange transfer. Valid values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"description":"Describes an exchange rate used in an exchange transfer."}},"components/schemas/FiatExchangeTransferUserInfo":{"id":"components/schemas/FiatExchangeTransferUserInfo","kind":"json-schema","title":"FiatExchangeTransferUserInfo","data":{"type":"object","required":["json","node_address","state"],"description":"Custom information about an exchange transfer provided by a RippleNet address involved in the exchange transfer.","properties":{"node_address":{"type":"string","example":"rn.us.ny.new_york","description":"RippleNet address of the fiat node instance that set the user information."},"state":{"type":"string","example":"EXECUTED","description":"State of the exchange transfer set when the RippleNet address set the user information.","enum":["EXECUTED","COMPLETED","FAILED"]},"json":{"type":"object","description":"One or more arbitrary key/value pairs.","properties":{}},"created_at":{"type":"string","format":"date-time","description":"timestamp of when this user info was created"}}}},"components/schemas/FiatExchangeTransferExecuteRequest":{"id":"components/schemas/FiatExchangeTransferExecuteRequest","kind":"json-schema","title":"FiatExchangeTransferExecuteRequest","data":{"type":"object","required":["amount","amount_type","receiver_address","sender_address"],"properties":{"sender_address":{"type":"string","example":"alias_usd_lon@rn.eur.uk.london","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiver_address":{"type":"string","example":"conct_gbp_lon@rn.eur.uk.london","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the receiver, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"amount":{"type":"number","minimum":0,"example":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount transferred, expressed in the curency of the account indicated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"amount_type":{"type":"string","example":"SENDER_AMOUNT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount type used for the exchange transfer."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To indicate that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is expressed in the currency of the account provided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value, set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To indicate that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is expressed in the currency of the account provided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receiver_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value, set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVER_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["SENDER_AMOUNT","RECEIVER_AMOUNT"]},"end_to_end_id":{"type":"string","maxLength":128,"example":378910,"description":"ID set by the sender that is persisted on all fiat node instances that participated in the transfer."},"internal_id":{"type":"string","maxLength":128,"example":1987,"description":"Internal ID that the sender can optionally specify. Only visible to the sender. Only the sending fiat node instance stores this ID."},"user_info":{"type":"object","description":"Provide one or more arbitrary key/value pairs.","properties":{}}},"description":"JSON request object to execute an exchange transfer."}},"components/schemas/FiatExchangeTransferQuoteRequest":{"id":"components/schemas/FiatExchangeTransferQuoteRequest","kind":"json-schema","title":"FiatExchangeTransferQuoteRequest","data":{"type":"object","required":["amount","amount_type","receiver_address","sender_address"],"properties":{"sender_address":{"type":"string","example":"alias_usd_lon@rn.eur.uk.london","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiver_address":{"type":"string","example":"conct_gbp_lon@rn.eur.uk.london","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the receiver, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"amount":{"type":"number","minimum":0,"example":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount transferred, expressed in the curency of the account indicated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"amount_type":{"type":"string","example":"SENDER_AMOUNT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount type of the exchange transfer."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To indicate that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is expressed in the currency of the account provided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value, set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To indicate that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is expressed in the currency of the account provided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receiver_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value, set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVER_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["SENDER_AMOUNT","RECEIVER_AMOUNT"]}},"description":"Use this JSON request body to request a quote for an exchange transfer."}},"components/schemas/FiatExchangeTransferQuoteResponse":{"id":"components/schemas/FiatExchangeTransferQuoteResponse","kind":"json-schema","title":"FiatExchangeTransferQuoteResponse","data":{"type":"object","required":["destination_amount","destination_currency","fx_transfer_rate","receiver_address","sender_address","source_amount","source_currency","type"],"properties":{"type":{"type":"string","description":"Indicates the exchange transfer's quoted FX rate type.","default":"FIRM","example":"INDICATIVE","enum":["FIRM","INDICATIVE"],"x-enumDescriptions":{"FIRM":"A firm exchange rate ensures that the quoted and delivered transfer amounts are equal.","INDICATIVE":"An indicative exchange rate allows for movement between quoted rate and transfer execution, such that the quoted amount and delivered amount may differ."}},"sender_address":{"type":"string","example":"alias_usd_lon@rn.eur.uk.london","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiver_address":{"type":"string","example":"conct_gbp_lon@rn.eur.uk.london","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the receiver, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source_amount":{"type":"number","example":100,"description":"Sending amount of the exchange transfer."},"destination_amount":{"type":"number","example":89,"description":"Receiving amount of the exchange transfer."},"source_currency":{"type":"string","example":"USD","description":"Sending currency of the exchange transfer."},"destination_currency":{"type":"string","example":"GBP","description":"Receiving currency of the exchange transfer."},"fx_transfer_rate":{"description":"Rate used for this exchange transfer.","$ref":"#/components/schemas/ExchangeTransferRate"}},"description":"JSON response object that represents a quote for an exchange transfer."}},"components/schemas/AccountLookupStatus":{"id":"components/schemas/AccountLookupStatus","kind":"json-schema","title":"AccountLookupStatus","data":{"type":"string","enum":["REQUESTED","PROCESSED","FAILED","EXPIRED"]}},"components/schemas/CreateODLFlagConfigRequest":{"id":"components/schemas/CreateODLFlagConfigRequest","kind":"json-schema","title":"CreateODLFlagConfigRequest","data":{"type":"object","description":"Request object for creating a ODL Flag Configuration.","required":["flag"],"properties":{"flag":{"type":"string","description":"Flag to be passed to ODL in payment/estimate requests."},"flag_value":{"type":"string","description":"flag value to be passed to ODL in payment/estimate requests."},"exchange":{"type":"string","description":"Exchange name for which this flag should be added to the ODL payment/estimate request"},"sender_host":{"type":"string","description":"Sender host ripplenet hostname who sends the payment for which this flag is to be applied"}}}},"components/schemas/UpdateODLFlagConfigRequest":{"id":"components/schemas/UpdateODLFlagConfigRequest","kind":"json-schema","title":"UpdateODLFlagConfigRequest","data":{"type":"object","description":"Request object for updating a Liquidation Configuration.","properties":{"flag":{"type":"string","description":"Flag to be passed to ODL in payment/estimate requests."},"flag_value":{"type":"string","description":"flag value to be passed to ODL in payment/estimate requests."},"exchange":{"type":"string","description":"Exchange name for which this flag should be added to the ODL payment/estimate request"},"sender_host":{"type":"string","description":"Sender host ripplenet hostname who sends the payment for which this flag is to be applied"}}}},"components/schemas/ODLFlagConfigResponse":{"id":"components/schemas/ODLFlagConfigResponse","kind":"json-schema","title":"ODLFlagConfigResponse","data":{"type":"object","description":"Response object for Liquidation Configuration","properties":{"odl_flag_config_id":{"type":"string","format":"uuid","description":"The unique identifier for this ODL Flag Configuration."},"flag":{"type":"string","description":"Flag to be passed to ODL in payment/estimate requests."},"flag_value":{"type":"string","description":"flag value to be passed to ODL in payment/estimate requests."},"exchange":{"type":"string","description":"Exchange name for which this flag should be added to the ODL payment/estimate request"},"sender_host":{"type":"string","description":"Sender host ripplenet hostname who sends the payment for which this flag is to be applied"}}}},"components/schemas/ODLFlagConfigsPage":{"id":"components/schemas/ODLFlagConfigsPage","kind":"json-schema","title":"ODLFlagConfigsPage","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/ODLFlagConfigResponse"}}}}],"description":"Paged response for ODL Flag Configurations"}},"components/schemas/RpoSchemaRequest":{"id":"components/schemas/RpoSchemaRequest","kind":"json-schema","title":"RpoSchemaRequest","data":{"type":"object","required":["receiver_address","schema_name","schema","receiver_currency"],"properties":{"sender_address":{"type":"string","maxLength":64,"example":"test.ros.com","description":"RippleNet sender address."},"receiver_address":{"type":"string","maxLength":64,"example":"test.ros.com","description":"RippleNet receiver address."},"schema_name":{"type":"string","maxLength":64,"example":"schema1","description":"customer schema name."},"schema":{"type":"object","description":"RPO schema."},"schema_description":{"type":"string","maxLength":256,"description":"RPO schema description."},"receiver_currency":{"type":"string","minLength":3,"maxLength":3,"pattern":"^[a-zA-Z0-9_]*$","description":"Receiver currency code for schema."},"payment_method":{"type":"string","pattern":"^[a-zA-Z0-9@_,:\\s-]*$","minLength":2,"maxLength":32,"description":"Payment method for schema."}},"description":"JSON request object that represents an RPO schema."}},"components/schemas/RpoSchemaResponse":{"id":"components/schemas/RpoSchemaResponse","kind":"json-schema","title":"RpoSchemaResponse","data":{"type":"object","required":["schema_id","sender_address","receiver_address","schema_name","schema","schema_description","receiver_currency","created_at","payment_method"],"properties":{"schema_id":{"type":"string","format":"uuid","example":"5492648d-2132-4e70-9ded-2fc86f22b321","description":"Unique Identifier of an RPO schema."},"sender_address":{"type":"string","maxLength":64,"example":"test.ros.com","description":"RippleNet sender address."},"receiver_address":{"type":"string","example":"test.ros.com","description":"RippleNet receiver address."},"schema_name":{"type":"string","example":"schema1","description":"customer schema name."},"schema_description":{"type":"string","description":"RPO schema description."},"receiver_currency":{"type":"string","description":"receiver currency code for schema."},"payment_method":{"type":"string","description":"payment method for schema."},"created_at":{"type":"string","format":"date-time","example":"2018-04-06T20:33:35Z","description":"Date and time at which the RPO was created, as an ISO-8601 timestamp in UTC."},"schema":{"type":"object","description":"RPO schema."}},"description":"JSON response object that represents an RPO schema."}},"components/schemas/RpoSchemasAddresses":{"id":"components/schemas/RpoSchemasAddresses","kind":"json-schema","title":"RpoSchemasAddresses","data":{"type":"array","items":{"$ref":"#/components/schemas/RpoSchemasAddressResponse"},"description":"List response of RPO schemas for RippleNet receiver addresses."}},"components/schemas/RpoSchemasAddressResponse":{"id":"components/schemas/RpoSchemasAddressResponse","kind":"json-schema","title":"RpoSchemasAddressResponse","data":{"type":"object","required":["receiver_address","schemas","created_at"],"properties":{"receiver_address":{"type":"string","example":"test.ros.com","description":"RippleNet receiver address."},"schemas":{"type":"array","description":"RPO schema details.","items":{"$ref":"#/components/schemas/RpoSchema"}}},"description":"Response for RPO schema of a RippleNet receiver address."}},"components/schemas/RpoSchema":{"id":"components/schemas/RpoSchema","kind":"json-schema","title":"RpoSchema","data":{"type":"object","required":["schema_id","schema_name","receiver_currency","payment_method","created_at","schema"],"properties":{"schema_id":{"type":"string","format":"uuid","example":"5492648d-2132-4e70-9ded-2fc86f22b321","description":"Unique Identifier of an RPO schema."},"schema_name":{"type":"string","example":"schema1","description":"customer schema name."},"schema_description":{"type":"string","maxLength":255,"description":"RPO schema description."},"receiver_currency":{"type":"string","description":"receiver currency code for schema."},"payment_method":{"type":"string","description":"payment method for schema."},"created_at":{"type":"string","format":"date-time","example":"2018-04-06T20:33:35Z","description":"Date and time at which the RPO was created, as an ISO-8601 timestamp in UTC."},"schema":{"type":"object","description":"RPO schema."}},"description":"JSON response object that represents a payment.\n\nA payment is the movement of value across accounts on potentially different RippleNet instances involving one or more currencies.\n"}},"components/schemas/ActivityRequest":{"id":"components/schemas/ActivityRequest","kind":"json-schema","title":"ActivityRequest","data":{"type":"object","required":["name","context_name","bean_name","notification_type","activity_description"],"properties":{"name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_]*$","example":"custom_get_quote_v1","description":"Name of the activity. It must start with 'custom'."},"context_name":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[a-zA-Z0-9_]*$","example":"get_quote","description":"Context name used for accessing request/response of activities."},"bean_name":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[a-zA-Z0-9]*$","example":"getQuoteV1","description":"Bean name used for activity execution."},"end_activity":{"type":"boolean","example":false,"default":false,"description":"Flag to denote whether the activity is an end acitvity."},"notification_type":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-zA-Z0-9_:]*$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notification_type used for validating messages in queue when activity in execution."},"children":[]}]}]}]},"activity_description":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[a-zA-Z0-9@_,.:\\s-]*$","description":"Description of the activity."},"retry_interval":{"type":"integer","description":"Retry interval time of the activity in minutes."}},"description":"JSON request object that represents an activity."}},"components/schemas/ActivityResponse":{"id":"components/schemas/ActivityResponse","kind":"json-schema","title":"ActivityResponse","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"5492648d-2132-4e70-9ded-2fc86f22b321","description":"Unique Identifier of the activity."},"name":{"type":"string","example":"get_quote_v1","description":"Activity name."},"context_name":{"type":"string","example":"get_quote","description":"Context name used for accessing request/response of activities."},"bean_name":{"type":"string","example":"getQuoteV1","description":"Bean name used for activity execution."},"end_activity":{"type":"boolean","example":false,"description":"Flag to denote whether the activity is an end acitvity."},"activity_description":{"type":"string","maxLength":256,"description":"Description of the activity."},"retry_interval":{"type":"integer","description":"Retry interval time of the activity in minutes."},"created_at":{"type":"string","format":"date-time","example":"2018-04-06T20:33:35Z","description":"Date and time at which the activity was created, as an ISO-8601 timestamp in UTC."}},"description":"JSON response object that represents an activity."}},"components/schemas/Activities":{"id":"components/schemas/Activities","kind":"json-schema","title":"Activities","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/ActivityResponse"}}}}]}},"components/schemas/OrchestrationTemplateRequest":{"id":"components/schemas/OrchestrationTemplateRequest","kind":"json-schema","title":"OrchestrationTemplateRequest","data":{"type":"object","required":["name","payment_type","connector_role","activity_order"],"properties":{"name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]*$","example":"custom_orchestration_template_v1","description":"Name of the orchestration template. It must start with 'custom'."},"payment_type":{"type":"string","description":"The payment type for which the template is to be used.","enum":["REGULAR","RETURN","ACCEPT","REVERSAL"]},"connector_role":{"type":"string","description":"The connector role for which the template is to be used.","enum":["SENDING","RECEIVING","INTERMEDIARY"]},"default_template":{"type":"boolean","example":true,"default":false,"description":"Is orchestration template default."},"orchestration_template_description":{"type":"string","maxLength":256,"pattern":"^[a-zA-Z0-9@_,.:\\s-]*$","default":"","description":"Orchestration template description."},"activity_order":{"type":"array","description":"Activity order list.","minItems":1,"items":{"$ref":"#/components/schemas/ActivityOrderRequest"}}},"additionalProperties":false,"description":"JSON request object that represents a orchestration template request."}},"components/schemas/OrchestrationTemplateUpdateRequest":{"id":"components/schemas/OrchestrationTemplateUpdateRequest","kind":"json-schema","title":"OrchestrationTemplateUpdateRequest","data":{"type":"object","required":["default_template"],"properties":{"default_template":{"type":"boolean","example":true,"default":false,"description":"Is orchestration template default."}},"description":"JSON request object that represents an orchestration template put request."}},"components/schemas/ActivityOrderRequest":{"id":"components/schemas/ActivityOrderRequest","kind":"json-schema","title":"ActivityOrderRequest","data":{"type":"object","required":["activity_name","next_activity"],"properties":{"activity_name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_]*$","example":"activity_v1","description":"Activity name."},"next_activity":{"type":"array","description":"Next activity based on current activity status.","items":{"$ref":"#/components/schemas/NextActivityRequest"}}},"description":"JSON request object that represents an Activity Order."}},"components/schemas/ActivityUpdateRequest":{"id":"components/schemas/ActivityUpdateRequest","kind":"json-schema","title":"ActivityUpdateRequest","data":{"type":"object","required":["retry_interval"],"properties":{"retry_interval":{"type":"integer","description":"Retry interval time of the activity, in minutes."}},"description":"JSON request object that represents an activity put request."}},"components/schemas/NextActivityRequest":{"id":"components/schemas/NextActivityRequest","kind":"json-schema","title":"NextActivityRequest","data":{"type":"object","required":["status","activity_name"],"properties":{"status":{"type":"string","description":"Activity status","enum":["SUCCESS","FAILURE","DECLINED","REDO","SUBSTATE","NOTIFY","SUBTASK"]},"activity_name":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_]*$","example":"activity_v1","description":"Activity name."}},"description":"JSON request object that represents a next activity based on current activity status."}},"components/schemas/OrchestrationTemplateResponse":{"id":"components/schemas/OrchestrationTemplateResponse","kind":"json-schema","title":"OrchestrationTemplateResponse","data":{"type":"object","required":["name","activity_order"],"properties":{"name":{"type":"string","maxLength":64,"example":"custom_orchestration_template_v1","description":"Orchestration template name."},"payment_type":{"type":"string","description":"The payment type for which the template is to be used.","enum":["REGULAR","RETURN","REVERSAL"]},"connector_role":{"type":"string","description":"The connector role for which the template is to be used.","enum":["SENDING","RECEIVING","INTERMEDIARY"]},"default_template":{"type":"boolean","example":true,"default":false,"description":"Is orchestration template default."},"orchestration_template_description":{"type":"string","maxLength":255,"description":"Orchestration template description."},"activity_order":{"type":"array","description":"Activity order list.","items":{"$ref":"#/components/schemas/ActivityOrderResponse"}}},"description":"JSON request object that represents an orchestration template response."}},"components/schemas/ActivityOrderResponse":{"id":"components/schemas/ActivityOrderResponse","kind":"json-schema","title":"ActivityOrderResponse","data":{"type":"object","required":["activity_name","next_activity"],"properties":{"activity_name":{"type":"string","maxLength":64,"example":"activity_v1","description":"Activity name."},"next_activity":{"type":"array","description":"Next activity based on current activity status.","items":{"$ref":"#/components/schemas/NextActivityResponse"}}},"description":"JSON request object that represents an Activity Order response."}},"components/schemas/NextActivityResponse":{"id":"components/schemas/NextActivityResponse","kind":"json-schema","title":"NextActivityResponse","data":{"type":"object","required":["status","activity_name"],"properties":{"status":{"type":"string","description":"Activity status","enum":["SUCCESS","FAILURE","DECLINED","REDO","SUBSTATE","NOTIFY","SUBTASK"]},"activity_name":{"type":"string","maxLength":64,"example":"activity_v1","description":"Activity name."}},"description":"JSON request object that represents a next activity based on current activity status."}},"components/schemas/OrchestrationTemplateList":{"id":"components/schemas/OrchestrationTemplateList","kind":"json-schema","title":"OrchestrationTemplateList","data":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationTemplateResponse"},"description":"List response of orchestration templates."}},"components/schemas/OrchestrationPaymentRequest":{"id":"components/schemas/OrchestrationPaymentRequest","kind":"json-schema","title":"OrchestrationPaymentRequest","data":{"type":"object","required":["sender_end_to_end_id","sending_address","receiving_address","amount","currency","quote_type","user_info"],"properties":{"sender_end_to_end_id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9@_,:\\s-]*$","description":"Unique ID that the sender can specify.\n\nPersisted on all instances that participate in the payment.\n"},"internal_id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9@_,:\\s-]*$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[Sender only]"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal ID that the sender can optionally specify."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only visible to the sender. Only the sending RippleNet instance stores this ID."},"children":[]}]}]}]},"orchestration_template":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]*$","description":"Parameter for the orchestration template name.\n\nIf you don't specify a template name, a default template will be picked.\n"},"sending_address":{"type":"string","minLength":1,"maxLength":256,"pattern":"^([\\.a-zA-Z0-9_~-]+@)?(rn|dev|test|uat)([.][a-zA-Z0-9_~-]+)+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]}]}]}]},"receiving_address":{"type":"string","minLength":1,"maxLength":256,"pattern":"^([\\.a-zA-Z0-9_~-]+@)?(rn|dev|test|uat)([.][a-zA-Z0-9_~-]+)+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the receiver."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]}]}]}]},"amount":{"type":"string","minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to be sent or received, depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this table to determine what "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to assign."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"1\""},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quote type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SENDER_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to be sent by the payment originator"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SENDER_INSTITUTION_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to calculate the quote based on the amount to be sent, plus any fees collected by the sending institution"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECEIVER_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to be received by the payment beneficiary"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECEIVER_INSTITUTION_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to calculate the quote based on the amount to be received, minus any fees collected by the receiving institution"},"children":[]}]}]}]}]}]}]},"currency":{"type":"string","minLength":3,"maxLength":3,"example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code of the amount to be sent or received, depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this table to determine what "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code to assign."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quote type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SENDER_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the currency code for the sending currency, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SENDER_INSTITUTION_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the currency code for the sending currency, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECEIVER_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the currency code for the receiving currency, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECEIVER_INSTITUTION_AMOUNT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the currency code for the receiving currency, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]}]}]}]}]}]}]},"quote_type":{"type":"string","example":"SENDER_AMOUNT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to calculate the quote."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_AMOUNT"},"children":[]}]}]}],"enum":["SENDER_AMOUNT","RECEIVER_AMOUNT","SENDER_INSTITUTION_AMOUNT","RECEIVER_INSTITUTION_AMOUNT"],"x-enumDescriptions":{"SENDER_AMOUNT":"Quote based on the amount the payment originator or originating institution wants to send","SENDER_INSTITUTION_AMOUNT":"Quote based on the amount (to debit the originator) is `amount` plus any fees to be collected by the sending institution","RECEIVER_AMOUNT":"Quote based on the amount the payment beneficiary or beneficiary institution should receive","RECEIVER_INSTITUTION_AMOUNT":"The amount (to credit the beneficiary) is `amount` minus any fees to be collected by the receiving institution"}},"sender_or_receiver_currency":{"type":"string","minLength":3,"maxLength":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code of the sender or receiver based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If provided, you can use this to filter the options for quotes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]}]}]}],"example":"USD"},"custom_fee":{"type":"number","description":"Custom fee for the sending account.\n\nSetting this field overrides all fees configured on the sender's RippleNet instance.\n"},"custom_rate":{"$ref":"#/components/schemas/PaymentCustomRateRequest"},"quote_route":{"type":"array","example":["rn.us.ca.san_francisco","rn.us.tx.austin","rn.us.ny.new_york"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom route that quote must follow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide an array of RippleNet address strings that convey the route the quote must follow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"g.us.ca.san_francisco"},"children":[]}]}]}],"items":{"type":"string"}},"payment_method":{"type":"string","pattern":"^[a-zA-Z0-9@_,:\\s-]*$","minLength":2,"maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this field, when using ODL, to indicate the type of fees to apply."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When testing, set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"payment_method\": \"none\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure funds remain at the destination exchange and are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" paid out to a local rail."},"children":[]}]}]}]},"enable_quote_per_payout_method":{"type":"boolean","example":true,"description":"Enable this flag to generate quotes using payout methods configured by the receiver."},"digital_asset_origination":{"type":"boolean","example":false,"description":"When true, this flag tells RippleNet to provide a full quote as if the payment originates in the specified source fiat currency.\n\nThe quote for the source exchange excludes trading fees.\n\nOn execution, the source exchange trade is skipped, and XRP is withdrawn from the source exchange as the first step.\n"},"force_path_finding_and_liquidity_path_finding":{"type":"boolean","example":false,"description":"When true, this flag tells RippleNet to ignore cached value for path finding and liquidity path finding.\n\nForce performing new path finding and liquidity path finding.\n","default":false},"payout_method_category":{"type":"string","example":"BOOK_TRANSFER","description":"Category the payout method will be associated with.","enum":["REAL_TIME_GROSS_SETTLEMENT_SYSTEM","REAL_TIME_NET_SETTLEMENT_SYSTEM","MASS_NET_PAYMENT_SYSTEM","BOOK_TRANSFER","CASH_PAYOUT","WALLET_PAYMENT","OTHER"],"x-enumDescriptions":{"REAL_TIME_GROSS_SETTLEMENT_SYSTEM":"Real-time gross settlement system","REAL_TIME_NET_SETTLEMENT_SYSTEM":"Real-time net settlement system","MASS_NET_PAYMENT_SYSTEM":"Mass net payment system","BOOK_TRANSFER":"Book transfer","CASH_PAYOUT":"Cash payout","WALLET_PAYMENT":"Wallet payment","OTHER":"Other"}},"user_info":{"type":"object","properties":{},"description":"Provide one or more arbitrary key/value pairs."},"sender_segregated_account":{"type":"string","example":"conct_php_receiver_coins_sender@receiver","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender owned account at receiver to be used for failure conversion (in case of payment failure)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]}]}]}]},"quote_limit":{"type":"integer","description":"Flag for truncating the total amount of quotes to a maximum amount after sorting and filters are applied."},"quote_filter_types":{"type":"array","description":"Filter on a type of quote.","items":{"type":"string","enum":["LIQUIDITY_WARNINGS","QUOTE_ERRORS"],"x-enumDescriptions":{"LIQUIDITY_WARNINGS":"Filter for liquidity warnings","QUOTE_ERRORS":"Filter for quote errors"}}}},"description":"JSON request object that represents an orchestration payment."}},"components/schemas/OrchestrationPaymentAcceptRequest":{"id":"components/schemas/OrchestrationPaymentAcceptRequest","kind":"json-schema","title":"OrchestrationPaymentAcceptRequest","data":{"type":"object","required":["sender_end_to_end_id","quote_id","user_info"],"properties":{"sender_end_to_end_id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9@_,:\\s-]*$","description":"Unique ID that the sender can specify.\n\nPersisted on all instances that participate in the payment.\n"},"internal_id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9@_,:\\s-]*$","description":"Internal ID that the sender can optionally specify. Only visible to the sender. Only the sending RippleNet instance stores this ID."},"quote_id":{"type":"string","format":"uuid","example":"5492648d-2132-4e70-9ded-2fc86f22b321","description":"ID of the quote to accept and continue as a payment."},"orchestration_template":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_-]*$","description":"Parameter for the orchestration template name.\n\nIf you don't provide a template, a default template will be picked.\n"},"user_info":{"type":"object","properties":{},"description":"provide one or more arbitrary key/value pairs."}},"description":"JSON request object that represents an orchestration payment accept request."}},"components/schemas/PaymentCustomRateRequest":{"id":"components/schemas/PaymentCustomRateRequest","kind":"json-schema","title":"PaymentCustomRateRequest","data":{"type":"object","required":["base_currency","counter_currency","rate","rate_type"],"properties":{"rate":{"type":"number","description":"Exchange rate for a base and counter currency."},"base_currency":{"type":"string","minLength":3,"maxLength":3,"description":"Base currency of the exchange rate."},"counter_currency":{"type":"string","minLength":3,"maxLength":3,"description":"Counter currency of the exchange rate."},"rate_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order type for the exchange rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sell"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"description":"Custom rate that the return payment quotes must use."}},"components/schemas/OrchestrationPaymentSubmitResponse":{"id":"components/schemas/OrchestrationPaymentSubmitResponse","kind":"json-schema","title":"OrchestrationPaymentSubmitResponse","data":{"type":"object","properties":{"sender_end_to_end_id":{"type":"string","example":"00310000015","description":"Sender end-to-end ID."}},"description":"JSON response object that represents an orchestration payment query ID."}},"components/schemas/OrchestrationPaymentResponse":{"id":"components/schemas/OrchestrationPaymentResponse","kind":"json-schema","title":"OrchestrationPaymentResponse","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"5492648d-2132-4e70-9ded-2fc86f22b321","description":"Unique Identifier of the orchestration payment."},"unique_reference_number":{"type":"string","example":"00310000015","description":"Unique reference number."},"sender_end_to_end_id":{"type":"string","example":"00310000015","description":"Sender end-to-end ID."},"payment_type":{"type":"string","description":"The payment type for the payment.","enum":["REGULAR","RETURN","REVERSAL"]},"connector_role":{"type":"string","description":"The connector role for payment.","enum":["SENDING","RECEIVING","INTERMEDIARY"]},"payment_id":{"type":"string","example":"26bf269b-1a2b-c3d4-872a-7f18d7dcf9f2","description":"Payment ID for the transaction in RippleNet."},"payment_status":{"type":"string","example":"SUCCESS","description":"Status of the payment."},"previous_payment_status":{"type":"string","example":"EXECUTED","description":"Previous status of the payment."},"orchestration_template":{"type":"string","example":"default_template","description":"Template name used for executing the orchestration payment."},"orchestration_status":{"type":"string","example":"RUNNING","description":"Status of the orchestration payment."},"current_activity":{"type":"string","example":"get_quote_v1","description":"Current activity which is being executed."},"current_activity_status":{"type":"string","example":"SUCCESS","description":"Status of the current activity."},"initial_context":{"type":"object","properties":{},"description":"Initial context for the orchestration payment."},"current_context":{"type":"object","properties":{},"description":"Current context of the orchestration payment."},"error_message":{"type":"object","properties":{},"description":"Error message in case of any error."},"activity_list":{"type":"object","properties":{},"description":"Activity list of the activities executed so far."},"created_at":{"type":"string","format":"date-time","example":"2018-04-06T20:33:35Z","description":"Date and time at which the orchestration payment was created, as an ISO-8601 timestamp in UTC."},"modified_at":{"type":"string","format":"date-time","example":"2018-04-06T20:33:35Z","description":"Date and time at which the orchestration payment was modified, as an ISO-8601 timestamp in UTC."}},"description":"JSON response object that represents an orchestration payment."}},"components/schemas/OrchestrationPayments":{"id":"components/schemas/OrchestrationPayments","kind":"json-schema","title":"OrchestrationPayments","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/OrchestrationPaymentResponse"}}}}]}},"components/schemas/OrchestrationPaymentReturnRequest":{"id":"components/schemas/OrchestrationPaymentReturnRequest","kind":"json-schema","title":"OrchestrationPaymentReturnRequest","data":{"type":"object","required":["sender_end_to_end_id","original_payment_id"],"properties":{"sender_end_to_end_id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9@_,:\\s-]*$","description":"Unique ID that the sender can specify."},"original_payment_id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9@_,:\\s-]*$","description":"Unique ID of the payment that should be returned."},"return_reasons":{"type":"object","description":"Provide one or more arbitrary key/value pairs.","properties":{}},"return_amount_type":{"type":"string","default":"TOTAL_RECEIVED","description":"Amount type of the return payment.\n","enum":["TOTAL_RECEIVED","TOTAL_RECEIVED_MINUS_FEES"],"x-enumDescriptions":{"TOTAL_RECEIVED":"Indicates that the sender of the return payment will send the amount they received","TOTAL_RECEIVED_MINUS_FEES":"Indicates that the sender of the return payment will send the amount they received minus the receiving fees"}},"custom_fee":{"type":"number","description":"Custom fee charged and collected by the sending account.\n\nSetting this field overrides all applicable fees configured on the sender's RippleNet instance.\n"},"custom_rate":{"$ref":"#/components/schemas/PaymentCustomRateRequest"},"force_path_finding_and_liquidity_path_finding":{"type":"boolean","example":false,"description":"When true, this flag tells RippleNet to ignore cached value for path finding and liquidity path finding.\n\nForces performing new path finding and liquidity path finding.\n","default":false},"user_info":{"type":"object","properties":{},"description":"Provide one or more arbitrary key/value pairs."}},"description":"Use this JSON request object to return a payment."}},"components/schemas/OrchestrationPaymentReversalRequest":{"id":"components/schemas/OrchestrationPaymentReversalRequest","kind":"json-schema","title":"OrchestrationPaymentReversalRequest","data":{"type":"object","required":["sender_end_to_end_id","original_payment_id","reversal_reason"],"properties":{"sender_end_to_end_id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9@_,:\\s-]*$","description":"Unique ID that the sender can specify."},"original_payment_id":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9@_,:\\s-]*$","description":"Unique ID of the payment that should be reversed."},"reversal_reason":{"$ref":"#/components/schemas/PaymentReversalReasonRos"}},"description":"Use this JSON request object to reverse a payment."}},"components/schemas/Reason":{"id":"components/schemas/Reason","kind":"json-schema","title":"Reason","data":{"type":"object","properties":{"type":{"type":"string","description":"Type of reason."},"code":{"type":"string","description":"Code for the reason."},"reason":{"type":"object","description":"Actual description the reason."}},"description":"Use this JSON request object for specifying reasons."}},"components/schemas/HealthDetails":{"id":"components/schemas/HealthDetails","kind":"json-schema","title":"HealthDetails","data":{"type":"object","required":["healthy"],"properties":{"healthy":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the ROS component is up and running. If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the ROS component is down."},"children":[]}]}]}]},"error":{"type":"string","description":"Contains the error details of the ROS components."}},"description":"Contains the details of the ROS components status."}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","properties":{"timestamp":{"type":"string","example":"2019-12-27T07:21:50.045000Z","description":"Timestamp of the request."},"exception":{"type":"string","example":"ActivityNotFoundException","description":"Exception name."},"message":{"type":"string","example":"Activity not found with name get_quote_v1.","description":"Response message."},"detailedMessage":{"type":"string","example":"getActivity.name must match \\\"^[a-zA-Z0-9_]*$\\","description":"Detailed message."},"code":{"type":"string","example":"getQuoteV1","description":"Response code."},"status":{"type":"string","example":404,"description":"HTTP response status."},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Reason"}}},"description":"JSON response object that comes in case of any error."}},"components/schemas/ActivityStatus":{"id":"components/schemas/ActivityStatus","kind":"json-schema","title":"ActivityStatus","data":{"type":"string","description":"Activity status","enum":["SUCCESS","FAILURE","DECLINED","REDO","SUBSTATE","NOTIFY","PENDING","SUBTASK"],"example":"SUBSTATE","x-enumDescriptions":{"SUCCESS":"Set status to success","FAILURE":"Set status to failure\n\nUse with the `error` field to provide additional information.\n","DECLINED":"Set status to declined\n\nUse with the `error` field to provide additional information.\n","REDO":"Set status to redo","SUBSTATE":"Set status to substate","NOTIFY":"Set status to notify","PENDING":"Set status to pending","SUBTASK":"Set status to subtask"}}},"components/schemas/ExternalOutQueueMessage":{"id":"components/schemas/ExternalOutQueueMessage","kind":"json-schema","title":"ExternalOutQueueMessage","data":{"type":"object","required":["output"],"properties":{"sender_end_to_end_id":{"type":"string","description":"Set to the sender end-to-end ID associated with the payment."},"payment_id":{"type":"string","description":"Payment ID."},"payment_status":{"type":"string","description":"RippleNet payment status."},"previous_payment_status":{"type":"string","description":"RippleNet previous payment status."},"connector_role":{"type":"string","description":"Connector role of the payment SENDING/RECEIVING."},"payment_type":{"type":"string","description":"Payment type REGULAR/RETURN."},"payout_method":{"type":"string","description":"Payout method."},"original_sender_end_to_end_id":{"type":"string","description":"Original sender end-to-end if the payment is marked as returned; otherwise, blank."},"output":{"type":"object","properties":{},"description":"Activity output in JSON fromat."}},"description":"Payload for external out queue."}},"components/schemas/NotificationList":{"id":"components/schemas/NotificationList","kind":"json-schema","title":"NotificationList","data":{"type":"array","items":{"$ref":"#/components/schemas/NotificationResponseRos"},"description":"List response of external notifications."}},"components/schemas/PaymentActionRequest":{"id":"components/schemas/PaymentActionRequest","kind":"json-schema","title":"PaymentActionRequest","data":{"type":"object","required":["unique_reference_number","status","notification_type"],"properties":{"unique_reference_number":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9@_,:\\s-]*$","description":"Set to the unique reference number associated with the payment.","example":"310000015"},"status":{"$ref":"#/components/schemas/ActivityStatus"},"notification_type":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-zA-Z0-9_:]*$","example":"PARTNER_SUBSTATE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activity context name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to define the action."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notification type"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRM_LOCK"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirm the lock"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRM_SETTLE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirm settlement"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRM_COMPLETE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirm completion"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTNER_SUBSTATE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notify on partner substate"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"output.sub_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to provide additional information."},"children":[]}]}]}]}]}]}]},"output":{"$ref":"#/components/schemas/ActivityOutput"},"error":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of one or more activity error objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILURE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use this to fail a payment or decline a request to lock a payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values, this property can be null."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ActivityError"},"example":"null"}}}},"components/schemas/ActivityOutput":{"id":"components/schemas/ActivityOutput","kind":"json-schema","title":"ActivityOutput","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this object when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTNER_SUBSTATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other values of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notification_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this property can be null."},"children":[]}]}]}],"properties":{"sub_state":{"type":"string","minLength":1,"maxLength":128,"example":"AMENDED","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-form string that describes a sub-state of the payment while it is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXECUTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FORWARDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWAITING_COLLECTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also displays as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the receiving node's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_info.executed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}]},"memo":{"type":"string","example":"Last name must be corrected","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-form details that describe the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the payment, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"with courier heading to payout location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the receiving node's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_info.executed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}]},"info":{"type":"object","properties":{},"description":"Provide one or more arbitrary key/value pairs.","example":{"last_name":"Gonzales"}}}}},"components/schemas/PaymentInternalActionRequest":{"id":"components/schemas/PaymentInternalActionRequest","kind":"json-schema","title":"PaymentInternalActionRequest","data":{"type":"object","required":["payment_id","payment_status"],"properties":{"payment_id":{"type":"string","format":"uuid","description":"Unique identifier of a payment."},"payment_status":{"$ref":"#/components/schemas/PaymentStatus","description":"Payment state."}},"description":"Payload for internal action request."}},"components/schemas/ActivityError":{"id":"components/schemas/ActivityError","kind":"json-schema","title":"ActivityError","data":{"type":"object","description":"Activity error object in JSON format.","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For recommended type values, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/resources/error-codes/returns-and-error-codes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns and failure codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For recommended failure codes, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/resources/error-codes/returns-and-error-codes/#812-failure-type-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns and failure codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"reason":{"type":"string","description":"The reason for the failure or lock decline."}}}},"components/schemas/PaymentStatus":{"id":"components/schemas/PaymentStatus","kind":"json-schema","title":"PaymentStatus","data":{"type":"string","description":"Payment status.","enum":["PENDING","QUOTED","ACCEPTED","LOCKED","LOCK_DECLINED","PREPARED","SETTLEMENT_DECLINED","EXECUTED","EXPIRED","FAILED","COMPLETED","RETURNED"]}},"components/schemas/PaymentActionResponse":{"id":"components/schemas/PaymentActionResponse","kind":"json-schema","title":"PaymentActionResponse","data":{"type":"object","properties":{"unique_reference_number":{"type":"string","example":"00310000015","description":"Unique Reference Number."}},"description":"JSON response object that represents a payment action query ID."}},"components/schemas/NotificationUUIDList":{"id":"components/schemas/NotificationUUIDList","kind":"json-schema","title":"NotificationUUIDList","data":{"type":"object","properties":{"uuids":{"type":"array","minItems":1,"items":{"type":"string","format":"uuid","example":"328b3e50-7983-46d5-94a0-ef004d78db1d"},"description":"List of orchestration payment notification UUIDs."}},"description":"JSON request object that represents a list of orchestration payment notification UUIDs to acknolwedge."}},"components/schemas/NotificationAckResponse":{"id":"components/schemas/NotificationAckResponse","kind":"json-schema","title":"NotificationAckResponse","data":{"type":"object","properties":{"notification_ack_list":{"type":"array","items":{"$ref":"#/components/schemas/NotificationResponseRos"},"description":"List of responses of acknowledged orchestration payment notifications."},"invalid_uuid_list":{"type":"array","items":{"type":"string","format":"uuid","example":"328b3e50-7983-46d5-94a0-ef004d78db1d","description":"Invalid notification UUIDs."}}},"description":"Orchestration payment notification acknoledge response."}},"components/schemas/CallbackMessage":{"id":"components/schemas/CallbackMessage","kind":"json-schema","title":"CallbackMessage","data":{"type":"object","properties":{"msg_id":{"type":"string","format":"uuid","example":"5492648d-2132-4e70-9ded-2fc86f22b321","description":"Message ID of the callback notification."}},"description":"JSON request object that represents a callback notification."}},"components/schemas/InfoResponse":{"id":"components/schemas/InfoResponse","kind":"json-schema","title":"InfoResponse","data":{"type":"object","properties":{"name":{"type":"string","example":"Integration Module","description":"Application name."},"version":{"type":"string","example":"1.2.0","description":"Application version."}},"description":"JSON response object that represents application info."}},"components/schemas/TenantRequest":{"id":"components/schemas/TenantRequest","kind":"json-schema","title":"TenantRequest","data":{"type":"object","description":"JSON request object that represents a tenant request.","required":["tenant_id","xcurrent_url"],"properties":{"tenant_id":{"type":"string","example":"urn:ripplexcurrent-prod:name","description":"Tenant ID of the tenant."},"callback_enabled":{"type":"boolean","example":false,"default":false,"description":"Flag to denote whether callback is enabled for this tenant."},"callback_url":{"type":"string","minLength":1,"maxLength":256,"pattern":"^(http[s]?:\\/\\/)[\\w@%.\\\\+~#=-]{2,256}(:[0-9]{2,5})?(\\/[\\w-]*)*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to be invoked for callback for this tenant. Mandatory if callback_enabled is true."},"children":[]}]}]}]},"xcurrent_client_id":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[a-zA-Z0-9@_,.\\s-]*$","description":"Client ID for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally."},"xcurrent_password":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[a-zA-Z0-9@_,.\\s-]*$","description":"Password for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally."},"xcurrent_connection_timeout":{"type":"integer","default":10000,"format":"int32","description":"Timeout, in milliseconds, to obtain a connection with RippleNet for this tenant."},"xcurrent_socket_timeout":{"type":"integer","default":60000,"format":"int32","description":"Timeout, in milliseconds, to obtain a response for a RippleNet API operation for this tenant."},"xcurrent_url":{"type":"string","minLength":1,"maxLength":256,"pattern":"^(http[s]?:\\/\\/)[\\w@%.\\\\+~#=-]{2,256}(:[0-9]{2,5})?(\\/[\\w-]*)*","description":"URL of the RippleNet (RN node) system to which orchestration service connects."}}}},"components/schemas/TenantUpdateRequest":{"id":"components/schemas/TenantUpdateRequest","kind":"json-schema","title":"TenantUpdateRequest","data":{"type":"object","description":"JSON request object that represents a tenant update request.","properties":{"callback_enabled":{"type":"boolean","example":false,"default":false,"description":"Flag to denote whether callback is enabled for this tenant."},"callback_url":{"type":"string","minLength":1,"maxLength":256,"pattern":"^(http[s]?:\\/\\/)[\\w@%.\\\\+~#=-]{2,256}(:[0-9]{2,5})?(\\/[\\w-]*)*","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to be invoked for callback for this tenant. Mandatory if callback_enabled is true."},"children":[]}]}]}]},"xcurrent_connection_timeout":{"type":"integer","format":"int32","description":"Timeout, in milliseconds, to obtain a connection with RippleNet for this tenant."},"xcurrent_socket_timeout":{"type":"integer","format":"int32","description":"Timeout, in milliseconds, to obtain a response for a RippleNet API operation for this tenant."},"xcurrent_url":{"type":"string","minLength":1,"maxLength":256,"pattern":"^(http[s]?:\\/\\/)[\\w@%.\\\\+~#=-]{2,256}(:[0-9]{2,5})?(\\/[\\w-]*)*","description":"URL of the RippleNet (RN node) system to which orchestration service connects."}}}},"components/schemas/TenantResponse":{"id":"components/schemas/TenantResponse","kind":"json-schema","title":"TenantResponse","data":{"type":"object","description":"JSON request object that represents a tenant response.","properties":{"tenant_id":{"type":"string","example":"urn:ripplexcurrent-prod:name","description":"Tenant ID of the tenant."},"callback_enabled":{"type":"boolean","example":false,"description":"Flag to denote whether callback is enabled for this tenant."},"callback_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to be invoked for callback for this tenant. Mandatory if callback_enabled is true."},"children":[]}]}]}]},"xcurrent_client_id":{"type":"string","description":"Client ID for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally."},"xcurrent_password":{"type":"string","description":"Password for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally."},"xcurrent_connection_timeout":{"type":"integer","description":"Timeout, in milliseconds, to obtain a connection with RippleNet for this tenant."},"xcurrent_socket_timeout":{"type":"integer","description":"Timeout, in milliseconds, to obtain a response for a RippleNet API operation for this tenant."},"xcurrent_url":{"type":"string","description":"URL of the RippleNet (RN node) system to which orchestration service connects."}}}},"components/schemas/Tenants":{"id":"components/schemas/Tenants","kind":"json-schema","title":"Tenants","data":{"allOf":[{"$ref":"#/components/schemas/Page"},{"properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/TenantResponse"}}}}]}},"components/schemas/NotificationResponseRos":{"id":"components/schemas/NotificationResponseRos","kind":"json-schema","title":"NotificationResponseRos","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"5492648d-2132-4e70-9ded-2fc86f22b321","description":"Unique Identifier of the orchestration payment notification."},"notification_type":{"type":"string","example":"PAYMENT_SUCCESS","description":"Type of the orchestration payment notification."},"notification_version":{"type":"string","example":1,"description":"Version of the orchestration payment notification."},"notification_status":{"type":"string","enum":["NEW","SENT","ACK"],"description":"Orchestration payment notification status."},"notification_payload":{"type":"object","properties":{},"description":"Orchestration payment notification payload."},"created_at":{"type":"string","format":"date-time","example":"2018-04-06T20:33:35Z","description":"Date and time at which the message was created, as an ISO-8601 timestamp in UTC."},"modified_at":{"type":"string","format":"date-time","example":"2018-04-06T20:33:35Z","description":"Date and time at which the message was modified, as an ISO-8601 timestamp in UTC."}},"description":"JSON request object that represents an orchestration payment notification."}},"components/schemas/PaymentQuoteRequestRos":{"id":"components/schemas/PaymentQuoteRequestRos","kind":"json-schema","title":"PaymentQuoteRequestRos","data":{"type":"object","required":["amount","currency","quote_type","receiving_address","sending_address"],"properties":{"sending_address":{"type":"string","minLength":1,"maxLength":256,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiving_address":{"type":"string","minLength":1,"maxLength":256,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the receiver, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"amount":{"type":"string","minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to be sent or received, depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the value to be sent by the payment originator. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the amount (to debit the originator) is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus any fees to be collected by the sending institution."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVER_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the value to be received by the payment beneficiary. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the amount (to credit the beneficiary) is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minus any fees to be collected by the receiving institution."},"children":[]}]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code of the amount to be sent or received, depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is the currency of the amount to be sent. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVER_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is the currency of the amount to be received."},"children":[]}]}]}]},"quote_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how to calculate the quote. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a quote based on the amount the payment originator or originating institution wants to send, set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" respectively. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the amount (to debit the originator) is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus any fees to be collected by the sending institution."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a quote based on the amount the payment beneficiary or beneficiary institution should receive, set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVER_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" respectively. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the amount (to credit the beneficiary) is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minus any fees to be collected by the receiving institution."},"children":[]}]}]}]}],"enum":["SENDER_AMOUNT","RECEIVER_AMOUNT","SENDER_INSTITUTION_AMOUNT","RECEIVER_INSTITUTION_AMOUNT"]},"sender_or_receiver_currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code of the sender or receiver based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If provided, you can use this to filter the options for quotes."},"children":[]}]}]}],"example":"USD"},"custom_fee":{"type":"number","description":"Custom fee for the sending account. Setting this field overrides all fees configured on the sender's RippleNet instance."},"custom_rate":{"description":"Custom rate that quotes must use. The request returns only quotes that are able to provide this custom rate.","$ref":"#/components/schemas/PaymentQuoteCustomRateRequest"},"quote_route":{"type":"array","example":["rn.us.ca.san_francisco","rn.us.tx.austin","rn.us.ny.new_york"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom route that quotes must follow. Provide an array of RippleNet addresse strings ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"g.us.ca.san_francisco"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for example) that convey the route the quotes must follow."},"children":[]}]}]}],"items":{"type":"string"}},"payment_method":{"type":"string","pattern":"^[a-zA-Z0-9@_,:\\s-]*$","minLength":2,"maxLength":32,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Senders can use this field to manually define the payout method that the receiver should use to deliver the payment to end customer. On-Demand Liquidity (ODL) receivers should set "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment_method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outlet_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or \"none\" (to keep funds at the destination exchange) when paying out to a local rail."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Caution:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The existing quote parameter is named "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment_method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while elsewhere it is "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payout_method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"enable_quote_per_payout_method":{"type":"boolean","description":"Enable this flag to generate quotes using payout methods configured by the receiver.","example":false},"digital_asset_origination":{"type":"boolean","description":"When true, this flag tells RippleNet to provide a full quote as if the payment originates in the specified source fiat currency. The quote for the source exchange excludes trading fees. On execution, the source exchange trade is skipped, and XRP is withdrawn from the source exchange as the first step.","example":false},"force_path_finding_and_liquidity_path_finding":{"type":"boolean","example":false,"description":"When true, this flag tells RippleNet to ignore cached value for path finding and liquidity path finding and perform new path finding and liquidity path finding.","default":false},"payout_method_category":{"type":"string","example":"BOOK_TRANSFER","description":"Category the above payout method will be associated with.","enum":["REAL_TIME_GROSS_SETTLEMENT_SYSTEM","REAL_TIME_NET_SETTLEMENT_SYSTEM","MASS_NET_PAYMENT_SYSTEM","BOOK_TRANSFER","CASH_PAYOUT","WALLET_PAYMENT","OTHER"]},"sender_segregated_account":{"type":"string","example":"conct_php_receiver_coins_sender@receiver","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender owned account at receiver to be used for failure conversion (in case of payment failure) in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"quote_limit":{"type":"integer","description":"Flag for truncating the total amount of quotes to a maximum amount after sorting and filters are applied. Optional."},"quote_filter_types":{"type":"array","items":{"type":"string","enum":["LIQUIDITY_WARNINGS","QUOTE_ERRORS"]}}},"description":"JSON request object to generate a quote collection."}},"components/schemas/QuoteCollectionRos":{"id":"components/schemas/QuoteCollectionRos","kind":"json-schema","title":"QuoteCollectionRos","data":{"type":"object","required":["quote_collection_id","quotes"],"properties":{"quote_collection_id":{"type":"string","format":"uuid","example":"480e3a6f-3bcd-48cd-9ce9-9d940aa3c9c6","description":"Unique identifier of the quote collection."},"quotes":{"type":"array","items":{"$ref":"#/components/schemas/QuoteRos"}},"quote_errors":{"type":"array","items":{"$ref":"#/components/schemas/QuoteError"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided as a response to the [Create Quote Collection][] request, provides a JSON object representing quotes for a proposed payment. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided as a response to the [Return Payment][] request, provides a JSON object representing quotes for a proposed return payment."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided as a response to the [Get Quote Collection by ID][] request, provides the requested quote collection."},"children":[]}]}]}]}],"x-docs-model-object":{"object-name":"Quote Collection Object","nested-objects-array":[{"property-name":"quotes","object":"quote","docs-name":"Quote Object","data-type":"Array","has-nested-display":true}]}}},"components/schemas/QuotePathRos":{"id":"components/schemas/QuotePathRos","kind":"json-schema","title":"QuotePathRos","data":{"type":"object","required":["source","destination","source_currency","destination_currency"],"properties":{"source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the source account, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"destination":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the destination account, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source_currency":{"type":"string","description":"Currency associated with the source account."},"destination_currency":{"type":"string","description":"Currency associated with the destination account."},"account_liquidity_relationship_id":{"type":"string","format":"uuid","example":"480e3a6f-3bcd-48cd-9ce9-9d940aa3c9c6","description":"Unique identifier for an account liquidity relationship."},"peer_liquidity_relationship_id":{"type":"string","format":"uuid","example":"480e3a6f-3bcd-48cd-9ce9-9d940aa3c9c6","description":"Unique identifier for a peer liquidity relationship."}},"description":"Object that describes a liquidity path used to generate a quote.","x-docs-model-object":{"object-name":"Quote Path Object"}}},"components/schemas/QuoteRos":{"id":"components/schemas/QuoteRos","kind":"json-schema","title":"QuoteRos","data":{"type":"object","required":["amount","created_at","currency_code","currency_code_filter","expires_at","liquidity_warning","price_guarantee","quote_elements","quote_id","receiver_address","sender_address","service_type","type"],"properties":{"quote_id":{"type":"string","format":"uuid","example":"480e3a6f-3bcd-48cd-9ce9-9d940aa3c9c6","description":"Unique identifier for the quote."},"created_at":{"type":"string","format":"date-time","example":"2018-04-06T20:33:35Z","description":"Date and time at which the quote was created, as an ISO-8601 timestamp in UTC."},"expires_at":{"type":"string","format":"date-time","example":"2019-04-06T20:33:35Z","description":"Date and time after which the quote and its pricing expire, as an ISO-8601 timestamp in UTC. Defaults to 300s/300000ms."},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates how the amount field should be treated for calculating quote values. Valid values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVER_INSTITUTION_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECEIVER_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["SENDER_AMOUNT","RECEIVER_AMOUNT","SENDER_INSTITUTION_AMOUNT","RECEIVER_INSTITUTION_AMOUNT"]},"price_guarantee":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether a quote's pricing is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INDICATIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIRM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INDICATIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" quote allows for price movements between quote issuance and payment execution, such that the quoted amount and delivered amount may differ. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIRM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" quote ensures that the quoted and delivered payment amounts are equal. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIRM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"sender_address":{"type":"string","example":"new_york@rn.us.ny.new_york","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiver_address":{"type":"string","example":"new_york@rn.us.ny.new_york","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the receiver, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"amount":{"type":"string","example":"100","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to be sent or received, depending on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"currency_code":{"type":"string","example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}]},"currency_code_filter":{"type":"string","example":"EUR","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code that can be used to filter quotes at the opposite end of the quote request. For example, you can filter by this currency code to find the receiving currency for a quote with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SENDER_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" quote_type. If not sent in the request, this field value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"service_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"quote_elements":{"type":"array","description":"Transfer and exchange elements. A transfer element represents a movement of funds between two accounts. An exchange element represents the exchange of currencies between two accounts.","items":{"$ref":"#/components/schemas/QuoteElementRos"}},"liquidity_warning":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when a quote causes an account to go below its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimum_allowed_balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, this field value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"payment_method":{"type":"string","description":"Payment method (payment outlet) to use for this quote."}},"description":"JSON response object that represents a quote for a proposed payment or return payment."}},"components/schemas/QuoteElementRos":{"id":"components/schemas/QuoteElementRos","kind":"json-schema","title":"QuoteElementRos","data":{"type":"object","required":["quote_element_id","quote_element_order","quote_element_type","receiver_address","receiving_amount","receiving_fee","sender_address","sending_amount","sending_fee"],"properties":{"quote_element_id":{"type":"string","format":"uuid","example":"480e3a6f-3bcd-48cd-9ce9-9d940aa3c9c6","description":"Unique identifier for the quote element."},"quote_element_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of quote element. Valid values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE_TRADE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRYPTO_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the movement of funds between two accounts."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the exchange of currencies between two accounts."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE_TRADE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the exchange of fiat to digital currency on a digital exchange."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRYPTO_TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the movement of digital funds between two digital exchanges."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"p","attrs":{}},"children":[]}]}]}],"enum":["TRANSFER","EXCHANGE","EXCHANGE_TRADE","CRYPTO_TRANSFER"]},"quote_element_order":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order of each quote element along the liquidity path. If a quote includes five quote elements, each one is enacted according to its quote_element_order number to make the proposed payment."},"children":[]}]}]}]},"sender_address":{"type":"string","example":"new_york@rn.us.ny.new_york","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the sender, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiver_address":{"type":"string","example":"new_york@rn.us.ny.new_york","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RippleNet account name and address of the receiver, in the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountname@ripplenetaddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new_york@rn.us.ny.new_york"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"sending_amount":{"type":"number","example":100,"description":"Amount the sender is sending."},"receiving_amount":{"type":"number","example":97,"description":"Amount the receiver is receiving."},"sending_fee":{"type":"number","example":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fees the sender is charging. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_element_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field value is always set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiving_fee":{"type":"number","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fees the receiver is charging. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_element_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field value is always set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"sending_currency_code":{"type":"string","example":"USD","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code of the sending amount. Included in quote elements with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_element_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"receiving_currency_code":{"type":"string","example":"INR","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code of the receiving amount. Included in quote elements with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_element_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fx_rate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange rate details. Included in quote elements with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_element_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCHANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/FXRate"},"transfer_currency_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency code of the transfer. Included in quote elements with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quote_element_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"description":"JSON object that provides transfer and exchange elements used to provide the quote. A transfer element represents the transfer of currency between two accounts. An exchange element represents the exchange of currencies between two accounts."}},"components/schemas/PaymentReversalReasonRos":{"id":"components/schemas/PaymentReversalReasonRos","kind":"json-schema","title":"PaymentReversalReasonRos","data":{"type":"object","required":["code"],"properties":{"code":{"type":"string","example":"RB001","description":"The code indicating the reason for payment reversal.","enum":["RB001","RB002","RB003","RB004","RB005","RB008","RB009","RB010","RB011","RB012","RB013","RB017","RB018","RB023","RB024","RB026","RB027","RB028","RB029","RB030","RB031","RB032","RB033","RB034","RB035","RB036","RB037","AC01","AC03","AC04","AC06","AC08","AC09","AC11","AC12","AC13","AC14","AC15","AG01","AG02","AG03","AG05","AG06","AM02","AM03","AM04","AM11","AM13","AM14","AM15","AM21","AM22","BE01","BE04","BE05","BE06","BE07","BE08","BE09","BE10","BE11","BE12","BE13","BE14","BE15","BE16","BE17","BE18","BE19","BE20","BE21","BE22","CERI","CH11","CH12","CH13","CH14","CH21","CNOR","CUST","DS24","DU05","DUPL","ED06","FF03","FF04","FF05","FF06","FF07","FF08","FF10","MD06","MD07","MS02","MS03","NARR","RC01","RC02","RC04","RC05","RC07","RC08","RC10","RC12","RF01","RR01","RR02","RR03","RR04","RR05","RR06","RR07","RR10","SL03"],"x-enumDescriptions":{"RB001":"The account number structure is valid but the account number does not correspond to the individual identified in the payment. <br /><br />This error typically occurs because the Originator specified the Beneficiary's account number incorrectly while initiating the payment.<br/><br/><b>Error handling</b><br/>The Sending Member may introduce prompts in the user interface during payment initiation to ensure that the Originator validates the Beneficiary's account number.","RB002":"The Sender has requested Receiver for return of the payment.<br /><br />This error typically occurs in business scenarios where the Originator contacts the Sending Member to indicate that they (the Originator) provided incorrect account information.<br/><br/><b>Error handling</b><br/>The Sending Member must contact the Receiving Member and obtain agreement that the payment should be returned. After obtaining agreement, the Receiving Member can initiate the return of the payment.","RB003":"The funds for the payment have not been collected by the Beneficiary within the set period.<br/><br/><b>Error handling</b><br/>The Originator must inform the Beneficiary that they should collect the funds within the prescribed time frame. <br /><br />The Receiving Member may also contact the Beneficiary to inform them of pending or uncollected funds. <br />Further, the Receiving Member must ensure that the Sending Member includes the Beneficiary's contact information in the RippleNet Payment Object.","RB004":"Beneficiary's account is frozen due to specific action taken by the Receiver or by legal action. <br /><br /> This error typically occurs when the Beneficiary's bank has frozen the account due to suspected misuse, or on the Beneficiary's request.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account information or to agree on an alternative payment mechanism.","RB005":"The Receiver has returned the payment due to one of the following reasons: <br /><br /><ul><li>The exact amount required has not been remitted. </li><li>Acceptance of the transaction results in an overpayment.</li></ul><br/><br/><b>Error handling</b><br/>In case of a technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not transfer the incorrect amount. <br /><br />The Beneficiary may contact the Originator and ask them to initiate a payment for the exact amount.","RB008":"Invalid account title or name prefix. <br /><br />This error typically occurs when the Beneficiary's title or name specified in the payment does not match the information associated with their account.<br/><br/><b>Error handling</b><br/>In case of a technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not provide the incorrect Beneficiary title or name. <br /><br />If the Beneficiary provided incorrect information, the Originator may contact the Beneficiary to obtain the correct information.","RB009":"Beneficiary's account is dormant. <br /><br />This error typically occurs because the Beneficiary's Bank has marked the account as dormant due to a lack of activity or financial transactions on the account.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account information or to agree upon a different payment mechanism.","RB010":"The minimum amount required has not been remitted. <br /><br />This error typically occurs because the Originator has initiated payment for an amount that is lower than the intended amount that they previously agreed upon with the Beneficiary.<br/><br/><b>Error handling</b><br/>In case of technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not specify incorrect amounts.","RB011":"The account is subject to litigation. <br /><br />This error typically occurs because the Beneficiary's Bank has frozen the account due to legal reasons, or under suspicion of misuse, or on the Beneficiary's request.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account information or to agree upon a different payment mechanism.","RB012":"The Originator is not known to the Recipient or Beneficiary.<br/><br/><b>Error handling</b><br/>In case of technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not initiate payments to unknown or unintended Beneficiary accounts.","RB013":"The Receiver has not authorized this credit entry to the Beneficiary's account. <br /><br />This error typically occurs because the Beneficiary's Bank has blocked the account due to legal reasons.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account information or to agree upon a different payment mechanism.","RB017":"Government or National ID of the individual identified in the payment is not mapped to the account number. <br /><br />This error typically occurs when the payment cannot be booked to the Beneficiary's account because their Government or National ID is not linked with their account.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary to agree upon a different payment mechanism.","RB018":"Customer insolvent or other reason.","RB023":"Beneficiary account name does not match Beneficiary account number.<br/><br/><b>Error handling</b><br/>In case of technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not specify incorrect Beneficiary name.<br /><br /> If the account name was invalid, the Originator may contact the Beneficiary for correct information.","RB024":"Account is not in currency quoted.<br/><br/><b>Error handling</b><br/>In case of technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not specify incorrect account currency information.<br /><br /> The Originator may request the Beneficiary to provide accurate information about their account currency.","RB026":"Beneficiary account number closed.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account information.","RB027":"Beneficiary does not support or accept this message or payment type.<br/><br/><b>Error handling</b><br/>In case of technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not specify the wrong payment type.<br /><br />The Beneficiary may request the Originator to re-initiate the payment with a supported payment type.","RB028":"Payment was not processed as Receiver is unavailable or offline. <br /><br />This error typically occurs when the RippleNet connection to and from the Receiving Member or Intermediary Bank is unavailable due to network issues.<br/><br/><b>Error handling</b><br/>The Sending Member may request the Originator to reissue the RippleNet payment at a later time.","RB029":"Invalid payment type. The payment type used is not allowed or enabled for this Bank.<br/><br/><b>Error handling</b><br/>In case of technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not specify the wrong payment type.<br /><br />The Beneficiary may request the Originator to re-initiate the payment with a valid payment type.","RB030":"Card is blocked, or lost, or hotlisted. <br /><br /> This error typically occurs if the Beneficiary Bank has blocked the card account due to reported theft or other legal issues.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account details.","RB031":"Card is expired.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account details.","RB032":"Invalid card number. <br /><br />This error typically occurs either because the Originator entered an invalid card number while initiating the payment, or because the Beneficiary provided an invalid card number to the Originator.<br/><br/><b>Error handling</b><br/>In case of a technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not supply an invalid or incomplete card number. <br /><br />If the Beneficiary provided an incorrect card number, the Originator may contact the Beneficiary for the correct number.","RB033":"Transactions to the card are restricted. <br /><br /> This error typically occurs because the Beneficiary Bank has restricted financial transactions on the card due to legal reasons or reports of fraudulent usage.<br/><br/><b>Error handling</b><br/>The Originator may request the Beneficiary to provide alternative account information.","RB034":"Beneficiary has exceeded the number of transactions allowed for a set time period. <br /><br /> This error typically occurs due to failed velocity or fraud checks conducted by the Receiving Member.","RB035":"Beneficiary has exceeded the cumulative transaction amount allowed for a set time period. <br /><br /> This error typically occurs due to failed velocity or fraud checks conducted by the Receiving Member.<br/><br/><b>Error handling</b><br/>N/A","RB036":"Originator has exceeded the number of transactions allowed for a set time period. <br /><br /> This error typically occurs due to failed velocity or fraud checks conducted by the Receiving Member.<br/><br/><b>Error handling</b><br/>N/A","RB037":"Originator has exceeded the cumulative transaction amount allowed for a set time period. <br /><br /> This error typically occurs due to failed velocity or fraud checks conducted by the Receiving Member.<br/><br/><b>Error handling</b><br/>N/A","AC01":"Account number is invalid or missing.","AC03":"Creditor account number invalid or missing.<br/><br/><b>Error handling</b><br/>If the account number or IBAN is invalid, the Sending Member may repair the transaction by specifying a valid Creditor account number.<br /><br />If the account number is missing from the payment message, the Originator may reissue the payment with the Creditor account number or IBAN included.","AC04":"Account number specified has been closed on the Receiver's books.<br />The Beneficiary may have closed their account since the last time the Originator made a payment transfer to this Beneficiary.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for their new account number.","AC06":"Account specified is blocked, prohibiting posting of transactions against it. <br />The Account Servicer may have frozen the account for legal reasons, or on the Beneficiary's request.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account details.","AC08":"Branch code is invalid or missing.<br/><br/><b>Error handling</b><br/>If the branch code is invalid, the Sending Member may repair the transaction by specifying the complete branch code.<br /><br />If the branch code is missing, the Originator may reissue the payment with the correct branch code included.","AC09":"Account currency is invalid or missing.<br /> This error is likely caused by a technical or human error. This error may also occur if the Beneficiary provided incorrect information to the Originator.<br/><br/><b>Error handling</b><br/>In case of a technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not specify invalid account currency information. <br /><br />If the Beneficiary provided incorrect account information, the Originator may contact the Beneficiary for accurate information.","AC11":"Creditor account currency is invalid or missing.<br/><br/><b>Error handling</b><br/>If the account currency information is invalid, the Sending Member may repair the transaction by specifying a valid Beneficiary account currency.<br /><br /> If the account currency information is missing, the Originator may reissue the payment with the Beneficiary account currency specified.","AC12":"Account type missing or invalid. Generic usage if cannot specify between group and payment information levels.","AC13":"Debtor account type missing or invalid.<br/><br/><b>Error handling</b><br/>If the account type information is invalid, the Sending Member may repair the transaction by specifying the correct Originator account type.<br /><br /> If the account type information is missing, the Originator may reissue the payment with the Originator account type specified.","AC14":"Creditor account type missing or invalid.<br/><br/><b>Error handling</b><br/>If the account type information is invalid, the Sending Member may repair the transaction by specifying the correct Beneficiary account type.<br /><br /> If the account type information is missing, the Originator may reissue the payment with the Beneficiary account type specified.","AC15":"The account details for the counterparty have changed.","AG01":"Transaction forbidden on this type of account (formerly NoAgreement).<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for details of an alternative account that can receive the transaction.","AG02":"Bank Operation code specified in the message is not valid for receiver.<br/><br/><b>Error handling</b><br/>If the bank code information is invalid, the Sending Member may repair the transaction by specifying the correct code.<br /><br /> If the bank code information is missing, the Originator may reissue the payment with the bank code specified.","AG03":"Transaction type not supported/authorized on this account.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary to agree on a different payment instrument.","AG05":"Debtor agent country code is missing or invalid.<br/><br/><b>Error handling</b><br/>If the country code information is invalid, the Sending Member may repair the transaction by specifying the correct Sender Agent country code.<br /><br /> If the country code information is missing, the Originator may reissue the payment with the Sender Agent country code specified.","AG06":"Creditor agent country code is missing or invalid.<br/><br/><b>Error handling</b><br/>If the country code information is invalid, the Sending Member may repair the transaction by specifying the correct Beneficiary Agent country code.<br /><br /> If the country code information is missing, the Originator may reissue the payment with the Beneficiary Agent country code specified.","AM02":"Specific transaction/message amount is greater than allowed maximum.<br/><br/><b>Error handling</b><br/>The Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not transfer incorrect amounts.","AM03":"Specified message amount is a non-processable currency outside of existing agreement.<br/><br/><b>Error handling</b><br/>The Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not initiate payments in unsupported currency.","AM04":"Amount of funds available to cover specified message amount is insufficient. <br /><br />This error may occur due to the following reasons:<ul><li>The Originator's account does not have sufficient funds to debit the full amount of the payment.</li><li>There are insufficient funds in the Sending/Originating Bank's nostro settlement account at the Local Clearing/Receiver/Beneficiary bank to process the payment. </li></ul><br/><br/><b>Error handling</b><br/>If the Originator's account previously had insufficient funds, the Sending Member may reissue the payment after the Originator ensures that their account contains the funds required to process the payment.<br /><br />If the Sending/Originating Bank's nostro settlement account previously had insufficient funds, they can reissue the payment after ensuring that their settlement account contains sufficient funds to process the payment.","AM11":"Transaction currency information is invalid or missing.","AM13":"Transaction amount exceeds limits set by clearing system.<br/><br/><b>Error handling</b><br/>The Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not transfer incorrect amounts.","AM14":"Transaction amount exceeds limits agreed between bank and client.<br/><br/><b>Error handling</b><br/>The Beneficiary may request the Originator to initiate a payment whose transaction amount is within the agreed limits. Further, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not transfer incorrect amounts.","AM15":"Transaction amount below minimum set by clearing system.<br/><br/><b>Error handling</b><br/>The Beneficiary may request the Originator to initiate a payment whose transaction amount is within the agreed limits. Further, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not transfer incorrect amounts.","AM21":"Transaction amount exceeds limits agreed between bank and client.","AM22":"Unable to apply zero amount to designated account. For example, where the rules of a service allow the use of zero amount payments, however the back-office system is unable to apply the funds to the account. If the rules of a service prohibit the use of zero amount payments, then code AM01 is used to report the error condition.","BE01":"Identification of end customer is not consistent with associated account number (formerly CreditorConsistency). <br />This error typically occurs because the Originator entered an incorrect Beneficiary account number while initiating the payment.<br/><br/><b>Error handling</b><br/>The Sending Member may introduce additional prompts in the user interface during payment initiation to ensure that the Originator verifies the Beneficiary's account number.","BE04":"Specification of creditor's address, which is required for payment, is missing/not correct (formerly IncorrectCreditorAddress).<br/><br/><b>Error handling</b><br/>If the Beneficiary address is invalid, the Sending Member may repair the transaction by providing the correct Beneficiary address. <br /><br />If the Beneficiary address is missing, the Originator may reissue the payment with the Beneficiary address specified.","BE05":"Party who initiated the message is not recognized by the end customer.","BE06":"End customer specified is not known at associated Sort/National Bank Code or does no longer exist in the books.","BE07":"Specification of debtor's address, which is required for payment, is missing/not correct.<br/><br/><b>Error handling</b><br/>If the Originator's address is invalid, the Sending Member may repair the transaction by providing the correct Originator address. <br /><br /> If the Originator's address is missing, the Originator may reissue the payment with their address specified.","BE08":"Debtor name is missing.<br/><br/><b>Error handling</b><br/>If the Originator's name is invalid, the Sending Member may repair the transaction by providing the correct Originator name. <br /><br /> If the Originator's name is missing, the Originator may reissue the payment with their name specified.","BE09":"Country code is missing or Invalid. Generic usage if cannot specifically identify debtor or creditor.","BE10":"Debtor country code is missing or invalid.<br/><br/><b>Error handling</b><br/>If the Originator's country code is invalid, the Sending Member may repair the transaction by providing the correct Originator country code. <br /><br /> If the Originator's country code is missing, the Originator may reissue the payment with the country code specified.","BE11":"Creditor country code is missing or invalid.<br/><br/><b>Error handling</b><br/>If the Beneficiary's country code is invalid, the Sending Member may repair the transaction by providing the correct Beneficiary country code. <br /><br /> If the Beneficiary's country code is missing, the Originator may reissue the payment with the Beneficiary country code specified.","BE12":"Country code of residence is missing or Invalid. This generic error code should be used only if the relevant party is not clearly identifiable or specified.","BE13":"Country code of debtor's residence is missing or Invalid.<br/><br/><b>Error handling</b><br/>If the country code for Originator's country of residence is invalid, the Sending Member may repair the transaction by providing the correct country code.<br /><br /> If the country code for Originator's country of residence is missing, the Originator may reissue the payment with the country code specified.","BE14":"Country code of creditor's residence is missing or Invalid.<br/><br/><b>Error handling</b><br/>If the country code for Beneficiary's country of residence is invalid, the Sending Member may repair the transaction by providing the correct country code.<br /><br /> If the country code for Beneficiary's country of residence is missing, the Originator may reissue the payment with the Beneficiary country code specified.","BE15":"Identification code missing or invalid. Generic usage if cannot specifically identify debtor or creditor.","BE16":"Debtor or Ultimate Debtor identification code missing or invalid.<br/><br/><b>Error handling</b><br/>If the Originator's identification code is invalid, the Sending Member may repair the transaction by providing the correct identification code. <br /><br />If the Originator's identification code is missing, the Originator may reissue the payment with the identification code specified.","BE17":"Creditor or Ultimate Creditor identification code missing or invalid.<br/><br/><b>Error handling</b><br/>If the Beneficiary's identification code is invalid, the Sending Member may repair the transaction by providing the correct identification code. <br /><br />If the Beneficiary's identification code is missing, the Originator may reissue the payment with the Beneficiary identification code specified.","BE18":"Contact details missing or invalid.<br/><br/><b>Error handling</b><br/>If the contact details are invalid, the Sending Member may repair the transaction by providing the correct contact details.<br /><br /> If the contact details are missing, the Originator may reissue the payment with the contact details specified.","BE19":"Charge bearer code for transaction type is invalid.<br/><br/><b>Error handling</b><br/>If the charge bearer code is invalid, the Sending Member may repair the transaction by providing the correct charge bearer code.<br /><br /> If the charge bearer code is missing, the Originator may reissue the payment with the charge bearer code specified.","BE20":"Name length exceeds local rules for payment type.","BE21":"Name missing or invalid. Generic usage if cannot specifically identify debtor or creditor.","BE22":"Creditor name is missing.<br/><br/><b>Error handling</b><br/>If the Beneficiary's name is invalid, the Sending Member may repair the transaction by providing the correct Beneficiary name. <br /><br />If the Beneficiary's name is missing, the Originator may reissue the payment with the Beneficiary's name specified.","CERI":"Credit transfer is not tagged as an Extended Remittance Information (ERI) transaction but contains ERI.","CH11":"Value in Creditor Identifier is incorrect.","CH12":"Creditor Identifier is ambiguous at Transaction Level.","CH13":"Original Debtor Account is not to be used.","CH14":"Original Debtor Agent is not to be used.","CH21":"Mandatory element is missing.","CNOR":"Creditor bank is not registered under this BIC in the CSM.","CUST":"Cancellation requested by the Debtor.","DS24":"Waiting time expired due to incomplete order.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary and ask them to take the actions necessary to receive funds. <br /><br />If the payment is resubmitted, a new reference ID must be used.","DU05":"Instruction ID is not unique. <br /><br />This error typically occurs when the Sending Member submits a transaction with an Instruction ID that matches a previous transaction's Instruction ID.<br/><br/><b>Error handling</b><br/>The Sending Member must resubmit the transaction with a unique Instruction ID. <br /><br />The following measures may also be considered:<ul><li>Sending and Receiving Members agree on the criteria to identify duplicate payments, and the window within which Intermediaries or Receiving Members will check for duplicate payments.</li><li>The Sending Member may implement checks to avoid submitting duplicate payments.</li><li>If a duplicate payment occurs, the Sending Member may resubmit the payment with new reference information within the duplication window. If the window expires, the Sending Member may initiate a new payment.</li></ul>","DUPL":"Payment is a duplicate of another payment. <br /><br />This error typically occurs when the Sending Member submits a transaction with reference information that matches a previous transaction's reference information.<br/><br/><b>Error handling</b><br/>The Sending Member must resubmit the transaction with unique reference information. <br /><br />The following measures may also be considered:<ul><li>Sending and Receiving Members agree on the criteria to identify duplicate payments, and the window within which Intermediaries or Receiving Members will check for duplicate payments.</li><li>The Sending Member may implement checks to avoid submitting duplicate payments.</li><li>If a duplicate payment occurs, the Sending Member may resubmit the payment with new reference information within the duplication window. If the window expires, the Sending Member may initiate a new payment.</li></ul>","ED06":"Interbank settlement system not available. <br /><br />This error typically occurs when the connecting infrastructure of the local clearing rail at the Receiving Member is unavailable to process or transmit any payment messages.<br/><br/><b>Error handling</b><br/>The Sending Member may recommend that the Originator reissue the RippleNet payment at a later time.<br /><br />The Originator may contact the Beneficiary to determine an alternative solution to make the payment.","FF03":"Payment Type Information is missing or invalid. This generic error code should be used only if Service Level or Local Instrument code are not specified.<br/><br/><b>Error handling</b><br/>If the payment type information is invalid, the Sending Member may repair the transaction by providing the correct payment type information.<br /><br />If the payment type information is missing, the Originator may reissue the payment with the payment type information specified.","FF04":"Service Level code is missing or invalid.<br/><br/><b>Error handling</b><br/>If the service level code is invalid, the Sending Member may repair the transaction by providing the correct code.<br /><br />If the service level code is missing, the Originator may reissue the payment with the code specified.","FF05":"Local Instrument code is missing or invalid.<br/><br/><b>Error handling</b><br/>If the local instrument code is invalid, the Sending Member may repair the transaction by providing the correct code.<br /><br />If the local instrument code is missing, the Originator may reissue the payment with the code specified.","FF06":"Category Purpose code is missing or invalid.<br/><br/><b>Error handling</b><br/>If the category purpose code is invalid, the Sending Member may repair the transaction by providing the correct code.<br /><br />If the category purpose code is missing, the Originator may reissue the payment with the code specified.","FF07":"Purpose of payment is missing or invalid.<br/><br/><b>Error handling</b><br/>If the purpose of payment information is invalid, the Sending Member may repair the transaction by providing the correct information.<br /><br />If the purpose of payment information is missing, the Originator may reissue the payment with the purpose of payment specified.","FF08":"End to End Id missing or invalid.<br/><br/><b>Error handling</b><br/>If the end-to-end ID is invalid, the Sending Member may repair the transaction by providing the correct ID. <br /><br /> If the end-to-end ID is missing, the Originator may reissue the payment with the ID specified.","FF10":"File or transaction cannot be processed due to technical issues at the bank side.<br/><br/><b>Error handling</b><br/>The Sending Member may recommend that the Originator reissue the RippleNet payment at a later time.<br /><br />The Originator may contact the Beneficiary to determine an alternative solution to make the payment.","MD06":"Return of funds requested by end customer.","MD07":"End customer is deceased.","MS02":"Reason has not been specified by end customer.","MS03":"Reason has not been specified by agent.","NARR":"Reason is provided as narrative information in the additional reason information.","RC01":"Bank identifier code specified in the message has an incorrect format (formerly IncorrectFormatForRoutingCode).","RC02":"Bank identifier is invalid or missing. Generic usage if cannot specify between debit or credit account.","RC04":"Creditor bank identifier is invalid or missing.<br/><br/><b>Error handling</b><br/>If the Creditor Bank identifier is invalid, the Sending Member may repair the transaction by providing the correct identifier. <br /><br />If the Creditor Bank identifier is missing, the Originator may reissue the payment with the identifier specified.","RC05":"BIC identifier is invalid or missing. This generic error code should be used only if the relevant party is not clearly identifiable or specified.<br/><br/><b>Error handling</b><br/>If the BIC is invalid, the Sending Member may repair the transaction by providing the correct identifier. <br /><br />If the BIC is missing, the Originator may reissue the payment with the BIC identifier specified.","RC07":"Creditor BIC identifier is invalid or missing.<br/><br/><b>Error handling</b><br/>If the Beneficiary's BIC identifier is invalid, the Sending Member may repair the transaction by providing the correct BIC identifier.<br /><br /> If the Beneficiary's BIC identifier is missing, the Originator may reissue the payment with the BIC identifier specified.","RC08":"ClearingSystemMember identifier is invalid or missing. Generic usage if cannot specify between debit or credit account.","RC10":"Creditor ClearingSystemMember identifier is invalid or missing.<br/><br/><b>Error handling</b><br/>If the Beneficiary's ClearingSystemMember identifier is invalid, the Sending Member may repair the transaction by providing the correct identifier.<br /><br /> If the Beneficiary's ClearingSystemMember identifier is missing, the Originator may reissue the payment with the identifier specified.","RC12":"Creditor Scheme Id is invalid or missing.","RF01":"Transaction reference is not unique within the message.","RR01":"Specification of the debtor's account or unique identification needed for reasons of regulatory requirements is insufficient or missing.","RR02":"Specification of the debtor's name and/or address needed for regulatory requirements is insufficient or missing.","RR03":"Specification of the creditor's name and/or address needed for regulatory requirements is insufficient or missing.<br/><br/><b>Error handling</b><br/>If the Beneficiary's name and/or address information is invalid, the Sending Member may repair the transaction by providing the correct information.<br /><br /> If the Beneficiary's name and/or address information is missing, the Originator may reissue the payment with the Beneficiary's information specified.","RR04":"Regulatory Reason. This error typically occurs when there is a restriction due to Anti-Money Laundering (AML), embargo, or compliance reasons.<br/><br/><b>Error handling</b><br/>The Originator may contact the Sending Member to enquire about the reasons for the error and take remedial action as they see fit.","RR05":"Regulatory or Central Bank Reporting information missing, incomplete or invalid.<br/><br/><b>Error handling</b><br/>In case of a technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not supply invalid or incomplete information. <br /><br />If the Beneficiary provided incorrect information, the Originator may contact the Beneficiary for accurate information.","RR06":"Tax information missing, incomplete or invalid.","RR07":"Remittance information structure does not comply with rules for payment type.","RR10":"Character set supplied not valid for the country and payment type.<br/><br/><b>Error handling</b><br/>In case of a technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not supply an invalid character set. <br /><br />If the Beneficiary provided incorrect information, the Originator may contact the Beneficiary for accurate information.","SL03":"Due to a specific service offered by the clearing system."}},"description":{"type":"string","example":"No account / Unable to locate account","description":"User-defined string describing the reason for payment reversal."}},"description":"A structured object detailing reasons for a payment reversal."}},"components/schemas/HealthRos":{"id":"components/schemas/HealthRos","kind":"json-schema","title":"HealthRos","data":{"type":"object","required":["healthy"],"properties":{"healthy":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the ROS server is up and running. If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the ROS server is down."},"children":[]}]}]}]},"details":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HealthDetails"},"description":"Contains the details of the ros components status."}},"description":"Provides a high-level status of the health of the ROS server."}},"components/schemas/PageRos":{"id":"components/schemas/PageRos","kind":"json-schema","title":"PageRos","data":{"type":"object","properties":{"first":{"type":"boolean","description":"true if  this is the first page."},"last":{"type":"boolean","description":"true if  this is the last page."},"number":{"type":"integer","description":"Page number."},"numberOfElements":{"type":"integer","description":"Number Of elements in this request."},"size":{"type":"integer","description":"Page size."},"totalElements":{"type":"integer","description":"Total number of elements for the given request.","format":"int64"},"totalPages":{"type":"integer","description":"Total number of pages for the given request."}},"description":"Paginated response base object."}},"schema_0":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"number"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","enum":["EQUAL_TO","GREATER_THAN","LESS_THAN","BETWEEN"],"default":"EQUAL_TO"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"string","enum":["ACCOUNT_NAME","CURRENCY","BALANCE","LAST_MODIFIED_DATE"],"default":"LAST_MODIFIED_DATE"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","enum":["ASC","DESC"],"default":"ASC"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"integer","default":0},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":10},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"string","enum":["INFO","WARN","ERROR"]},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"string","enum":["USER_MANAGEMENT","CONFIG_MANAGEMENT","OTHER"]},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/EventTrailEvent"}},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AccountLookupStatus"},"default":["REQUESTED"]},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"string","enum":["CREATED_DATE","LAST_MODIFIED_DATE"],"default":"LAST_MODIFIED_DATE"},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":20},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"integer","default":10},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string","enum":["SENDING_AMOUNT","RECEIVING_AMOUNT"]},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"number","minimum":0},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"string","default":"MODIFIED_AT"},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"string","default":"DESC"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","format":"uuid"}},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/NodeStatus"}},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"string","enum":["CREATED","DELIVERED","READ","DELETED"],"default":"DELIVERED"},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"string","enum":["ALL","ERROR","INFO","WARN"],"default":"ALL"},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"string","enum":["CREATED_DTTM","MODIFIED_DTTM"],"default":"CREATED_DTTM"},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"string","enum":["CREATED_AT","MODIFIED_AT"],"default":"MODIFIED_AT"},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"string","enum":["INITIAL","RUNNING","COMPLETED","PAUSED","FAILURE","DECLINED","RETRY"]},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"string","format":"String","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9@_,:\\s-]*$"},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"string","enum":["NEW","SENT"]},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"integer","default":30},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"string","format":"string"},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"array","description":"List of all active RippleNet platforms.","items":{"$ref":"#/components/schemas/PlatformResponse"}},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"array","description":"List of all pool accounts.","items":{"$ref":"#/components/schemas/PoolAccountResponse"}},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Quote"}},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"string","enum":["REQUESTED","ACCEPTED","FAILED"]},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"string","enum":["CREATED_AT","MODIFIED_AT"]},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"string","enum":["ASC","DESC"],"default":"DESC"},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SSAConfigResponse"}},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"string","enum":["PREPARED","EXECUTED","COMPLETED","FAILED","PENDING"]},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"string","enum":["ASC","DESC"]},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"string","enum":["SENDING","RECEIVING"]},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"string","pattern":"^[^\\s]+@[^\\s]+$"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"string","format":"string","maxLength":64},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"string","format":"String","maxLength":64},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"string","format":"String","minLength":3,"maxLength":3},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"string","format":"String","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z0-9_]*$"},"id":"schema_49"}},"exampleStore":{},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations require a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of each request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/payments-odl/api-docs/ripplenet/best-practices/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"in":"header","paramName":"Authorization"}},"servers":[{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","isMockServer":true,"description":"Mock server"},{"url":"//[domainPrefix].ripplexcurrent.com/v4"}],"specType":"openapi"},"options":{"codeSamples":{"languages":[{"lang":"curl"},{"lang":"Python"}]},"schemasExpansionLevel":3,"hideSchemaTitles":true,"hidePropertiesPrefix":true,"hideDownloadButtons":true,"mockServer":{"url":"/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/ripplenet.json?download"},{"url":"/_bundle/@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/ripplenet.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"RippleNet Server API","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` |"}},"baseSlug":"/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet","routesMapping":{}}