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. Veja Acompanhar repasses.
Cada pagamento recebido com split gera um repasse (payout) por instrução. O repasse passa por uma sequência de status até terminar: ele é concluído, cancelado ou devolvido ao cliente final. Nesta página, você vê, para cada status:
  • como o repasse entra nele e como sai;
  • quem provoca a mudança: a Delfinance, o gestor do marketplace pela API ou a instituição do beneficiário;
  • onde está o dinheiro;
  • se o status é final.
O status vem no campo status do repasse, como enum (name, description e value). Use sempre o name na sua integração. Veja Formato dos enums.

Visão geral

Ciclo de vida

O ciclo está dividido em dois diagramas, para evitar setas cruzadas. Nos diagramas, os status finais têm borda arredondada e a marca (final).

Agendamento, execução e reprocessamento

Pausa, cancelamento e devolução

Status e significados

Não confunda CANCELED com REFUNDED. No cancelamento, o dinheiro fica na conta de recebimento. Na devolução, o dinheiro sai da conta de recebimento e volta ao cliente final por um Pix de devolução.

Transições permitidas

Qualquer transição que não está nesta tabela não acontece. Se você pedir uma ação num status que não a aceita, a API recusa o pedido. Algumas ações não mudam o status:

Regras de negócio

Agendamento

  • A data do repasse é definida na instrução de split do QR Code, por daysUntilPayment (dias corridos após o pagamento) ou por paymentDate (data fixa). Veja Agendar um repasse.
  • A data calculada por daysUntilPayment aparece em paymentDate nas consultas.
  • Os repasses agendados saem na rodada diária, às 6h (horário de Brasília), na data do repasse.
  • O split padrão da conta não tem agendamento: os repasses nascem em PENDING.

Pausa e liberação

  • Só um repasse em SCHEDULED pode ser pausado (HOLD).
  • Em HOLDING, o repasse não é executado, nem na data prevista. Você ainda pode mudar a data, devolver parte do valor ou cancelar.
  • RELEASE devolve o repasse para SCHEDULED. Para liberar com uma nova data, envie paymentDate junto.

Execução

O valor só sai da conta de recebimento na execução. Mantenha saldo para os repasses agendados.

Erros e reprocessamento

  • Em ERROR, o motivo vem em errorMessage, e o valor fica na conta de recebimento.
  • Depois de corrigir a causa, por exemplo, recompondo o saldo, reprocesse o repasse. Ele volta para PROCESSING.
  • Se a causa não puder ser corrigida, como uma conta do beneficiário encerrada, cancele o repasse. Os dados do beneficiário não podem ser alterados.
  • A falha de um repasse não afeta os outros repasses da mesma ordem de recebimento com split.

Cancelamento

  • É aceito em SCHEDULED, PENDING, HOLDING e ERROR, e é irreversível.
  • O valor fica na conta de recebimento. Nenhum dinheiro é movimentado.
  • PENDING costuma durar poucos segundos. Para ter tempo de cancelar, agende o repasse.

Devolução integral

  • A devolução envia um Pix de devolução do pagamento original ao cliente final, com o valor saindo da conta de recebimento, e desconta esse valor do repasse.
  • Só é aceita em HOLDING. Para devolver, pause o repasse antes com HOLD, o que exige que ele esteja agendado (SCHEDULED). Depois de SUCCESS, o dinheiro já está com o beneficiário.
  • O repasse vai para REFUNDED só quando o total devolvido chega ao valor original. Com devoluções parciais, ele continua em HOLDING e, depois de liberado com RELEASE, é executado com o valor restante.

Campos relacionados ao status

Veja a estrutura completa do repasse em Listar repasses. Exemplo de um repasse em ERROR, com os campos de status:

Exemplos de jornada

PENDING → PROCESSING → SUCCESS, em segundos, logo após o pagamento.
Instrução com daysUntilPayment: 30 e transferType: PIX_KEY. O repasse nasce em SCHEDULED, com paymentDate igual ao dia do pagamento mais 30 dias. Na data, às 6h, vai para PENDING e depois para PROCESSING. Termina em SUCCESS quando o Pix é confirmado.
SCHEDULED → HOLD → HOLDING. Uma devolução de parte do valor diminui o amount, e o status continua HOLDING. Depois, RELEASE → SCHEDULED. Na data, o repasse é executado com o valor restante.
Com o repasse em HOLDING, você pode cancelar (CANCEL → CANCELED, e o valor fica na conta de recebimento) ou devolver todo o valor ao cliente final (devolução total → REFUNDED).
Na data, PENDING → PROCESSING → ERROR, com o motivo em errorMessage. Depois de recompor o saldo, reprocesse: ERROR → PROCESSING → SUCCESS.