Sign in

v1

latestOpenAPI 3.0.12026-08-06135.9 KB

Request OAuth token

Request an OAuth token from the Ratepay authorization server.

post/oauth/token

Request body

client_idstring required

Client ID provided by Ratepay.

client_secretstring required

Client secret provided by Ratepay.

audiencestring required

Specific resources and scope (environment). To access the API, use the URLs defined below.

STAGEAPIURL
IntegrationPayment APIhttps://api-integration.ratepay.com/transaction/management
IntegrationDispute APIhttps://api-integration.ratepay.com/dispute/management
IntegrationWebhook Subscriptionshttps://api-integration.ratepay.com/webhook/management
IntegrationBank Account Management APIhttps://api-integration.ratepay.com/shop/consumer/v1
IntegrationPay Later APIhttps://api-integration.ratepay.com/paylater
IntegrationTransaction Status API (For Payment API 1.8)https://api-integration.ratepay.com/order/status/v2/transactions
IntegrationTransaction Status API (For Payment API 2.0)https://api-integration.ratepay.com/transaction/status/v2/transactions
IntegrationHosted Payment Page APIhttps://payment-integration.ratepay.com
STAGEAPIURL
ProductionPayment APIhttps://api.ratepay.com/transaction/management
ProductionDispute APIhttps://api.ratepay.com/dispute/management
ProductionWebhook Subscriptionshttps://api.ratepay.com/webhook/management
ProductionBank Account Management APIhttps://api.ratepay.com/shop/consumer/v1
ProductionPay Later APIhttps://api.ratepay.com/paylater
ProductionTransaction Status API (For Payment API 1.8)https://api.ratepay.com/order/status/v2/transactions
ProductionTransaction Status API (For Payment API 2.0)https://api.ratepay.com/transaction/status/v2/transactions
ProductionHosted Payment Page APIhttps://payment.ratepay.com
grant_typestring required

The type of grant presented in the exchange. Use client_credentials.

Example request

{
  "client_id": "your-client-id",
  "client_secret": "your-client-secret",
  "audience": "https://api.ratepay.com/transaction/management",
  "grant_type": "client_credentials"
}

Response

Successfully created an access token.

access_tokenstring
expires_innumber
token_typestring

Example response

{
  "access_token": "ey...",
  "expires_in": 1800,
  "token_type": "Bearer"
}