Skip to main content
POST
Simulate a deposit

Authorizations

Authorization
string
header
required

Bearer authentication header on the format Bearer <API_KEY>.

Headers

Idempotency-Key
string<uuid>

Optional UUID v4 idempotency key. If you resend the same key with a different request body, the API returns a 409 error. Cached responses include the header X-Idempotency-Cached: true. Keys expire after 24 hours.

Body

application/json
accountId
string<uuid>
required

Account that receives the simulated deposit.

Example:

"44dd9734-176a-4ced-924f-103f8d50ea5e"

reference
string
required

Deposit reference. Use the rule's sourceDepositInfo depositIdentifier (PIX) or reference (SPEI) to match the rule.

Example:

"IIDCDYjYUTbKouEUOyvxZ3xnU"

amount
string
required

Deposit amount as a numeric string.

Example:

"100.00"

Response

201 - application/json

Deposit successfully simulated.

matchedRule
boolean

Whether the simulated deposit matched an active rule.

Example:

true