Skip to main content
GET
/
payment
/
list
Get payment list
curl --request GET \
  --url https://ramp-sandbox.hexarails.ai/payment/list \
  --header 'X-API-Key: <api-key>'
{
  "status": "SUCCESS",
  "data": {
    "pageNum": 1,
    "pageSize": 10,
    "total": 100,
    "list": [
      {
        "id": "12209d2d-47b4-4a07-8a01-b49052cd8204",
        "status": "CONFIRMED",
        "beneficiaryName": "John Doe",
        "deductAmount": "10000",
        "deductCurrency": "USDT",
        "receivedAmount": "9500",
        "receivedCurrency": "USD",
        "createTime": "2024-01-01T00:00:00Z"
      }
    ]
  }
}

Authorizations

X-API-Key
string
header
required

Query Parameters

pageNum
number
default:1

Page number

Example:

1

pageSize
number
default:10

Page size

Example:

10

status
enum<string>

Filter by payment status

Available options:
PROCESSING,
CONFIRMED
Example:

"CONFIRMED"

Response

Get payment list successful

status
enum<string>
required

Success response status

Available options:
SUCCESS
Example:

"SUCCESS"

data
object
required

Response data