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	string	captures
id	string	The capture unique identifier
links.self	string	The capture endpoint URL
attributes.number	string	The transaction number, auto generated.
attributes.currency_code	string	The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.
attributes.amount_cents	integer	The transaction amount, in cents.
attributes.amount_float	float	The transaction amount, float.
attributes.formatted_amount	string	The transaction amount, formatted.
attributes.succeeded	boolean	Indicates if the transaction is successful.
attributes.message	string	The message returned by the payment gateway.
attributes.error_code	string	The error code, if any, returned by the payment gateway.
attributes.error_detail	string	The error detail, if any, returned by the payment gateway.
attributes.token	string	The token identifying the transaction, returned by the payment gateway.
attributes.gateway_transaction_id	string	The ID identifying the transaction, returned by the payment gateway.
attributes._forward	boolean	Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.
attributes.created_at	datetime	Time at which the resource was created.
attributes.updated_at	datetime	Time at which the resource was last updated.
attributes.reference	string	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	string	Any identifier of the third party system that defines the reference code.
attributes.metadata	object	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	boolean	Send this attribute if you want to create a refund for this capture.
attributes._refund_amount_cents	integer	Send this attribute as a value in cents if you want to overwrite the amount to be refunded.
attributes.refund_amount_cents	integer	The amount to be refunded, in cents.
attributes.refund_amount_float	float	The amount to be refunded, float.
attributes.formatted_refund_amount	string	The amount to be refunded, formatted.
attributes.refund_balance_cents	integer	The balance to be refunded, in cents.
attributes.refund_balance_float	float	The balance to be refunded, float.
attributes.formatted_refund_balance	string	The balance to be refunded, formatted.
attributes._cancel	boolean	Send this attribute if you want to refund a succeeded capture of a pending order (which is left unpaid).
relationships.order	object	The associated order.
relationships.attachments	array	The associated attachments.
relationships.events	array	The associated events.
relationships.versions	array	The associated changes.
relationships.reference_authorization	object	The associated reference authorization.
relationships.refunds	array	The associated refunds.
relationships.return	object	The associated return.
meta.mode	string	The resource environment (can be one of test or live)