{"templateId":"markdown","versions":[{"version":"v2026.04","label":"v2026.04","link":"/products/payments-direct-2/user-interface/guides/generate-api-credentials","default":true,"active":true,"folderId":"eb16255d"},{"version":"v2026.03","label":"v2026.03","link":"/products/payments-direct-2/v2026.03/user-interface/guides/generate-api-credentials","default":false,"active":false,"folderId":"eb16255d"},{"version":"v2025.11","label":"v2025.11","link":"/products/payments-direct-2/v2025.11/user-interface/guides/generate-api-credentials","default":false,"active":false,"folderId":"eb16255d"}],"sharedDataIds":{"sidebar":"sidebar-products/payments-direct-2/@v2025.11/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Generate and rotate API credentials","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"generate-and-rotate-api-credentials","__idx":0},"children":["Generate and rotate API credentials"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this guide to generate a client ID and secret for API access, rotate credentials when needed, and manage your organization's API credentials in the ","Payments Direct"," interface."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You must have the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Credentials: Can Edit"]}," permission."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your organization can hold a maximum of 3 API credentials at a time."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"generate-a-new-api-credential","__idx":2},"children":["Generate a new API credential"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the left navigation, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Credentials"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New Credential"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your organization already has 3 credentials, the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New Credential"]}," button is disabled. Delete an existing credential before creating a new one."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enter a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Credential name"]}," to identify the credential in the list."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save & Generate Key"]},"."]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A dialog appears showing the credential details:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Audience"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The API audience value for your environment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Client ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The unique identifier for this credential."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Secret"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The generated secret key."]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Save your secret now"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The secret is displayed only once. After you close this dialog, it cannot be retrieved. Copy the secret and store it in a secure location before closing."]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":6},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Copy the Client ID and secret, then select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Close"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"rotate-an-api-credential","__idx":3},"children":["Rotate an API credential"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Rotate a credential to generate a new secret while keeping the same Client ID. Use this when a secret is compromised or as part of a regular credential rotation schedule."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the left navigation, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Credentials"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["On the credential card you want to rotate, select the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["..."]}," action menu."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Rotate Credential"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the confirmation dialog, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Rotate Credential"]}," to confirm."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A dialog appears showing the rotated credential's new secret."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Save your new secret now"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The new secret is displayed only once. The previous secret is immediately invalidated. Copy and store the new secret before closing."]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":6},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Copy the new secret, then select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Close"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Update any API clients or integrations using the old secret to use the new one."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"rename-a-credential","__idx":4},"children":["Rename a credential"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["On the credential card you want to rename, select the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["..."]}," action menu."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Edit"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Update the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Credential name"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delete-a-credential","__idx":5},"children":["Delete a credential"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can delete non-primary credentials that are no longer needed."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Primary credential"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The primary credential cannot be deleted. To remove it, you must first designate a different credential as primary, or contact your Ripple representative."]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["On the credential card you want to delete, select the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["..."]}," action menu."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Delete"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the confirmation dialog, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Delete"]}," to confirm."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The credential is permanently removed. Any API clients using the deleted credential will immediately lose access."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-to-do-next","__idx":6},"children":["What to do next"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the Client ID and secret to authenticate API requests. For instructions, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/payments-direct-2/api-docs/developer-guides/request-an-access-token"},"children":["Request an access token"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If you need to control which IP addresses can use the API, see your Ripple representative for network-level access controls."]}]}]},"headings":[{"value":"Generate and rotate API credentials","id":"generate-and-rotate-api-credentials","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Generate a new API credential","id":"generate-a-new-api-credential","depth":2},{"value":"Rotate an API credential","id":"rotate-an-api-credential","depth":2},{"value":"Rename a credential","id":"rename-a-credential","depth":2},{"value":"Delete a credential","id":"delete-a-credential","depth":2},{"value":"What to do next","id":"what-to-do-next","depth":2}],"frontmatter":{"title":"Generate and rotate API credentials","seo":{"title":"Generate and rotate API credentials"}},"lastModified":"2026-05-27T18:08:00.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/payments-direct-2/user-interface/guides/generate-api-credentials","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}