SelectwinSelectwin

Consulta um recebível

GET/v1/receivables/{receivableId}

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

Parâmetros do caminho

  • receivableIdstringobrigatório

    Identificador público (rec_…)

Respostas

200Sucesso
  • 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.

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
404Não encontrado
  • 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

Preferências de cookies

Hoje o site usa só cookies essenciais: nenhuma ferramenta de medição ou de anúncios está ligada, e nada é compartilhado com terceiros. Se isso mudar, você decide aqui antes de qualquer coisa ser carregada.

  • Mantêm o site funcionando: segurança, a sua escolha sobre cookies e preferências como a versão da documentação. Não dependem de consentimento.

    Sempre ativos