Authentication OpenAPI specification (version 1)

Download OpenAPI specification:Download

This is the documentation for the Ratepay authorization server. The API uses the OAuth 2.0 protocol with JSON Web Tokens (JWT) for authentication and authorization.

Request OAuth token

Request an OAuth token from the Ratepay authorization server.

Request
Request Body schema: application/json
required
client_id
required
string

Client ID provided by Ratepay.

client_secret
required
string

Client secret provided by Ratepay.

audience
required
string

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

STAGE API URL
Integration Payment API https://api-integration.ratepay.com/transaction/management
Integration Dispute API https://api-integration.ratepay.com/dispute/management
Integration Webhook Subscriptions https://api-integration.ratepay.com/webhook/management
Integration Bank Account Management API https://api-integration.ratepay.com/shop/consumer/v1
Integration Pay Later API https://api-integration.ratepay.com/paylater
Integration Transaction Status API (For Payment API 1.8) https://api-integration.ratepay.com/order/status/v2/transactions
Integration Transaction Status API (For Payment API 2.0) https://api-integration.ratepay.com/transaction/status/v2/transactions
STAGE API URL
Production Payment API https://api.ratepay.com/transaction/management
Production Dispute API https://api.ratepay.com/dispute/management
Production Webhook Subscriptions https://api.ratepay.com/webhook/management
Production Bank Account Management API https://api.ratepay.com/shop/consumer/v1
Production Pay Later API https://api.ratepay.com/paylater
Production Transaction Status API (For Payment API 1.8) https://api.ratepay.com/order/status/v2/transactions
Production Transaction Status API (For Payment API 2.0) https://api.ratepay.com/transaction/status/v2/transactions
grant_type
required
string

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

Responses
200

Successfully created an access token.

401

Invalid credentials.

post/oauth/token
Request samples
application/json
{}
Response samples
application/json
{
  • "access_token": "ey...",
  • "expires_in": 1800,
  • "token_type": "Bearer"
}