Skip to main content
Funcionalidade em beta. As rotas, os campos e os status descritos aqui são uma proposta e podem mudar antes da versão final. Não use em produção sem alinhar com o time Delfinance.
Cada pagamento recebido com split gera um ou mais repasses, um para cada instrução. Com as APIs desta seção, você acompanha esses repasses depois que o pagamento entrou na conta de recebimento: quais foram pagos, quais estão em andamento, quais falharam e quanto cada beneficiário ainda tem a receber. Isso vale para os dois tipos de split: o split padrão da conta e o split por cobrança. Os termos usados aqui seguem os conceitos do Split de Pagamentos.
Essas APIs são a base para montar um marketplace: a plataforma recebe o pagamento na conta de recebimento e consegue mostrar a cada vendedor (o beneficiário) o que já foi repassado e o que ainda vai receber. Veja a jornada completa no guia para marketplaces.

Recebimento e repasses

Um recebimento com split é o pagamento original que chegou na conta de recebimento e gerou repasses. Ele é identificado pelo id, 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 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
Para monitorar falhas, use Listar repasses com status=FAILED.Veja todos os filtros em Listar recebimentos com split.
2

Veja os repasses de um recebimento

Use 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
Veja a resposta completa em Consultar recebimento com split.
3

Acompanhe os repasses de um beneficiário

Use 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
Veja todos os filtros em Listar repasses.
4

Consulte o valor a receber de um beneficiário

Use 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
Veja a resposta completa em Consultar valor a receber.
5

Cancele um repasse, se necessário

Use 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
Só é possível cancelar repasses em 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

Nesta primeira fase, todo repasse é executado logo após o recebimento. Por isso, um repasse fica em PENDING por pouquíssimo tempo, e o cancelamento raramente é possível na prática. Pelo mesmo motivo, o valor a receber se resume aos repasses Pix ainda em PROCESSING.O cancelamento e o valor a receber ganham uso real com os repasses com data futura (status SCHEDULED), previstos para uma próxima fase.

Referência da API

Listar recebimentos com split

GET /split-payments/orders

Consultar recebimento com split

GET /split-payments/orders/{id}

Listar repasses

GET /split-payments/payouts

Consultar valor a receber

GET /split-payments/receivables

Cancelar repasse

POST /split-payments/payouts/{payoutId}/cancel