Transaction

Version 2019-10

Transactions are created for every order that results in an exchange of money.

There are five types of transactions:

  • Authorization: An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.
  • Sale: An authorization and capture performed together in a single step.
  • Capture: A transfer of the money that was reserved during the authorization stage.
  • Void: A cancellation of a pending authorization or capture.
  • Refund: A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

Refund transactions must be created by using the Refund resource.

Note

An order can have no more than 100 transactions associated with it.

What you can do with Transaction

The Shopify API lets you do the following with the Transaction resource. More detailed versions of these general actions may be available:

Transaction properties

amount
"amount": "10.00"

The amount of money included in the transaction. If you don't provide a value for `amount`, then it defaults to the total cost of the order (even if a previous transaction has been made towards it).

authorization
"authorization": "ch_1AtJu6CktlpKSclI4zjeQb2t"

The authorization code associated with the transaction.

created_at
read-only
"created_at": "2012-03-13T16:09:54-04:00"

The date and time (ISO 8601 format) when the transaction was created.

currency
"currency": "USD"

The three-letter code (ISO 4217 format) for the currency used for the payment.

device_id
read-only
"device_id": 1

The ID for the device.

error_code
read-only
"error_code": "invalid_cvc"
<