OZozav
Accounts

Retrieve a withdrawal

The withdrawal and its status: pending until the payment institution classifies the outcome, accepted when it took the order, settled when the money arrived, rejected when it did not leave (balance_restored: true: the amount is back in the customer's balance).

get/withdrawals/{withdrawal_id}

Request

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

Path parameters

withdrawal_idstring required

The opaque withdrawal id (ozav_wdr_...).

Response

The withdrawal.

idstring required
object'withdrawal' required
customer_idstring required
payout_destination_idstring required
referencestring required
status'pending' | 'accepted' | 'settled' | 'rejected' required
balance_restoredboolean required

true when the Pix did not leave and the amount is back in the customer's balance.

created_atstring date-time nullable

Example response

{
  "id": "ozav_wdr_01J00000000000000000000000",
  "amount": {
    "value": "100.00"
  }
}

Changes

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