Skip to main content
POST
/
v1
/
issuing
/
transfers
Create Issuing Transfer
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/issuing/transfers \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "source_account_id": "7c4ff2cd-1bf6-4aaa-bf16-266771425011",
  "destination_account_id": "7c4ff2cd-1bf6-4aaa-bf16-266771425011",
  "currency": "SGD",
  "amount": 1000,
  "remark": "Transfer to Jack."
}
'
{
  "transfer_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395"
}

Authorizations

x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

x-on-behalf-of
string

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

x-idempotency-key
string<uuid>
required

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

Body

application/json
source_account_id
string<uuid>
required

The account id that initiated the transfer.

Example:

"7c4ff2cd-1bf6-4aaa-bf16-266771425011"

destination_account_id
string<uuid>
required

The account id that received the transfer.

Example:

"7c4ff2cd-1bf6-4aaa-bf16-266771425011"

currency
string
required

Transfer currency.

Example:

"SGD"

amount
number
required

Transfer amount. Precision is limited to two decimal places.

Must be a multiple of 0.01
Example:

1000

remark
string

The remark of the transfer.

Example:

"Transfer to Jack."

Response

Transfer creation successfully.

transfer_id
string<uuid>
required

Unique identifier for transfer.

Example:

"5135e6cc-28b6-4889-81dc-3b86a09e1395"