verify entry-code at external provider
Authorization
bearerAuth In: header
Request Body
application/json
AiFi store id
Retailer store id
ISO formatted creation time of the event, that caused this webhook to be sent
date-timeISO formatted time, in which this webhook was sent
date-timeAiFi customer id
Customer information
"customer" | "employee" | "tester" | "untracked" | "unknown"The id of check-in device
Entry code to be verified
Group size that was specified by the user in the customer app, when requesting a qr code
Size of a group that was present in the scanning zone during qr code scan
Response Body
application/json
curl -X POST "https://oasis-api.public.sandbox.oasis.aifi.com/api/push/entry-code/verify" \ -H "Content-Type: application/json" \ -d '{ "storeId": 0, "store": { "oasisApiStoreId": 0, "aifiUniqueStoreId": "string" }, "storeExternalId": "string", "timeOfOrigin": "2019-08-24T14:15:22Z", "timeOfIssue": "2019-08-24T14:15:22Z", "customerId": 0, "customer": { "externalId": "string", "metadata": { "arbitraryKey": "arbitraryValue" }, "id": "string", "role": "customer" }, "role": "customer", "checkInDeviceId": 0, "entryCode": "string", "expectedGroupSize": 0, "payment": { "paymentProvider": "NONE" } }'{
"status": "FAILED",
"reason": "Payment verification failed",
"sessionId": "cc256d83-a307-483e-b3bf-3740cb925f92",
"customerId": 123
}How is this guide?
notify external provider on entry-code validation failure POST
AiFi system shall call this webhook when entry-code validation fails due to some reason. Request is sent as a fire-and-forget hence retailer's response will not be used at all. **Note**: As an integrator the URL you specify for this webhook is going to be exactly the URL that will be called. For example if you specify "http://example-retailer-api.com/webhook" then exactly "http://example-retailer-api.com/webhook" will be called.
request to third party to evaluate order price POST
AiFi system shall call this webhook when a customer checked out but **before** an order is being placed in AiFi system. The webhook expects that the third party system is going to take the list of the products specified and based on them calculate the final total price of the order that is going to be then used to check out the customer. **Note**: as an integrator the URL you specify for this webhook is going to be exactly the URL that will be called. For example if you specify "http://example-retailer-api.com/webhook" then exactly "http://example-retailer-api.com/webhook" will be called.