Skip to main content
O split divide o valor de uma venda entre a sua conta e outras contas NyxPag. Você manda a lista de recebedores na própria cobrança, e a NyxPag credita cada um assim que o Pix é aprovado, sem você fazer transferência nenhuma depois.

Como funciona

1

Você cria a cobrança com split

O campo split entra no mesmo POST /transactions da cobrança normal.
2

O pagador paga o Pix

O valor da venda não muda para ele.
3

A NyxPag credita cada recebedor

Na aprovação, o valor de cada recebedor entra no saldo disponível dele, na hora.
4

Você recebe o líquido

A comissão sai do seu líquido, ao lado da tarifa da NyxPag. O que sobra é o netAmount.
O recebedor precisa ter conta na NyxPag. Quem não tem conta não recebe split.

Criando uma cobrança com split

Cada item de split tem um recebedor e um modo de cálculo: amount (valor fixo em reais) ou percent (percentual sobre o valor da venda). Nunca os dois no mesmo item.

Campos de cada item

Resposta

A transação volta com splitAmount (total descontado) e split (uma linha por recebedor). O netAmount já sai descontado do split.
Os valores são ilustrativos: a tarifa (fee) depende da sua conta. A conta do exemplo seria: R$ 100,00 − R$ 0,50 de tarifa − R$ 15,00 de split = R$ 84,50 de líquido. Em split, origin: "api" são os recebedores que você enviou. Contas ligadas a uma parceria da NyxPag também podem ter uma linha origin: "partner", aplicada automaticamente.

Limites

Erros

O split entra na verificação de idempotência. Reenviar a mesma Idempotency-Key ou externalId com um split diferente retorna 409 idempotency_conflict.

coverFee e split

Com coverFee: false (padrão), a tarifa e o split saem do seu líquido, como no exemplo acima. Com coverFee: true, o valor do Pix gerado fica maior que o amount enviado.
Ao combinar coverFee: true com split, crie antes uma cobrança de R$ 1,00 e confira amount, fee, splitAmount e netAmount na resposta. O amount da resposta é o valor que o pagador paga. Veja coverFee.

Quando o recebedor vê o dinheiro

O crédito acontece quando a cobrança é aprovada, e vai para o saldo disponível do recebedor, sem reserva. Se a cobrança expirar ou falhar, ninguém é creditado. O crédito é idempotente: um webhook repetido não credita duas vezes.

Receber por Pix

Todos os campos da cobrança e como apresentar o QR Code.

Criar cobrança Pix

Referência completa do endpoint.