Skip to main content
POST
/
v1
/
transfer
Create Transfer
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/transfer \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "source_account_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
  "target_account_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
  "currency": "USD",
  "amount": "1000",
  "reason": "Transfer"
}
'
{
  "transfer_id": "e08146de-4267-4e76-b35b-f7b34b656a53",
  "short_reference_id": "P220406-LLCVLRM"
}

Authorizations

​
x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

​
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
required

A unique identifier of the account.

Example:

"f5bb6498-552e-40a5-b14b-616aa04ac1c1"

​
target_account_id
string
required

A unique identifier of the account.

Example:

"f5bb6498-552e-40a5-b14b-616aa04ac1c1"

​
currency
string
required

Currency code ISO 4217 for the transfer.

Example:

"USD"

​
amount
string
required

The amount to transfer.

Example:

"1000"

​
reason
string
required

The reason for the transfer.

Example:

"Transfer"

Response

Transfer creation successfully.

​
transfer_id
string
required

Unique identifier for the created transfer.

Example:

"e08146de-4267-4e76-b35b-f7b34b656a53"

​
short_reference_id
string
required

System-generated short reference for the transfer.

Example:

"P220406-LLCVLRM"