---
title: "List payments"
method: GET
path: "/payments"
tags: ["Payments"]
---

# List payments

`GET /payments`

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

## Query parameters

- `participant_code` string
- `page` number
- `size` number
- `start_date` integer
- `end_date` integer

## Headers

- `X-SCX-SIGNED` string, required
- `X-SCX-TIMESTAMP` string, required

## Response `200`

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

- GetPaymentsResponse
  - `message` Payment[]
    - `payment_id` string — Payment id
    - `payment_type` 'payout' — type of the payment
    - `payment_details` object
      - `withdrawal_request_id` string — Withdrawal request linked to the payment
      - `trade_id` string — Trade linked to the payment
      - `on_chain_transaction_id` string — On chain transaction linked to the payment
      - `network_fee_notional` string — total notional value of network fees
      - `network_fee_quantity` string — value of network fees in the proper network token
    - `participant_code` string — Participant code
    - `description` string — Description of payment
    - `total` string — payment total (if total was requested)
    - `quantity` string — payment quantity (if quantity was requested)
    - `asset` string — The asset used for the payment
    - `quoted_asset` string — The quoted asset used for the payment
    - `status` string — The status of the payment
    - `external_account_id` string — Linked account id
    - `network` string — The network in which the payment took place
    - `obo_participant` OBOParticipantEntity
      - `participant_code` string — The identifier of the participant making the request
      - `account_group` string — The identifier of the the account group
      - `account_label` string — The account label associated with the account
    - `created_at` string — Created at date with time
    - `updated_at` string — Updated at date with time
    - `failure_reason` string — filled if payment status=failed
    - `reference_id` string — platform reference id passed through token
  - `request_id` string — Request id
  - `platform_code` string — Platform code
  - `total` number

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/zerohash/apis/zerohash-api.md) · [All operations](https://skmtc.net/zerohash/apis/zerohash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zerohash/zerohash-api/revisions/8b647d934363/schema)