{"templateId":"openapi_docs","versions":[{"version":"v2026.03","label":"v2026.03","link":"/products/payments-direct-2/api-docs/payments-direct-api/payments-direct-2-api","default":true,"active":true,"folderId":"eb16255d"},{"version":"v2025.11","label":"v2025.11","link":"/products/payments-direct-2/v2025.11/api-docs/payments-direct-api/payments-direct-2-api","default":false,"active":false,"folderId":"eb16255d"}],"sharedDataIds":{"openAPIDocsStore":"oas-products/payments-direct-2/@v2026.03/api-docs/payments-direct-api/payments-direct-2-api.yml","sidebar":"sidebar-products/payments-direct-2/@v2025.11/sidebars.yaml"},"props":{"definitionId":"products/payments-direct-2/@v2026.03/api-docs/payments-direct-api/payments-direct-2-api.yml","dynamicMarkdocComponents":[],"baseSlug":"/products/payments-direct-2/api-docs/payments-direct-api/payments-direct-2-api","seo":{"title":"Payments Direct API","siteUrl":"https://docs.ripple.com/products/custody","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"Payments Direct API","description":"Use the Payments Direct API to get quotes, create and manage payments, and manage originator and beneficiary identities.\n\n## API environments\n\nThe Payments Direct API offers the following environments:\n\n| <div style=\"width:90px\">Environment</div>  | Base URL                      | Description                               |\n| ------------------------------------------ | ----------------------------- | ----------------------------------------- |\n| UAT                                       | `https://api.test.ripple.com` | UAT environment with simulated currency. |\n| Production                                 | `https://api.ripple.com`      | Production environment                    |\n\n## API authentication\n\nAll {% $env.PUBLIC_VAR_RPD %} API operations require a Bearer access token specific to the environment you're using. Ripple provides a secure model for authentication and authorization by providing access tokens scoped for a set of credentials.\n\n### Generate client ID and client secret\n\nYou will need your _client ID_ and _client secret_ to obtain an access token.\n\nIf you do not already have your client ID and client secret, do the following:\n\n1. Log into the Ripple Payments UI.\n2. In the left navigation menu, click **Settings**.\n3. Under **Administration**, click **API Credentials**.\n4. In the dropdown list next to the page title, select the access environment. For example, to provision credentials for the test environment, select **UAT** from the dropdown list.\n5. In the upper right corner of the page, click **New Credential**.\n6. Click **Save and Generate Key**.\n\n**Caution:** The *client secret* is displayed only once when you are creating new credentials. You cannot retrieve the secret after exiting this page. Copy and store the client secret securely and share it with authorized individuals in accordance with your organization's security policy.\n\nYou can now use the client ID and client secret to generate access tokens using the [Request an access token](/products/payments-direct-2/api-docs/payments-direct-api/payments-direct-2-api/authentication/authenticate) operation.\n\n### Request an access token\n\nTo get an access token, use the [Request an access token](/products/payments-direct-2/api-docs/payments-direct-api/payments-direct-2-api/authentication/authenticate) operation with your `client_id` and `client_secret`. The response contains a token in the `access_token` field.\n\nWe recommend rotating your API credentials at regular intervals according to your organization's security policy.\n\n**Note**: Authentication tokens are not a fixed length and can vary, avoid validating tokens based on character length.\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"ripple-product-docs.redocly.app","port":4000,"ipAddress":"216.73.216.152"},"lang":"default_locale","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":"Ripple Payments Direct","PUBLIC_VAR_SL":"Smart Liquidation","PUBLIC_VAR_SLAPI":"Smart Liquidation API","PUBLIC_VAR_CUS":"Ripple Custody","PUBLIC_VAR_RPO":"RippleNet Payment Object","PUBLIC_VAR_RNH":"Ripple Payments 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_UI":"Ripple Stablecoin UI"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/products/payments-direct-2/api-docs/payments-direct-api/payments-direct-2-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}