Skip to main content
POST
/
v1
/
pvt
/
POS
/
customers
/
{id}
/
challenge
Creates a challenge (OTP) to confirm that the customer is the owner of the points
curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/POS/customers/{id}/challenge \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "TransactionId": "<string>",
  "Phone": "<string>",
  "Email": "<string>"
}
'
{
  "Success": true,
  "FriendlyErrorMessage": "<string>",
  "ShouldInformPhone": true,
  "ShouldInformEmail": true,
  "SentBySMS": true,
  "SentByEmail": true,
  "TransactionId": "<string>",
  "ErrorMessage": "<string>",
  "Code": "<string>"
}

Authorizations

​
Authorization
string
header
required

Use API Basic Auth Keys

Path Parameters

​
id
string
required

Body

application/json
​
TransactionId
string | null

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

​
Phone
string | null

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

​
Email
string | null

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

Response

200 - application/json
​
Success
boolean

If true, the challenge was successfuly sent

​
FriendlyErrorMessage
string

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

​
ShouldInformPhone
boolean

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

​
ShouldInformEmail
boolean

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

​
SentBySMS
boolean

If true, the challenge PIN was sent by SMS

​
SentByEmail
boolean

If true, the challenge PIN was sent by Email

​
TransactionId
string | null

Same Transaction ID as informed in the request

​
ErrorMessage
string | null

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

​
Code
string

The code sent to the customer