Consultas

Consulta de pagamento por conta

<div class="bkly-ref-description"> <p>Consulte todos os pagamentos (completados ou não) realizados por uma conta específica.</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 de pagamento por conta](/docs/consulta-pagamento-por-conta)." } [/block]

get/bill-payment

Request

Base URL
https://api-mtls.sandbox.bankly.com.br
URL
https://api-mtls.sandbox.bankly.com.br/bill-payment
Auth
none declared. Required headers: api-version, Authorization, x-correlation-id

Query parameters

bankBranchstring required

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

bankAccountstring required

Número da conta do pagador.

pageSizeinteger

Número de itens por página que a consulta deve retornar.

pageTokenstring

Após a primeira consulta, será retornado um token no campo nextPage, que identifica as páginas retornadas. Caso deseje consultar a próxima página, é preciso informá-lo neste campo (<code>pageToken</code>).

Headers

api-versionstring required

Versão da API. Atualmente estamos na 1.0.

Authorizationstring required

<i>Token</i> de autorização do tipo Bearer.

x-correlation-idstring required

Informe um GUID v4. A cada requisição, deve-se gerar um novo GUID.

Response

Recurso encontrado.

nextPagestring nullable

Identificador da página retornada. Caso deseje consultar a próxima página, é preciso informá-lo no campo <code>pageToken</code>.

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.