v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB

Transactions

ListTransactions

Lists transactions for a particular location.

Transactions include payment information from sales and exchanges and refund information from returns and exchanges.

Max results per page: 50

get/v2/locations/{location_id}/transactions

Path parameters

location_idstring required

The ID of the location to list transactions for.

Query parameters

begin_timestring

The beginning of the requested reporting period, in RFC 3339 format.

See Date ranges for details on date inclusivity/exclusivity.

Default value: The current time minus one year.

end_timestring

The end of the requested reporting period, in RFC 3339 format.

See Date ranges for details on date inclusivity/exclusivity.

Default value: The current time.

sort_orderstring

The order in which results are listed in the response (ASC for oldest first, DESC for newest first).

Default value: DESC

cursorstring

A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.

See Paginating results for more information.

Response

Success

cursorstring

A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the cursor parameter in a subsequent request to this endpoint.

See Paginating results for more information.

Example response

{
  "transactions": [
    {
      "created_at": "2016-01-20T22:57:56Z",
      "id": "KnL67ZIwXCPtzOrqj0HrkxMF",
      "location_id": "18YC4JDH91E1H",
      "product": "EXTERNAL_API",
      "reference_id": "some optional reference id",
      "refunds": [
        {
          "additional_recipients": [
            {
              "amount_money": {
                "amount": 100,
                "currency": "USD"
              },
              "description": "Application fees",
              "location_id": "057P5VYJ4A5X1"
            }
          ],
          "amount_money": {
            "amount": 5000,
            "currency": "USD"
          },
          "created_at": "2016-01-20T22:59:20Z",
          "id": "7a5RcVI0CxbOcJ2wMOkE",
          "location_id": "18YC4JDH91E1H",
          "processing_fee_money": {
            "amount": 138,
            "currency": "USD"
          },
          "reason": "some reason why",
          "status": "APPROVED",
          "tender_id": "MtZRYYdDrYNQbOvV7nbuBvMF",
          "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF"
        }
      ],
      "tenders": [
        {
          "additional_recipients": [
            {
              "amount_money": {
                "amount": 20,
                "currency": "USD"
              },
              "description": "Application fees",
              "location_id": "057P5VYJ4A5X1"
            }
          ],
          "amount_money": {
            "amount": 5000,
            "currency": "USD"
          },
          "card_details": {
            "card": {
              "card_brand": "VISA",
              "last_4": "1111"
            },
            "entry_method": "KEYED",
            "status": "CAPTURED"
          },
          "created_at": "2016-01-20T22:57:56Z",
          "id": "MtZRYYdDrYNQbOvV7nbuBvMF",
          "location_id": "18YC4JDH91E1H",
          "note": "some optional note",
          "processing_fee_money": {
            "amount": 138,
            "currency": "USD"
          },
          "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF",
          "type": "CARD"
        }
      ]
    }
  ]
}