---
title: "List payment captures"
method: GET
path: "/payment_captures"
tags: ["Payment Captures"]
---

# List payment captures

`GET /payment_captures`

List and filter payment captures.

## Query parameters

- `limit` integer
- `starting_after` string, uuid
- `sort_order` 'asc' | 'desc'
- `start_date` string, date
- `end_date` string, date
- `idempotency_key` string
- `connected_account_id` string, uuid
- `payment_reference` string
- `remittance_reference` string
- `start_value_date` string, date
- `end_value_date` string, date
- `transaction_reference` string
- `amount_from` integer
- `amount_to` integer
- `original_payment_amount_from` integer
- `original_payment_amount_to` integer
- `currency` string
- `canceled` boolean
- `reconciliation_status` 'unreconciled' | 'partially_reconciled' | 'reconciled' | 'excluded'
- `source` 'api' | 'reporting_file'
- `merchant_id` string
- `type` 'charge' | 'chargeback' | 'refund'
- `network` string

## Response `200`

200

- object
  - `records` PaymentCaptureDetails[], required
    - `id` string, uuid, required — The UUID of the payment capture.
    - `idempotency_key` string — An idempotency key is a unique value sent by the client, which the server uses to recognize subsequent retries of the same request.
    - `object` 'payment_capture', required — Label used to identify this kind of object.
    - `connected_account_id` string, uuid, required — The ID of the connected account.
    - `transaction_reference` string — The transaction reference of the payment capture.
    - `amount` integer, required — The absolute amount of the payment capture, in the specified currency's smallest units. For euro payments, the smallest unit is cents. €20 is represented as `2000`.
    - `original_payment_amount` integer — The original amount of the payment capture, in the specified currency's smallest units. For euro payments, the smallest unit is cents. €20 is represented as `2000`.
    - `currency` string, required — The ISO 4217 currency code of the payment capture.
    - `type` 'charge' | 'chargeback' | 'refund', required — The type of the payment capture.
    - `authorization_id` string, required — The authorization ID of the payment capture.
    - `payment_reference` string, required — The payment reference of the payment capture (e.g. archiving reference).
    - `date` string, date, required — The date of the payment capture.
    - `value_date` string, date, required — The value date of the payment capture.
    - `network` 'visa' | 'mastercard' | 'cb' | 'american_express', required — The network of the payment capture.
    - `remittance_reference` string, required — The remittance reference of the payment capture.
    - `remittance_date` string, date, required — The remittance date of the payment capture.
    - `fee_amount` integer, required — The fee amount of the payment capture.
    - `fee_currency` string, required — The ISO 4217 fee currency code of the payment capture.
    - `net_amount` integer, required — The net amount of the payment capture.
    - `net_currency` string, required — The ISO 4217 net currency code of the payment capture.
    - `reconciled_amount` integer, required — The reconciled amount.
    - `reconciliation_status` 'unreconciled' | 'partially_reconciled' | 'reconciled' | 'excluded', required — The reconciliation status of the payment order, which is either `unreconciled`, `reconciled`, `partially_reconciled`, or `excluded`.
    - `source` 'api' | 'reporting_file', required — The source of the payment capture.
    - `merchant_id` string — The merchant ID of the payment capture.
    - `metadata` object, required — Additional client data in JSON format. See [Metadata](https://docs.numeral.io/reference/metadata).
    - `canceled_at` string, date-time, nullable, required — The UTC timestamp of the cancelation of the payment capture.
    - `created_at` string, date-time, required — The UTC timestamp of the creation of the payment capture.
    - `cbs_data` CommonCbsData
      - `transaction_id` string, uuid — The ID of the transaction booked in the core banking system.
      - `authorization_id` string — The ID of the authorization hold acquired in the core banking system.
      - `transactions` CommonCbsTransaction[] — List of all transactions on core banking system for the payment.
        - `id` string, uuid — The ID of the transaction booked in the core banking system.
        - `type` 'deposit' | 'withdrawal' | 'disbursement' | 'repayment' | 'adjustment' — Type of the transaction.
        - `context` 'deposit' | 'suspense' | 'disbursement' | 'repayment' — Context of the transaction.
        - `payment_validation_type` 'internal_account_is_active' | 'direct_debit_mandate_is_active' | 'liquidity_screening' | 'sanctions_screening' | 'risk_screening' | 'limits_screening' | 'mambu_authorization' — The type of the payment validation associated with transaction (key value in `suspense` context).
        - `account_id` string — Account ID on the core banking system used for the transaction.
        - `authorization_id` string — The ID of the authorization hold acquired in the core banking system.
        - `external_id` string — External ID used on the transaction.
        - `channel` string — Channel on the core banking system used for the transaction.
        - `booked_at` string, date-time — The UTC timestamp that the transaction has been booked on the core banking system.

## Other responses

- `400` — Validation error.

---

[API](https://skmtc.net/numeral/apis/payments.md) · [All operations](https://skmtc.net/numeral/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/numeral/payments/revisions/220f101cc2ef/schema)