Consulta por código de autenticação

stable

Este endpoint permite que o cliente do parceiro Bankly obtenha todos os detalhes de um pagamento específico (completado ou não) por meio de seu código de autenticação (authenticationCode).

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

O parceiro possua o authenticationCode gerado após a confirmação do pagamento.

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/bill-payment/detail

--location --request GET 'https://api-mtls.sandbox.bankly.com.br/bill-payment/detail' \
--header 'accept: application/json' \
--header 'api-version: 1.0' \
--header 'authorization: Bearer {{Token}}' \
--header 'x-correlation-id: GUID' \

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Scope	Descrição
`payment.read`	Concede acesso para consultar um pagamento por conta.

Cabeçalhos (Headers)

Nome	Descrição
`api-version`	Obrigatório. Versão da API. Atualmente estamos na versão 1.0.
`authorization`	Obrigatório. Token de autorização do tipo Bearer.
`x-correlation-id`	Obrigatório. Informe um GUID, sendo um novo cada requisição.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

Nome	Tipo	Descrição
`bankBranch`	`query`	Obrigatório. Número da agência do banco do pagador.
`bankAccount`	`query`	Obrigatório. Número da conta do pagador.
`authenticationCode`	`query`	Obrigatório. Código de autenticação do pagamento que se deseja consultar. O valor pode ser obtido no retorno da requisição de confirmação de pagamento.

Corpo da requisição (Body)

Não é necessário enviar parâmetros no body desta requisição.

Resposta (Response)

O status code 200 indicará que a solicitação foi aceita com sucesso e trará as informações do pagamento.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`authenticationCode`	`string`	Id de confirmação da transação.
`bankAccount`	`string`	Número da conta do pagador.
`bankBranch`	`string`	Número da agência do banco do pagador.
`paymentDate`	`string`	Data do pagamento, no formato YYYY-MM-DDTHH:mm:SS.MMMZ.
`status`	`string`	Situação do pagamento. Confira a lista dos possíveis status no final da página.
`companyKey`	`string`	Chave identificadora da companhia.
`documentNumber`	`string`	Número do documento do pagador.
`confirmedAt`	`string`	Data da confirmação do pagamento, no formato YYYY-MM-DDTHH:mm:SS.MMMZ.
`digitable`	`string`	Linha digitável.
`amount`	`number`	Valor pago.
`originalAmount`	`number`	Valor original, sem encargos.
`assignor`	`string`	Nome do cedente.
`recipientDocument`	`string`	Número do documento do recebedor.
`recipientName`	`string`	Nome do recebedor. do pagamento.
`charges`	`object`	Objeto que contém informações sobre os encargos aplicados na transação. Em caso de pagamentos desfeitos, esse objeto retornará seus campos com valores nulos.
`charges.interestAmountCalculated`	`number`	Valor dos juros.
`charges.fineAmountCalculated`	`number`	Valor da multa.
`charges.discountAmount`	`number`	Valor do desconto.
`settleDate`	`string`	Data em que o pagamento será liquidado, no formato YYYY-MM-DDTHH:mm:SS.MMMZ. Caso a data de vencimento coincida com feriados ou finais de semana, esse campo informará a data do próximo dia úti
`dueDate`	`string`	Data de vencimento, no formato YYYY-MM-DDTHH:mm:SS.MMMZ. Importante: No caso de contas concessionárias (contas de consumo, como água, luz, telefone) e de tributos (como IPVA, IPTU), é esperado que este campo retorne nulo.
`description`	`string`	Descrição do pagamento.

{
   "authenticationCode": "f13f7139-aea3-43cc-8667-2f48c6ad18bb",
   "bankAccount": "123456",
   "bankBranch": "0001",
   "paymentDate": "2022-04-05T20:09:49.652+00:00",
   "status": "Created",
   "companyKey": "XXXXXX",
   "documentNumber": "47742663023",
   "confirmedAt": null,
   "digitable": "856600000017242000042026202286530052311789846491",
   "amount": 124.2,
   "originalAmount": 124.2,
   "assignor": "Conta - Teste",
   "recipientDocument": null,
   "recipientName": null,
   "charges": {
      "interestAmountCalculated": 0,
      "fineAmountCalculated": 0,
      "discountAmount": 0
   },
   "settleDate": "2022-04-06T00:00:00+00:00",
   "dueDate": "2022-04-06T00:00:00+00:00",
   "description": null
}

👍
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.

Status

Status	Descrição
Created	Significa que o título já foi validado e o pagamento está sendo iniciado.
Completed	O pagamento do título foi confirmado.
Canceled	O pagamento foi cancelado.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status code	Code	Descrição
400	FORBIDDEN_SOURCE_ACCOUNT	A conta informada não pertence a essa `companyKey`.
403	---	Falha na autenticação do usuário.
404	NOT_FOUND_BILL_PAYMENT_BY_AUTHENTICATION_CODE	Não foram encontrados pagamentos com esse `authenticationCode`.

Válido lembrar que a API também poderá retornar erros comuns entre todos os endpoints.

🚧
Importante
Os erros estão em processo de mapeamento. Em breve, as listas serão atualizadas.

Eventos

Este endpoint não possui eventos relacionados a ele.

Updated 21 days ago