• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
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.

Name Description
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 1 Max Length 64
checkout
TerminalCheckout

Required

The checkout to create.

Response Fields

Name Description
errors
Error [ ]

Information about errors encountered during the request.

checkout
TerminalCheckout

The created TerminalCheckout.

Examples

You are viewing an old version of the API
POST /v2/terminals/checkouts
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/terminals/checkouts \
  -X POST \
  -H 'Square-Version: 2021-05-13' \
  -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"
    }
  }'
Response JSON
{
  "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",
    "created_at": "2020-04-06T16:39:32.545Z",
    "updated_at": "2020-04-06T16:39:32.545Z",
    "app_id": "APP_ID",
    "deadline_duration": "PT10M",
    "payment_type": "CARD_PRESENT"
  }
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?