Listar agendamentos

Este endpoint permite listar os agendamentos únicos ou do Pix Automático 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

curl --request GET \
     --url 'https://api-mtls.sandbox.bankly.com.br/pix/scheduling-payments?liquidationCodeSubType=COMMON_SCHEDULING&page=1&pageSize=100' \
     --header 'Authorization: bearer' \
     --header 'accept: application/json' \
     --header 'api-version: 1' \
     --header 'x-bkly-pix-user-id: 123456789' \
     --header 'x-correlation-id: haseher-2414n-bnjk2-213jl'

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 os agendamentos.

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.	`^([0-9]{11}\|[A-Z0-9]{12}[0-9]{2})$`
`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
`liquidationCodeSubtype`	`query`	Subtipo de código de liquidação.	Allowed: `COMMON_SCHEDULING` `AUTOMATIC_PIX_SCHEDULING`
`debtorAccountIdentification`	`query`	Conta transacional do usuário pagador (obrigatório se `debtorAccountIssuer`estiver preenchido).	—
`debtorAccountIssuer`	`query`	Agência do usuário pagador sem dígito verificador (obrigatório se `debtorAccountIdentification` estiver preenchido).	—
`status`	`query`	Status dos agendamentos	`AWAITING_ENRICHMENT` `CANCELED` `SENT_PRE_VALIDATION` `PROCESSING` `RESCHEDULED` `SCHEDULED` `ATTEMPTS_EXCEEDED` `SUCCESSFULLY_COMPLETED` `UNSUCCESSFULLY_COMPLETED`
`initialDate`	`query`	Data de início do período para a busca das regras de agendamentos.	—
`endDate`	`query`	Data fim do período para a busca das regras de agendamentos.	—
`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.
`scheduling`	`objeto`	Objeto que contem os dados dos agendamentos.
`scheduling.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 `QRDN`- pagamento por QR code dinâmico na modalidade de cobrança com vencimento `QRES`- pagamento por QR code estático `INIC` - pagamento iniciado por open finance `AUTO`- pagamento Pix Automático
`scheduling.interbankSettlementAmount`	`number`	Valor do agendamento interbancário.
`scheduling.liquidationCodeSubType`	`string`	Subtipo de código de liquidação. `COMMON_SCHEDULING` `AUTOMATIC_PIX_SCHEDULING`
`scheduling.dateSchedule`	`date`	Data do agendamento.
`scheduling.requestIdentifier`	`string`	Identificador da solicitação.
`scheduling.remittanceInformation`	`string`	Informação da remessa
`scheduling.endToEndIdentification`	`string`	Identificador de ponta a ponta.
`scheduling.transactionIdentification`	`string`	Identificador da transação.
`scheduling.insertDateTime`	`datetime`	Data e hora de inserção.
`scheduling.status`	`string`	Status dos agendamentos
`scheduling.purpose`	`string`	Propósito do agendamento. `AGND`- Primeiro agendamento `RIFL`- Retentativa de agendamento pós falha `NTAG`- Retentativa pós vencimento
`scheduling.paymentInitiator`	`string`	CNPJ do iniciador do pagamento.
`scheduling.creditor`	`objeto`	Objeto que deve conter os dados do recebedor da recorrência de pagamento.
`scheduling.creditor.accountIdentification`	`string`	Número da conta do cliente recebedor.
`scheduling.creditor.accountIssuer`	`string`	Número da agência do cliente recebedor
`scheduling.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. `SLRY`- Conta-Salário. `SVGS`- Conta de Poupança. `TRAN`- Conta de Pagamento.
`scheduling.creditor.agentMemberIdentification`	`string`	ISPB do banco do recebedor
`scheduling.creditor.name`	`string`	Nome do recebedor
`scheduling.creditor.privateIdentification`	`string`	CNPJ do cliente recebedor
`scheduling.creditor.accountProxy`	`string`	Chave Pix do recebedor
`scheduling.debtor`	`Objeto`	Objeto que deve conter os dados do pagador.
`scheduling.debtor.accountIdentification`	`string`	Número da conta do cliente pagador.
`scheduling.debtor.accountIssuer`	`string`	Número da agencia do cliente pagador.
`scheduling.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. `SLRY` - Conta-Salário. `SVGS` - Conta de Poupança. `TRAN` - Conta de Pagamento.
`scheduling.debtor.agentMemberIdentification`	`string`	ISPB do banco do pagador.
`scheduling.debtor.name`	`string`	Nome do pagador.
`scheduling.debtor.privateIdentification`	`string`	CNPJ do cliente pagador.
`scheduling.recurrence`	`Objeto`	Objeto que contem os dados da recorrência
`scheduling.recurrence.requestIdentifier`	`string`	Identificador da solicitação da recorrência
`scheduling.recurrence.frequency`	`string`	Periodicidade do pagamento recorrente via Pix automático. `WEEK`- Semanal `MNTH`- Mensal `QURT`- Trimestral `MIAN`- Semestral `YEAR`- Anual
`scheduling.recurrence.initialDateSchedule`	`date`	Data inicial da recorrência.
`scheduling.recurrence.finalDateSchedule`	`date`	Data final da recorrência.
`scheduling.recurrence.repetition`	`string`	Número de repetições.
`scheduling.recurrence.interbankSettlementAmount`	`string`	Valor interbancário da recorrência.
`scheduling.recurrence.description`	`string`	Descrição da recorrência.

{
  "totalItems": 8,
  "totalPages": 3,
  "currentPage": 1,
  "scheduling": [
    {
      "initiationForm": "DICT",
      "interbankSettlementAmount": 100,
      "liquidationCodeSubType": "COMMON_SCHEDULING",
      "dateSchedule": "2024-08-25",
      "requestIdentifier": "E9999901012341234123412345678900",
      "remittanceInformation": "Teste",
      "endToEndIdentification": "E9999901012341234123412345678900",
      "insertDateTime": "2024-08-30T18:56:52.570Z",
      "status": "PROCESSING",
      "purpose": "AGND",
      "paymentInitiator": "11111111",
      "creditor": {
        "accountIdentification": "100010",
        "accountIssuer": "2020",
        "accountType": "CACC",
        "agentMemberIdentification": "99999010",
        "name": "João da Silva",
        "privateIdentification": "12312312312",
        "accountProxy": "+5561988880000"
      },
      "debitor": {
        "accountIdentification": "100011",
        "accountIssuer": "2020",
        "accountType": "CACC",
        "agentMemberIdentification": "99999010",
        "name": "Maria da Silva",
        "privateIdentification": "45645645645"
      },
      "recurrence": {
        "frequency": "MONTHLY",
        "initialDateSchedule": "2024-09-05",
        "finalDateSchedule": "2024-10-10",
        "repetition": 12,
        "interbankSettlementAmount": 1.99,
        "description": "Recorrencia 1",
        "requestIdentifier": "5de1be0d-4ea2-4ce1-939f-830c90acaf1a"
      }
    }
  ]
}

{
  "totalItems": 8,
  "totalPages": 3,
  "currentPage": 1,
  "scheduling": [
    {
      "initiationForm": "AUTO",
      "interbankSettlementAmount": 100,
      "liquidationCodeSubType": "AUTOMATIC_PIX_SCHEDULING",
      "dateSchedule": "2024-08-25",
      "requestIdentifier": "E9999901012341234123412345678900",
      "remittanceInformation": "Teste",
      "endToEndIdentification": "E9999901012341234123412345678900",
      "transactionIdentification": "80c498f40c091210a40f191a19130094",
      "insertDateTime": "2024-08-30T18:56:52.570Z",
      "status": "PROCESSING",
      "purpose": "AGND",
      "paymentInitiator": "11111111",
      "creditor": {
        "accountIdentification": "100010",
        "accountIssuer": "2020",
        "accountType": "CACC",
        "agentMemberIdentification": "99999010",
        "name": "João da Silva",
        "privateIdentification": "12312312312",
        "accountProxy": "+5561988880000"
      },
      "debtor": {
        "accountIdentification": "100011",
        "accountIssuer": "2020",
        "accountType": "CACC",
        "agentMemberIdentification": "99999010",
        "name": "Maria da Silva",
        "privateIdentification": "45645645645"
      },
      "recurrence": {
        "requestIdentifier": "5de1be0d-4ea2-4ce1-939f-830c90acaf1a"
      }
    }
  ]
}

👍
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.