# The capture object

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.**payment\_method\_type**       | `string`   | Information about the payment method used in the transaction.                                                                                                                                       |
| 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.**payment\_source**          | `object`   | The associated payment source.                                                                                                                                                                      |
| relationships.**attachments**              | `array`    | The associated attachments.                                                                                                                                                                         |
| relationships.**events**                   | `array`    | The associated events.                                                                                                                                                                              |
| relationships.**versions**                 | `array`    | The associated changes.                                                                                                                                                                             |
| relationships.**event\_stores**            | `array`    | The associated event stores.                                                                                                                                                                        |
| 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`)                                                                                                                                           |