An authorization object is returned as part of the response body of each successful list, retrieve or update API call.
Field | Type | Description |
type |
|
|
id |
| The authorization unique identifier |
links.self |
| The authorization 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.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.cvv_code |
| The CVV code returned by the payment gateway |
attributes.cvv_message |
| The CVV message returned by the payment gateway |
attributes.avs_code |
| The AVS code returned by the payment gateway |
attributes.avs_message |
| The AVS message returned by the payment gateway |
attributes.fraud_review |
| The fraud review message, if any, returned by the payment gateway |
attributes._capture |
| Send this attribute if you want to create a capture for this authorization. |
attributes._capture_amount_cents |
| The associated capture amount, in cents. |
attributes.capture_amount_cents |
| The amount to be captured, in cents. |
attributes.capture_amount_float |
| The amount to be captured, float. |
attributes.formatted_capture_amount |
| The amount to be captured, formatted. |
attributes.capture_balance_cents |
| The balance to be captured, in cents. |
attributes.capture_balance_float |
| The balance to be captured, float. |
attributes.formatted_capture_balance |
| The balance to be captured, formatted. |
attributes._void |
| Send this attribute if you want to create a void for this authorization. |
attributes.void_balance_cents |
| The balance to be voided, in cents. |
attributes.void_balance_float |
| The balance to be voided, float. |
attributes.formatted_void_balance |
| The balance to be voided, formatted. |
relationships.order |
| The associated order |
relationships.captures |
| The associated captures |
relationships.voids |
| The associated voids |
meta.mode |
| The resource environment (can be one of |