Sign in

v4

OpenAPI 3.0.02026-07-31811,0021.1 MB
POS

Creates a challenge (OTP) to confirm that the customer is the owner of the points

When this endpoint is called BonifiQ sends a unique PIN code to the customer Phone (SMS) or E-mail.

The customer must inform this number in the /challengevalidate endpoint call

post/v1/pvt/POS/customers/{id}/challenge

Path parameters

idstring required

Request body

TransactionIdstring nullable

This is a unique ID that is used to identify this request. Can be any string that is linked to the currente purchase. If no ID is available, the current timestamp can be used

Phonestring nullable

If the customers dont have a phone number in BonifiQ yet it can be informed by the customer. BonifiQ can use this number to execute the challenge

Emailstring nullable

If the customer dont have an e-mail address yet in BonifiQ it can be informed by the customer. BonifiQ can use this address to execute the challenge

Documentstring nullable

Customer document. Used only when a new customer is created by this challenge flow.

Namestring nullable

Customer name. Used only when a new customer is created by this challenge flow.

Response

Successboolean

If true, the challenge was successfuly sent

FriendlyErrorMessagestring

If Success=false them this field will display some helpful message

ShouldInformPhoneboolean

Is Success=False and this field is true them the customer Phone must be informed in a new request call

ShouldInformEmailboolean

Is Success=False and this field is true them the customer Email must be informed in a new request call

SentBySMSboolean

If true, the challenge PIN was sent by SMS

SentByEmailboolean

If true, the challenge PIN was sent by Email

TransactionIdstring nullable

Same Transaction ID as informed in the request

ErrorMessagestring nullable

If Success=false this field will show information regarding the problem

Codestring

The code sent to the customer