Consulta de recorrência de agendamentos

stable

Este endpoint permite listar as recorrências de agendamentos a partir de campos informados na requisição.

Requisição (Request)

Requisição HTTP

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

curl --request GET \
    --url 'https://api-mtls.sandbox.bankly.com.br/pix/scheduling-payments/recurrences?' \
    --header 'accept: application/json' \
    --header 'api-version: 1' \
    --header 'Authorization: {{token}}' \
    --header 'x-bkly-pix-user-id: {{privateIdentification}}' \
    --header 'x-correlation-id: {{correlationId}}' \

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
`pix.schedule-payment.read`	Concede acesso para consultar todos as recorrências.

Cabeçalhos (Headers)

Nome	Descrição	Especificação
`api-version`	Obrigatório. Versão da API. Atualmente estamos na versão 1.	—
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.	—
`x-bkly-pix-user-id`	Obrigatório. Número do documento do usuário que está fazendo a requisição.	Informe somente números.
`x-correlation-id`	Obrigatório. Identificador de correlação da requisição.	Formato GUID v4. A cada requisição, deve-se gerar um novo GUID.

Parâmetros da rota (Path)

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

Nome	Tipo	Descrição	Especificação
`debtorAccountIdentification`	`query`	Conta transacional do usuário pagador .
`debtorAccountIssuer`	`query`	Agência do usuário pagador sem dígito verificador.	—
`status`	`query`	Status da recorrência	`AWAITING_ENRICHMENT` `CANCELED` `PROCESSING` `COMPLETED`
`initialDate`	`query`	Data de início do período para a busca das regras de recorrência	—
`endDate`	`query`	Data fim do período para a busca das regras de recorrência.	—
`pageSize`	`query`	Quantidade de registros por página.	—
`page`	`query`	Número da página para paginação.	—

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará sucesso na consulta.

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

Nome	Tipo	Descrição
`totalItems`	`number`	Número total de itens..
`totalPages`	`number`	Número total de páginas.
`currentPage`	`number`	Página atual.
`recurrence`	`objeto`	Objeto que contem os dados da recorrência.
`recurrence.requestIdentifier`	`string`	Identificador da solicitação.
`recurrence.initialDateSchedule`	`date`	Data inicial da recorrência.
`recurrence.finalDateSchedule`	`date`	Data final da recorrência.
`recurrence.insertDateTime`	`datetime`	Data e hora de inserção.
`recurrence.status`	`string`	Status das recorrências `PROCESSING` `CANCELED` `COMPLETED` `AWAITING_ENRICHMENT`
`recurrence.repetition`	`string`	Número de repetições
`recurrence.interbankSettlementAmount`	`number`	Valor do agendamento interbancário
`recurrence.recurrenceDescription`	`string`	Descrição da recorrência
`recurrence.invalidDatePayment`	`string`	Indica se o agendamento deve ser antecipado ou postergado em caso de data inexistente (ex. dias 29 e 31). `ANTICIPATE` `POSTPONE`
`recurrence.frequency`	`string`	Periodicidade da recorrência `WEEKLY` `MONTLHY` `YEARLY`
`recurrence.initiationForm`	`string`	Forma de iniciação. `DICT` - pagamento por chave Pix `MANU` - pagamento por inserção manual dos dados da conta transacional do usuário recebedor
`recurrence.creditor`	`objeto`	Objeto que deve conter os dados do recebedor da recorrência de pagamento.
`recurrence.creditor.accountIdentification`	`string`	Número da conta do cliente recebedor.
`recurrence.creditor.accountIssuer`	`string`	Número da agencia do cliente recebedor
`recurrence.creditor.accountType`	`string`	Tipo de conta do cliente recebedor. `CACC` - Conta corrente de cliente ou conta de instituição participante direto do SPI para liquidação de obrigações e direitos próprios. `SVGS` - Conta de Poupança. `TRAN` - Conta de Pagamento.
`recurrence.creditor.agentMemberIdentification`	`string`	ISPB do banco do recebedor
`recurrence.creditor.name`	`string`	Nome do recebedor
`recurrence.creditor.privateIdentification`	`string`	CNPJ do cliente recebedor
`recurrence.creditor.accountProxy`	`string`	Chave Pix do recebedor Apenas quando `recurrence.initiationForm` = `DICT`
`recurrence.debtor`	`Objeto`	Objeto que deve conter os dados do pagador.
`recurrence.debtor.accountIdentification`	`string`	Número da conta do cliente pagador.
`recurrence.debtor.accountIssuer`	`string`	Número da agencia do cliente pagador.
`recurrence.debtor.accountType`	`string`	Tipo de conta do cliente pagador. `CACC`- Conta corrente de cliente ou conta de instituição participante direto do SPI para liquidação de obrigações e direitos próprios. `SVGS`- Conta de Poupança. `TRAN`- Conta de Pagamento.
`recurrence.debtor.agentMemberIdentification`	`string`	ISPB do banco do pagador.
`recurrence.debtor.name`	`string`	Nome do pagador.
`recurrence.debtor.privateIdentification`	`string`	CNPJ do cliente pagador.

{
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "recurrence": [
    {
      "requestIdentifier": "R13140088202510081746000000000000001",
      "initialDateSchedule": "2025-10-09T00:00:00",
      "finalDateSchedule": "2025-12-09T00:00:00",
      "insertDateTime": "2025-10-08T17:47:14Z",
      "status": "PROCESSING",
      "repetition": 0,
      "interbankSettlementAmount": 8.01,
      "recurrenceDescription": "Descrição da recorrência",
      "invalidDatePayment": "ANTICIPATE",
      "frequency": "WEEKLY",
      "initiationForm": "MANU",
      "creditor": {
        "accountIdentification": "100011",
        "accountIssuer": "0001",
        "accountType": "TRAN",
        "agentMemberIdentification": "13140088",
        "name": "Nome do recebedor",
        "privateIdentification": "1212312312",
        "accountProxy": "[email protected]" 
      },
      "debtor": {
        "accountIdentification": "100010",
        "accountIssuer": "0001",
        "accountType": "TRAN",
        "agentMemberIdentification": "13140088",
        "name": "Nome do pagador",
        "privateIdentification": "45645645645",
      }
    }
  ]
}

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

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.

Updated about 1 hour ago