A valid request URL is required to generate request examples{
"id": "<string>",
"programId": "<string>",
"balanceType": "cashback"
}Locate-or-enroll the customer (opt-in)
Sent when the customer opts into the program at checkout. The click IS the consent (consent.grantedAt is the moment of the click; timestamps carry the platform’s UTC offset). The customer profile is attested by DeliveryVip (non-guest, complete profile). The operator may answer with a PIN challenge instead of an account: DeliveryVip then re-sends the same body plus challenge.answer typed by the customer. The PIN is validated exclusively on the operator side (rate limiting included) and is never stored by DeliveryVip. Answering with both id and challenge in one response is forbidden (DeliveryVip treats challenge as authoritative and discards the id).
A valid request URL is required to generate request examples{
"id": "<string>",
"programId": "<string>",
"balanceType": "cashback"
}Autorizações
The uid of the operator's OAuth application on DeliveryVip.
The UUID of the merchant (company) the call concerns.
Hex HMAC-SHA256 of the raw request body (empty string when there is no body), keyed with the app's OAuth secret. Verify against the exact bytes received.
Corpo
The operator-side program identifier (as pushed in the merchant configuration).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Whether the program accepts enrollment through checkout (mirrors the pushed capability).
Present only on the re-send after a PIN challenge.
Show child attributes
Show child attributes
Resposta
Account located/enrolled, or a challenge is required first.
- Option 1
- Option 2
The account located or enrolled by accounts:link. The balance is not part of this answer — DeliveryVip reads it from the balance endpoint.