v1

latestOpenAPI 3.1.02026-07-241653251.3 MB

Payments

List payments

Retrieves a paginated list of payouts for the platform, optionally filtered by participant_code and a start_date / end_date window.

get/payments

Query parameters

participant_codestring

Filter for participant code

pagenumber

Filter for a specific page (pagination)

sizenumber

Filter for the amount of payments returned

start_dateinteger

Example:1704067200

Unix timestamp in seconds. Returns payments created on or after this date.

end_dateinteger

Example:1704153600

Unix timestamp in seconds. Returns payments created on or before this date.

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required

Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

Successfully retrieved paginated list of payouts with optional filters: participant_code, start_date, end_date.

request_idstring

Request id

platform_codestring

Platform code

totalnumber

Example response

{
  "message": [
    {
      "payment_id": "0f68333e-2114-469d-b505-c850d776e063",
      "payment_type": "payout",
      "payment_details": {
        "withdrawal_request_id": "0f68333e-2114-469d-b505-c850d776e063",
        "trade_id": "0f68333e-2114-469d-b505-c850d776e063",
        "on_chain_transaction_id": "F4184fc596403b9d638783cf57adfe4c75c605f6356fbc91338530e9831e9e16",
        "network_fee_notional": "0.01",
        "network_fee_quantity": "0.0000000384712"
      },
      "participant_code": "ALI123",
      "description": "this is a payout",
      "total": "7.66",
      "quantity": "7.66",
      "asset": "USDC",
      "quoted_asset": "USD",
      "status": "settled",
      "external_account_id": "0f68333e-2114-469d-b505-c850d776e063",
      "network": "ETH",
      "obo_participant": {
        "participant_code": "20XRLH",
        "account_group": "WRD1K0",
        "account_label": "general"
      },
      "created_at": "1975-08-19T23:15:30.000Z",
      "updated_at": "1975-08-19T23:15:30.000Z",
      "failure_reason": "unable to validate external account",
      "reference_id": "0338eee8-8626-4708-aa12-f33646a50423"
    }
  ],
  "request_id": "0f68333e-2114-469d-b505-c850d776e063",
  "platform_code": "AHU75O",
  "total": 10
}