v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB

Transfers

List Transfers

Request a list of transfers, filtered by the specified criteria.

get/v1/transfer

Query parameters

page_sizeinteger required

Example:10

The maximum number of items to return per page. This number can be between 1 - 100

page_numberinteger required

Example:1

The page number to retrieve the next set of items. The number has to be greater than 1.

start_timestring

Example:2024-03-01T00:00:00+08:00

Exclusive start time used to filter by create_time. ISO 8601 format.

end_timestring

Example:2024-03-02T00:00:00+08:00

Exclusive end time used to filter by create_time. ISO 8601 format.

transfer_status'completed' | 'failed'

Example:completed

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.

currencystring

Example:USD,SGD

Currency code ISO_4217.

Response

OK - Successfully retrieved a list of transfers.

total_pagesinteger

The total pages of available items.

total_itemsinteger

The total counts of available items.

Example response

{
  "total_pages": 10,
  "total_items": 105,
  "data": [
    {
      "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"
    }
  ]
}