v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

Payments

ListPayments

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.

get/v2/payments

Query parameters

begin_timestring

Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the created_at field for each Payment. Inclusive. Default: The current time minus one year.

end_timestring

Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the created_at field for each Payment.

Default: The current time.

sort_orderstring

The order in which results are listed by ListPaymentsRequest.sort_field:

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

cursorstring

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_idstring

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

totalinteger

The exact amount in the total_money for a payment.

last_4string

The last four digits of a payment card.

card_brandstring

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

limitinteger

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

is_offline_paymentboolean

Whether the payment was taken offline or not.

offline_begin_timestring

Indicates the start of the time range for which to retrieve offline payments, in RFC 3339 format for timestamps. The range is determined using the offline_payment_details.client_created_at field for each Payment. If set, payments without a value set in offline_payment_details.client_created_at will not be returned.

Default: The current time.

offline_end_timestring

Indicates the end of the time range for which to retrieve offline payments, in RFC 3339 format for timestamps. The range is determined using the offline_payment_details.client_created_at field for each Payment. If set, payments without a value set in offline_payment_details.client_created_at will not be returned.

Default: The current time.

updated_at_begin_timestring

Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the updated_at field for each Payment.

updated_at_end_timestring

Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the updated_at field for each Payment.

sort_field'CREATED_AT' | 'OFFLINE_CREATED_AT' | 'UPDATED_AT'

The field used to sort results by. The default is CREATED_AT.

Response

Success

cursorstring

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

For more information, see Pagination.

Example response

{
  "payments": [
    {
      "amount_money": {
        "amount": 555,
        "currency": "USD"
      },
      "application_details": {
        "application_id": "sq0ids-Pw67AZAlLVB7hsRmwlJPuA",
        "square_product": "VIRTUAL_TERMINAL"
      },
      "approved_money": {
        "amount": 555,
        "currency": "USD"
      },
      "card_details": {
        "auth_result_code": "2Nkw7q",
        "avs_status": "AVS_ACCEPTED",
        "card": {
          "bin": "411111",
          "card_brand": "VISA",
          "card_type": "DEBIT",
          "exp_month": 11,
          "exp_year": 2022,
          "fingerprint": "sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ",
          "last_4": "1111",
          "prepaid_type": "NOT_PREPAID"
        },
        "card_payment_timeline": {
          "authorized_at": "2021-10-13T19:34:33.680Z",
          "captured_at": "2021-10-13T19:34:34.340Z"
        },
        "cvv_status": "CVV_ACCEPTED",
        "entry_method": "KEYED",
        "statement_description": "SQ *EXAMPLE TEST GOSQ.C",
        "status": "CAPTURED"
      },
      "created_at": "2021-10-13T19:34:33.524Z",
      "delay_action": "CANCEL",
      "delay_duration": "PT168H",
      "delayed_until": "2021-10-20T19:34:33.524Z",
      "employee_id": "TMoK_ogh6rH1o4dV",
      "id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY",
      "location_id": "L88917AVBK2S5",
      "note": "Test Note",
      "order_id": "d7eKah653Z579f3gVtjlxpSlmUcZY",
      "processing_fee": [
        {
          "amount_money": {
            "amount": 34,
            "currency": "USD"
          },
          "effective_at": "2021-10-13T21:34:35.000Z",
          "type": "INITIAL"
        }
      ],
      "receipt_number": "bP9m",
      "receipt_url": "https://squareup.com/receipt/preview/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY",
      "source_type": "CARD",
      "status": "COMPLETED",
      "team_member_id": "TMoK_ogh6rH1o4dV",
      "total_money": {
        "amount": 555,
        "currency": "USD"
      },
      "updated_at": "2021-10-13T19:34:37.261Z",
      "version_token": "vguW2km0KpVCdAXZcNTZ438qg5LlVPTP4HO5OpiHNfa6o"
    }
  ]
}