GuidesAPI ReferenceChangelog
Log In
Guides
Start typing to search…

Overview

This guide provides comprehensive instructions for managing cards and cardholders through the Dashboard and API. Whether you are creating cards, assigning them to users, or managing their status, this guide will walk you through each step.

Before Start

  • Ensure you have passed UQPAY's onboarding review and your account is active.
  • Contact your UQPAY Account Manager to enable the required configurations for your Issuing Account.
  • Obtain your access token API. The access token will be required for calling all other API endpoints.

Create API Key

  1. Sign in to the Dashboard.
  2. Navigate to the API Keys page.
  3. Click the Create API Keysbutton in the top-right corner.
  4. Fill in the required information in the pop-up form.
  5. Click Create to generate the API key.

Once created, the API key will be displayed only once. Make sure to save it securely, as it will not be shown again.

Request an Access Token

  1. Navigate to the API Documents page.
  2. Go to Authentication > Request Access Token.
  3. Use the following parameters in the HTTP request header:
    1. x-client-id: The Client ID generated when you created the API key.
    2. x-api-key: The API key you saved earlier.
  4. Click Try it to execute the request. If successful, you will receive an x-auth-token (Access Token) for further API calls.

You can use the Access Token in subsequent API requests, such as creating a cardholder or creating a card. Simply include the x-auth-token in the HTTP request header along with other required parameters.

Updated 5 months ago