Skip to content
Developer
/
/
Authentication OpenAPI sp...

Authentication OpenAPI specification (version 1)

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.

Download OpenAPI description
authentication_api.json
authentication_api.yaml
Overview
URL

https://www.ratepay.com/

Ratepay

info@ratepay.com

Languages
Servers
Ratepay Authorization Server

https://oauth.ratepay.com/

Request OAuth token

Request

Request an OAuth token from the Ratepay authorization server.

Bodyapplication/jsonrequired
client_idstringrequired

Client ID provided by Ratepay.

Example: "your-client-id"
client_secretstringrequired

Client secret provided by Ratepay.

Example: "your-client-secret"
audiencestringrequired

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
Example: "https://api.ratepay.com/transaction/management"
grant_typestringrequired

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

Example: "client_credentials"
curl -i -X POST \
  https://oauth.ratepay.com/oauth/token \
  -H 'Content-Type: application/json' \
  -d '{
    "client_id": "your-client-id",
    "client_secret": "your-client-secret",
    "audience": "https://api.ratepay.com/transaction/management",
    "grant_type": "client_credentials"
  }'

Responses

Successfully created an access token.

Bodyapplication/json
access_tokenstring
Example: "ey..."
expires_innumber
Example: 1800
token_typestring
Example: "Bearer"
Response
application/json
{
  "access_token": "ey...",
  "expires_in": 1800,
  "token_type": "Bearer"
}