Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
V1Transactions

RetrievePayment

Provides comprehensive information for a single payment.

get/v1/{location_id}/payments/{payment_id}

Path parameters

location_idstring required

The ID of the payment's associated location.

payment_idstring required

The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint.

Response

Success

created_atstring

The time when the payment was created, in ISO 8601 format. Reflects the time of the first payment if the object represents an incomplete partial payment, and the time of the last or complete payment otherwise.

creator_idstring

The unique identifier of the Square account that took the payment.

idstring

The payment's unique identifier.

is_partialboolean

Indicates whether or not the payment is only partially paid for. If true, this payment will have the tenders collected so far, but the itemizations will be empty until the payment is completed.

merchant_idstring

The unique identifier of the merchant that took the payment.

payment_urlstring

The URL of the payment's detail page in the merchant dashboard. The merchant must be signed in to the merchant dashboard to view this page.

receipt_urlstring

The URL of the receipt for the payment. Note that for split tender payments, this URL corresponds to the receipt for the first tender listed in the payment's tender field. Each Tender object has its own receipt_url field you can use to get the other receipts associated with a split tender payment.