Skip to main content
GET
Funcionalidade em beta. Contrato em proposta, sujeito a mudanças. Veja o guia Acompanhar repasses.
Retorna o valor a receber de um beneficiário na conta de recebimento: a soma dos repasses que ainda não foram concluídos (SCHEDULED, PENDING e PROCESSING). Se você informar um período, a resposta também traz o total já pago nesse período.
Nesta fase, todo repasse é executado logo após o recebimento. Por isso, o valor a receber costuma se resumir aos repasses Pix ainda em PROCESSING. Com os repasses com data futura, previstos para uma próxima fase, os repasses agendados (SCHEDULED) também entram nessa soma.

Headers

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

Query params

string
required
CPF ou CNPJ do beneficiário, somente números.
string
Data inicial para o total pago, no formato YYYY-MM-DD. Informe junto com paidTo.
string
Data final para o total pago, no formato YYYY-MM-DD. Informe junto com paidFrom.

Response

string
CPF ou CNPJ do beneficiário consultado.
number
Valor a receber: soma dos repasses em SCHEDULED, PENDING e PROCESSING.
object
Valor a receber separado por status.
object
Total pago no período. Presente apenas quando paidFrom e paidTo são informados.