Getting started

Before you start the process of integrating with the Ripple Payments Direct 2.0 API, you need to address the following items:

GitHub repository

The official Payments Direct 2.0 GitHub repository is the single source of truth for everything you need to integrate with Payments Direct 2.0:

  • OpenAPI Specification: The canonical definition of the Payments Direct 2.0 API.
  • SDKs: Client libraries in multiple languages, available in the repository and through standard package managers.
  • Examples: End-to-end sample code for common payment flows (create a quote, submit a payment, check status).
  • Releases: Tagged versions that align the spec, SDKs, and examples with specific API releases.

See the repository README for installation instructions and usage examples.

Tooling

To prepare for integrating with the Ripple Payments Direct 2.0 API:

  • Install Postman (as an alternative, curl examples are provided in documentation).
  • Use Postman to generate a collection from the Payments Direct 2.0 API specification. For guidance on how to do this, see Generate collections from you API specification .
  • Set up a password manager for API keys.
  • Confirm with your Ripple liaison that your test instance is ready.

User creation

To set up accounts for developers, your organization administrator must:

  1. Access the Ripple Payments UI .
  2. Navigate to Settings and then select Users .
  3. Select New User .
  4. Check Can Read API Credentials permission.
  5. Check Can Edit API Credentials permission.
  6. Save the user and repeat the process for each developer on the team.

API credentials

To set up API credentials, each developer must:

  1. Access the Ripple Payments UI , click Settings , and then click API Credentials in the Integration section.
  2. Click New Credential .
  3. Enter a name for your new credential.
  4. Click Save & Generate Key .
  5. Copy the credential and store it in a secure location to use for API calls.
  6. To finish credential creation, click Close .