Sign in
latestOpenAPI 3.1.02026-07-2440101174.2 KB

e20afa10cd0e

Pix agendado

Criação de agendamento único

Utilize este endpoint para criar agendamentos únicos.

post/pix/scheduling-payments

Parameters

#/paths/~1pix~1claims/get/parameters/0 — unresolved $ref
#/paths/~1pix~1claims/get/parameters/2 — unresolved $ref
#/paths/~1pix~1claims/get/parameters/3 — unresolved $ref
#/paths/~1pix~1recurring-payments/get/parameters/10 — unresolved $ref

Request body

initiationForm'DICT' | 'MANU' | 'QRDN' | 'QRES' required

Forma de iniciação do agendamento.

transactionIdentificationstring nullable

Deve ser preenchido com o valor do <code>conciliationId</code> quando esse campo retornar na leitura do QR Code. Sendo obrigatório para QR Code Dinâmico e opcional para QR Code Estático.

interbankSettlementAmountnumber required

Valor do agendamento.

requestDateTimestring date-time required

Data e hora que o usuário solicitou o agendamento.

dateSchedulestring date required

Data do agendamento. Formato (yyyy-MM-dd).

endToEndIdstring

Identificador fim-a-fim do agendamento. Obrigatório quando <b>initiationForm</b> for igual a <b>DICT</b> ou <b>QRDN</b>, <b>QRES</b>.

remittanceInformationstring nullable

Informações do usuário pagador para o usuário recebedor.

Example request

{
  "transactionIdentification": "ABC99901012341234123412345678xyz",
  "interbankSettlementAmount": 150.5,
  "requestDateTime": "2024-08-05T13:41:47.191-03:00",
  "dateSchedule": "2024-08-25",
  "endToEndId": "E5958811120250808184150764PB2233",
  "creditor": {
    "accountIdentification": "10319867",
    "accountIssuer": "0001",
    "agentMemberIdentification": "59588111",
    "name": "Empresa Exemplo LTDA",
    "privateIdentification": "29194244000134"
  },
  "debtor": {
    "accountIdentification": "1031986787",
    "accountIssuer": "0001",
    "name": "João da Silva",
    "privateIdentification": "61949998029"
  },
  "remittanceInformation": "Pagamento de serviço"
}

Response

Sucesso na criação do agendamento único.

requestIdentifierstring

Identificador do agendamento.

messagestring

Mensagem de sucesso.

Example response

{
  "requestIdentifier": "E9999901012341234123412345678900",
  "message": "Agendamento cadastrado com sucesso"
}