Criar recorrência de agendamento

Este endpoint permite que o usuário pagador possa criar uma recorrência de agendamentos.

Requisição (Request)

Requisição HTTP

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

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

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.write`	Concede acesso para criar uma recorrência de agendamento.

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.

Parâmetros da rota (Path)

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

Corpo da requisição (Body)

No body, envie o seguinte campo em formato JSON:

Nome	Tipo	Descrição
`requestDateTime`	`date`	Data e hora que o usuário solicitou o agendamento
`payment`	`objeto`	Objeto que contem os dados do pagamento.
`payment.initiationForm`	`string`	Forma de iniciação do agendamento `DICT` `MANU`
`payment.interbankSettlementAmount`	`string`	Valor do agendamento da recorrência.
`payment.remittanceInformation`	`string`	Informações do usuário pagador para o usuário recebedor.

`payment.creditor`	`objeto`	Objeto que contem os dados da conta recebedora.
`payment.creditor.accountIdentification`	`string`	Conta do cliente recebedor.
`payment.creditor.accountIssuer`	`string`	Agência do cliente recebedor.
`payment.creditor.accountType`	`string`	Tipo de conta. `CACC` `TRAN` `SVGS`
`payment.creditor.agentMemberIdentification`	`string`	ISPB do banco do cliente recebedor.
`payment.creditor.name`	`string`	Nome do recebedor.
`payment.creditor.privateIdentification`	`string`	CPF ou CNPJ do cliente recebedor.
`payment.creditor.accountProxy`	`string`	Chave Pix do usuário recebedor. Obrigatório apenas quando `initiationForm` = `DICT`.
`payment.debtor`	`objeto`	Objeto que contem os dados da conta pagadora.
`payment.debtor.accountIdentification`	`string`	Conta do cliente pagador.
`payment.debtor.accountIssuer`	`string`	Agência do cliente pagador.
`payment.debtor.accountType`	`string`	Tipo de conta pagadora. `CACC` `TRAN` `SVGS`
`payment.debtor.agentMemberIdentification`	`string`	ISPB do banco do cliente pagador.
`payment.debtor.name`	`string`	Nome do pagador.
`payment.debtor.privateIdentification`	`string`	CPF ou CNPJ do cliente pagador.
`recurrence`	`objeto`	Objeto que contem os dados da recorrência.
`recurrence.frequency`	`string`	Frequência da recorrência. `WEEKLY` `MONTLHY` `YEARLY`
`recurrence.initialDateSchedule`	`date`	Data de início da recorrência, ou seja, data do primeiro pagamento
`recurrence.finalDateSchedule`	`date`	Data de fim da recorrência, ou seja, data do último agendamento
`recurrence.repetition`	`string`	Quantidade de repetições da recorrência.
`recurrence.description`	`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). ENUM: `ANTICIPATE` `POSTPONE`

Resposta (Response)

O status code 201 indicará sucesso na criação do agendamento.

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

Nome	Tipo	Descrição
`recurrence`	`objeto`	Objeto que contem os dados da recorrência.
`recurrence.requestIdentifier`	`string`	Identificador da recorrência.
`message`	`string`	Mensagem de sucesso.

{
  "recurrence": {
    "requestIdentifier": "R1314008820250926102859521EET8W2KAYM"
  },
  "message": "Solicitação de recorrência recebida com sucesso"
}

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