TenderTransaction

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.

What you can do with TenderTransaction

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

TenderTransaction properties

id
read-only
"id": 999225661

The ID of the transaction.

order_id
read-only
"order_id": 450789469

The ID of the order that the tender transaction belongs to.

amount
read-only
"amount": "10.00"

The amount of the tender transaction in the shop's currency.

currency
read-only
"currency": "USD"

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

user_id
read-only
"user_id": 106045196

The ID of the user logged into the Shopify POS device that processed the tender transaction, if applicable.

test
read-only
"test": true

Whether the tender transaction is a test transaction.

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

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

remote_reference
read-only
"remote_reference": "ch_1AtJu6CktlpKSclI4zjeQb2t"

The remote (gateway) reference associated with the tender.

payment_details
read-only
"payment_details": {
  "credit_card_number": "•••• •••• •••• 4242",
  "credit_card_company": "Visa"
}

Information about the payment instrument used for this transaction. It has the following properties:

  • credit_card_company: The name of the company that issued the customer's credit card.
  • credit_card_number: The customer's credit card number, with most of the leading digits redacted.

payment_method
read-only
"payment_method": "credit_card"

Information about the payment method used for this transaction. Valid values:

  • credit_card
  • cash
  • android_pay
  • apple_pay
  • google_pay
  • samsung_pay
  • shopify_pay
  • amazon
  • klarna
  • paypal
  • unknown
  • other

Endpoints

GET /admin/tender_transactions.json
Retrieves a list of tender transactions.
since_id

Retrieve only transactions after the specified ID.

processed_at_min

Show tender transactions processed_at or after the specified date.

processed_at_max

Show tender transactions processed_at or before the specified date.

processed_at

Show tender transactions processed at the specified date.

order

Show tender transactions ordered by processed_at in ascending or descending order.

Retrieve tender transactions processed_at or before the specified date

GET /admin/tender_transactions.json?processed_at_max=2005-08-06 10:22:51 -0400
View Response
HTTP/1.1 200 OK
{
  "tender_transactions": [
    {
      "id": 776836104,
      "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": {
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "payment_method": "credit_card"
    }
  ]
}

Retrieve tender transactions processed_at the specified date

GET /admin/tender_transactions.json?processed_at_max=2005-08-05 10:22:51 -0400
View Response
HTTP/1.1 200 OK
{
  "tender_transactions": [
    {
      "id": 776836106,
      "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": {
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "payment_method": "credit_card"
    }
  ]
}

Retrieve tender transactions ordered by processed_at

GET /admin/tender_transactions.json?order=processed_at ASC
View Response
HTTP/1.1 200 OK
{
  "tender_transactions": [
    {
      "id": 776836108,
      "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": {
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "payment_method": "credit_card"
    },
    {
      "id": 776836109,
      "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": {
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "payment_method": "credit_card"
    }
  ]
}

Retrieve all tender transactions

GET /admin/tender_transactions.json
View Response
HTTP/1.1 200 OK
{
  "tender_transactions": [
    {
      "id": 776836111,
      "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": {
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "payment_method": "credit_card"
    },
    {
      "id": 776836110,
      "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": {
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "payment_method": "credit_card"
    }
  ]
}

Retrieve tender transactions after the specified ID

GET /admin/tender_transactions.json?since_id=776836112
View Response
HTTP/1.1 200 OK
{
  "tender_transactions": [
    {
      "id": 776836113,
      "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": {
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "payment_method": "credit_card"
    }
  ]
}

Retrieve tender transactions processed_at or after the specified date

GET /admin/tender_transactions.json?processed_at_min=2005-08-06 10:22:51 -0400
View Response
HTTP/1.1 200 OK
{
  "tender_transactions": [
    {
      "id": 776836115,
      "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": {
        "credit_card_number": "•••• •••• •••• 4242",
        "credit_card_company": "Visa"
      },
      "payment_method": "credit_card"
    }
  ]
}

Sign up for a Partner account to get started.

Sign up