Skip to main content
POST
Request a PIX Automatico authorization

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json
contractNumber
string
obrigatório

Contract/order identifier (nrContrato).

Exemplo:

"1234567890ABC"

frequency
integer<int64>
obrigatório

tpFrequencia (0=Weekly,1=Monthly,2=Quarterly,3=Semiannual,4=Annual).

Exemplo:

1

idRecorrencia
string
obrigatório

Unique recurrence id (29-char, format RR...).

Exemplo:

"RR0435879820240605njua7shf40o"

payer
object
obrigatório

The recurrence pagador (account being authorized).

recipient
object
obrigatório

The recurrence recebedor (authorized charging entity).

startDate
string
obrigatório

First payment date (dtInicialRecorrencia; aaaa-mm-dd).

Exemplo:

"2024-01-10"

amount
integer<int64>

Fixed payment amount in centavos (valor; omit/0 for a variable recurrence).

Exemplo:

110001

contractDesc
string

Free-text contract description (descContrato).

Exemplo:

"Conta de energia"

createdDateTime
string

Recurrence creation timestamp (dtHrCriacaoRecorrencia, UTC).

Exemplo:

"2024-01-05T10:00:00Z"

debtor
object

The devedor, sent only when it differs from the payer.

endDate
string

Last payment date (dtFinalRecorrencia; aaaa-mm-dd).

Exemplo:

"2026-01-10"

expirationDateTime
string

Solicitation expiration timestamp (dtHrExpiracaoSolicitacao, UTC).

Exemplo:

"2024-01-06T10:00:00Z"

floorMaxAmount
integer<int64>

Receiver floor in centavos (pisoValorMaximo).

Exemplo:

55000

solicitationDateTime
string

Solicitation creation timestamp (dtHrCriacaoSolicitacao, UTC).

Exemplo:

"2024-01-05T10:00:00Z"

Resposta

Accepted

idRecorrencia
string
obrigatório

The recurrence id (echoed).

Exemplo:

"RR0435879820240605njua7shf40o"

idReqJdPi
string
obrigatório

The JDPI request id (36-char GUID).

Exemplo:

"52c43361-caa1-4ddb-9152-708426a25db3"

requestedAt
string
obrigatório

JDPI request timestamp (dtHrReqJdPi, UTC).

Exemplo:

"2024-01-05T10:00:01Z"

status
string
obrigatório

The resulting local authorization status.

Exemplo:

"Requested"