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.

Anchor to section titled 'undefined'

TenderTransaction

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?
#Endpoints
Anchor to section titled 'The TenderTransaction resource'

The TenderTransaction resource

Properties
id
read-only
->id
The ID of the transaction.
order_id
read-only
->order
The ID of the order that the tender transaction belongs to.
amount
read-only
->amount
The amount of the tender transaction in the shop's currency.
currency
read-only
->amount
The three-letter code (ISO 4217 format) for the currency used for the tender transaction.
user_id
read-only
->user
The ID of the user logged into the Shopify POS device that processed the tender transaction, if applicable.
test
read-only
->test
Whether the tender transaction is a test transaction.
processed_at
read-only
->processedAt
The date and time (ISO 8601 format) when the tender transaction was processed.
remote_reference
read-only
->remoteReference
The remote (gateway) reference associated with the tender.
payment_details
read-only
->transactionDetails
Information about the payment instrument used for this transaction. It has the following properties:
payment_method
read-only
->paymentMethod
Information about the payment method used for this transaction. Valid values:
Was this section helpful?
{}The TenderTransaction resource
{
  "id": 999225661,
  "order_id": 450789469,
  "amount": "10.00",
  "currency": "USD",
  "user_id": 106045196,
  "test": true,
  "processed_at": "2012-03-13T16:09:54-04:00",
  "remote_reference": "ch_1AtJu6CktlpKSclI4zjeQb2t",
  "payment_details": {
    "credit_card_number": "•••• •••• •••• 4242",
    "credit_card_company": "Visa"
  },
  "payment_method": "credit_card"
}
Anchor to section titled 'GET request, Retrieves a list of tender transactions'

get
Retrieves a list of tender transactions

tenderTransactions
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.
Anchor to section titled 'Parameters of Retrieves a list of tender transactions'

Parameters

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?
Anchor to section titled 'Examples of Retrieves a list of tender transactions'

Examples

Was this section helpful?
get
/admin/api/2024-10/tender_transactions.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/tender_transactions.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
HTTP/1.1 200 OK
{
  "tender_transactions": [
    {
      "id": 1011222858,
      "order_id": 450789469,
      "amount": "250.94",
      "currency": "USD",
      "user_id": null,
      "test": false,
      "processed_at": "2005-08-07T10:22:51-04:00",
      "remote_reference": "authorization-key",
      "payment_details": null,
      "payment_method": "credit_card"
    },
    {
      "id": 1011222857,
      "order_id": 450789469,
      "amount": "250.94",
      "currency": "USD",
      "user_id": null,
      "test": false,
      "processed_at": "2005-08-05T10:22:51-04:00",
      "remote_reference": "authorization-key",
      "payment_details": null,
      "payment_method": "credit_card"
    }
  ]
}