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.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Notice: UQPAY Developer Docs Have Moved
The UQPAY developer documentation site has moved to a new platform.
- New site: https://developers.uqpay.com/
- Old site (this page): will remain accessible until mid-June 2026, then be retired.
During the transition period, this site will stay online but will no longer receive updates. All future API changes, new endpoints, and documentation updates will be published only on the new site.
Before you start, make sure you already have an API Key. Go to Create API Keys for detailed steps.
Internal server error - An error occurred on UQPAY's end. (These are rare.)
Not implemented - The endpoint has not been implemented yet.
Bad Gateway.
Service unavailable - The service that you're trying to access is temporarily unavailable.
Gateway timeout - The underlying service did not respond in a timely manner.