# Request OAuth token

Request an OAuth token from the Ratepay authorization server.

Endpoint: POST /oauth/token
Version: version 1

## Request fields (application/json):

  - `client_id` (string, required)
    Client ID provided by Ratepay.
    Example: "your-client-id"

  - `client_secret` (string, required)
    Client secret provided by Ratepay.
    Example: "your-client-secret"

  - `audience` (string, required)
    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  |
| Integration | Hosted Payment Page API                      | https://payment-integration.ratepay.com                                 |

| 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              |
| Production  | Hosted Payment Page API                      | https://payment.ratepay.com                                             |
    Example: "https://api.ratepay.com/transaction/management"

  - `grant_type` (string, required)
    The type of grant presented in the exchange. Use client_credentials.
    Example: "client_credentials"

## Response 200 fields (application/json):

  - `access_token` (string)
    Example: "ey..."

  - `expires_in` (number)
    Example: 1800

  - `token_type` (string)
    Example: "Bearer"

## Response 401 fields (application/json):

  - `error` (string)
    Example: "access_denied"

  - `error_description` (string)
    Example: "Unauthorized"