The transaction object

A comprehensive list of the transaction resource's attributes and relationships

A transaction object is returned as part of the response body of each successful list or retrieve API call to the /api/transactions endpoint.

Fields

Field	Type	Description
type	string	transactions
id	string	The transaction unique identifier
links.self	string	The transaction endpoint URL
attributes._forward	boolean	Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.
attributes.amount_cents	integer	The transaction amount, in cents.
attributes.amount_float	float	The transaction amount, float.
attributes.created_at	datetime	Time at which the resource was created.
attributes.currency_code	string	The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.
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.formatted_amount	string	The transaction amount, formatted.
attributes.gateway_transaction_id	string	The ID identifying the transaction, returned by the payment gateway.
attributes.message	string	The message returned by the payment gateway.
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.number	string	The transaction number, auto generated.
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.succeeded	boolean	Indicates if the transaction is successful.
attributes.token	string	The token identifying the transaction, returned by the payment gateway.
attributes.updated_at	datetime	Time at which the resource was last updated.
relationships.attachments	array	The associated attachments.
relationships.events	array	The associated events.
relationships.order	object	The associated order.
relationships.versions	array	The associated changes.
meta.mode	string	The resource environment (can be one of test or live)