Passos de integração

Passo	Ação	Endpoint	Descrição
1	Webhooks	`POST /v1/webhooks`	Cadastre o seu endpoint para receber as notificações de status.
2	Cadastro do remetente	`POST /v1/senders`	Crie o remetente com o seu external ID. Confira o nível de compliance na resposta.
3	Limites do remetente	`GET /v1/limits/senders/{senderId}`	Confira o limite usado e disponível em 24h, 30d e 180d.
4	Beneficiário	`POST /v1/beneficiaries`	Crie o beneficiário no Brasil.
5	Aguardar a chave Pix	`GET /v1/beneficiaries/{beneficiaryId}`	Cada chave Pix entra em `SCREENING`. Aguarde `APPROVED` (webhook `beneficiary.status_changed`).
6	Adicionar ou desativar chaves	`PATCH /v1/beneficiaries/{beneficiaryId}`	Atualize o beneficiário para adicionar uma chave Pix ou desativar uma.
7	Limites do beneficiário	`GET /v1/limits/beneficiaries/{beneficiaryId}`	Confira quanto o beneficiário ainda pode receber em 24h, 30d e 180d.
8	Linha de crédito	`GET /v1/credit-line`	No `CREDIT`: confira o crédito disponível.
9	Wallets	`GET /v1/wallets`	No `PREFUNDED`: confira o saldo em USD disponível.
10	Pedir cotação	`POST /v1/fx/quotes`	Peça um preço para um valor fixo em USD ou BRL. Um preço para as duas modalidades. Nenhum remetente é enviado.
11	Criar o withdrawal	`POST /v1/remittances/withdrawals`	Envie cotação, remetente, beneficiário, chave Pix, finalidade, relação e modalidade de funding. Cria a remessa.
12	Acompanhar a remessa	`GET /v1/remittances/{remittanceId}`	Acompanhe o status e os sub-status. Os webhooks notificam cada mudança.
13	Comprovante	`GET /v1/remittances/{remittanceId}/receipt`	Baixe o comprovante depois de `COMPLETED`.

O passo 2 é feito uma vez por remetente, e os passos 4 a 6 uma vez por beneficiário. Os passos 4 a 7 também podem ser feitos depois da cotação, desde que antes do passo 11. Repita o passo 3 antes de cada cotação: o remetente só é validado no withdrawal, e assim você evita mostrar um preço para uma remessa que será rejeitada.

Primeiros passos

Remessas

Cadastros e saldos

Operação