All Versions

Terminal checkout created

EVENT terminal.checkout.created

Published when a TerminalCheckout is created.

Permissions

PAYMENTS_READ

Event payload

Example code

Name	Description
`merchant_id string`	The ID of the target merchant associated with the event.
`type string`	The type of event this represents, `"terminal.checkout.created"`.
`event_id string`	A unique ID for the event.
`created_at string`	Read only RFC 3339 timestamp of when the event was created. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
`data TerminalCheckoutCreatedSquareEventData`	Data associated with the event.

Examples

All Versions

{
  "merchant_id": "7NZR58EPNGNPC",
  "type": "terminal.checkout.created",
  "event_id": "7229a692-def5-4a7e-b4f3-80638aa2f24d",
  "created_at": "2020-04-10T14:43:55.262Z",
  "data": {
    "type": "checkout.event",
    "id": "dhgENdnFOPXqO",
    "object": {
      "checkout": {
        "amount_money": {
          "amount": 111,
          "currency": "USD"
        },
        "app_id": "sq0idp-734Md5EcFjFmwpaR0Snm6g",
        "created_at": "2020-04-10T14:43:55.262Z",
        "deadline_duration": "PT5M",
        "device_options": {
          "device_id": "907CS13101300122",
          "skip_receipt_screen": false,
          "tip_settings": {
            "allow_tipping": false
          }
        },
        "id": "dhgENdnFOPXqO",
        "note": "A simple note",
        "reference_id": "id72709",
        "status": "PENDING",
        "updated_at": "2020-04-10T14:43:55.262Z"
      }
    }
  }
}