Integration steps

Step	Action	Endpoint	Description
1	Webhooks	`POST /v1/webhooks`	Register your endpoint to receive status notifications.
2	Sender onboarding	`POST /v1/senders`	Create the sender with your external ID. Check the compliance level in the response.
3	Sender limits	`GET /v1/limits/senders/{senderId}`	Check the limit used and available in 24h, 30d and 180d.
4	Beneficiary	`POST /v1/beneficiaries`	Create the beneficiary in Brazil.
5	Wait for the Pix key	`GET /v1/beneficiaries/{beneficiaryId}`	Each Pix key enters `SCREENING`. Wait for `APPROVED` (webhook `beneficiary.status_changed`).
6	Add or deactivate keys	`PATCH /v1/beneficiaries/{beneficiaryId}`	Update the beneficiary to add a new Pix key or deactivate one.
7	Beneficiary limits	`GET /v1/limits/beneficiaries/{beneficiaryId}`	Check the amount the beneficiary can still receive in 24h, 30d and 180d.
8	Credit line	`GET /v1/credit-line`	For `CREDIT`: check the credit available.
9	Wallets	`GET /v1/wallets`	For `PREFUNDED`: check the USD balance available.
10	Get a quote	`POST /v1/fx/quotes`	Request a price for a fixed USD or BRL amount. One price for both funding modes. No sender is sent.
11	Create the withdrawal	`POST /v1/remittances/withdrawals`	Send quote, sender, beneficiary, Pix key, purpose, relationship and funding mode. Creates the remittance.
12	Track the remittance	`GET /v1/remittances/{remittanceId}`	Follow the status and sub-status. Webhooks notify each change.
13	Receipt	`GET /v1/remittances/{remittanceId}/receipt`	Download the receipt after `COMPLETED`.

Step 2 is done once per sender, and steps 4 to 6 once per beneficiary. Steps 4 to 7 can also be done after the quote, as long as they are done before step 11. Repeat step 3 before each quote: the sender is only validated at the withdrawal, so this avoids showing a price for a remittance that will be rejected.

Get started

Remittances

Records and balances

Operations