Criar agendamento único

initiationForm

string

• Obrigatório: Forma de iniciação do agendamento

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

transactionIdentification

string

• Identificador único da transação, utilizado no processo de conciliação de pagamentos. _Obrigatório _ somente se initiationForm for QRDN ou QRES.
• initiationForm = MANU ou DICT o campo deverá ser nulo.

initiationForm = QRES: preenchimento obrigatório com o valor do QR Code estático. Deve conter até 25 caracteres alfanuméricos ([A-Za-z0-9]).

initiationForm = QRDN: preenchimento obrigatório com o valor do payload JSON do QR Code dinâmico, contendo entre 26 e 35 caracteres alfanuméricos ([A-Za-z0-9]).

interbankSettlementAmount

number

• Obrigatório: Valor do agendamento.

\d{1,16}.\d{2}

requestDateTime

datetime

• Obrigatório: Data e hora que o usuário solicitou o agendamento.

Exemplo: 2026-02-10T16:41:47.191-03:00

dateSchedule

date

• Obrigatório: Data do agendamento.

yyyy-MM-dd

endToEndId

string

• Identificador fim-a-fim do agendamento. _Obrigatório _ quando initiationForm for igual a DICT , QRDN ou QRES.
• initiationForm = MANU o campo deverá ser nulo.

[a-zA-Z0-9]{32}
ExxxxxxxxyyyyMMddHHmmkkkkkkkkkkk

creditor

objeto

• Dados da conta recebedora.
  Obrigatório somente quando initiationForm for igual a MANU.
• Quando initiationForm for igual a DICT , QRDN ou QRES o campo deverá ser nulo.

creditor.accountIdentification

string

• Conta do cliente recebedor. Obrigatório somente quando initiationForm for igual a MANU.

^[0-9]{1,20}$

creditor.accountIssuer

string

• Agência do usuário recebedor sem dígito verificador. Obrigatório somente quando initiationForm for igual a MANU.

^[0-9]{1,4}$

creditor.accountType

string

• Tipo de conta transacional do usuário recebedor. Obrigatório somente quando initiationForm for igual a MANU.

CACC - Conta Corrente

TRAN - Conta de Pagamento

SVGS - Conta Poupança

creditor.agentMemberIdentification

string

• ISPB do banco do cliente recebedor. Obrigatório somente quando initiationForm for igual a MANU.

^[0-9]{8}$

creditor.name

string

• Nome do recebedor. Obrigatório somente quando initiationForm for igual a MANU.

<= 140 caracteres

creditor.privateIdentification

string

• CPF ou CNPJ do cliente recebedor. Obrigatório somente quando initiationForm for igual a MANU.

([0-9]{11}|[0-9]{14})

debtor

objeto

• Obrigatório: Dados da conta pagadora.

debtor.accountIdentification

string

• Obrigatório: Conta do cliente pagador.

^[0-9]{1,20}$

debtor.accountIssuer

string

• Obrigatório: Agência do cliente pagador.

^[0-9]{1,4}$

debtor.accountType

string

• Obrigatório: Tipo de conta pagadora.

CACC - Conta Corrente

TRAN - Conta de Pagamento

SVGS - Conta Poupança

debtor.name

string

• Obrigatório: Nome do pagador.

<= 140 caracteres

debtor.privateIdentification

string

• Obrigatório: CPF ou CNPJ do cliente pagador.

([0-9]{11}|[0-9]{14})

remittanceInformation

string

• Obrigatório: Informações do usuário pagador para o usuário recebedor.

<= 140 caracteres

400

INVALID_PARAMETER

Algum parâmetro não foi informado corretamente.

403

INVALID_LICENSE

Invalid license.

A licença informada está fora do padrão ou não existe.

422

RECURRENCE_REPROVED

The recurrence request could not be processed.

A solicitação de recorrência não pôde ser processada.

422

BUSINESS_RULE_VIOLATED

A mensagem a ser retornada está na tabela abaixo.

Este erro pode retornar por vários motivos.
Os motivos estarão descritos no campo "messages"

422

END_TO_END_ID_NOT_FOUND

No decode or entry request associated with this EndToEndId was found.

Nenhuma solicitação de decodificação ou consulta de chave associada a este EndToEndId foi encontrada.

422

INCORRECT_END_TO_END_ID_OR_INITIATION_FORM

EndToEndId with this InitiationForm not found.

EndToEndId com o InitiationForm informado não foi encontrado.

500

UNEXPECTED_ERROR

An unexpected result occurred during the operation

Ocorreu um erro inesperado.

503

SERVICE_UNAVAILABLE

Service unavailable.