Skip to main content
POST
Request an access token

Authorizations

x-api-key
string
header
required

You can use your secret API key in the x-api-key header of your API requests for supported endpoints: x-api-key: <YOUR_API_KEY_HERE>. API keys are environment specific and should be securely guarded.

You don't have your API key yet? Contact your Payrails account manager.

Path Parameters

clientId
string
required

The id of the client that wants to retrieve an OAuth token.

Response

OK - A successful access token.

access_token
string
required

The access token issued.

token_type
string
default:Bearer
required

Case insensitive token type issued.

expires_in
integer<int32>
default:3600
required

The lifetime in seconds of the access token.

Last modified on October 7, 2026