A payment capture is a card or alternative payment method charge, refund, or chargeback. While card payments cannot be initiated through Numeral, they can be stored in the payment_capture object and reconciled with the corresponding bank transaction.
| Attribute | Description |
|---|---|
| id string | 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. See Idempotency. |
| object string | The object, here payment_capture. |
| connected_account_id string | The ID of the connected account related to the payment. |
| transaction_reference string | The transaction reference of the card payment, coming from the card settlement bank reporting file. |
| type string | The type of the payment capture. Either charge, chargeback, or refund. |
| amount integer | The absolute value of the payment in the specified currency's smallest unit. |
| original_payment_amount integer | For chargeback and return payment captures, the original amount of the payment, if provided in the card settlement bank reporting file. |
| currency string | The currency of the payment capture. All ISO-4217 currency codes are supported. |
| date date | The date of the payment capture. |
| authorization_id string | The authorization ID of the payment capture. |
| payment_reference string | The payment reference of the payment capture. It must be filled with a technical ID persisted from card payment authorisation to card settlement bank reporting (e.g. référence d'archivage). |
| value_date date | The value date of the payment capture, retrieved from a card reporting file. |
| network string | The scheme of the payment capture (e.g. visa or mastercard). |
| remittance_date date | The remittance date of the payment capture, retrieved from a card reporting file. |
| remittance_reference string | The remittance reference of the payment capture, retrieved from a card reporting file. |
| fee_amount integer | The fee of the payment capture, retrieved from a card reporting file. |
| fee_amount_currency string | The currency of the payment capture fee, retrieved from a card reporting file. |
| net_amount integer | The net amount of the payment capture, retrieved from a card reporting file. |
| net_amount_currency string | The currency of the payment capture net amount, retrieved from a card reporting file. |
| source string | The source of the payment capture, either api or reporting_file. |
| merchant_id string | The merchant ID related to the payment capture. |
| reconciliation_status string | The reconciliation status of the payment capture, which is either unreconciled, reconciled, or partially_reconciled. |
| reconciled_amount integer | The amount of the payment capture that is already reconciled. It is the sum of the amount of the reconciliations related to this card payment. |
| metadata object | Additional data in JSON key:value format. See Metadata. |
| canceled_at datetime | The UTC timestamp of the cancellation of this payment capture. canceled_at is null if the expected payment was not canceled. |
| created_at datetime | The UTC timestamp of the creation of the payment capture. |
| updated_at datetime | The UTC timestamp of the last update of the payment capture. |
Below is an example of a payment_capture :
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"idempotency_key": "4e19a57a-0e8e-401f-b2d7-453ad41b826e",
"object": "payment_capture",
"connected_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction_reference": "GT67178B",
"amount": 500,
"original_payment_amount": null,
"currency": "EUR",
"type": "charge",
"authorization_id": "45635726367276367213",
"payment_reference": "3FG2V3F21G3KP",
"date": "2022-01-03",
"value_date": "2022-01-03",
"network": "visa",
"remittance_reference": "string",
"remittance_date": "2022-01-03",
"fee_amount": 0,
"fee_currency": "EUR",
"net_amount": 500,
"net_currency": "EUR",
"reconciled_amount": 500,
"reconciliation_status": "unreconciled",
"source": "api",
"merchant_id": "3256136726",
"metadata": "",
"canceled_at": null,
"created_at": "2023-09-25T08:50:07.605Z"
}