Skip to main content
GET
Funcionalidade em beta. Contrato em proposta, sujeito a mudanças. Veja o guia Acompanhar repasses.
Retorna, de forma paginada, os repasses de todos os recebimentos com split da conta de recebimento. Use o filtro beneficiaryDocument para mostrar a um beneficiário o histórico dos repasses dele.

Headers

string
required
Sua API key.
string
required
Número da conta de recebimento.

Query params

string
CPF ou CNPJ do beneficiário, somente números.
string
Status do repasse: SCHEDULED, PENDING, PROCESSING, PAID, FAILED ou CANCELED.
string
Forma do repasse: INTERNAL ou PIX_MANUAL.
string
Data inicial do repasse, no formato YYYY-MM-DD.
string
Data final do repasse, no formato YYYY-MM-DD.
number
default:"1"
Número da página (começa em 1).
number
default:"20"
Itens por página. Máximo de 100.

Response

Array de repasses. Os dados de paginação vêm no header Pagination, descrito em Paginação.
string
Identificador do repasse. Use-o para cancelar o repasse.
object
Recebimento com split que gerou o repasse. Mostra o valor integral do pagamento, a origem das instruções e a base de cálculo, sem precisar de outra consulta. É o mesmo recurso retornado por Consultar recebimento com split.
string
SCHEDULED, PENDING, PROCESSING, PAID, FAILED ou CANCELED. Veja o significado de cada um em Status do repasse.
string
INTERNAL ou PIX_MANUAL.
string
Tipo da instrução que gerou o repasse: PERCENTAGE ou FIXED.
number
Percentual ou valor definido na instrução.
number
Valor calculado do repasse, em reais.
string
Data prevista do repasse, no formato YYYY-MM-DD. Nesta fase, é sempre a data do recebimento.
object
Conta do beneficiário, no mesmo formato usado nas transferências.
string
Id da transferência que executou o repasse (transferência interna ou Pix). null enquanto o repasse não é executado.
string
Identificador do Pix, em repasses PIX_MANUAL.
string
Motivo da falha, quando o status é FAILED.
string
Data e hora em que o repasse foi pago, em ISO 8601.
string
Data e hora do cancelamento, em ISO 8601.
string
Motivo informado no cancelamento.
string
Data e hora de criação do repasse, em ISO 8601.
string
Data e hora da última mudança de status, em ISO 8601.

Paginação

A resposta é um array. Os dados de paginação vêm no header Pagination:
Header