<- Payments API

Payments API

All versions ->

List payments

GET

/v2/payments

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

Max results per page: 100

Permissions:PAYMENTS_READ

Try in API Explorer

Link to section

Query parameters

Example code

Link to section

begin_time

string

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

Link to section

end_time

string

Timestamp for the end of the requested 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

Link to section

sort_order

string

The order in which results are listed.

ASC - oldest to newest
DESC - newest to oldest (default).

Link to section

cursor

string

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

See Pagination for more information.

Link to section

location_id

string

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

Link to section

total

integer(64-bit)

The exact amount in the total_money for a Payment.

Link to section

last_4

string

The last 4 digits of Payment card.

Link to section

card_brand

string

The brand of Payment card. For example, VISA

Link to section

limit

integer(32-bit)

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.

If the supplied value is greater than 100, at most 100 results will be returned.

Default: 100

Link to section

Response fields

Link to section

errors

Information on errors encountered during the request.

Link to section

payments

The requested list of Payments.

Link to section

cursor

string

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

See Pagination for more information.

Link to section

Examples

All versions ->

GET /v2/payments

curl https://connect.squareup.com/v2/payments \
  -H 'Square-Version: 2020-09-23' \
  -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"
      },
      "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"
      },
      "location_id": "QLIJX16Q3UZ0A",
      "order_id": "MvfIilKnIYKBium4rauH67wFzRxv"
    },
    {
      "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"
      },
      "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"
      },
      "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"
          }
        }
      ]
    }
  ],
  "cursor": "2TTnuq0yRYDdBRSFF2XuFkgO1Bclt4ZHNI7YrFNeyZ6rL1WZXkdnLn10H8fBIwFKdKW1Af6ifRa"
}

List payments

Query parameters

Response fields

Strictly necessary technology

Performance and analytical technology

Functionality technology

Retargeting or advertising technology