Skip to main content
GET
/
v1
/
transfer
/
{id}
Retrieve Transfer
curl --request GET \
  --url https://api-sandbox.uqpaytech.com/api/v1/transfer/{id} \
  --header 'x-auth-token: <api-key>'
{
  "transfer_id": "94d48e21-0a99-480c-b1b7-2e6d34e6eb67",
  "reference_id": "P220406-LLCVLRM",
  "short_reference_id": "P220406-LLCVLRM",
  "source_account_name": "UQPAY SOURCE",
  "destination_account_name": "UQPAY DEST",
  "transfer_currency": "USD",
  "transfer_amount": "1000",
  "transfer_status": "pending",
  "create_time": "2024-04-02T10:27:08+08:00",
  "complete_time": "0001-01-01T00:00:00Z",
  "created_by": "System"
}

Authorizations

​
x-auth-token
string
header
required

The API token for login provided by UQPay.

Path Parameters

​
id
string<uuid>
required

Universally unique identifier (UUID v4) of a resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"

Response

Retrieve a transfer successfully.

​
transfer_id
string
required

A unique UUID identifier for the transfer transaction.

Example:

"94d48e21-0a99-480c-b1b7-2e6d34e6eb67"

​
reference_id
string
required

The reference generated by the system to identify the entity.

Example:

"P220406-LLCVLRM"

​
short_reference_id
string
required

The shorter reference generated by the system to identify the entity.

Example:

"P220406-LLCVLRM"

​
source_account_name
string
required

The name of the account from which the funds are transferred.

Example:

"UQPAY SOURCE"

​
destination_account_name
string
required

The name of the account receiving the transferred funds.

Example:

"UQPAY DEST"

​
transfer_currency
string
required

The currency used for the transfer. Currency codes follow the ISO 4217 standard.

Example:

"USD"

​
transfer_amount
string
required

The amount of money transferred.

Example:

"1000"

​
transfer_status
enum<string>
required

Indicates the current status of the transfer transaction. Valid values are:

  • completed: indicates that the transfer transaction has been successfully completed.
  • failed: indicates that the transfer transaction has failed.
Available options:
completed,
failed
Example:

"pending"

​
create_time
string
required

The timestamp when the request was initiated in the system.

Example:

"2024-04-02T10:27:08+08:00"

​
complete_time
string
required

The timestamp when the request was successfully processed and marked as COMPLETED.

Example:

"0001-01-01T00:00:00Z"

​
created_by
string
required

The identifier of the user or system that initiated the transfer.

Example:

"System"