# 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.

## Resource Properties ### TenderTransaction * id: The ID of the transaction. * Type: x-string * Example: 999225661 * order_id: The ID of the order that the tender transaction belongs to. * Type: x-string * Example: 450789469 * amount: The amount of the tender transaction in the shop's currency. * Type: x-string * Example: "10.00" * currency: The three-letter code (ISO 4217 format) for the currency used for the tender transaction. * Type: x-string * Example: "USD" * user_id: The ID of the user logged into the Shopify POS device that processed the tender transaction, if applicable. * Type: x-string * Example: 106045196 * test: Whether the tender transaction is a test transaction. * Type: x-string * Example: true * processed_at: The date and time (ISO 8601 format) when the tender transaction was processed. * Type: x-string * Example: "2012-03-13T16:09:54-04:00" * remote_reference: The remote (gateway) reference associated with the tender. * Type: x-string * Example: "ch_1AtJu6CktlpKSclI4zjeQb2t" * payment_details: Information about the payment instrument used for this transaction. It has the following properties: * Type: x-string * Example: {"credit_card_number"=>"•••• •••• •••• 4242", "credit_card_company"=>"Visa"} * payment_method: Information about the payment method used for this transaction. Valid values: * Type: x-string * Example: "credit_card" ## Retrieves a list of tender transactions 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. ### Endpoint /admin/api/#{api_version}/tender_transactions.json (GET) ### Parameters * api_version (required): * limit: 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. ### Responses #### 200 Retrieves a list of tender transactions Examples: ##### Retrieve all tender transactions Request: ``` GET /admin/api/unstable/tender_transactions.json ``` Response: ``` HTTP/1.1 200 OK {"tender_transactions":[{"id":1011222837,"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":1011222836,"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"}]} ``` ##### Retrieve tender transactions after the specified ID Request: ``` GET /admin/api/unstable/tender_transactions.json ``` Response: ``` HTTP/1.1 200 OK {"tender_transactions":[{"id":1011222835,"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"}]} ``` ##### Retrieve tender transactions ordered by processed_at Request: ``` GET /admin/api/unstable/tender_transactions.json ``` Response: ``` HTTP/1.1 200 OK {"tender_transactions":[{"id":1011222826,"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"},{"id":1011222827,"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"}]} ``` ##### Retrieve tender transactions processed_at or after the specified date Request: ``` GET /admin/api/unstable/tender_transactions.json ``` Response: ``` HTTP/1.1 200 OK {"tender_transactions":[{"id":1011222831,"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"}]} ``` ##### Retrieve tender transactions processed_at or before the specified date Request: ``` GET /admin/api/unstable/tender_transactions.json ``` Response: ``` HTTP/1.1 200 OK {"tender_transactions":[{"id":1011222828,"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"}]} ``` ##### Retrieve tender transactions processed_at the specified date Request: ``` GET /admin/api/unstable/tender_transactions.json ``` Response: ``` HTTP/1.1 200 OK {"tender_transactions":[{"id":1011222832,"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"}]} ```