v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Payment Captures

List payment captures

List and filter payment captures.

get/payment_captures

Query parameters

limitinteger
starting_afterstring uuid

The ID of the object from which your list request will start. It is not included in the result.

sort_order'asc' | 'desc'

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

start_datestring date

The creation date of the payment capture.

end_datestring date

The creation date of the payment capture.

idempotency_keystring
connected_account_idstring uuid

The ID of the connected account related to the payment capture.

payment_referencestring

The payment reference of the payment capture (e.g. archiving reference).

remittance_referencestring

The remittance reference of the payment capture.

start_value_datestring date

The value date of the payment capture.

end_value_datestring date

The value date of the payment capture.

transaction_referencestring

The transaction reference of the payment capture.

amount_frominteger

The amount of the payment capture.

amount_tointeger

The amount of the payment capture.

original_payment_amount_frominteger

The original amount of the payment capture.

original_payment_amount_tointeger

The original amount of the payment capture.

currencystring

The currency of the payment capture.

canceledboolean

If true, only canceled payment captures will be fetched.

reconciliation_status'unreconciled' | 'partially_reconciled' | 'reconciled' | 'excluded'

The reconciliation status of the payment capture.

source'api' | 'reporting_file'

The source of the payment capture.

merchant_idstring

The merchant ID of the payment capture.

type'charge' | 'chargeback' | 'refund'

The type of the payment capture.

networkstring

The scheme of the payment capture.

Response

200

Example response

{
  "records": [
    {
      "idempotency_key": "8A2gcC",
      "object": "payment_capture",
      "amount": 500,
      "original_payment_amount": 500,
      "currency": "EUR",
      "date": "2022-01-03",
      "value_date": "2022-01-03",
      "remittance_date": "2022-01-03",
      "fee_amount": 500,
      "fee_currency": "EUR",
      "net_amount": 500,
      "net_currency": "EUR",
      "reconciled_amount": 2000,
      "metadata": {
        "property_a": true,
        "property_b": "some label"
      },
      "cbs_data": {
        "transaction_id": "c2c303de-c0f0-4015-801d-6ae24f248092",
        "authorization_id": "62f87f47-86c6-4b1e-b49d-e6df91922cd7",
        "transactions": [
          {
            "id": "c2c303de-c0f0-4015-801d-6ae24f248092",
            "type": "withdrawal",
            "context": "deposit",
            "authorization_id": "62f87f47-86c6-4b1e-b49d-e6df91922cd7",
            "channel": "cash",
            "booked_at": "2022-01-03T11:53:19.568Z"
          }
        ]
      }
    }
  ]
}