{"templateId":"api_docs","sharedDataIds":{"apiDocsStore":"api-docs-@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/reference/openapi.yaml","sidebar":"sidebar-@l10n/pt-BR/products/payments-odl/sidebars.yaml"},"props":{"definitionId":"@l10n/pt-BR/products/payments-odl/api-docs/ripplenet/reference/openapi.yaml","settings":{"baseUrlPath":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi"},"disableAutoScroll":true,"seo":{"title":"RippleNet Server API","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US"},"dynamicMarkdocComponents":[],"metadata":{"type":"openapi","title":"RippleNet Server API","version":"4.0.0","description":"The {% $env.PUBLIC_VAR_RNSERVER %} API provides you the ability to develop custom applications to manage or interact with your RippleNet instance.\n\nCheck out the [best practices](../../ripplenet/best-practices/) and [tutorials](../../ripplenet/tutorials/).\n\n### Authentication\n\nAll API operations require a bearer access token for your target environment.<br>Learn how to [request the access token](../best-practices/authentication/#request-the-access-token).\n\n### API environments\n\nThe RippleNet Server API creates a dynamic `[domainPrefix]` that consists of `{tenant}.{environment}`.\n\n**Note**: This example uses `aperture` as the tenant. Your tenant ID is different.\n\n| Environment  | Domaing Prefix | Domain | Base URL |\n| --- | --- | --- | --- |\n| Test | `aperture.test` | `ripplexcurrent.com`| `https://aperture.test.ripplexcurrent.com` |\n| UAT | `aperture.uat` | `ripplexcurrent.com`| `https://aperture.uat.ripplexcurrent.com` |\n| Production | `aperture.prod` | `ripplexcurrent.com`| `https://aperture.prod.ripplexcurrent.com` |"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.ripple.com","port":4000,"ipAddress":"216.73.217.37"},"lang":"pt-BR","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main-enterprise-product-docs","PUBLIC_VAR_LQH":"Liquidity Hub","PUBLIC_VAR_LQHUI":"Liquidity Hub UI","PUBLIC_VAR_ODL":"On-Demand Liquidity","PUBLIC_VAR_RN":"RippleNet","PUBLIC_VAR_RNC":"RippleNet Cloud","PUBLIC_VAR_RNSERVER":"RippleNet Server","PUBLIC_VAR_ROSAPINAME":"RippleNet Orchestration","PUBLIC_VAR_RPD":"Payments Direct","PUBLIC_VAR_SL":"Smart Liquidation","PUBLIC_VAR_SLAPI":"Smart Liquidation API","PUBLIC_VAR_CUS":"Ripple Custody","PUBLIC_VAR_CUSVAULTDEP":"Vault Deployer","PUBLIC_VAR_RPO":"RippleNet Payment Object","PUBLIC_VAR_RNH":"Payments Direct UI","PUBLIC_VAR_RPODL":"Ripple Payments ODL","PUBLIC_VAR_RP":"Ripple Payments","PUBLIC_VAR_RNAPI":"RippleNet Server API","PUBLIC_VAR_RIPPLE_USD":"Ripple USD","PUBLIC_VAR_RLUSD":"RLUSD","PUBLIC_VAR_RS":"Ripple Stablecoin","PUBLIC_VAR_RS_PLATFORM":"Ripple Mint","PUBLIC_VAR_RS_UI":"Ripple Mint UI","PUBLIC_VAR_RS_API":"Ripple Mint API"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}