Introdução
A PayerPix é uma infraestrutura de pagamentos Pix com suporte a múltiplos merchants sob uma mesma conta: cada merchant tem saldo e extrato isolados, e a receita pode ser dividida automaticamente entre vários recebedores (splits).
Conceitos
- Usuário (conta de API): dono das credenciais. Pode possuir vários merchants.
- Merchant: unidade de recebimento (loja, marca, cliente). Tem
balanceAvailableebalanceBlockedpróprios. - Cobrança Pix: um pagamento de entrada (
DEPOSIT) com QR Code. Pode ser vinculada a um merchant. - Split: regra que distribui a receita de um merchant entre recebedores (usuários ou merchants).
Na prática, um usuário tem vários merchants (1→N). Cada merchant pode dividir sua receita entre vários recebedores via splits — é onde a relação vira muitos‑para‑muitos no fluxo do dinheiro.
Base e convenções
| Item | Valor |
|---|---|
| Base URL | https://api.betpaympix.com |
| Prefixo | /v1 |
| Formato | JSON |
| Valores | centavos (1990 = R$ 19,90) |
| Datas | ISO‑8601 (UTC) |
Fluxo típico
- Crie a cobrança Pix (
POST /v1/pix) — criando o merchant na hora pelo objetomerchant(ou referenciando um existente commerchantId). - Receba o webhook de confirmação na sua
callbackUrl. - Concilie e repasse: consulte os saldos por merchant e use splits (em
merchant.recipients) para repasses automáticos.
Importante: não existe endpoint separado para criar merchant. Ele nasce junto da cobrança, pelo objeto
merchant(identificado pelo seuexternalId). Depois é só reusar o mesmoexternalIdou omerchantIdretornado.