OZozav
Accounts

Retrieve a deposit

The deposit and its status: awaiting_payment until the Pix is paid, then paid, with amount_paid and paid_at. A code not paid in 24 hours turns expired. A paid or expired deposit no longer returns its BR Code; a new deposit needs a new reference.

get/deposits/{deposit_id}

Request

  • Base URL
    https://developers.ozav.io/v2
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

deposit_idstring required

The opaque deposit id (ozav_dep_...).

Response

The deposit.

idstring required
object'deposit' required
customer_idstring required
status'awaiting_payment' | 'paid' | 'expired' required
referencestring nullable
paid_atstring date-time nullable
created_atstring date-time nullable

Example response

{
  "id": "ozav_dep_01J00000000000000000000000",
  "amount": {
    "value": "250.00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.