{"templateId":"markdown","versions":[{"version":"v2026.04","label":"v2026.04","link":"/pt-br/products/payments-direct-2/user-interface/settings/api-credentials","default":true,"active":false,"folderId":"7e5507fe"},{"version":"v2026.03","label":"v2026.03","link":"/pt-br/products/payments-direct-2/v2026.03/user-interface/settings/api-credentials","default":false,"active":true,"folderId":"7e5507fe"},{"version":"v2025.11","label":"v2025.11","link":"/pt-br/products/payments-direct-2/v2025.11/user-interface/settings/api-credentials","default":false,"active":false,"folderId":"7e5507fe"}],"sharedDataIds":{"sidebar":"sidebar-@l10n/pt-BR/products/payments-direct-2/@v2025.11/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"API credentials","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-credentials","__idx":0},"children":["API credentials"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ","Ripple Payments","  API calls require Bearer authentication tokens that you retrieve from the authentication operation using API credentials. This topic explains how to create and rotate an API credential."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"../../images/ripplenet-home/api-credentials.png","alt":"API Credentials page"},"children":[]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each environment can have up to three credentials."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your user needs to have permissions to view and edit API credentials.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," To check your ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["API Credentials"]}," permissions, select ",{"$$mdtype":"Tag","name":"img","attributes":{"src":"../../images/ripplenet-home/user-profile-icon.png","alt":"User profile icon"},"children":[]}," > ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Profile"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-new-credential","__idx":2},"children":["Create new credential"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["To create an API credential"]}," consisting of a client ID and client secret (credential):"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Log in to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://home.ripple.com"},"children":["Ripple Payments"]}," as described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/payments-direct-2/v2026.03/user-interface/guides/sign-in-to-your-ripple-account"},"children":["Sign in to your Ripple account"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On the top right of the page, click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings"]}," gear icon."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Under ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Integration"]},", select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Credentials"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On the top right of the page, next to the ",{"$$mdtype":"Tag","name":"img","attributes":{"src":"../../images/ripplenet-home/question-mark-icon.png","alt":"Question mark"},"children":[]}," icon, select the access environment for which you want to create API credentials. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"For example, to provision credentials for the UAT environment, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["UAT"]}," from the dropdown list."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New Credential"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Credential name"]}," field, enter a name for the credential."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"../../images/ripplenet-home/api-credential-new.png","alt":"API credential dialog box"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save & Generate Key"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ","Payments Direct UI"," presents a dialog box with the client ID and audience that you’ll use with the credential, together with the credential itself."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Security"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The credential is displayed only once and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["you won’t be able to view it again after exiting the page"]},". Copy and store the client secret (credential) securely and share it with authorized individuals in accordance with your organization's security policy."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"../../images/ripplenet-home/api-credential-details.png","alt":"API credential details"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To finish credential creation, click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Close."]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can now use the client ID and client secret to generate access tokens using the authentication operation. For more information, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/pt-br/products/payments-direct-2/v2026.03/api-docs/get-started/authentication#fetch-an-access-token"},"children":["Authentication"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We recommend rotating your API credentials at regular intervals in accordance with your organization's security policy."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"rotate-credential","__idx":3},"children":["Rotate credential"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Rotating credentials is the process of changing your password and replacing your cryptographic key for accessing RippleNet."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["To rotate your RippleNet credential:"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Rotate Credential"]}," from the dropdown menu in the credential card and confirm your choice."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"../../images/ripplenet-home/api-credential-rotate.png","alt":"API credential details"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":2},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Rotate Credential"]}," button to confirm."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"../../images/ripplenet-home/api-credential-rotate-dialog.png","alt":"API credential details"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":3},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Once again, copy the credential and store it in a secure location because you won’t be able to view it later."]}]}]},"headings":[{"value":"API credentials","id":"api-credentials","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Create new credential","id":"create-new-credential","depth":2},{"value":"Rotate credential","id":"rotate-credential","depth":2}],"frontmatter":{"seo":{"title":"API credentials"}},"lastModified":"2026-10-21T03:05:03.818Z","pagePropGetterError":{"message":"","name":""}},"slug":"/pt-br/products/payments-direct-2/v2026.03/user-interface/settings/api-credentials","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}