Criar agendamento único

Este endpoint permite que o usuário pagador possa criar um agendamento de um pagamento.

Requisição (Request)

Requisição HTTP

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

curl --request POST \
     --url https://api-mtls.sandbox.bankly.com.br/pix/scheduling-payments \
     --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 um agendamento de pagamento.

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
`initiationForm`	`string`	Forma de iniciação do agendamento `DICT` `MANU` `QRDN` `QRES`
`transactionIdentification`	`string`	Identificação única da transação. Obrigatório somente se `initiationForm` for "`QRDN`", "`QRES`".
`interbankSettlementAmount`	`string`	Valor do agendamento.
`requestDateTime`	`date`	Data e hora que o usuário solicitou o agendamento
`dateSchedule`	`date`	Data do agendamento. Formato (yyyy-MM-dd).
`requestIdentifier`	`string`	Identificador fim-a-fim do agendamento.
`creditor`	`objeto`	Dados da conta recebedora.
`creditor.accountIdentification`	`string`	Conta do cliente recebedor.
`creditor.accountIssuer`	`string`	Agência do cliente recebedor.
`creditor.accountType`	`string`	Tipo de conta. `CACC` `TRAN` `SVGS`
`creditor.agentMemberIdentification`	`string`	ISPB do banco do cliente recebedor.
`creditor.name`	`string`	Nome do recebedor.
`creditor.privateIdentification`	`string`	CPF ou CNPJ do cliente recebedor.
`creditor.accountProxy`	`string`	Chave Pix do usuário recebedor. Obrigatório apenas quando `initiationForm` = `DICT`.
`debtor`	`objeto`	Dados da conta pagadora.
`debtor.accountIdentification`	`string`	Conta do cliente pagador.
`debtor.accountIssuer`	`string`	Agência do cliente pagador.
`debtor.accountType`	`string`	Tipo de conta pagadora. `CACC` `TRAN` `SVGS`
`debtor.agentMemberIdentification`	`string`	ISPB do banco do cliente pagador.
`debtor.name`	`string`	Nome do pagador.
`debtor.privateIdentification`	`string`	CPF ou CNPJ do cliente pagador.
`remittanceInformation`	`string`	Informações do usuário pagador para o usuário recebedor.
`encodedValue`	`string`	Copia e cola do QRCode em base64. Obrigatório somente se initiationForm for "`QRDN`", "`QRES`".

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
`requestIdentifier`	`string`	Identificador do agendamento.
`message`	`string`	Mensagem de sucesso.

{
  "requestIdentifier": "E9999901012341234123412345678900",
  "schedulingUniqueKey": "5de1be0d-4ea2-4ce1-939f-830c90acaf1a",
  "message": "Agendamento cadastrado com sucesso"
}

{
  "requestIdentifier": "E5958811120250324200809925PFR97O",
  "status": "CANCELED",
  "uidSchedule": "39f42215-0196-1000-ae4a-ffffffff8d2d",
  "dateSchedule": "2025-04-15"
}

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