Skip to main content
POST
Effect an inbound PIX Automatico settlement debit

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
dtContabil
string
obrigatório

Accounting date (aaaa-mm-dd).

Exemplo:

"2024-09-20"

dtHrEfetivacao
string
obrigatório

JDPI effectuation timestamp (UTC).

Exemplo:

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

dtHrLiquidacao
string
obrigatório

SPI settlement timestamp (UTC).

Exemplo:

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

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"

Resposta

OK

dtHrOperacaoSgct
string
obrigatório

SGCT operation timestamp (UTC).

Exemplo:

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

endToEndId
string
obrigatório

Unique payment-instruction id (32-char).

Exemplo:

"E11111111202409181500y6j6mt9l1pi"

idOperacaoSgct
string
obrigatório

SGCT debit-operation id (the Midaz transaction id, a GUID).

Exemplo:

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