Consultas

Consulta por código de autenticação

<div class="bkly-ref-description"> <p>Consulte todos os detalhes de um pagamento específico (completado ou não) por meio de seu código de autenticação (<code>authenticationCode</code>).</p> <span class="bkly-ref-small-stable-tag">stable</span> <span class="bkly-ref-scope-tag">scope: payment.read</span> </div> [block:callout] { "type": "info", "title": "Nota", "body": "Para mais informações, confira a documentação [Consulta por código de autenticação](/docs/consulta-por-codigo-de-autenticacao)." } [/block]

get/bill-payment/detail

Request

Base URL
https://api-mtls.sandbox.bankly.com.br
URL
https://api-mtls.sandbox.bankly.com.br/bill-payment/detail
Auth
none declared

Query parameters

bankBranchstring required

Número da agência do banco do pagador.

bankAccountstring required

Número da conta do pagador.

authenticationCodestring required

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.

Parameters

#/paths/~1bill-payment/get/parameters/0 (unresolved $ref)

#/paths/~1bill-payment/get/parameters/1 (unresolved $ref)

#/paths/~1bill-payment/get/parameters/2 (unresolved $ref)

Response

Recurso encontrado.

authenticationCodestring uuid

Id de confirmação da transação que poderá ser utilizado para consultar um pagamento específico.

bankBranchstring nullable

Número da agência do banco do pagador.

bankAccountstring nullable

Número da conta do pagador.

paymentDatestring date-time

Data do pagamento.

status'Created' | 'Completed' | 'Canceled'

Situação do pagamento.

companyKeystring nullable

Chave identificadora da companhia.

documentNumberstring nullable

Número do documento do pagador.

confirmedAtstring date-time

Data da confirmação do pagamento.

digitablestring nullable

Linha digitável.

amountnumber double

Valor pago.

originalAmountnumber double

Valor original, sem encargos.

assignorstring nullable

Nome do cedente.

recipientDocumentstring nullable

Número do documento do recebedor.

recipientNamestring nullable

Nome do recebedor do pagamento.

settleDatestring date-time

Data de liquidação do título.

dueDatestring date-time

Data de vencimento do título.

descritpionstring nullable

Descrição do pagamento.

Changes

No recorded changes to this operation across all 1 revision of this API.