Lista os recebíveis

GET/v1/receivables

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros de consulta

limitinteger
Tamanho da página (itens por página).
offsetinteger
Posição do primeiro item (a partir de 0).
sortstring
Expressão de ordenação, ex.: "-createdAt"
daterangeum de
Criados neste dia (YYYY-MM-DD) ou neste instante.
daterangegtstring (date-time)
Criados depois deste instante (exclusivo).
daterangegtestring (date-time)
Criados a partir deste instante (inclusivo).
daterangeltstring (date-time)
Criados antes deste instante (exclusivo).
daterangeltestring (date-time)
Criados até este instante (inclusivo).
statusstring
Só recebíveis com este status (ex.: pending, paid, canceled).
transactionIdstring
Só os recebíveis desta cobrança.
releasedstring
yes: só recebíveis liberados; no: só os ainda pendentes.
Valores:yesno
idstring
Só este recebível.
expectedOnrangegtestring (date-time)
Limite inferior (inclusivo, instante ISO) de expectedOnAt
expectedOnrangeltestring (date-time)
Limite superior (inclusivo, instante ISO) de expectedOnAt
orderBystring
A ordem da lista: createdAt (padrão) ou expectedOn
Valores:createdAtexpectedOn

Respostas

200Sucesso

dataobject[]obrigatório
Os itens desta página.
+26 campos de data
- idstringobrigatório
  Identificador público (rec_…)
- splitstringobrigatóriopode ser nulo
  O split de que vem; null quando é do próprio vendedor.
- _linksobject
  Links para operações relacionadas, por ação (self, create, update, delete, list…).
- amountintegerobrigatório
  Valor líquido, em centavos (o que chega ao saldo).
- liablebooleanobrigatóriopode ser nulo
  Se o recebedor arca com os chargebacks dele.
- paidAtstringobrigatóriopode ser nulo
  Quando foi liberado para o saldo; null até lá.
- statusstringobrigatório
  Status: pending (aguardando a data de liberação), paid (liberado para o saldo), canceled, refunded, chargeback…
- currencystringobrigatório
  Moeda (ISO 4217).
- merchantobject
  A conta dona do recurso (o vendedor de registro).
  +3 campos de merchant
  - namestringobrigatóriopode ser nulo
    Nome fantasia da conta dona do recurso.
  - merchantIdstringobrigatóriopode ser nulo
    Id público da conta dona do recurso (bus_…).
  - isSubAccountbooleanobrigatório
    true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
- releasedbooleanobrigatóriopode ser nulo
  Se foi liberado para o saldo disponível.
- createdAtstringobrigatório
  Quando o recurso foi criado (ISO 8601, UTC).
- recipientstringobrigatóriopode ser nulo
  A conta que o recebe (bus_…).
- updatedAtstringobrigatório
  Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).
- canceledAtstringobrigatóriopode ser nulo
  Quando foi cancelado; null quando não foi.
- disputedAtstringobrigatóriopode ser nulo
  Quando entrou em disputa; null quando não entrou.
- expectedOnstringobrigatóriopode ser nulo
  Data prevista de liberação.
- refundedAtstringobrigatóriopode ser nulo
  Quando foi estornado; null quando não foi.
- descriptionstringobrigatóriopode ser nulo
  Descrição; null quando não há.
- grossAmountintegerobrigatório
  Valor bruto, em centavos (antes das taxas).
- chargedBackAtstringobrigatóriopode ser nulo
  Quando sofreu chargeback; null quando não sofreu.
- transactionIdstringobrigatóriopode ser nulo
  A cobrança de que o recebível vem.
- fraudChekingAtstringobrigatóriopode ser nulo
  Quando foi retido para análise de fraude; null quando não foi. O nome mantém a grafia histórica.
- antecipationFeenumberobrigatóriopode ser nulo
  Taxa cobrada para antecipá-lo, em centavos; null quando não foi antecipado. O nome mantém a grafia histórica.
- authorizationCodestringobrigatóriopode ser nulo
  Código de autorização da cobrança; null em Pix/boleto.
- installmentNumberintegerobrigatóriopode ser nulo
  Parcela da cobrança a que pertence; null em pagamento à vista.
- chargeProcessingFeebooleanobrigatóriopode ser nulo
  Se o recebedor paga a taxa de processamento dele.
pageobjectobrigatório
Cursores de paginação da lista.
+3 campos de page
- totalintegerobrigatório
  Número total de páginas.
- offsetobjectobrigatório
  O offset para pedir a primeira, a anterior, a próxima e a última página.
  +4 campos de offset
  - lastintegerobrigatório
    Posição da última página.
  - nextintegerobrigatório
    Posição da próxima página (fica nesta quando ela é a última).
  - previntegerobrigatório
    Posição da página anterior (0 na primeira).
  - firstintegerobrigatório
    Posição da primeira página.
- currentintegerobrigatório
  Número da página atual (a primeira é 1).
limitintegerobrigatório
Tamanho da página, como pedido.
totalintegerobrigatório
Número total de itens que atendem aos filtros.
_linksobject
Links para operações relacionadas, por ação (self, create, update, delete, list…).
offsetintegerobrigatório
Posição do primeiro item desta página, como pedido.
hasMorebooleanobrigatório
true quando há mais itens depois desta página.
merchantobject
A conta dona do recurso (o vendedor de registro).
+3 campos de merchant
- namestringobrigatóriopode ser nulo
  Nome fantasia da conta dona do recurso.
- merchantIdstringobrigatóriopode ser nulo
  Id público da conta dona do recurso (bus_…).
- isSubAccountbooleanobrigatório
  true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorSimula as taxas e os totais de um meio de pagamento PróximaAgenda de liberação por dia — recebíveis pendentes pela data prevista de liberação, garantia pela data de devolução, e os vencidos