The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.
orders
, marketplace_orders
.
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 more than one authorization transaction associated with it. This might happen when an order is edited or when a post-purchase upsell is added to the order. To be notified when an order is edited subscribe to the OrderEdit webhook.
If your app captures payments, you should make a GET
request to the /admin/api/{version}/orders/{order_id}/transactions.json
endpoint to retrieve the
authorization transactions associated with an order. Then, to complete the full order payment capture, you should use the authorization
or parent_id
properties in separate capture POST
requests to the same endpoint for each authorization transaction.
Note
An order can have no more than 100 transactions associated with it.
Creates a transaction for an order.
external
to import a cash transaction for the associated order.Retrieves a list of transactions.
Transactions attached to multi-currency orders are in the presentment currency by default. To retrieve transactions in the shop currency, include the URL parameter in_shop_currency=true
.
Retrieves a specific transaction.
Transactions attached to multi-currency orders are in the presentment currency by default. To retrieve transactions in the shop currency, include the URL parameter in_shop_currency=true
.
extended_authorization_attributes
are available on this endpoint only to stores on the Shopify Plus plan that use Shopify Payments. To learn more about extended authorization periods, refer to Payment authorization.