Autenticação: token JWT obrigatório. Superusuários ignoram a verificação de acesso. Usuários comuns só visualizam recebíveis cuja
receiver_account ou acquirer_account esteja em seu conjunto de contas relacionadas.expected_on decrescente, excluindo linhas com status == 'deleted'.
Parâmetros de caminho
Identificador da conta unificada. São retornados recebíveis em que esta conta é receptora ou processadora.
Parâmetros de query
Busca textual sem distinção de maiúsculas/minúsculas nos campos
acquirer_account.display_name, receiver_account.display_name, status e zoop_id.Correspondência exata. Valores comuns:
pending, paid, refunded, scheduled.Filtra pela conta unificada que recebe o valor.
Filtra pela conta unificada que processou a transação.
Filtra pela transação unificada que originou o recebível.
ISO-8601. Apenas recebíveis criados nesta data ou após.
ISO-8601. Limite superior inclusivo — o servidor adiciona 1 dia para cobrir o dia inteiro.
ISO-8601. Limite inferior para
expected_on.ISO-8601. Limite superior inclusivo (1 dia adicionado).
Resposta
Retorna um array de recebíveis.Projeção
{id, display_name, type} da conta unificada que recebe o valor.Projeção
{id, display_name, type} da conta unificada que processou a venda.Identificador da transação unificada.
Um dos valores
pending, paid, refunded, scheduled, deleted (linhas excluídas não aparecem na lista, mas podem aparecer no detalhe).Valor líquido a receber, em BRL (em formato string, com
. como separador decimal).Valor bruto antes das taxas, em BRL.
Taxa de antecipação cobrada quando o recebível foi antecipado.
Indica se uma regra de split já foi aplicada a este recebível.
Indica se o recebível foi pago antecipadamente.
Indica se o vendedor é responsável em caso de disputa.
Número da parcela (ex.:
"1" de 12). null para produtos sem parcelamento.ISO-8601 se cancelado.
ISO-8601 do momento em que o recebível foi registrado.
ISO-8601 da transação originadora.
ISO-8601 do momento da liquidação.
ISO-8601 — dia previsto para a liquidação do recebível.
Identificador histórico do recurso na infraestrutura de processamento.
Estado reportado pela infraestrutura de processamento.
Data da última sincronização com a infraestrutura de processamento.
Erros
| Status | Quando |
|---|---|
401 | Token ausente ou inválido. |
403 | O chamador não possui acesso a sellers_pk nem às contas relacionadas. |
404 | sellers_pk inexistente. |