Skip to main content
POST
Error

Autorizações

X-App-Id
string
header
obrigatório

The uid of the operator's OAuth application on DeliveryVip.

X-App-MerchantId
string
header
obrigatório

The UUID of the merchant (company) the call concerns.

X-App-Signature
string
header
obrigatório

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

application/json
accountId
string
obrigatório

The DeliveryVip order UUID — the idempotency key (one debit per order).

kind
enum<string>
obrigatório
Opções disponíveis:
balance
amount
number
obrigatório

Value to debit, up to 2 decimal places, as a JSON number.

order
object
obrigatório

Resposta

Balance debited.

redemptionId
string
obrigatório

The operator's identifier for this debit (needed for reversal).