--- title: "RetrievePayment" method: GET path: "/v1/{location_id}/payments/{payment_id}" tags: ["V1Transactions"] --- # RetrievePayment `GET /v1/{location_id}/payments/{payment_id}` Provides comprehensive information for a single payment. ## Path parameters - `location_id` string, required - `payment_id` string, required ## Response `200` Success - V1Payment — A payment represents a paid transaction between a Square merchant and a customer. Payment details are usually available from Connect API endpoints within a few minutes after the transaction completes. Each Payment object includes several fields that end in `_money`. These fields describe the various amounts of money that contribute to the payment total: - `additive_tax` V1PaymentTax[] — All of the additive taxes associated with the payment. - `applied_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `errors` Error[] — Any errors that occurred during the request. - `category` string, required — The high-level category for the error. - `code` string, required — The specific code of the error. - `detail` string — A human-readable description of the error for debugging purposes. - `field` string — The name of the field provided in the original request (if any) that the error pertains to. - `fee_id` string — The ID of the tax, if available. Taxes applied in older versions of Square Register might not have an ID. - `inclusion_type` string — Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. - `name` string — The merchant-defined name of the tax. - `rate` string — The rate of the tax, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. - `additive_tax_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `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. - `creator_id` string — The unique identifier of the Square account that took the payment. - `device` Device - `id` string — The device's Square-issued ID. - `name` string — The device's merchant-specified name. - `discount_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `gross_sales_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `id` string — The payment's unique identifier. - `inclusive_tax` V1PaymentTax[] — All of the inclusive taxes associated with the payment. - `applied_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `errors` Error[] — Any errors that occurred during the request. - `category` string, required — The high-level category for the error. - `code` string, required — The specific code of the error. - `detail` string — A human-readable description of the error for debugging purposes. - `field` string — The name of the field provided in the original request (if any) that the error pertains to. - `fee_id` string — The ID of the tax, if available. Taxes applied in older versions of Square Register might not have an ID. - `inclusion_type` string — Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. - `name` string — The merchant-defined name of the tax. - `rate` string — The rate of the tax, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. - `inclusive_tax_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `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. - `itemizations` V1PaymentItemization[] — The items purchased in the payment. - `discount_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `discounts` V1PaymentDiscount[] — All discounts applied to this itemization. - `applied_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `discount_id` string — The ID of the applied discount, if available. Discounts applied in older versions of Square Register might not have an ID. - `name` string — The discount's name. - `gross_sales_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `item_detail` V1PaymentItemDetail — V1PaymentItemDetail - `category_name` string — The name of the item's merchant-defined category, if any. - `item_id` string — The unique ID of the item purchased, if any. - `item_variation_id` string — The unique ID of the item variation purchased, if any. - `sku` string — The item's merchant-defined SKU, if any. - `item_variation_name` string — The name of the item variation purchased, if any. - `itemization_type` string — The type of purchase that the itemization represents, such as an ITEM or CUSTOM_AMOUNT - `modifiers` V1PaymentModifier[] — All modifier options applied to this itemization. - `applied_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `modifier_option_id` string — The ID of the applied modifier option, if available. Modifier options applied in older versions of Square Register might not have an ID. - `name` string — The modifier option's name. - `name` string — The item's name. - `net_sales_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `notes` string — Notes entered by the merchant about the item at the time of payment, if any. - `quantity` number — The quantity of the item purchased. This can be a decimal value. - `single_quantity_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `taxes` V1PaymentTax[] — All taxes applied to this itemization. - `applied_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `errors` Error[] — Any errors that occurred during the request. - `category` string, required — The high-level category for the error. - `code` string, required — The specific code of the error. - `detail` string — A human-readable description of the error for debugging purposes. - `field` string — The name of the field provided in the original request (if any) that the error pertains to. - `fee_id` string — The ID of the tax, if available. Taxes applied in older versions of Square Register might not have an ID. - `inclusion_type` string — Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. - `name` string — The merchant-defined name of the tax. - `rate` string — The rate of the tax, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. - `total_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `merchant_id` string — The unique identifier of the merchant that took the payment. - `net_sales_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `net_total_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `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. - `processing_fee_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `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. - `refunded_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `refunds` V1Refund[] — 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. - `created_at` string — The time when the merchant initiated the refund for Square to process, in ISO 8601 format. - `is_exchange` boolean — Indicates whether or not the refund is associated with an exchange. If is_exchange is true, the refund reflects the value of goods returned in the exchange not the total money refunded. - `merchant_id` string - `payment_id` string — A Square-issued ID associated with the refund. For single-tender refunds, payment_id is the ID of the original payment ID. For split-tender refunds, payment_id is the ID of the original tender. For exchange-based refunds (is_exchange == true), payment_id is the ID of the original payment ID even if the payment includes other tenders. - `processed_at` string — The time when Square processed the refund on behalf of the merchant, in ISO 8601 format. - `reason` string — The merchant-specified reason for the refund. - `refunded_additive_tax` V1PaymentTax[] — All of the additive taxes associated with the refund. - `applied_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `errors` Error[] — Any errors that occurred during the request. - `category` string, required — The high-level category for the error. - `code` string, required — The specific code of the error. - `detail` string — A human-readable description of the error for debugging purposes. - `field` string — The name of the field provided in the original request (if any) that the error pertains to. - `fee_id` string — The ID of the tax, if available. Taxes applied in older versions of Square Register might not have an ID. - `inclusion_type` string — Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. - `name` string — The merchant-defined name of the tax. - `rate` string — The rate of the tax, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. - `refunded_additive_tax_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `refunded_discount_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `refunded_inclusive_tax` V1PaymentTax[] — All of the inclusive taxes associated with the refund. - `applied_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `errors` Error[] — Any errors that occurred during the request. - `category` string, required — The high-level category for the error. - `code` string, required — The specific code of the error. - `detail` string — A human-readable description of the error for debugging purposes. - `field` string — The name of the field provided in the original request (if any) that the error pertains to. - `fee_id` string — The ID of the tax, if available. Taxes applied in older versions of Square Register might not have an ID. - `inclusion_type` string — Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. - `name` string — The merchant-defined name of the tax. - `rate` string — The rate of the tax, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. - `refunded_inclusive_tax_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `refunded_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `refunded_processing_fee_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `refunded_surcharge_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `refunded_surcharges` V1PaymentSurcharge[] — A list of all surcharges associated with the refund. - `amount_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `applied_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `name` string — The name of the surcharge. - `rate` string — The amount of the surcharge as a percentage. The percentage is provided as a string representing the decimal equivalent of the percentage. For example, "0.7" corresponds to a 7% surcharge. Exactly one of rate or amount_money should be set. - `surcharge_id` string — A Square-issued unique identifier associated with the surcharge. - `taxable` boolean — Indicates whether the surcharge is taxable. - `taxes` V1PaymentTax[] — The list of taxes that should be applied to the surcharge. - `applied_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `errors` Error[] — Any errors that occurred during the request. - `category` string, required — The high-level category for the error. - `code` string, required — The specific code of the error. - `detail` string — A human-readable description of the error for debugging purposes. - `field` string — The name of the field provided in the original request (if any) that the error pertains to. - `fee_id` string — The ID of the tax, if available. Taxes applied in older versions of Square Register might not have an ID. - `inclusion_type` string — Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. - `name` string — The merchant-defined name of the tax. - `rate` string — The rate of the tax, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. - `type` string — Indicates the source of the surcharge. For example, if it was applied as an automatic gratuity for a large group. - `refunded_tax_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `refunded_tip_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `type` string — The type of refund - `surcharge_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `surcharges` V1PaymentSurcharge[] — A list of all surcharges associated with the payment. - `amount_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `applied_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `name` string — The name of the surcharge. - `rate` string — The amount of the surcharge as a percentage. The percentage is provided as a string representing the decimal equivalent of the percentage. For example, "0.7" corresponds to a 7% surcharge. Exactly one of rate or amount_money should be set. - `surcharge_id` string — A Square-issued unique identifier associated with the surcharge. - `taxable` boolean — Indicates whether the surcharge is taxable. - `taxes` V1PaymentTax[] — The list of taxes that should be applied to the surcharge. - `applied_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `errors` Error[] — Any errors that occurred during the request. - `category` string, required — The high-level category for the error. - `code` string, required — The specific code of the error. - `detail` string — A human-readable description of the error for debugging purposes. - `field` string — The name of the field provided in the original request (if any) that the error pertains to. - `fee_id` string — The ID of the tax, if available. Taxes applied in older versions of Square Register might not have an ID. - `inclusion_type` string — Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. - `name` string — The merchant-defined name of the tax. - `rate` string — The rate of the tax, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. - `type` string — Indicates the source of the surcharge. For example, if it was applied as an automatic gratuity for a large group. - `swedish_rounding_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `tax_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `tender` V1Tender[] — All of the tenders associated with the payment. - `card_brand` string — The brand of credit card provided. - `change_back_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `employee_id` string — The ID of the employee that processed the tender. - `entry_method` string — The tender's unique ID. - `id` string — The tender's unique ID. - `is_exchange` boolean — Indicates whether or not the tender is associated with an exchange. If is_exchange is true, the tender represents the value of goods returned in an exchange not the actual money paid. The exchange value reduces the tender amounts needed to pay for items purchased in the exchange. - `name` string — A human-readable description of the tender. - `pan_suffix` string — The last four digits of the provided credit card's account number. - `payment_note` string — Notes entered by the merchant about the tender at the time of payment, if any. Typically only present for tender with the type: OTHER. - `receipt_url` string — The URL of the receipt for the tender. - `refunded_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `settled_at` string — The time when the tender was settled, in ISO 8601 format. - `tendered_at` string — The time when the tender was created, in ISO 8601 format. - `tendered_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `total_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `type` string — The type of tender. - `tip_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string - `total_collected_money` V1Money - `amount` integer — Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). - `currency_code` string --- [API](https://skmtc.net/square/apis/squareup.md) · [All operations](https://skmtc.net/square/apis/squareup/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/square/squareup/versions/8d95e3639487/schema)