v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB

Deposits

List Deposits

Returns a list of deposits made into your UQPAY wallet. You can filter results by specifying a time range. If no time range is provided, or only the end date is specified, the response will include deposits from the past 30 days up to today or the specified end date.

get/v1/deposit

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.

status'PENDING' | 'COMPLETED' | 'FAILED'

Example:COMPLETED

Status of deposit.

PENDING: Deposit is being processed and funds are not yet available.
COMPLETED: Deposit has been successfully processed and funds are available.
FAILED: Deposit could not be processed and was rejected or returned.

Headers

x-on-behalf-ofstring

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 API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Response

OK - Successfully retrieved a list of payouts.

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": [
    {
      "code": 200,
      "message": "Success",
      "data": {
        "order_status": "Success"
      }
    }
  ]
}