Create a deposit
Creates a deposit and returns the funding instruction the customer should use to send money in.
Authorizations
JWT bearer token. Include as Authorization: Bearer <token>. See the Authentication guide for how to obtain one.
Headers
Key that makes the request safe to retry. Any non-blank string of up to 255 characters. See Idempotency.
255"00000000-0000-4000-8000-000000000001"
Body
Every deposit references a quote previously obtained from POST /v1/quotes. The quote determines sourceAmount and targetAmount and locks the FX rate (or the 1:1 spot for same-asset). A quote can be consumed by at most one operation.
The customer picks the funding rail via fundingInstruction.rail.
Your own identifier for the operation. Stored as given and returned on every read and every webhook. Free-form: it is not deduplicated, and the same value may appear on more than one operation. null when none was sent, and on a deposit credited from an incoming payment nobody requested.
1 - 255"order-2026-0043"
Response
Deposit accepted. The operation is in REQUESTED status and intent.fundingInstruction is null until the instruction is generated.
A created operation. Withdrawals, swaps, deposits, and transfers share this shape; intent.type identifies which.
Your own identifier for the operation. Stored as given and returned on every read and every webhook. Free-form: it is not deduplicated, and the same value may appear on more than one operation. null when none was sent, and on a deposit credited from an incoming payment nobody requested.
1 - 255"order-2026-0043"
Rail-level transactions for the operation. Only confirmed transactions are included; pending or failed rail movements are omitted.
A rail-level transaction associated with the operation. Discriminated by type, which names the rail that moved the money — INTERNAL_DEBIT and INTERNAL_CREDIT are the two legs of a movement that stays inside the platform and touches no external rail.
- PIX
- Crypto
- TED
- Boleto
- Internal debit
- Internal credit