Recebimento e repasses
Um recebimento com split é o pagamento original que chegou na conta de recebimento e gerou repasses. Ele é identificado peloid, que é o id da transação de crédito no extrato e no webhook de recebimento.
Cada recebimento traz os valores usados no cálculo:
Status do repasse
Repasses
INTERNAL passam direto de PENDING para PAID, porque a transferência entre contas Delfinance é instantânea. Repasses PIX_MANUAL passam por PROCESSING até a confirmação do Pix.A falha de um repasse não afeta os outros repasses do mesmo recebimento. Cada repasse é executado e registrado de forma independente.
Passo a passo
1
Liste os recebimentos com split
Use Para monitorar falhas, use Listar repasses com
GET /baas/api/v1/split-payments/orders para ver os pagamentos da conta de recebimento que geraram repasses, em um período. Cada item traz o valor recebido, a tarifa e a base de cálculo dos repasses.cURL
status=FAILED.Veja todos os filtros em Listar recebimentos com split.2
Veja os repasses de um recebimento
Use Veja a resposta completa em Consultar recebimento com split.
GET /baas/api/v1/split-payments/orders/{id} para ver o detalhe de um recebimento: os valores usados no cálculo e a lista completa de repasses, com o status de cada um.cURL
3
Acompanhe os repasses de um beneficiário
Use Veja todos os filtros em Listar repasses.
GET /baas/api/v1/split-payments/payouts para listar repasses de todos os recebimentos, filtrando pelo documento do beneficiário, pelo status ou pela data do repasse. É a consulta indicada para mostrar a um vendedor o histórico de repasses dele.cURL
4
Consulte o valor a receber de um beneficiário
Use Veja a resposta completa em Consultar valor a receber.
GET /baas/api/v1/split-payments/receivables para saber quanto um beneficiário ainda vai receber: a soma dos repasses em SCHEDULED, PENDING e PROCESSING. Se você informar um período, a resposta também traz o total já pago nesse período.cURL
5
Cancele um repasse, se necessário
Use Só é possível cancelar repasses em
POST /baas/api/v1/split-payments/payouts/{payoutId}/cancel para cancelar um repasse que ainda não foi executado. O valor permanece na conta de recebimento.cURL
SCHEDULED ou PENDING. Nesses status, nenhum dinheiro saiu ainda da conta de recebimento.Veja os detalhes em Cancelar repasse.O que muda em cada fase
Referência da API
Listar recebimentos com split
GET /split-payments/ordersConsultar recebimento com split
GET /split-payments/orders/{id}Listar repasses
GET /split-payments/payoutsConsultar valor a receber
GET /split-payments/receivablesCancelar repasse
POST /split-payments/payouts/{payoutId}/cancel
