Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header on the format Bearer <API_KEY>.

Body

application/json
accountId
string<uuid>
required

Account that receives the simulated deposit.

Example:

"bdb68dac-0370-4957-a7ea-5fcb7d5a4008"

amount
string
required

Deposit amount in the account's currency, as a numeric string.

Example:

"100.00"

reference
string

Deposit reference used to match the rule. For PIX, send the rule's sourceDepositInfo[].depositIdentifier; for SPEI, send sourceDepositInfo[].reference. Without the right reference, PIX and SPEI deposits do not match. Omit for USD, EUR, and GBP, where deposits are matched to the account. Must not be empty when sent.

Example:

"3go8DkN7BjyTRVn5dgJtcnWxH"

Response

Deposit successfully simulated.

matchedRule
boolean

Whether the simulated deposit matched an active rule. When false, no conversion starts.

Example:

true