• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
List payments

GET /v2/payments

Retrieves a list of payments taken by the account making the request.

Results are eventually consistent, and new payments or changes to payments might take several seconds to appear.

The maximum results per page is 100.

Name Description
begin_time
string

The timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. Default: The current time minus one year.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

end_time
string

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

Default: The current time.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

sort_order
string

The order in which results are listed:

  • ASC - Oldest to newest.
  • DESC - Newest to oldest (default).
cursor
string

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

For more information, see Pagination.

location_id
string

Limit results to the location supplied. By default, results are returned for the default (main) location associated with the seller.

total
integer (64-bit)

The exact amount in the total_money for a payment.

last_4
string

The last four digits of a payment card.

card_brand
string

The brand of the payment card (for example, VISA).

limit
integer (32-bit)

The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page.

The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead.

Default: 100

Response Fields

Name Description
errors
Error [ ]

Information about errors encountered during the request.

payments
Payment [ ]

The requested list of payments.

cursor
string

The pagination cursor to be used in a subsequent request. If empty, this is the final response.

For more information, see Pagination.

Examples

You are viewing an old version of the API
GET /v2/payments
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/payments \
  -H 'Square-Version: 2021-06-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "payments": [
    {
      "id": "ifrBnAil7rRfDtd27cdf9g9WO8paB",
      "created_at": "2019-07-09T14:36:13.745Z",
      "updated_at": "2019-07-09T14:36:13.883Z",
      "amount_money": {
        "amount": 1000,
        "currency": "USD"
      },
      "total_money": {
        "amount": 1000,
        "currency": "USD"
      },
      "approved_money": {
        "amount": 1000,
        "currency": "USD"
      },
      "status": "APPROVED",
      "source_type": "CARD",
      "card_details": {
        "status": "AUTHORIZED",
        "card": {
          "card_brand": "VISA",
          "last_4": "1111",
          "exp_month": 2,
          "exp_year": 2022,
          "fingerprint": "sq-1-lHpUJIUyqOPQmH89b6GuQEljmc-mZmu4kSTaMlkLDkJI7NVjAl4Zirn2sk3OeyVKVA"
        },
        "entry_method": "KEYED",
        "cvv_status": "CVV_ACCEPTED",
        "avs_status": "AVS_ACCEPTED",
        "auth_result_code": "NQbV3A",
        "card_payment_timeline": {
          "authorized_at": "2019-07-09T14:36:13.798Z"
        }
      },
      "location_id": "QLIJX16Q3UZ0A",
      "order_id": "MvfIilKnIYKBium4rauH67wFzRxv",
      "capabilities": [
        "EDIT_AMOUNT_UP",
        "EDIT_AMOUNT_DOWN",
        "EDIT_TIP_AMOUNT_UP",
        "EDIT_TIP_AMOUNT_DOWN"
      ],
      "version_token": "v6orqdHcW2TwuzCQRdF6a4ktbG8T8nbDcBx8eyrkoZl6o"
    },
    {
      "id": "GQTFp1ZlXdpoW4o6eGiZhbjosiDFf",
      "created_at": "2019-07-08T01:00:51.607Z",
      "updated_at": "2019-07-08T01:13:58.508Z",
      "amount_money": {
        "amount": 1000,
        "currency": "USD"
      },
      "total_money": {
        "amount": 1000,
        "currency": "USD"
      },
      "approved_money": {
        "amount": 1000,
        "currency": "USD"
      },
      "status": "COMPLETED",
      "source_type": "CARD",
      "card_details": {
        "status": "CAPTURED",
        "card": {
          "card_brand": "VISA",
          "last_4": "2796",
          "exp_month": 7,
          "exp_year": 2026,
          "fingerprint": "sq-1-TpmjbNBMFdibiIjpQI5LiRgNUBC7u1689i0TgHjnlyHEWYB7tnn-K4QbW4ttvtaqXw"
        },
        "entry_method": "ON_FILE",
        "cvv_status": "CVV_ACCEPTED",
        "avs_status": "AVS_ACCEPTED",
        "auth_result_code": "vPIr0K",
        "card_payment_timeline": {
          "authorized_at": "2019-07-08T01:00:51.617Z",
          "captured_at": "2019-07-08T01:13:58.508Z"
        }
      },
      "location_id": "XTI0H92143A39",
      "order_id": "m2Hr8Hk8A3CTyQQ1k4ynExg92tO3",
      "customer_id": "RDX9Z4XTIZR7MRZJUXNY9HUK6I",
      "processing_fee": [
        {
          "effective_at": "2019-07-08T03:00:53.000Z",
          "type": "INITIAL",
          "amount_money": {
            "amount": 59,
            "currency": "USD"
          }
        }
      ],
      "version_token": "pE0wanQBErcnO4ubL49pHCV1yAs4BUScWXb8fVvkRqa6o"
    }
  ],
  "cursor": "2TTnuq0yRYDdBRSFF2XuFkgO1Bclt4ZHNI7YrFNeyZ6rL1WZXkdnLn10H8fBIwFKdKW1Af6ifRa"
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?