Getting started

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

• Tooling
• User creation
• API credentials
• Postman collection
• Test identities

Tooling

To prepare for integrating with the Ripple Payments API:

• Install Postman (as an alternative, curl examples are provided in documentation)
• Set up a password manager for API keys.
• Allowlist your IPs and set up a proxy.
• Confirm with your Ripple liaison that your test receiver 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 , then click Users .
3. Click the New User button.
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 .

Postman collection

Contact your Ripple liaison to get a Postman collection of Ripple Payments API calls.

Get test identities

If you are developing your integration for a third-party payment use case contact your Ripple liaison to get the originator identity token for testing purposes.