API Reference

Connected Accounts

As connected UQPAY accounts, you may be able to make API requests on behalf of them.

To act as connected accounts, clients can issue requests using the x-on-behalf-of special header. Make sure that this header contains a UQPAY customer account ID.

The value is set per-request as shown in the adjacent code sample. Methods on the returned object reuse the same account ID.

This feature must first be enabled for your account, and may not be available for all endpoints. Please contact your integration manager for more information.

Example request

curl --request POST \
     --url https://api.uqpay.com/api/v1/issuing/cardholders \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-auth-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtYXN0ZXJfaWQiOiIwIiwiY3VzdG9tZXJfaWQiOiI3NGJkNmU3MS0zMzJmLTRmM2ItODBhNi0yYWFmMTgzN2IzY2UiLCJhY2NvdW50X2lkIjoiNzRiZDZlNzEtMzMyZi00ZjNiLTgwYTYtMmFhZjE4MzdiM2NlIiwiYXBpX3ZlcnNpb24iOiJWMS4wIiwiY2xpZW50X2lkIjoiNEo3aEN2Q2t6MlhjdmtxODU1bkNNTCIsImV4cCI6MTcxMTgzMzQzNiwiaXNzIjoidXFwYXkifQ.x8A3czt6ephNFju5kSderETlAFCOShWsqDaQkOBBunY' \
     --header 'x-idempotency-key: 18523f72-f4de-4f9c-bb8e-ec7d1c4f32be' \
     --header 'x-on-behalf-of: 18523f72-f4de-4f9c-bb8e-ec7d1c4f32be' \
     --data '
{
  "residential_address": {
    "city": "Singapore",
    "country": "SG",
    "line2": "THE METROPOLIS",
    "state": "Singapore",
    "line1": "9 N Buona Vista Dr",
    "postal_code": "138666"
  },
  "phone_number": "86683306",
  "country_code": "SG",
  "last_name": "Toy",
  "first_name": "Emily",
  "email": "[email protected]"
}
'