The capture object
A comprehensive list of the capture resource's attributes and relationships
A capture object is returned as part of the response body of each successful list, retrieve or update API call to the /api/captures
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The capture unique identifier |
links.self |
| The capture endpoint URL |
attributes.number |
| The transaction number, auto generated. |
attributes.currency_code |
| The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order. |
attributes.amount_cents |
| The transaction amount, in cents. |
attributes.amount_float |
| The transaction amount, float. |
attributes.formatted_amount |
| The transaction amount, formatted. |
attributes.succeeded |
| Indicates if the transaction is successful. |
attributes.message |
| The message returned by the payment gateway. |
attributes.error_code |
| The error code, if any, returned by the payment gateway. |
attributes.error_detail |
| The error detail, if any, returned by the payment gateway. |
attributes.token |
| The token identifying the transaction, returned by the payment gateway. |
attributes.gateway_transaction_id |
| The ID identifying the transaction, returned by the payment gateway. |
attributes._forward |
| Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly. |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code. |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
attributes._refund |
| Send this attribute if you want to create a refund for this capture. |
attributes._refund_amount_cents |
| Send this attribute as a value in cents if you want to overwrite the amount to be refunded. |
attributes.refund_amount_cents |
| The amount to be refunded, in cents. |
attributes.refund_amount_float |
| The amount to be refunded, float. |
attributes.formatted_refund_amount |
| The amount to be refunded, formatted. |
attributes.refund_balance_cents |
| The balance to be refunded, in cents. |
attributes.refund_balance_float |
| The balance to be refunded, float. |
attributes.formatted_refund_balance |
| The balance to be refunded, formatted. |
relationships.order |
| The associated order. |
relationships.attachments |
| The associated attachments. |
relationships.events |
| The associated events. |
relationships.versions |
| The associated changes. |
relationships.reference_authorization |
| The associated reference authorization. |
relationships.refunds |
| The associated refunds. |
relationships.return |
| The associated return. |
meta.mode |
| The resource environment (can be one of |
Last updated