v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

Terminal

CreateTerminalCheckout

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

post/v2/terminals/checkouts

Request body

idempotency_keystring 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.

Example request

{
  "checkout": {
    "amount_money": {
      "amount": 2610,
      "currency": "USD"
    },
    "device_options": {
      "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003"
    },
    "note": "A brief note",
    "reference_id": "id11572"
  },
  "idempotency_key": "28a0c3bc-7839-11ea-bc55-0242ac130003"
}

Response

Success

Example response

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