Accounts

Simulate a Pix credit into a sandbox BRL account (sandbox only)

Simulates a Pix that a payer sends into a sandbox BRL account. The credit is added to the account's balance, listed on GET /accounts/{account_id}/movements and announced with account.credited, the same three things a real Pix into a live account produces. Use it to build and test your deposit handling before a live account receives money.

To test the conversion, create a transfer with source.type: account from this account to the customer's wallet. In the sandbox the balance is debited at once, the transfer completes, and the refusals are the live ones: below the BRL 1,000 floor, or above the balance not already committed to an open order (422 ACCOUNT_BALANCE_INSUFFICIENT).

Available only to test-environment API keys on sandbox BRL accounts. A live key, or an account in another currency, gets 404 SIMULATION_NOT_AVAILABLE.

This route takes no Idempotency-Key: every call is a new credit.

post/accounts/{account_id}/simulate/credit

Request

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

Path parameters

account_idstring required

The opaque account id (ozav_acc_...).

Request body

amountstring required

The amount the payer sends, in BRL, as a decimal string with at most 2 decimal places. Must be positive.

Example request

{
  "amount": "1500.00"
}

Response

The credit, in the same shape GET /accounts/{account_id}/movements lists it.

idstring required

The entry's identifier. Stable across reads; use it to de-duplicate. It is the institution's own identifier where the statement is read live, and an OZAV id (ozav_amov_...) on a BRL account. The same id arrives in account.credited.

object'account_movement' required
direction'credit' required

Only credits are listed today - money that arrived in the account.

amountstring required

The amount the payer sent, as a decimal string in currency.

currencystring required

Uppercase ISO 4217 code or stablecoin symbol (e.g. BRL, USD, EUR, MXN, USDC, USDT). Uppercase is the canonical form: values are accepted case-insensitively on input but are always uppercase in responses.

occurred_atstring date-time required

When the institution booked the credit (RFC 3339, UTC).

referencestring

The free text the payer sent with the transfer, when the rail carries one. Absent means the rail carried none.

Changes

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