Skip to main content
GET
/
v1
/
ramp
/
deposit
List Deposits
curl --request GET \
  --url https://api-sandbox.uqpaytech.com/api/v1/ramp/deposit \
  --header 'x-auth-token: <api-key>'
{
  "code": 200,
  "message": "Success",
  "data": {
    "data": [
      {
        "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "short_order_id": "<string>",
        "order_status": "Success",
        "balance_currency": "<string>",
        "network": "<string>",
        "amount": "<string>",
        "deposit_address": "<string>",
        "transaction_id": "<string>",
        "create_time": "<string>",
        "completed_time": "<string>"
      }
    ],
    "total_pages": 123,
    "total_items": 123
  }
}

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

Query Parameters

​
page_num
integer
default:1
required

Page number, default 1

Required range: x >= 1
​
page_size
integer
default:20
required

Items per page, default 20

Required range: x >= 1
​
asset
string

Filter by asset code

​
network
string

Filter by network code

​
status
string

Order status

​
start_time
string

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

Example:

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

​
end_time
string

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

Example:

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

Response

Successfully retrieved deposits

​
code
integer
required
Example:

200

​
message
string
required
Example:

"Success"

​
data
object
required