rcv_) é a fatia de uma venda paga que vai cair na carteira de um recebedor
(rec_) numa data prevista. Cada pagamento confirmado gera um recebível por recebedor do split e
por parcela: uma venda de R$ 300 em 3x com um único recebedor gera três; com dois recebedores no
split, seis. Pix, boleto e venda à vista geram um por recebedor, e toda venda tem ao menos o
recebedor da sua própria conta.
Até o adquirente confirmar a parcela, o recebível é previsão: nasce com feeAmount zero,
netAmount igual ao bruto e uma data que ainda pode mudar. Somar o líquido de recebíveis
projected como se fosse dinheiro certo é o erro mais comum — o valor só é definitivo a partir de
confirmed, e só está na carteira em liquidated.
Todas as rotas exigem o header
x-api-key (sua chave de sandbox). Veja
Autenticação. Os exemplos nas páginas de cada endpoint usam a base URL de
sandbox https://api.sandbox.z2pay.com/v1.Endpoints
Cada endpoint tem sua própria página, com os filtros aceitos, exemplos e o playground para testar. Não háPOST: o recebível nasce da venda, muda pelo que o adquirente informa e sai do futuro ao
liquidar.
Status do recebível
Você nunca define o status: ele avança com o que o adquirente confirma, com o calendário e com a liquidação na carteira. O caminho normal éprojected → confirmed → paid → liquidated no cartão, e
projected → confirmed → liquidated em Pix e boleto, que não passam por paid.
Estornos e chargebacks
Um reembolso ou um chargeback não apaga o histórico: ele muda o recebível da venda ou cria um recebível de sinal contrário. Três regras explicam o que você vê.type diz a natureza e flow diz o sinal. credit é a parcela da venda; refund e
chargeback são débitos; refund_reversal e chargeback_refund devolvem um débito, como num
chargeback ganho. Os valores são sempre positivos — flow: "credit" soma na carteira e
flow: "debit" subtrai. Para uma prévia do que ainda vai cair, some netAmount − anticipationFeeAmount com o sinal do flow nos status projected, confirmed e paid.Estorno total antes da liquidação cancela; depois dela, debita. Se a venda é reembolsada ou
contestada por inteiro enquanto o recebível ainda não caiu na carteira, ele vira
cancelled. Se
o dinheiro já caiu, nasce um recebível refund ou chargeback que liquida na data prevista e
debita a carteira.Reembolso parcial sempre gera débito. Devolver parte de uma parcela não cancela a parcela:
o recebível
credit continua, e um recebível refund com o valor devolvido entra ao lado dele
— mesmo antes da liquidação.Veja também
Carteiras
O saldo do recebedor e o extrato onde o recebível liquidado aparece como lançamento.
Liquidação
Os prazos de liberação por método de pagamento que definem
expectedAt.Transações
A venda de origem: filtre os recebíveis por
transactionId para ver o cronograma dela.Reembolsos
O estorno que cancela ou debita um recebível.