v5

latestOpenAPI 3.1.02026-07-262421791.5 MB

oauth-token

Create an OAuth token

Exchange credentials or authorisation grants for an OAuth 2.0 access token.

The grant_type field determines which parameters are required and which response fields are returned.

See managing token expiration for guidance on refreshing tokens before they expire.

post/oauth/token

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Response

Token created successfully.

access_tokenstring

Access token to be used when calling the API. Valid for 12 hours.

token_typestring

Type of the token.

refresh_tokenstring

Refresh token used to obtain new user access tokens without requiring the user to re-authorise. Valid for up to 20 years.

Only returned for user access token grant types (registration_code, authorization_code, refresh_token).

expires_ininteger

Access token expiry time in seconds.

expires_atstring

Access token expiration timestamp (UTC).

refresh_token_expires_ininteger

Refresh token expiry time in seconds.

Only returned for user access token grant types (registration_code, authorization_code, refresh_token).

refresh_token_expires_atstring

Refresh token expiration timestamp (UTC).

Only returned for user access token grant types (registration_code, authorization_code, refresh_token).

scopestring

Scope of the token.

created_atstring

Token creation time in ISO 8601 format.

Only returned for user access token grant types (registration_code, authorization_code, refresh_token).

Example response

{
  "access_token": "01234567-89ab-cdef-0123-456789abcdef",
  "token_type": "bearer",
  "refresh_token": "01234567-89ab-cdef-0123-456789abcdef",
  "expires_in": 43199,
  "expires_at": "2025-04-11T03:43:28.148Z",
  "refresh_token_expires_in": 628639555,
  "refresh_token_expires_at": "2045-03-12T13:49:23.552Z",
  "scope": "transfers",
  "created_at": "2020-01-01T12:33:33.12345Z"
}