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 Mambu Payments (formerly Numeral), they can be recorded as payment_capture objects and reconciled with the corresponding bank transactions.

Attribute

Description

  • *id**
    string

The payment capture ID.

  • *idempotencykey**
    _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.

  • *connectedaccount_id**
    _string

The ID of the connected account used for the payment capture.

  • *transactionreference**
    _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.

  • *originalpayment_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.

  • *authorizationid**
    _string

The payment capture authorization ID.

  • *paymentreference**
    _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).

  • *valuedate**
    _date

The payment capture value date.

  • *network**
    string

The payment capture scheme or network (e.g. visa or mastercard).

  • *remittancedate**
    _date

The payment capture remittance date.

  • *remittancereference**
    _string

The payment capture remittance reference.

  • *feeamount**
    _integer

The payment capture fee amount.

  • *feeamount_currency**
    _string

The payment capture fee amount currency.

  • *netamount**
    _integer

The payment capture net amount.

  • *netamount_currency**
    _string

The payment capture net amount currency.

  • *source**
    string

The payment capture source, either api or reporting_file.

  • *merchantid**
    _string

The payment capture merchant ID.

  • *reconciliationstatus**
    _string

The payment capture reconciliation status, either unreconciled, reconciled, or partially_reconciled.

  • *reconciledamount**
    _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.

  • *canceledat**
    _datetime

The payment capture cancelation UTC timestamp.

  • *updatedat**
    _datetime

The payment capture update UTC timestamp.

  • *createdat**
    _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"
}