Bloquear saldo no agendamento

O Cliente deve desenvolver do lado deles esperando receber esse payload e devendo nos devolver seguindo o exemplo.

post

Body

endToEndIdstring · max: 32Required

Identificador Único da transação de pagamento. Deve ser gerado pelo PSP Recebedor, será utilizado em toda a cadeia de mensagens da instrução de pagamento. *Regra de preenchimento: O PSP Recebedor deverá, no que tange a composição do “endToEndId” utilizar a data para qual o Pix está sendo agendado e horário fixo 15H:00 UTC, que dará para o PSP Pagador a janela de efetivação de 00:00 e 23:59 do horário de Brasília.

Example: E00038166202409171500y6j6mt9l0pi

ispbnumberRequired

ISPB do Participante Pagador.

Example: 12345678

tpPessoanumber · enumRequired

Tipo Pessoa do Pagador. Domínio: 0 – Pessoa Física, 1 – Pessoa Jurídica.

Default: 0Example: 0Possible values:

cpfCnpjnumberRequired

CPF ou CNPJ usuário do Pagador.

Example: 12345678901

nrAgenciastring · max: 4Required

Número da Agência do Recebedor.

Example: 0001

nrContastring · min: 1 · max: 20Required

Número da Conta do Recebedor. *Regra de preenchimento: Deve ser preenchido com o número da conta transacional do usuário recebedor, com dígito verificador (se este existir), se houver valor alfanumérico, este deve ser convertido para 0. Mínimo 1 e máximo 20 caracteres.

Example: 12345678901234567890

codMunIbgenumberRequired

Código de município do usuário pagador no IBGE.

Example: 1234567

valorstring | nullableRequired

Valor dos pagamentos.

Example: 100.00

Responses

default

application/json

post

HTTPcURLJavaScriptPython

POST /psti/registrar-bloqueio-saldo HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 190

{
  "endToEndId": "E00038166202409171500y6j6mt9l0pi",
  "ispb": 12345678,
  "tpPessoa": 0,
  "cpfCnpj": 12345678901,
  "nrAgencia": "0001",
  "nrConta": "12345678901234567890",
  "codMunIbge": 1234567,
  "valor": "100.00"
}

default

{
  "endToEndId": "E00038166202409171500y6j6mt9l0pi",
  "resultado": 0,
  "motivo": "SGCTPIX001",
  "motivoComplemento": "Informações adicionais sobre a rejeição.",
  "idOperacaoSgct": "69F963C6-7487-4363-9406-A1DE2A9636D4",
  "dtHrRespostaSgct": "2023-01-01T00:00:00.000Z"
}