Consulta de recorrência de agendamentos

get

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

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

debtorAccountIdentification

string

Conta transacional do usuário pagador

debtorAccountIssuer

string

Agência do usuário pagador sem dígito verificador

status

string

enum

Status da recorrência

Allowed:

initialDate

string

Data de início do período para a busca das regras de recorrência

endDate

string

Data fim do período para a busca das regras de recorrência

page

integer

Defaults to 1

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

pageSize

integer

Defaults to 100

Número de registros desejados (caso não seja informado vamos trazer todos os registros com base nos parâmetros fornecidos acima)

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

200Consulta realizada com sucesso.

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

401Acesso não autorizado.

403O acesso ao recurso foi negado pelo servidor.

500Ocorreu algum erro inexperado em nosso servidor.