.mint-block {
    display: block
}
.mint-hidden {
    display: none
}
.dark\:mint-block:is(.dark *) {
    display: block
}
.dark\:mint-hidden:is(.dark *) {
    display: none
}

Products

Quick links

Welcome to the home of your new documentation

Introduction

UQPAY Docs

Github

Linkedin

Official Website

API Reference

Dashboard

Support

Use API keys to authenticate your client requests when utilizing UQPAY APIs.

Authentication

Ensure that you ensure your transactions are executed only once in case they need to be retried.

Idempotent Requests

Authenticates and authorizes a user to the UQPAY API. The authentication token is required to make requests to all other endpoints in the UQPAY API. Tokens expire after 10 minutes of inactivity.

Sign in via API

This endpoint returns a list of balances for opened currency.

List all balances

Create a balance

This endpoint returns a balance based on the currency.

Retrieve a balance

This endpoint returns a bank details of a balance based on the currency.

Retrieve a bank details

List all transactions related to the account.

List all transactions

This endpoint get list of cards issued under an account.

List all cards

This endpoint is used to create a card(prepaid,debit,credit). Only `USD` is supported for now.

Create a card

This endpoint retrieve card details by card id.

Retrieve card details

Retrieves the secure information for a specific card identified by `card_id`. This information includes details such as `expire date` and `CVV2`.

Retrieve sensitive card details

This endpoint recharge a card. Add money to your card using your account balance.

Recharge a card

This endpoint allows for withdrawals from the card balance.

Withdraw a card

This endpoint freeze a card by card id. No transactions can be made on frozen cards.

Freeze a card

This endpoint unfreeze a card by card id.

Unfreeze a card

This endpoint update a card name by card id.

Update a card

This endpoint cancel a card by card id. The remaining balance of the card will be refunded to the corresponding currency account.

Cancel a card

This endpoint retrieve the results of card open, card recharge, and card withdraw by unique_request_id.

Retrieve card operation result

This endpoint get all activated card products under the current account, choose one when creating a card.

List Card Products

List all cardholders

This endpoint create a cardholder. Cardholders are individuals with the ability to own cards. Creation of cardholders involves passing our KYC (Know-Your-Customer) process and so individuals are required to present contact details.

Create a cardholder

This endpoint retrieve cardholder details by cardholder id.

Retrieve cardholder details

This endpoint delete a cardholder by cardholder id.

Delete a cardholder

This endpoint get list of card transactions.

List all card transactions

Get list of payers

List all payouts

This endpoint create a new payout to a beneficiary. The payout only supported the same currency between payer and beneficiary.

Create a new payout

This endpoint returns a payout based on the id.

Retrieve a payout by id

List all beneficiaries

Create a beneficiary

Update a beneficiary

Delete a beneficiary

This endpoint returns a beneficiary based on the id.

Retrieve a beneficiary by id

This endpoint returns a list of payment methods.

Get a list of payment methods

This endpoint returns payment validation.

Check payment validation

Query a beneficiary

We will send the following header and body to the provided Url in a post request

Get Started

Introduction

Products

Accept global payments

Make payouts easily

Card Issuing

Convert payments

Quick links

Reference APIs

SDKs

Get Started

​Products

Accept global payments

Make payouts easily

Card Issuing

Convert payments

​Quick links

Reference APIs

SDKs

Products

Quick links