Create a checkin

Required scopes:

  • checkin.create

This endpoint creates a "check-in" for a given customer. In case, the customer is not found with the phone number, a new customer is created.

Body Params
string
required

Store in which the checkin is created. The slug of an existing record in the stores table.

string | null

Mobile phone number in international format. This field is required when payment_method_hash is not present.

string | null

Hash of the new customer payment method. This field is required when international_phone_number is not present.

string | null

POS order identifier that triggered the checkin creation.

integer
required

Order amount in cents that triggered the checkin creation.

string | null

Datetime, in iso 8601 format, when the customer has checked in. Must be a valid date in the format Y-m-d\TH:i:sP. Must be a date before or equal to now.

tags
array of strings
required

List of tags to associate to the customer.

tags*
boolean | null

Determines if the checkin delay should be enforced. By default, checkin delay is not enforced, any checkin following a payment is considered valid since the customer paid its order. When set to true, the checkin delay configured by the merchant is enforced, and the checkin will be considered invalid if this delay is not respected.

Response

Language
Credentials
Bearer
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json