Payment capture object

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.