Authentication API
The Authentication API allows you to generate access tokens to authenticate with Ripple APIs.
All API operations require an access token specific to the environment you're using. Ripple provides a secure model for authentication and authorization by providing access tokens scoped for a set of credentials.
The Authentication operation returns an access token in the access_token response field. You must include your client_id and client_secret in the JSON request body to get a valid access token.
You will need your client ID and client secret to obtain an access token.
If you do not already have your client ID and client secret, do the following:
- Log into Ripple Payments UI.
- In the left navigation menu, click Settings.
- Under Administration, click API Credentials.
- In the dropdown list next to the page title, select the access environment. For example, to provision credentials for the test environment, select Test from the dropdown list.
- In the upper right corner of the page, click New Credential.
- Click Save and Generate Key.
Caution: The client secret is displayed only once when you are creating new credentials. You cannot retrieve the secret after exiting this page. Copy and store the client secret securely and share it with authorized individuals in accordance with your organization's security policy.
You can now use the client ID and client secret to generate access tokens using the Authentication operation.
We recommend rotating your API credentials at regular intervals according to your organization's security policy.
Once you have your client ID and client secret, follow these steps to get an access token to use with Ripple Payments Direct API calls:
The first step to request an access token is to determine the environment where you want to use the API.
The following table describes the different environments that provide Ripple Payments Direct API access. Take note of the environment string for the environment you want to access.
| Environment | Request URL | Environment String | Currency |
|---|---|---|---|
| Test | https://auth-test.rnc.ripplenet.com/oauth/token | test | Simulated |
| Production | https://auth.rnc.ripplenet.com/oauth/token | prod | Actual |
Step 2: Request the Access Token
Step 3: Test the Access Token
https://docs.ripple.com/_mock/products/payments-direct/api-docs/auth-proxy/reference/authproxy-external/