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

# List All Payments

`GET /payments`

Returns all individual payments matching the request criteria. This endpoint supports pagination, and filtering on payment status, type, receiver ID, and timestamp. Each payment has details on the transaction itself, receiver, disbursement, asset, status history, and blockchain information.

## Query parameters

- `page` number
- `q` string
- `type` 'DIRECT' | 'DISBURSEMENT'
- `page_limit` number
- `status` 'DRAFT' | 'READY' | 'PENDING' | 'PAUSED' | 'SUCCESS' | 'FAILED' | 'CANCELED'
- `receiver_id` string
- `created_at_after` string
- `created_at_before` string
- `sort` 'updated_at' | 'created_at'
- `direction` 'asc' | 'desc'

## Response `200`

A paginated list of payments

- PaymentPagination
  - `pagination` Pagination
    - `next` string
    - `prev` string
    - `pages` integer
    - `total` integer
  - `data` Payment[]
    - `id` string
    - `amount` string — The amount of the payment
    - `stellar_transaction_id` string — The ID of the transaction in the Stellar network. It can be used to track the payment in the Stellar network using [Stellar Laboratory](https://laboratory.stellar.org), or [StellarExpert](https://stellar.expert).
    - `circle_transfer_request_id` string — The Circle transfer request ID. It is only present when the payment was made using Circle.
    - `stellar_operation_id` string
    - `status` 'DRAFT' | 'READY' | 'PENDING' | 'PAUSED' | 'SUCCESS' | 'FAILED' | 'CANCELED' — The status of the payment
    - `status_history` PaymentStatusHistoryEntry[] — An aggregated list of metadata objects containing the statuses and the timestamp of when these status changes occurred.
      - `status` 'DRAFT' | 'READY' | 'PENDING' | 'PAUSED' | 'SUCCESS' | 'FAILED' | 'CANCELED' — The status of the payment
      - `status_message` string
      - `timestamp` string, date-time
    - `type` 'DISBURSEMENT' | 'DIRECT' — The type of the payment.
    - `disbursement` DisbursementLite
      - `id` string, uuid — The unique identifier of the disbursement
      - `name` string — The name of the disbursement
      - `receiver_registration_message_template` string — The custom template used to send invitations to receivers. The `default` message isn't returned. In the message's content it's possible to add the following template variables: `{{.OrganizationName}}` which is the Organization Name configured and `{{.RegistrationLink}}` which is the link generated by SDP to send to the receiver (in case this is not present in the message, it's automatically appended at the end).
      - `registration_contact_type` 'EMAIL' | 'PHONE_NUMBER' | 'EMAIL_AND_WALLET_ADDRESS' | 'PHONE_NUMBER_AND_WALLET_ADDRESS'
      - `status` 'DRAFT' | 'READY' | 'STARTED' | 'PAUSED' | 'COMPLETED'
      - `verification_field` 'DATE_OF_BIRTH' | 'YEAR_MONTH' | 'PIN' | 'NATIONAL_ID_NUMBER'
      - `status_history` DisbursementStatusHistoryEntry[]
        - `user_id` string
        - `status` 'DRAFT' | 'READY' | 'STARTED' | 'PAUSED' | 'COMPLETED'
        - `timestamp` string, date-time
      - `file_name` string
      - `created_at` string, date-time — The creation timestamp of the disbursement
      - `updated_at` string, date-time — The last update timestamp of the disbursement
    - `asset` Asset — The Stellar asset object
      - `id` string
      - `code` string — Asset code
      - `issuer` string — Asset issuer address
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `deleted_at` string, date-time
    - `receiver_wallet` ReceiverWalletLite
      - `id` string
      - `receiver` ReceiverLite
        - `id` string
      - `wallet` WalletLite
        - `id` string
        - `name` string
        - `homepage` string
        - `sep_10_client_domain` string
        - `deep_link_schema` string
        - `enabled` boolean
        - `user_managed` boolean
      - `stellar_address` string
      - `stellar_memo` string
      - `stellar_memo_type` string
      - `sep24_transaction_id` string
      - `created_at` string
      - `updated_at` string
      - `invitation_sent_at` string
      - `status` 'DRAFT' | 'READY' | 'REGISTERED' | 'FLAGGED'
      - `status_history` ReceiversWalletStatusHistoryEntry[]
        - `status` 'DRAFT' | 'READY' | 'REGISTERED' | 'FLAGGED'
        - `timestamp` string, date-time
      - `otp_confirmed_at` string, date-time
      - `otp_confirmed_with` string
    - `external_payment_id` string — Optional external payment identifier provided by the client.
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/stellar/apis/stellar-disbursement-platform-api.md) · [All operations](https://skmtc.net/stellar/apis/stellar-disbursement-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stellar/stellar-disbursement-platform-api/revisions/39f9dc64156c/schema)