Consulta de agendamento por identificador

Este endpoint permite consultar os detalhes de um agendamento único ou do pix automático a partir do identificador.

Requisição (Request)

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/pix/scheduling-payments/{requestIdentifier}

curl --request GET \
     --url https://api-mtls.sandbox.bankly.com.br/pix/scheduling-payments/RR595881112025031252S6M18DDD1 \
     --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 um agendamento a partir do identificador.

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
`requestIdentifier`	`path`	Obrigatório. Identificador do agendamento.	—

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
`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
`interbankSettlementAmount`	`number`	Valor do agendamento interbancário.
`liquidationCodeSubType`	`string`	Subtipo de código de liquidação. `COMMON_SCHEDULING` `AUTOMATIC_PIX_SCHEDULING`
`dateSchedule`	`date`	Data do agendamento.
`requestIdentifier`	`string`	Identificador da solicitação.
`remittanceInformation`	`string`	Informação da remessa
`endToEndIdentification`	`string`	Identificador de ponta a ponta.
`transactionIdentification`	`string`	Identificador da transação.
`insertDateTime`	`datetime`	Data e hora de inserção.
`status`	`string`	Status dos agendamentos
`purpose`	`string`	Tipo do agendamento. `AGND`- Primeiro agendamento `RIFL`- Retentativa de agendamento pós falha `NTAG`- Retentativa pós vencimento
`paymentInitiator`	`string`	CNPJ do iniciador do pagamento.
`creditor`	`objeto`	Objeto que deve conter os dados do recebedor da recorrência de pagamento.
`creditor.accountIdentification`	`string`	Número da conta do cliente recebedor.
`creditor.accountIssuer`	`string`	Número da agência do cliente recebedor
`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.
`creditor.agentMemberIdentification`	`string`	ISPB do banco do recebedor
`creditor.name`	`string`	Nome do recebedor
`creditor.privateIdentification`	`string`	CNPJ do cliente recebedor
`creditor.accountProxy`	`string`	Chave Pix do recebedor
`debtor`	`Objeto`	Objeto que deve conter os dados do pagador.
`debtor.accountIdentification`	`string`	Número da conta do cliente pagador.
`debtor.accountIssuer`	`string`	Número da agencia do cliente pagador.
`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.
`debtor.agentMemberIdentification`	`string`	ISPB do banco do pagador.
`debtor.name`	`string`	Nome do pagador.
`debtor.privateIdentification`	`string`	CNPJ do cliente pagador.
`recurrence`	`Objeto`	Objeto que contem os dados da recorrência
`recurrence.requestIdentifier`	`string`	Identificador da solicitação da recorrência
`recurrence.frequency`	`string`	Periodicidade do pagamento recorrente via Pix automático. `WEEK`- Semanal `MNTH`- Mensal `QURT`- Trimestral `MIAN`- Semestral `YEAR`- Anual
`recurrence.initialDateSchedule`	`date`	Data inicial da recorrência.
`recurrence.finalDateSchedule`	`date`	Data final da recorrência.
`recurrence.repetition`	`number`	Número de repetições.
`recurrence.interbankSettlementAmount`	`string`	Valor interbancário da recorrência.
`recurrence.description`	`string`	Descrição da recorrência.

{
  "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"
  },
  "debtor": {
    "accountIdentification": "100011",
    "accountIssuer": "2020",
    "accountType": "CACC",
    "agentMemberIdentification": "99999010",
    "name": "Maria da Silva",
    "privateIdentification": "45645645645"
  },
  "recurrence": {
    "frequency": "MONTLHY",
    "initialDateSchedule": "2024-09-05",
    "finalDateSchedule": "2024-10-10",
    "repetition": 12,
    "interbankSettlementAmount": 1.99,
    "description": "Recorrencia 1",
    "requestIdentifier": "5de1be0d-4ea2-4ce1-939f-830c90acaf1a"
  }
}

{
  "initiationForm": "AUTO",
  "interbankSettlementAmount": 100,
  "liquidationCodeSubType": "AUTOMATIC_PIX_SCHEDULING",
  "dateSchedule": "2024-08-25",
  "purpose": "AGND",
  "requestIdentifier": "E9999901012341234123412345678900",
  "remittanceInformation": "Teste",
  "endToEndIdentification": "E9999901012341234123412345678900",
  "transactionIdentification": "80c498f40c091210a40f191a19130094",
  "insertDateTime": "2024-08-30T18:56:52.570Z",
  "status": "PROCESSING",
  "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.