Skip to main content
GET
/
deposit
/
list
List partner deposits
curl --request GET \
  --url https://ramp-sandbox.hexarails.ai/deposit/list \
  --header 'X-API-Key: <api-key>'
{
  "status": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "<string>",
        "currency": "<string>",
        "amount": "<string>",
        "txid": "<string>",
        "voutIndexTxKey": "<string>",
        "timestamp": "<string>",
        "customerName": "<string>",
        "customerId": {},
        "txFrom": {},
        "txReference": {}
      }
    ],
    "total": 123,
    "pageNum": 123,
    "pageSize": 123
  }
}

Authorizations

X-API-Key
string
header
required

Query Parameters

pageNum
number
default:1

Page number

Required range: x >= 1
pageSize
number
default:10

Page size

Required range: 1 <= x <= 100
customerId
string

Filter by customer (party) ID

currency
string

Filter by currency

status
enum<string>

Filter by deposit status

Available options:
RECEIVED,
CONFIRMED,
ACTION_REQUIRED,
REJECTED

Response

Partner deposit list

status
enum<string>
required

Success response status

Available options:
SUCCESS
Example:

"SUCCESS"

data
object
required

Response data