{"templateId":"markdown","versions":[{"version":"v2026.03","label":"v2026.03","link":"/products/payments-direct-2/api-docs/getting-started","default":true,"active":true,"folderId":"eb16255d"},{"version":"v2025.11","label":"v2025.11","link":"/products/payments-direct-2/v2025.11/api-docs/getting-started","default":false,"active":false,"folderId":"eb16255d"}],"sharedDataIds":{"sidebar":"sidebar-products/payments-direct-2/@v2025.11/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Getting started","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com/products/custody","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":"getting-started","__idx":0},"children":["Getting started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you start the process of integrating with the Ripple Payments Direct 2.0 API, you need to address the following items:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"#github-repository"},"children":["GitHub Repository"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"#tooling"},"children":["Tooling"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"#user-creation"},"children":["User creation"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"#api-credentials"},"children":["API credentials"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"github-repository","__idx":1},"children":["GitHub repository"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The official ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://github.com/ripple/payments-direct"},"children":["Payments Direct 2.0 GitHub repository"]}," is the single source of truth for everything you need to integrate with ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Payments Direct 2.0 API v2026.03"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://github.com/ripple/payments-direct/blob/v2026.03/openapi_spec/rpd2_spec.yml"},"children":["OpenAPI Specification:"]}]}," The canonical definition of the Payments Direct 2.0 API."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://github.com/ripple/payments-direct/tree/v2026.03/sdks"},"children":["SDKs:"]}]}," Client libraries in multiple languages, available in the repository and through standard package managers."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://github.com/ripple/payments-direct/tree/v2026.03/examples"},"children":["Examples:"]}]}," End-to-end sample code for common payment flows (create a quote, submit a payment, check status)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://github.com/ripple/payments-direct/tags"},"children":["Releases:"]}]}," Tagged versions that align the spec, SDKs, and examples with specific API releases."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the repository ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://github.com/ripple/payments-direct/blob/v2026.03/README.md"},"children":["README"]}," for installation instructions and usage examples."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"tooling","__idx":2},"children":["Tooling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To prepare for integrating with the Ripple Payments Direct 2.0 API:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Install ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://www.postman.com/downloads/"},"children":["Postman"]}," (as an alternative, ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://curl.se"},"children":["curl"]}," examples are provided in documentation)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use Postman to generate a collection from the Payments Direct 2.0 API specification. For guidance on how to do this, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://learning.postman.com/docs/design-apis/specifications/generate-collections/"},"children":["Generate collections from you API specification"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set up a password manager for API keys."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Confirm with your Ripple liaison that your test instance is ready."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"user-creation","__idx":3},"children":["User creation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To set up accounts for developers, your organization administrator must:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Access the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://home.ripple.com/"},"children":["Ripple Payments UI"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Navigate to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings"]}," and then select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Users"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New User"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Check ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Can Read"]}," API Credentials permission."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Check ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Can Edit"]}," API Credentials permission."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Save the user and repeat the process for each developer on the team."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-credentials","__idx":4},"children":["API credentials"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To set up API credentials, each developer must:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Access the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://home.ripple.com/"},"children":["Ripple Payments UI"]},", click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings"]},", and then click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Credentials"]}," in the Integration section."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New Credential"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter a name for your new credential."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save & Generate Key"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Copy the credential and store it in a secure location to use for API calls."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To finish credential creation, click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Close"]},"."]}]}]},"headings":[{"value":"Getting started","id":"getting-started","depth":1},{"value":"GitHub repository","id":"github-repository","depth":2},{"value":"Tooling","id":"tooling","depth":2},{"value":"User creation","id":"user-creation","depth":2},{"value":"API credentials","id":"api-credentials","depth":2}],"frontmatter":{"seo":{"title":"Getting started"}},"lastModified":"2026-03-11T21:13:28.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/payments-direct-2/api-docs/getting-started","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}