Skip to main content
POST
Reserve an inbound PIX Automatico debit hold

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

Authorization
string

Bearer access token (the financial-ingress gate; the handler fails closed with PIX-0082 when absent).

Exemplo:

"Bearer eyJ..."

Chave-Idempotencia
string
obrigatório

Idempotency key (= the endToEndId of the transaction). Mandatory per section 5.4.

Exemplo:

"E11111111202409181500y6j6mt9l1pi"

Corpo

application/json
codMunIbge
integer<int64>
obrigatório

Payer IBGE municipality code (7 digits).

Exemplo:

3550308

cpfCnpj
string
obrigatório

Payer CPF or CNPJ (a v5.5.0 string).

Exemplo:

"11111111111"

endToEndId
string
obrigatório

Unique payment-instruction id (32-char).

Exemplo:

"E11111111202409181500y6j6mt9l1pi"

ispb
string
obrigatório

Payer participant ISPB (8 digits, a v5.5.0 string).

Exemplo:

"04358798"

nrConta
string
obrigatório

Payer account number (nrConta, a string).

Exemplo:

"12345678"

tpPessoa
integer<int64>
obrigatório

Payer person type (0=Pessoa Fisica, 1=Pessoa Juridica).

Exemplo:

0

valor
number<double>
obrigatório

Reserve amount in reais (a JSON number; the only money field in section 5.4).

Exemplo:

1500.25

nrAgencia
string

Payer branch (nrAgencia, 4 digits, string).

Exemplo:

"1234"

Resposta

OK

dtHrRespostaSgct
string
obrigatório

SGCT response timestamp (UTC).

Exemplo:

"2024-09-20T04:00:01.001Z"

endToEndId
string
obrigatório

Unique payment-instruction id (32-char).

Exemplo:

"E11111111202409181500y6j6mt9l1pi"

resultado
integer<int64>
obrigatório

Block result (0=Rejeitado, 1=Aceito).

Exemplo:

1

idOperacaoSgct
string

SGCT block-operation id (GUID; present only when resultado=1).

Exemplo:

"58F752C5-6376-3252-8305-A2DE3A8525D3"

motivo
string

Rejection reason (SGCTPIX001=insufficient funds, SGCTPIX999=other; present only when resultado=0).

Exemplo:

"SGCTPIX001"

motivoComplemento
string

Rejection detail (present only when resultado=0).

Exemplo:

"Cliente nao possui saldo suficiente para o bloqueio solicitado"