Register an inbound PIX Automatico solicitation on the PSP Pagador

Registers an inbound recurring-payment solicitation delivered by JDPI to the PSP Pagador (section 5.2.3, the plugin is the server). This is payer-side genesis: it creates the payer-side authorization row in the Requested state and returns the local SGCT id. A re-delivered solicitation resolves to a 409 conflict.

POST /v1/pix-automatico/authorizations/inbound/payer/register

Register an inbound PIX Automatico solicitation on the PSP Pagador

cURL

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/authorizations/inbound/payer/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dtHrCriacaoRecorrencia": "2024-06-05T14:25:49.025Z",
  "dtHrCriacaoSolicitacao": "2024-06-05T14:25:49.025Z",
  "dtHrExpiracaoSolicitacao": "2024-06-15T14:25:49.025Z",
  "dtInicialRecorrencia": "2024-01-10",
  "idRecorrencia": "RR0435879820240920njua7shf40o",
  "idReqJdPi": "45F763C6-7487-4363-9406-A1DE2A9636D3",
  "jornada": 1,
  "nrContrato": "1234567890ABC",
  "pagador": {
    "cpfCnpj": "11111111111",
    "ispb": "99999004",
    "nrConta": "12345678",
    "tpPessoa": 0,
    "codMunIbge": 3550308,
    "nrAgencia": "1234"
  },
  "recebedor": {
    "cnpj": "61695227000193",
    "ispb": "04358798",
    "nome": "Enel"
  },
  "retentativa": 1,
  "tpFrequencia": 4,
  "descContrato": "Conta de energia",
  "dtFinalRecorrencia": "2026-01-10",
  "idSolicitacaoRecorrencia": "IS0435879820240605abcd1234567",
  "pisoValorMaximo": 10.5,
  "valor": 550
}
'

200

{
  "dtHrSgct": "2024-11-27T22:10:05.025Z",
  "idReqJdPi": "45F763C6-7487-4363-9406-A1DE2A9636D3",
  "idSgct": "69F963C6-7487-4363-9406-A1DE2A9636D4"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Body

application/json

dtHrCriacaoRecorrencia · string · required

Recurrence creation timestamp (UTC).

Example:

"2024-06-05T14:25:49.025Z"

dtHrCriacaoSolicitacao · string · required

Solicitation creation timestamp (UTC).

Example:

"2024-06-05T14:25:49.025Z"

dtHrExpiracaoSolicitacao · string · required

Solicitation expiration timestamp (UTC).

Example:

"2024-06-15T14:25:49.025Z"

dtInicialRecorrencia · string · required

First payment date (aaaa-mm-dd).

Example:

"2024-01-10"

idRecorrencia · string · required

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

Example:

"RR0435879820240920njua7shf40o"

idReqJdPi · string · required

JDPI request id (36-char GUID).

Example:

"45F763C6-7487-4363-9406-A1DE2A9636D3"

jornada · integer<int64> · required

Authorization journey (1 only on the PSP Pagador genesis).

Example:

1

nrContrato · string · required

Contract/order identifier (35-char).

Example:

"1234567890ABC"

pagador · object · required

The recurrence pagador.

Show child attributes

recebedor · object · required

The recurrence recebedor.

Show child attributes

retentativa · integer<int64> · required

Retry policy (0=none, 1=up to 3 in 7 days).

Example:

1

tpFrequencia · integer<int64> · required

Recurrence periodicity (0..4).

Example:

4

descContrato · string

Free-text contract description (35-char).

Example:

"Conta de energia"

devedor · object

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

Show child attributes

dtFinalRecorrencia · string

Last payment date (aaaa-mm-dd).

Example:

"2026-01-10"

idSolicitacaoRecorrencia · string

Confirmation-solicitation id (29-char, IS...).

Example:

"IS0435879820240605abcd1234567"

pisoValorMaximo · number<double>

Receiver floor in reais (a JSON number).

Example:

10.5

valor · number<double>

Fixed payment amount in reais (a JSON number).

Example:

550

Response

200

application/json

OK

dtHrSgct · string · required

SGCT registration timestamp (UTC).

Example:

"2024-11-27T22:10:05.025Z"

idReqJdPi · string · required

Echoed JDPI request id (36-char GUID).

Example:

"45F763C6-7487-4363-9406-A1DE2A9636D3"

idSgct · string · required

Local SGCT authorization id (36-char GUID).

Example:

"69F963C6-7487-4363-9406-A1DE2A9636D4"