Request Access Token

Request an access token by specifying your x-client-id and x-api-key in the HTTP request header. The token returned is required for calling all other API endpoints, which HTTP header must include x-auth-token: <YOUR_TOKEN_HERE>.

The access token can be used multiple times for all other API endpoints until it expires. It’s recommended to rely on expired_at for the accurate token expiration time.

auth_token is valid for 30 minutes in Production.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Responses

500

Internal server error - An error occurred on UQPAY's end. (These are rare.)

501

Not implemented - The endpoint has not been implemented yet.

502

Bad Gateway.

503

Service unavailable - The service that you're trying to access is temporarily unavailable.

504

Gateway timeout - The underlying service did not respond in a timely manner.

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json