API Reference
Log inContact us

Payment capture object

Use payment captures to reconcile payments processed by PSPs

Payment captures are card or alternative payment method charges, refunds, or chargebacks processed by PSPs. While card payments cannot be initiated through Numeral, they can be recored as payment_capture objects and reconciled with the corresponding bank transactions.

AttributeDescription
id
string		The payment capture ID.
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		Always payment_capture.
connected_account_id
string		The ID of the connected account used for the payment capture.
transaction_reference
string		The payment capture transaction reference, based on the bank settlement reporting file.
type
string		The payment capture type. Either charge, chargeback, or refund.
amount
integer		The payment capture amount, in the currency's smallest unit.

For instance, euro smallest unit is cents and €20 is thus represented as 2000.
original_payment_amount
integer		For chargeback and return payment captures, the original payment amount.
currency
string		The payment capture currency. All ISO-4217 currency codes are supported.
date
date		The payment capture date.
authorization_id
string		The payment capture authorization ID.
payment_reference
string		The payment capture payment reference, usually a technical ID persisted throughout the processing of the payment, from its initiation to its settlement (e.g. référence d'archivage).
value_date
date		The payment capture value date.
network
string		The payment capture scheme or network (e.g. visa or mastercard).
remittance_date
date		The payment capture remittance date.
remittance_reference
string		The payment capture remittance reference.
fee_amount
integer		The payment capture fee amount.
fee_amount_currency
string		The payment capture fee amount currency.
net_amount
integer		The payment capture net amount.
net_amount_currency
string		The payment capture net amount currency.
source
string		The payment capture source, either api or reporting_file.
merchant_id
string		The payment capture merchant ID.
reconciliation_status
string		The payment capture reconciliation status, either unreconciled, reconciled, or partially_reconciled.
reconciled_amount
integer		The amount reconciled, calculated as the sum of the reconciliations created for the payment capture.
metadata
object		Additional data in JSON key:value format. See Metadata.
canceled_at
datetime		The payment capture cancelation UTC timestamp.
updated_at
datetime		The payment capture update UTC timestamp.
created_at
datetime		The payment capture creation UTC timestamp.

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,
   "updated_at": null,
   "created_at": "2023-09-25T08:50:07.605Z"
}