Recebedores e split
Recebedores são quem recebe parte de uma cobrança. O split diz quanto vai para cada um; o que sobra fica com a plataforma.
Criar um recebedor
{
"nome": "Loja A",
"documento": "11222333000181",
"email": "contato@lojaa.example",
"telefone": "11999990000",
"dataNascimentoOuAbertura": "2019-04-10",
"endereco": {
"logradouro": "Rua das Flores", "numero": "100", "bairro": "Centro",
"cidade": "São Paulo", "uf": "SP", "cep": "01001000"
},
"contaBancaria": {
"banco": "341", "agencia": "1234", "conta": "56789-0", "tipo": "corrente"
}
}Só nome e documento são obrigatórios na API. O provedor de pagamento exige um conjunto maior de dados, e o que faltar volta como erro recebedor_dados_insuficientes. Documento com 11 dígitos é pessoa física; com 14, pessoa jurídica.
Verificação (KYC)
| Status | Significado |
|---|---|
pendente | Verificação em andamento. Não entra em split. |
aprovado | Pode receber. |
reprovado | Não pode receber. |
Alguns provedores pedem que o recebedor conclua a verificação num link. Quando for o caso, a resposta traz kycUrl e kycExpiraEm. Use POST /v1/recebedores/{id}/kyc-link para gerar outro link e POST /v1/recebedores/{id}/atualizar para reconsultar o status.
Split na cobrança
"split": [
{ "recebedorId": "rc_aaa", "percentualBps": 7000 },
{ "recebedorId": "rc_bbb", "valorCentavos": 500 }
]percentualBpsusa pontos-base:10000é 100%,7000é 70%.- Informe
percentualBpsouvalorCentavosem cada regra, nunca os dois. - O percentual é arredondado para baixo. A diferença de centavos fica com a plataforma.
- A soma das partes não pode passar do valor da cobrança. O mesmo recebedor não pode aparecer duas vezes.
- Todo recebedor do split precisa estar
aprovadoe pertencer à sua conta. - Cada provedor limita o número de recebedores por cobrança; passar do limite retorna erro.
Exemplo
Cobrança de R$ 100,01 (10001) com 33,33% para A e 50% para B: A recebe 3333, B recebe 5000 e a plataforma fica com 1668. A soma sempre fecha o valor da cobrança.