POST /v2/terminals/checkouts - Square API Reference

Create terminal checkout

POST

/v2/terminals/checkouts

Creates a Terminal checkout request and sends it to the specified device to take a payment for the requested amount.

Permissions:PAYMENTS_WRITE

Guide

Request a Square Terminal checkout

Try in API Explorer

Link to section

Request body

Example code

Link to section

idempotency_key

string

Required

A unique string that identifies this CreateCheckout request. Keys can be any valid string but must be unique for every CreateCheckout request.

See Idempotency keys for more information.

Min Length

Max Length

Link to section

checkout

Required

The checkout to create.

Link to section

Response fields

Link to section

errors

Information about errors encountered during the request.

Link to section

checkout

The created TerminalCheckout.

curl https://connect.squareup.com/v2/terminals/checkouts \ -X POST \ -H 'Square-Version: 2024-03-20' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -H 'Content-Type: application/json' \ -d '{ "idempotency_key": "28a0c3bc-7839-11ea-bc55-0242ac130003", "checkout": { "amount_money": { "amount": 2610, "currency": "USD" }, "reference_id": "id11572", "device_options": { "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003" }, "note": "A brief note" } }'

{ "checkout": { "id": "08YceKh7B3ZqO", "amount_money": { "amount": 2610, "currency": "USD" }, "reference_id": "id11572", "note": "A brief note", "device_options": { "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003", "tip_settings": { "allow_tipping": false }, "skip_receipt_screen": false }, "status": "PENDING", "location_id": "LOCATION_ID", "created_at": "2020-04-06T16:39:32.545Z", "updated_at": "2020-04-06T16:39:32.545Z", "app_id": "APP_ID", "deadline_duration": "PT5M", "payment_type": "CARD_PRESENT" } }

Create terminal checkout

Request body

Response fields

Error descriptions