Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Payment Captures

Create payment capture

Create a payment capture, that can be used for reconciliation purposes.

post/payment_captures

Headers

Idempotency-Keystring
Example:8A2gcC

An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request.

Request body

connected_account_idstring uuid required

The ID of the connected account.

transaction_referencestring

The transaction reference of the payment capture.

amountinteger required

The absolute amount of a payment, in the specified currency's smallest units. For euro payments, the smallest unit is cents. €20 is represented as 2000.

currencystring required

The ISO 4217 currency code of the payment capture.

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

The type of the payment capture.

authorization_idstring

The authorization ID of the payment capture.

payment_referencestring required

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

datestring date required

The date of the payment capture.

metadataobject

Additional client data in JSON format. See Metadata.

Example request

{
  "amount": 500,
  "currency": "EUR",
  "date": "2022-01-03",
  "metadata": {
    "property_a": true,
    "property_b": "some label"
  }
}

Response

200

idstring uuid required

The UUID of the payment capture.

idempotency_keystring

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_idstring uuid required

The ID of the connected account.

transaction_referencestring

The transaction reference of the payment capture.

amountinteger 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_amountinteger

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.

currencystring required

The ISO 4217 currency code of the payment capture.

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

The type of the payment capture.

authorization_idstring required

The authorization ID of the payment capture.

payment_referencestring required

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

datestring date required

The date of the payment capture.

value_datestring date required

The value date of the payment capture.

network'visa' | 'mastercard' | 'cb' | 'american_express' required

The network of the payment capture.

remittance_referencestring required

The remittance reference of the payment capture.

remittance_datestring date required

The remittance date of the payment capture.

fee_amountinteger required

The fee amount of the payment capture.

fee_currencystring required

The ISO 4217 fee currency code of the payment capture.

net_amountinteger required

The net amount of the payment capture.

net_currencystring required

The ISO 4217 net currency code of the payment capture.

reconciled_amountinteger 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_idstring

The merchant ID of the payment capture.

metadataobject required

Additional client data in JSON format. See Metadata.

canceled_atstring date-time nullable required

The UTC timestamp of the cancelation of the payment capture.

created_atstring date-time required

The UTC timestamp of the creation of the payment capture.

Example response

{
  "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"
      }
    ]
  }
}