Create a BRL deposit into a customer's balance
Returns a Pix code (BR Code) the customer pays. When it is paid, the amount becomes BRL balance held for that customer; nothing is converted. Convert later with POST /transfers from that balance.
The deposit belongs to the customer (an individual or a company). The code is issued on the account that carries that customer's money; the response does not name it.
reference is the idempotency lever. The same reference for the same customer returns the existing deposit with 200: the same code while it is payable, or its current status (paid, expired). The same reference with a different amount is 409 DEPOSIT_IDEMPOTENCY_CONFLICT.
Refusals, with named codes: deposits not enabled for your organization yet (422 DEPOSITS_NOT_ENABLED); no account ready to receive for this customer yet (422 DEPOSIT_ACCOUNT_NOT_AVAILABLE, the reason in the message); a customer without name or document on file (422 CUSTOMER_PROFILE_INCOMPLETE, also when the document is not a CPF or a numeric CNPJ); the charge cannot be issued or was refused and will not pass on retry (422 DEPOSIT_RAIL_CANNOT_CHARGE). When the deposit cannot be created right now the answer is 503 DEPOSIT_UNAVAILABLE: retry with the same reference.
Request
- Base URLhttps://developers.ozav.io/v2
- Auth
- API key in header X-API-Key
- or HTTP bearer
Request body
Example request
{
"amount": {
"value": "250.00"
}
}Response
The same deposit already existed (same reference); same code.
Example response
{
"id": "ozav_dep_01J00000000000000000000000",
"amount": {
"value": "250.00"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.