Guia
Split
Divida cada pagamento entre a sua empresa e recebedores, por percentual ou valor fixo.
1. Cadastre recebedores
Dados bancários validados na criação.
POST /v1/split/recipients
curl -X POST https://api2.bosspay.io/v1/split/recipients \
-H "Authorization: Bearer bp_test_SUA_CHAVE" \
-H "Content-Type: application/json" \
-d '{ "name": "Loja Parceira Ltda", "document": "11222333000181", "bankCode": "001", "branch": "1234", "account": "56789-0" }'2. Crie a regra
recipientId null representa a sua empresa. percentBps em pontos-base (1000 = 10%). chargeFees define quem paga a taxa; chargeRemainder, quem fica com o resto do arredondamento.
POST /v1/split/rules
curl -X POST https://api2.bosspay.io/v1/split/rules \
-H "Authorization: Bearer bp_test_SUA_CHAVE" \
-H "Content-Type: application/json" \
-d '{
"name": "Marketplace 85/15",
"items": [
{ "recipientId": null, "percentBps": 1500, "chargeFees": true, "chargeRemainder": true },
{ "recipientId": "RECIPIENT_ID", "percentBps": 8500 }
]
}'3. Simule antes
POST /v1/split/simulate mostra quanto cada parte recebe de um valor, com taxas. Repasses aparecem em GET /v1/split/transfers.
Webhooks relevantes
payment.approvedsettlement.completed