Consulta de agendamentos

get

https://api-mtls.sandbox.bankly.com.br/pix/scheduling-payments

Utilize este endpoint para consultar os agendamentos a partir de campos informados na requisição.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

liquidationCodeSubType

string

enum

Identificação do subtipo da liquidação.

Allowed:

debtorAccountIdentification

string

Conta transacional do usuário pagador (obrigatório se debtorAccountIssuer estiver preenchido).

debtorAccountIssuer

string

Agência do usuário pagador sem dígito verificador (obrigatório se debtorAccountIdentification estiver preenchido).

status

string

enum

Status dos agendamentos.

initialDate

string

Data de início do período para a busca das regras de agendamentos.

endDate

string

Data fim do período para a busca das regras de agendamentos.

page

string

Defaults to 1

Número da página para paginação.

pageSize

string

Defaults to 100

Quantidade de registros por página.

Headers

api-version

string

required

Defaults to 1

Versão da API. Atualmente estamos na 1.0.

x-bkly-pix-user-id

string

required

Número do documento do usuário que está fazendo a requisição. Informe somente números para CPF e caracteres alfanuméricos para CNPJ, sem formatação.

Authorization

string

required

Token de autorização do tipo Bearer.

x-correlation-id

string

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

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Retorno da consulta com sucesso.

400Há algum problema com a sua requisição.

401Acesso não autorizado.

403O acesso ao recurso foi negado pelo servidor.

404Recurso não encontrado.

500Ocorreu algum erro inexperado em nosso servidor.