Take Payments with the Terminal API

Applies to: Terminal API | Payments API | Devices API | Orders API

Learn how to take a payment with the Terminal API and Square Terminal.

Link to section

Overview

To take a payment with a paired Square Terminal, complete the following steps:

  1. Request a Square Terminal checkout for payment.
  2. Review additional options for payments in a checkout.
  3. Cancel a checkout request.
  4. Verify a payment.
  5. Search for Terminal checkout requests.

To learn how to configure a Square Terminal and pair it with your application, see Connect a Square Terminal to a POS Application.

Did you know?

You can test your Terminal API integration in the Square Sandbox without Square Terminal hardware interactions. Use these Sandbox test values to test your integration against successful and failed Terminal checkout requests.

When using a Sandbox device ID, you can test the Terminal checkout process and verify the checkout status change. In production, you should use Terminal API webhooks to get a checkout response notification because there can be a significant delay between requesting a checkout and the completion of the checkout. To learn more about subscribing to webhooks, see Subscribe to Event Notifications.

The following payment options are available only in the US:

  • Application fees
  • Delayed capture (including actions to be applied to delayed capture payments after the delay duration time has elapsed)
  • Orders and itemizations
  • (Beta) Statement description identifiers
  • (Beta) Tip money

Important

If the seller has a Square account that's not based in the US, you might encounter an error with Terminal checkout requests if the request contains fields for options not supported in the US. For example, the order_id field cannot be used for checkout requests from a non-US Square account.

Link to section

Requirements and limitations

  • Applications must have the following OAuth permissions: PAYMENTS_WRITE to process payments and PAYMENTS_READ to retrieve payments.
  • You cannot take cash payments with the Terminal API.
  • Application fees require calling CreateTerminalCheckout with an OAuth token and the PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS permission, in addition to the existing required OAuth permissions. For more information, see Terminal.
  • The Terminal API doesn't support updates made to orders after a Terminal checkout has been made with the order_id set to IN_PROGRESS, which means the Square Terminal is currently processing the checkout. If you try to update the order while the checkout is in progress, the checkout might respond with an erroneous result. To update the order, cancel the checkout with CancelTerminalCheckout and then create a new Terminal checkout request with the same order or create a new order along with a new Terminal checkout request.
  • Using CancelTerminalCheckout to cancel an e-money payment after getting an error on the Square Terminal is currently not supported. To cancel an e-money payment, the buyer needs to manually cancel the payment on the Square Terminal.
Link to section

Use the latest versions

To use the payment options for a Terminal checkout request, you must update the Square Terminal software to the latest version and use the latest release version of the Square API.

Link to section

1. Request a Square Terminal checkout

Your POS application must specify the total amount to be paid by the buyer (including any sales tax or other fees) when requesting a checkout. Optionally, your POS application can require the Square Terminal to prompt the buyer to add a tip amount, show a receipt screen, or show a signature screen.

Note

A Square Terminal accepts Apple Pay, Google Pay, Square gift cards, and prepaid debit cards. However, for US-based sellers, if the balance of a gift card or prepaid card isn't sufficient to pay for a transaction, the seller can delay the capture of the initial payment and request additional transactions to cover the remaining balance.

Link to section

Payment flow

To take a payment from a buyer, the Square Terminal needs to have the total purchase amount and currency. For example, a Square Terminal can be told to accept $100 (USD). To process this request, the POS application makes a request to Square using the Terminal API to send the payment request to a paired Square Terminal, identified by the device ID. The payment checkout process does the following steps:

  1. The POS client calls the CreateDeviceCode endpoint to pair with a Square Terminal and get a device ID. For more information, see Connect a Square Terminal to a POS Application.
  2. Await notification of device pairing success.
  3. The POS client sends the Terminal API a request to check out a buyer and accept a payment.
  4. Square sends the checkout details to the Square Terminal, which shows the payment details to the buyer.
  5. The buyer dips, taps, or swipes a payment card in the Square Terminal.
  6. The Square Terminal notifies Square of the payment.
  7. The Terminal API notifies the POS backend that the Terminal checkout is COMPLETED.

Important

In a production environment, you must use the device_id returned from the Devices API. In the checkout request body for device_id, you can also enter the Square Terminal's serial number, which is located on the back of the Square Terminal. You cannot use a device code generated from the Seller Dashboard; however, you can view the device ID in the Seller Dashboard after the Devices API has generated it.

If the collect_signature option is set to true in the CreateTerminalCheckout endpoint under device_options, the payment flow requests the buyer's signature for the payment.

Did you know?

To view the Square Terminal version and verify that your version supports a given checkout feature or device option:

  1. On the Square Terminal, swipe left, and then tap Settings.
  2. Tap Hardware, tap General, and then tap About Terminal.
  3. Under Terminal, view the OS Version.
Link to section

Prompt the buyer for a tip

The following command configures the Square Terminal checkout to:

  • Prompt for a tip on the Square Terminal.
  • Show the receipt screen.

The device_options object sets the following behaviors:

{ "device_options": { "skip_receipt_screen": false, "tip_settings": { "allow_tipping": true, "separate_tip_screen": true, "custom_tip_field": false } } }

Create terminal checkout

The response is returned with a PENDING status. Note that the PENDING status changes to IN_PROGRESS when the Square Terminal acknowledges the request and shows the checkout display screen to the buyer while awaiting input. When the checkout is complete and Square has accepted the payment card, the status is COMPLETED.

While the status of the checkout is PENDING, the POS client or the buyer can cancel the checkout. When the status is IN_PROGRESS, the process continues until COMPLETED. At that time, the POS client can query for the final state of the checkout. The buyer can also cancel the checkout through the POS application while the request is in the IN_PROGRESS status.

Square deletes completed checkouts after 30 days. If you need to store the checkouts for future reference, retain the checkout's payment IDs.

Link to section

Collect tip money prior to checkout

If the buyer uses the POS application to enter a tip amount before the checkout is sent to the Square Terminal, the seller doesn't need to use the Square Terminal to collect a tip. You already know the tip amount before calling the Terminal API, for which you use the tip_money parameter (Beta) and the amount_money parameter in the checkout request.

A common scenario for this tip collection flow involves the seller using a kiosk POS application that calculates the tip and you don't want the buyer to enter the tip on the Square Terminal. The buyer-facing flow on the kiosk includes adding a tip and the kiosk then sends the total amount (including tip) to the Square Terminal as a checkout request.

The tip_money parameter can only be set and included in the request if the checkout request has tip settings disabled. The default value for the allow_tipping field in the TipSettings object is false. For more information about how to process payments with tip money, see Take Cash Payments and Update Payment and Tip Amounts.

Link to section

Take a payment with a manually entered card

Square Terminal supports manual payment card entry by providing the payment_type field in the TerminalCheckout object and in the CheckoutOptionsPaymentType enumeration. When a payment_type with the value of MANUAL_CARD_ENTRY is specified in the checkout request, the Square Terminal displays the Manual Credit Card Entry form and a virtual keyboard for the input of card information.

The following command configures the Square Terminal checkout to accept manual payment card input:

Create terminal checkout

The response carries a checkout object with the payment_type requested:

Link to section

Take a payment with a signature

Square Terminal supports the ability to require or skip collecting a signature for a payment by providing the collect_signature field for the DeviceCheckoutOptions object. If collect_signature is set to true in the checkout request, the Square Terminal displays the signature collection screen during checkout. The buyer is then required to provide a signature before proceeding to the next screen.

If collect_signature is set to false, the checkout skips the signature capture screen. The default value for collect_signature is false.

Important

  • The Square API version must be 2022-04-20 or later to use the collect_signature field. If the Square-Version in the request header isn't set, the request defaults to using the API version from the Developer Dashboard. For more information, see How Square API versioning works.
  • The collect_signature field is applicable only in the United States and Canada. In other regions, Square Terminal determines whether it needs to collect signatures from buyers.

The following command configures the Square Terminal checkout request to require signature collection:

Create terminal checkout

The response carries a checkout object with collect_signature requested:

Link to section

2. Review options for payments in a checkout

The Terminal API provides additional options to work with payments. These options are also available through the Payments API.

  • The ability to collect fees.
  • The delay of the capture of payments.
  • Linking orders with line items to a Terminal checkout.
  • Taking partial payments from cards with a limited balance.
  • (Beta) Assigning a team member ID to the checkout. The ID is associated with an individual TeamMember record.
  • Specifying whether to cancel or complete a delayed capture payment, when the time for delaying the payment capture has elapsed.
  • (Beta) Adding a statement description identifier to the checkout request. The identifier can contain a customer ID or an order object ID. For more information about statement descriptions, see Card Payment and Statement Description.
Link to section

Take a fee from a payment

Square Terminal supports collecting an application fee from a payment. The app_fee_money property has a value amount limit.

The following steps provide an example of the fee collection flow:

  1. Create a CreateTerminalCheckout request and add app_fee_money with 100 ($1.00 USD) and USD as the amount and currency, respectively.

    Create terminal checkout

  2. When the buyer completes the checkout flow on the Square Terminal, the Terminal checkout transitions to a status of COMPLETED. A payment_id is attached to the Terminal checkout.

  3. Call the GetPayment endpoint using the payment_id to verify that the application fee amount was properly attached to the payment and attributed to the application ID.

  4. Sign in to the Seller Dashboard as the seller associated with your application and navigate to the Balances section to verify that the expected amount has been added to your Square balance. After you've linked a bank account, the collected fees are transferred nightly to your linked bank account.

For more information about how to collect fees from payments, see Collect Application Fees.

Link to section

Take a delayed capture payment

Square Terminal supports the delayed capture of payments made with the POS application. To learn how delayed capture works with card payments, see Delayed Capture of a Card Payment.

The delayed capture flow with the Terminal API works as follows:

  1. Create a CreateTerminalCheckout request and set autocomplete to false to authorize the payment but not capture it. Set delay_duration to PT24H, which is 24 hours.

    • The autocomplete attribute is a Boolean type that indicates whether Payment objects are automatically completed or left in an APPROVED status for later changes. The default value is true.

    • The delay_duration attribute is a modifiable string type that indicates the length of time, in RFC 3339 format, before Square automatically cancels the payment. This property applies only when autocomplete is false. The default value is PT36H, which is 36 hours from the time the checkout request was created.

    Create terminal checkout

  2. When the buyer completes the checkout flow on the Square Terminal, the Terminal checkout transitions to a COMPLETED status and includes the resulting payment_id. The Payment object now has a status of APPROVED.

  3. Call UpdatePayment using the payment_id to change the payment amount and tip amount after the payment is authorized.

  4. Call CompletePayment to capture the payment or call CancelPayment to void the payment.

You can also specify the action for Square to take on the payment when the length of time for the delayed capture has elapsed. Under payment_options, add the delayed_action attribute and set it to either CANCEL or COMPLETE.

To learn more about updating payments, see Update Payment and Tip Amounts.

Link to section

Take a payment for an itemized order

Square Terminal supports linking an order and an order's line items to a Terminal checkout.

Before adding an order to a Terminal checkout request, you must create a new Order object with the Orders API. For information about how to create an order, see Orders API. After creating a new order, you can link the order to a Terminal checkout by including the order's order_id in the Terminal checkout POST request body. The show_itemized_cart attribute determines whether a screen displaying the order's line items is shown on the Terminal screen. The default value is true.

The following checkout request shows where the order_id is defined:

Create terminal checkout

The order is created after the checkout request passes the following validation rules:

  • The order must belong to the location to which the Square Terminal is currently logged in.
  • The order must be in an OPEN state.
  • The order and checkout currency must match.
  • The order and checkout amount must be equal to each other if payment_options.autocomplete is set to true. This moves the order to a COMPLETED state.

After the checkout request is sent to the Square Terminal, the buyer can complete or cancel the checkout. If the buyer successfully completes the payment for the Terminal checkout, the Terminal checkout moves to the COMPLETED state.

Link to section

Take a partial authorized payment

Square Terminal supports accepting partial payments with a Square gift card and cards with a limited balance. The following information uses a Square gift card as an example.

A buyer swipes or manually enters a Square gift card on the Square Terminal. In the Terminal checkout request under payment_options, set accept_partial_authorization to true and autocomplete to false, which allows sellers to authorize a payment for less than the total amount when the Square gift card doesn't have enough money in the balance. The seller can then initiate a follow-up checkout request to authorize the remaining amount.

The following checkout request incorporates a partial payment authorization and an order ($20 order). The checkout request is for $20 USD and charging a Square gift card with a balance of $5.00.

Create terminal checkout

After the buyer uses their gift card, the Terminal checkout is set to the COMPLETED state and the payment_id is set to the APPROVED state.

To pay for the remainder of the order, which is $15, create another checkout with autocomplete set to false, accept_partial_authorization to true, and the same order_id.

Create terminal checkout

After the buyer completes the Terminal checkout with a credit card, the seller must complete the order by using the PayOrder endpoint.

For more information about partial payments and how to pay for orders, see Partial Payment Authorizations and Pay for Orders, respectively.

Link to section

3. Cancel a Terminal checkout

A Terminal checkout request can be canceled from the POS application while the status of the checkout is PENDING or IN_PROGRESS. To cancel a Terminal checkout, POST a request to the CancelTerminalCheckout endpoint. Canceling a PENDING Terminal checkout causes the Terminal checkout to be CANCELED. IN_PROGRESS Terminal checkouts transition to CANCEL_REQUESTED and, if the buyer hasn't yet completed the transaction, transition to CANCELED.

If the transaction is already complete, the checkout request becomes COMPLETED. In this case, the seller cannot trigger a refund for the Payment after the transaction is completed.

In this example, the seller cancels a PENDING Terminal request from the POS application:

Cancel terminal checkout

If the request is successful, the response provides the Terminal checkout object in its new state.

Link to section

Errors with canceling an e-money payment

Using CancelTerminalCheckout to cancel an e-money payment after getting an error on the Square Terminal is currently not supported. If the Square Terminal gets an error, the buyer needs to close the error message window and then tap the navigation button back to the checkout screen to cancel the checkout. The checkout request has either the IN_PROGRESS or PENDING status when this error occurs.

Link to section

Checkout request timeout cancellation

The Terminal API server sets a Terminal checkout to CANCELED if a checkout isn't completed prior to the created_at time.

A Terminal might be completing a payment at the threshold of the timeout. When this happens, the Terminal API server might set the CANCELED state on the checkout while the Terminal device is completing it. In this case, the checkout might become CANCELED prior to becoming COMPLETED. If you subscribe to Terminal API webhooks, any confusion can be avoided because you're receiving updates with each state change.

Link to section

4. Verify a payment

When the status of a Terminal checkout object is updated, webhook notifications are sent to the endpoint that is registered for a POS application. To get the notifications, be sure that your Square application is updated in the Developer Dashboard. The webhook notifications are as follows:

  • terminal.checkout.created
  • terminal.checkout.updated

When a Terminal checkout object is created, canceled, or completed, a full copy of the object is sent to your application at your webhook URL. The object provides status and payment_ids fields.

When the checkout completes, a Payment object is created to record the details of the charge. The payment status can be COMPLETED, CANCELED, or FAILED. A completed payment is normally for the full amount of the purchase but must be verified against the amount expected by your POS application. A completed payment for the full purchase amount means that the checkout is complete and the POS payment window can be closed.

When a checkout is completed, it has one or more payment_ids listed on it. These are confirmations about how much money was actually collected, if any.

Important

A COMPLETED checkout might not have collected the exact total you requested (for example, when a tip is added to the payment). You should always check the Payment object to determine the actual amount collected.

Get a completed checkout to find its payment_ids, as shown in the following example:

Get terminal checkout

The following is returned:

{ "checkout": { "id": "xv4gh2KBCmlqO", "amount_money": { "amount": 100, "currency": "USD" }, ...snip... "status": "COMPLETED", "payment_ids": [ "{PAYMENT_ID}" ], } }
Link to section

5. Search for Terminal checkout requests

Search for existing Terminal checkout requests filtered by the:

  • Device ID.
  • Time and date range that the Terminal checkout was requested.
  • Terminal checkout status.

Search results are sorted and paginated and allow for a custom page size.

The following example requests an additional page of completed Terminal checkout requests sent to the Square Terminal with ID R5WNWB5BKNG9R, created on or after noon UTC/GMT, and started on 03-20-2020. Results are limited to 10 Terminal checkouts per result page.

To learn more about how to work with cursors, see Pagination.

Search terminal checkouts