Consulta um recebível
/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órioIdentificador público (rec_…)
Respostas
200Sucesso
idstringobrigatórioIdentificador público (rec_…)
splitstringobrigatóriopode ser nuloO split de que vem;
nullquando é do próprio vendedor._linksobjectLinks para operações relacionadas, por ação (
self,create,update,delete,list…).amountintegerobrigatórioValor líquido, em centavos (o que chega ao saldo).
liablebooleanobrigatóriopode ser nuloSe o recebedor arca com os chargebacks dele.
paidAtstringobrigatóriopode ser nuloQuando foi liberado para o saldo;
nullaté lá.statusstringobrigatórioStatus:
pending(aguardando a data de liberação),paid(liberado para o saldo),canceled,refunded,chargeback…currencystringobrigatórioMoeda (ISO 4217).
merchantobjectA conta dona do recurso (o vendedor de registro).
+3 campos de
merchantnamestringobrigatóriopode ser nuloNome fantasia da conta dona do recurso.
merchantIdstringobrigatóriopode ser nuloId público da conta dona do recurso (
bus_…).isSubAccountbooleanobrigatóriotruequando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
releasedbooleanobrigatóriopode ser nuloSe foi liberado para o saldo disponível.
createdAtstringobrigatórioQuando o recurso foi criado (ISO 8601, UTC).
recipientstringobrigatóriopode ser nuloA conta que o recebe (
bus_…).updatedAtstringobrigatórioQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
canceledAtstringobrigatóriopode ser nuloQuando foi cancelado;
nullquando não foi.disputedAtstringobrigatóriopode ser nuloQuando entrou em disputa;
nullquando não entrou.expectedOnstringobrigatóriopode ser nuloData prevista de liberação.
refundedAtstringobrigatóriopode ser nuloQuando foi estornado;
nullquando não foi.descriptionstringobrigatóriopode ser nuloDescrição;
nullquando não há.grossAmountintegerobrigatórioValor bruto, em centavos (antes das taxas).
chargedBackAtstringobrigatóriopode ser nuloQuando sofreu chargeback;
nullquando não sofreu.transactionIdstringobrigatóriopode ser nuloA cobrança de que o recebível vem.
fraudChekingAtstringobrigatóriopode ser nuloQuando foi retido para análise de fraude;
nullquando não foi. O nome mantém a grafia histórica.antecipationFeenumberobrigatóriopode ser nuloTaxa cobrada para antecipá-lo, em centavos;
nullquando não foi antecipado. O nome mantém a grafia histórica.authorizationCodestringobrigatóriopode ser nuloCódigo de autorização da cobrança;
nullem Pix/boleto.installmentNumberintegerobrigatóriopode ser nuloParcela da cobrança a que pertence;
nullem pagamento à vista.chargeProcessingFeebooleanobrigatóriopode ser nuloSe o recebedor paga a taxa de processamento dele.
401Não autenticado (credencial ausente ou inválida)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
403Sem permissão
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
404Não encontrado
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório