Receive a PIX Automatico payer-side authorization registration event

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/events/authorization-payer-registered \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DataHoraEvento: <x-datahoraevento>' \
  --header 'X-NomeEvento: <x-nomeevento>' \
  --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
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/pix-automatico/events/authorization-payer-registered"

	payload := strings.NewReader("{\n  \"dtHrCriacaoRecorrencia\": \"2024-06-05T14:25:49.025Z\",\n  \"dtHrCriacaoSolicitacao\": \"2024-06-05T14:25:49.025Z\",\n  \"dtHrExpiracaoSolicitacao\": \"2024-06-15T14:25:49.025Z\",\n  \"dtInicialRecorrencia\": \"2024-01-10\",\n  \"idRecorrencia\": \"RR0435879820240920njua7shf40o\",\n  \"idReqJdPi\": \"45F763C6-7487-4363-9406-A1DE2A9636D3\",\n  \"jornada\": 1,\n  \"nrContrato\": \"1234567890ABC\",\n  \"pagador\": {\n    \"cpfCnpj\": \"11111111111\",\n    \"ispb\": \"99999004\",\n    \"nrConta\": \"12345678\",\n    \"tpPessoa\": 0,\n    \"codMunIbge\": 3550308,\n    \"nrAgencia\": \"1234\"\n  },\n  \"recebedor\": {\n    \"cnpj\": \"61695227000193\",\n    \"ispb\": \"04358798\",\n    \"nome\": \"Enel\"\n  },\n  \"retentativa\": 1,\n  \"tpFrequencia\": 4,\n  \"descContrato\": \"Conta de energia\",\n  \"dtFinalRecorrencia\": \"2026-01-10\",\n  \"idSolicitacaoRecorrencia\": \"IS0435879820240605abcd1234567\",\n  \"pisoValorMaximo\": 10.5,\n  \"valor\": 550\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-DataHoraEvento", "<x-datahoraevento>")
	req.Header.Add("X-NomeEvento", "<x-nomeevento>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-DataHoraEvento': '<x-datahoraevento>',
    'X-NomeEvento': '<x-nomeevento>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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
  })
};

fetch('https://api.example.com/v1/pix-automatico/events/authorization-payer-registered', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/pix-automatico/events/authorization-payer-registered"

payload = {
    "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
}
headers = {
    "X-DataHoraEvento": "<x-datahoraevento>",
    "X-NomeEvento": "<x-nomeevento>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

POST

pix-automatico

events

authorization-payer-registered

Receive a PIX Automatico payer-side authorization registration event

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/events/authorization-payer-registered \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DataHoraEvento: <x-datahoraevento>' \
  --header 'X-NomeEvento: <x-nomeevento>' \
  --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
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/pix-automatico/events/authorization-payer-registered"

	payload := strings.NewReader("{\n  \"dtHrCriacaoRecorrencia\": \"2024-06-05T14:25:49.025Z\",\n  \"dtHrCriacaoSolicitacao\": \"2024-06-05T14:25:49.025Z\",\n  \"dtHrExpiracaoSolicitacao\": \"2024-06-15T14:25:49.025Z\",\n  \"dtInicialRecorrencia\": \"2024-01-10\",\n  \"idRecorrencia\": \"RR0435879820240920njua7shf40o\",\n  \"idReqJdPi\": \"45F763C6-7487-4363-9406-A1DE2A9636D3\",\n  \"jornada\": 1,\n  \"nrContrato\": \"1234567890ABC\",\n  \"pagador\": {\n    \"cpfCnpj\": \"11111111111\",\n    \"ispb\": \"99999004\",\n    \"nrConta\": \"12345678\",\n    \"tpPessoa\": 0,\n    \"codMunIbge\": 3550308,\n    \"nrAgencia\": \"1234\"\n  },\n  \"recebedor\": {\n    \"cnpj\": \"61695227000193\",\n    \"ispb\": \"04358798\",\n    \"nome\": \"Enel\"\n  },\n  \"retentativa\": 1,\n  \"tpFrequencia\": 4,\n  \"descContrato\": \"Conta de energia\",\n  \"dtFinalRecorrencia\": \"2026-01-10\",\n  \"idSolicitacaoRecorrencia\": \"IS0435879820240605abcd1234567\",\n  \"pisoValorMaximo\": 10.5,\n  \"valor\": 550\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-DataHoraEvento", "<x-datahoraevento>")
	req.Header.Add("X-NomeEvento", "<x-nomeevento>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-DataHoraEvento': '<x-datahoraevento>',
    'X-NomeEvento': '<x-nomeevento>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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
  })
};

fetch('https://api.example.com/v1/pix-automatico/events/authorization-payer-registered', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/pix-automatico/events/authorization-payer-registered"

payload = {
    "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
}
headers = {
    "X-DataHoraEvento": "<x-datahoraevento>",
    "X-NomeEvento": "<x-nomeevento>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

Authorization

string

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

Ejemplo:

"Bearer eyJ..."

X-DataHoraEvento

string

requerido

Event registration instant (UTC: aaaa-mm-ddTHH:mm:ss.sssZ). Mandatory per §6.1.

Ejemplo:

"2024-06-05T10:10:05.025Z"

X-NomeEvento

string

requerido

Event name (see §6.3.1 catalog). Mandatory per §6.1; informational passthrough.

Ejemplo:

"situacao-autorizacao-callback"

Cuerpo

application/json

dtHrCriacaoRecorrencia

string

requerido

Recurrence creation timestamp (UTC).

Ejemplo:

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

dtHrCriacaoSolicitacao

string

requerido

Solicitation creation timestamp (UTC).

Ejemplo:

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

dtHrExpiracaoSolicitacao

string

requerido

Solicitation expiration timestamp (UTC).

Ejemplo:

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

dtInicialRecorrencia

string

requerido

First payment date (aaaa-mm-dd).

Ejemplo:

"2024-01-10"

idRecorrencia

string

requerido

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

Ejemplo:

"RR0435879820240920njua7shf40o"

idReqJdPi

string

requerido

JDPI request id (36-char GUID).

Ejemplo:

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

jornada

integer<int64>

requerido

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

Ejemplo:

1

nrContrato

string

requerido

Contract/order identifier (35-char).

Ejemplo:

"1234567890ABC"

pagador

object

requerido

The recurrence pagador.

Show child attributes

recebedor

object

requerido

The recurrence recebedor.

Show child attributes

retentativa

integer<int64>

requerido

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

Ejemplo:

1

tpFrequencia

integer<int64>

requerido

Recurrence periodicity (0..4).

Ejemplo:

4

descContrato

string

Free-text contract description (35-char).

Ejemplo:

"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).

Ejemplo:

"2026-01-10"

idSolicitacaoRecorrencia

string

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

Ejemplo:

"IS0435879820240605abcd1234567"

pisoValorMaximo

number<double>

Receiver floor in reais (a JSON number).

Ejemplo:

10.5

valor

number<double>

Fixed payment amount in reais (a JSON number).

Ejemplo:

550

Respuesta

No Content

Asientos

Reclamaciones

Bancos

Indirectos

Transacciones

Límites

Códigos QR

Devoluciones

PIX Automatico

MED Infracciones

MED Devoluciones

MED Marcadores de Fraude

MED Recuperaciones

MED Crédito Entrante

Webhooks

Manejo de errores

Eventos

Receive a PIX Automatico payer-side authorization registration event

Autorizaciones

Encabezados

Cuerpo

Respuesta