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.
Requires
orders
access scope.
Requires access to protected customer data.
Each tender transaction represents money passing between the merchant and a customer. A tender transaction with a positive amount represents a transaction where the customer paid money to the merchant. A negative amount represents a transaction where the merchant refunded money back to the customer. Tender transactions represent transactions that modify the shop's balance.
Was this section helpful?
Properties
The ID of the transaction.
The ID of the order that the tender transaction belongs to.
The amount of the tender transaction in the shop's currency.
The three-letter code (ISO 4217 format) for the currency used for the tender transaction.
The ID of the user logged into the Shopify POS device that processed the tender transaction, if applicable.
Whether the tender transaction is a test transaction.
The date and time (ISO 8601 format) when the tender transaction was processed.
The remote (gateway) reference associated with the tender.
Information about the payment instrument used for this transaction. It has the following properties:
Information about the payment method used for this transaction. Valid values:
Was this section helpful?
Retrieves a list of tender transactions. Note: This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to Make paginated requests to the REST Admin API.
api_version
string
required
limit
≤ 250
default 50
The maximum number of results to retrieve.
order
Show tender transactions ordered by processed_at in ascending or descending order.
processed_at
Show tender transactions processed at the specified date.
processed_at_max
Show tender transactions processed_at or before the specified date.
processed_at_min
Show tender transactions processed_at or after the specified date.
since_id
Retrieve only transactions after the specified ID.
Was this section helpful?
Was this section helpful?