<- Payments API

Payments API

V1Retrieve payment

GET

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

Provides comprehensive information for a single payment.

Permissions:PAYMENTS_READ
Try in API Explorer
Link to section

Path parameters

Example code

Link to section

location_id

string

Required

The ID of the payment's associated location.

Link to section

payment_id

string

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.

Link to section

Response fields

Link to section

id

string

The payment's unique identifier.

Link to section

merchant_id

string

The unique identifier of the merchant that took the payment.

Link to section

created_at

string

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.

Link to section

creator_id

string

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

Link to section

device

The device that took the payment.

Link to section

payment_url

string

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.

Link to section

receipt_url

string

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.

Link to section

inclusive_tax_money

The sum of all inclusive taxes associated with the payment.

Link to section

additive_tax_money

The sum of all additive taxes associated with the payment.

Link to section

tax_money

The total of all taxes applied to the payment. This is always the sum of inclusive_tax_money and additive_tax_money.

Link to section

tip_money

The total of all tips applied to the payment.

Link to section

discount_money

The total of all discounts applied to the payment.

Link to section

total_collected_money

The total of all discounts applied to the payment.

Link to section

processing_fee_money

The total of all processing fees collected by Square for the payment.

Link to section

net_total_money

The amount to be deposited into the merchant's bank account for the payment.

Link to section

refunded_money

The total of all refunds applied to the payment.

Link to section

swedish_rounding_money

The total of all sales, including any applicable taxes, rounded to the smallest legal unit of currency (e.g., the nearest penny in USD, the nearest nickel in CAD)

Link to section

gross_sales_money

The total of all sales, including any applicable taxes.

Link to section

net_sales_money

The total of all sales, minus any applicable taxes.

Link to section

inclusive_tax

All of the inclusive taxes associated with the payment.

Link to section

additive_tax

All of the additive taxes associated with the payment.

Link to section

tender

All of the tenders associated with the payment.

Link to section

refunds

All of the refunds applied to the payment. Note that the value of all refunds on a payment can exceed the value of all tenders if a merchant chooses to refund money to a tender after previously accepting returned goods as part of an exchange.

Link to section

itemizations

The items purchased in the payment.

Link to section

surcharge_money

The total of all surcharges applied to the payment.

Link to section

surcharges

A list of all surcharges associated with the payment.

Link to section

is_partial

boolean

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.