A valid request URL is required to generate request examples{
"id": "<string>",
"programId": "<string>",
"balanceType": "cashback",
"balance": 123,
"currency": "BRL",
"redemptionLimits": {
"min": {
"type": "fixed",
"value": 123
},
"max": {
"type": "fixed",
"value": 123
}
}
}Account balance
Balance read for the checkout surface. DeliveryVip caches the answer for 60 seconds per account. The request carries only the opaque account id — never the CPF. Unknown fields in the response are ignored (emitting extras such as expiresAt or metadata is safe). The optional redemptionLimits object pins per-customer boundaries that override the program’s for this customer — it rides the same 60-second cache as the balance, so a change to a customer’s rules takes up to a minute to reach checkout.
A valid request URL is required to generate request examples{
"id": "<string>",
"programId": "<string>",
"balanceType": "cashback",
"balance": 123,
"currency": "BRL",
"redemptionLimits": {
"min": {
"type": "fixed",
"value": 123
},
"max": {
"type": "fixed",
"value": 123
}
}
}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.
Parâmetros de caminho
The opaque account id returned by accounts:link.
Resposta
OK
Opaque and STABLE — relinking the same customer must return the same id byte-for-byte.
cashback Current balance in BRL. Read format-agnostically by DeliveryVip.
OPTIONAL per-customer boundaries. When present they REPLACE the program-level capabilities.redemptionLimits for this customer entirely — not field by field: declaring only max here means this customer has no minimum, whatever the program declares. Omit the object (or omit a bound inside it) to leave the customer under the program's own limits. Answer here ONLY when your rules genuinely vary per customer (a tier, a segment, an individual agreement) — a single rule for every customer belongs on the program's capabilities, not repeated on every account. Note that a limit reaching you inside a per-customer lookup is not by itself evidence that the limit is per-customer. Malformed values are ignored and the program's limits stand.
Show child attributes
Show child attributes