# 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](#github-repository)
- [Tooling](#tooling)
- [User creation](#user-creation)
- [API credentials](#api-credentials)


## GitHub repository

The official [Payments Direct 2.0 GitHub repository](https://github.com/ripple/payments-direct) is the single source of truth for everything you need to integrate with **Payments Direct 2.0 API v2025.11**:

* **[OpenAPI Specification:](https://github.com/ripple/payments-direct/blob/v2025.11/openapi_spec/rpd2_spec.yml)** The canonical definition of the Payments Direct 2.0 API.
* **[SDKs:](https://github.com/ripple/payments-direct/tree/v2025.11/sdks)** Client libraries in multiple languages, available in the repository and through standard package managers.
* **[Examples:](https://github.com/ripple/payments-direct/tree/v2025.11/examples)** End-to-end sample code for common payment flows (create a quote, submit a payment, check status).
* **[Releases:](https://github.com/ripple/payments-direct/tags)** Tagged versions that align the spec, SDKs, and examples with specific API releases.


See the repository [README](https://github.com/ripple/payments-direct/blob/v2025.11/README.md) for installation instructions and usage examples.

## Tooling

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

- Install [Postman](https://www.postman.com/downloads/) (as an alternative, [curl](https://curl.se) 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](https://learning.postman.com/docs/design-apis/specifications/generate-collections/).
- 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](https://home.ripple.com/).
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](https://home.ripple.com/), 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**.