Consulta de recorrência por identificador

Este endpoint permite consultar os detalhes de uma recorrência a partir do identificador.

Requisição (Request)

Requisição HTTP

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

curl --request GET \
     --url https://api-mtls.sandbox.bankly.com.br/pix/scheduling-payments/recurrences/requestIdentifier \
     --header 'accept: application/json' \
     --header 'api-version: 1'

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`	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 da recorrência.	—

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
`requestIdentifier`	`string`	Identificador da solicitação da recorrência.
`initialDateSchedule`	`date`	Data inicial da recorrência.
`finalDateSchedule`	`date`	Data final da recorrência.
`insertDateTime`	`datetime`	Data e hora de inserção.
`status`	`string`	Status da recorrência `PROCESSING` `CANCELED` `COMPLETED` `AWAITING_ENRICHMENT`
`repetition`	`number`	Número de repetições.
`interbankSettlementAmount`	`number`	Valor interbancário da recorrência.
`recurrenceDescription`	`string`	Descrição da recorrência.
`invalidDatePayment`	`string`	Indica se o agendamento deve ser antecipado ou postergado em caso de data inexistente (ex. dias 29 e 31). `ANTICIPATE` `POSTPONE`
`frequency`	`string`	Periodicidade da recorrência `WEEKLY` `MONTHLY` `YEARLY`
`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
`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 agencia 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. `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 usuário recebedor. Obrigatório apenas quando initiationForm = DICT
`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. `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.
`scheduling`	`objeto`	Objeto que contem os dados dos agendamentos da recorrência.
`scheduling.requestIdentifier`	`string`	Identificador da solicitação de recorrência.
`scheduling.endToEndIdentification`	`string`	Identificador de ponta a ponta.
`scheduling.ScheduledDate`	`string`	Data do agendamento.
`scheduling.insertDateTime`	`string`	Data e hora de inserção.
`scheduling.status`	`string`	Status dos agendamentos
`scheduling.interbankSettlementAmount`	`number`	Valor do agendamento.
`scheduling.remittanceInformation`	`string`	Informação da remessa

{
  "requestIdentifier": "R13140088202509221724149129XXE5OA3B5",
  "initialDateSchedule": "2024-01-01",
  "finalDateSchedule": "2024-03-01",
  "insertDateTime": "2024-08-30T18:56:52.570Z",
  "status": "PROCESSING",
  "repetition": 0,
  "interbankSettlementAmount": 1000,
  "recurrenceDescription": "Recorrência de agendamento",
  "invalidDatePayment": "ANTICIPATE",
  "frequency": "WEEKLY",
  "initiationForm": "DICT",
  "creditor": {
    "accountIdentification": "100010",
    "accountIssuer": "2020",
    "accountType": "TRAN",
    "agentMemberIdentification": "99999010",
    "name": "João da Silva",
    "privateIdentification": "12312312312",
    "accountProxy": "a8db35ae-2f7f-4e8a-9ad0-d37e0d2f26d2"
  },
  "debtor": {
    "accountIdentification": "100011",
    "accountIssuer": "2020",
    "accountType": "TRAN",
    "agentMemberIdentification": "99999010",
    "name": "José da silva",
    "privateIdentification": "45645645645"
  },
  "scheduling": [
    {
      "requestIdentifier": "E5958811120240827180458753XXXXX",
      "endToEndIdentification": "E5958811120240827180458753XXXXX",
      "scheduledDate": "2024-01-01",
      "insertDateTime": "2024-08-30T18:56:52.570Z",
      "status": "PROCESSING",
      "interbankSettlementAmount": 1000,
      "remittanceInformation": "teste"
    },
    {
      "requestIdentifier": "E5958811120240827180458753XXXXX",
      "endToEndIdentification": "E5958811120240827180458753XXXXX",
      "scheduledDate": "2024-02-01",
      "insertDateTime": "2024-08-30T18:56:52.570Z",
      "status": "SCHEDULED",
      "interbankSettlementAmount": 1000,
      "remittanceInformation": "teste"
    }
  ]
}

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