Validate an inbound PIX Automatico authorization

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/authorizations/inbound/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dtHrCriacaoRecorrencia": "2024-09-20T09:25:49.025Z",
  "dtInicialRecorrencia": "2024-01-10",
  "idRecorrencia": "RR0435879820240920njua7shf40o",
  "jornada": 2,
  "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",
  "dtHrAutorizacaoRecorrencia": "2024-09-20T14:11:27.453Z",
  "idSolicitacaoRecorrencia": "IS0435879820240605abcd1234567",
  "motivoRejeicao": "AP03",
  "resultadoAutorizacao": true,
  "valor": 550
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/pix-automatico/authorizations/inbound/validate"

	payload := strings.NewReader("{\n  \"dtHrCriacaoRecorrencia\": \"2024-09-20T09:25:49.025Z\",\n  \"dtInicialRecorrencia\": \"2024-01-10\",\n  \"idRecorrencia\": \"RR0435879820240920njua7shf40o\",\n  \"jornada\": 2,\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  \"dtHrAutorizacaoRecorrencia\": \"2024-09-20T14:11:27.453Z\",\n  \"idSolicitacaoRecorrencia\": \"IS0435879820240605abcd1234567\",\n  \"motivoRejeicao\": \"AP03\",\n  \"resultadoAutorizacao\": true,\n  \"valor\": 550\n}")

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

	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: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dtHrCriacaoRecorrencia: '2024-09-20T09:25:49.025Z',
    dtInicialRecorrencia: '2024-01-10',
    idRecorrencia: 'RR0435879820240920njua7shf40o',
    jornada: 2,
    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',
    dtHrAutorizacaoRecorrencia: '2024-09-20T14:11:27.453Z',
    idSolicitacaoRecorrencia: 'IS0435879820240605abcd1234567',
    motivoRejeicao: 'AP03',
    resultadoAutorizacao: true,
    valor: 550
  })
};

fetch('https://api.example.com/v1/pix-automatico/authorizations/inbound/validate', 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/authorizations/inbound/validate"

payload = {
    "dtHrCriacaoRecorrencia": "2024-09-20T09:25:49.025Z",
    "dtInicialRecorrencia": "2024-01-10",
    "idRecorrencia": "RR0435879820240920njua7shf40o",
    "jornada": 2,
    "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",
    "dtHrAutorizacaoRecorrencia": "2024-09-20T14:11:27.453Z",
    "idSolicitacaoRecorrencia": "IS0435879820240605abcd1234567",
    "motivoRejeicao": "AP03",
    "resultadoAutorizacao": True,
    "valor": 550
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dtHrValidacao": "2024-09-20T14:12:05.025Z",
  "motivoRejeicao": "AP03",
  "resultado": 1
}

{
  "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

authorizations

inbound

validate

Validate an inbound PIX Automatico authorization

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/authorizations/inbound/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dtHrCriacaoRecorrencia": "2024-09-20T09:25:49.025Z",
  "dtInicialRecorrencia": "2024-01-10",
  "idRecorrencia": "RR0435879820240920njua7shf40o",
  "jornada": 2,
  "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",
  "dtHrAutorizacaoRecorrencia": "2024-09-20T14:11:27.453Z",
  "idSolicitacaoRecorrencia": "IS0435879820240605abcd1234567",
  "motivoRejeicao": "AP03",
  "resultadoAutorizacao": true,
  "valor": 550
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/pix-automatico/authorizations/inbound/validate"

	payload := strings.NewReader("{\n  \"dtHrCriacaoRecorrencia\": \"2024-09-20T09:25:49.025Z\",\n  \"dtInicialRecorrencia\": \"2024-01-10\",\n  \"idRecorrencia\": \"RR0435879820240920njua7shf40o\",\n  \"jornada\": 2,\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  \"dtHrAutorizacaoRecorrencia\": \"2024-09-20T14:11:27.453Z\",\n  \"idSolicitacaoRecorrencia\": \"IS0435879820240605abcd1234567\",\n  \"motivoRejeicao\": \"AP03\",\n  \"resultadoAutorizacao\": true,\n  \"valor\": 550\n}")

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

	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: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dtHrCriacaoRecorrencia: '2024-09-20T09:25:49.025Z',
    dtInicialRecorrencia: '2024-01-10',
    idRecorrencia: 'RR0435879820240920njua7shf40o',
    jornada: 2,
    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',
    dtHrAutorizacaoRecorrencia: '2024-09-20T14:11:27.453Z',
    idSolicitacaoRecorrencia: 'IS0435879820240605abcd1234567',
    motivoRejeicao: 'AP03',
    resultadoAutorizacao: true,
    valor: 550
  })
};

fetch('https://api.example.com/v1/pix-automatico/authorizations/inbound/validate', 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/authorizations/inbound/validate"

payload = {
    "dtHrCriacaoRecorrencia": "2024-09-20T09:25:49.025Z",
    "dtInicialRecorrencia": "2024-01-10",
    "idRecorrencia": "RR0435879820240920njua7shf40o",
    "jornada": 2,
    "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",
    "dtHrAutorizacaoRecorrencia": "2024-09-20T14:11:27.453Z",
    "idSolicitacaoRecorrencia": "IS0435879820240605abcd1234567",
    "motivoRejeicao": "AP03",
    "resultadoAutorizacao": True,
    "valor": 550
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "dtHrValidacao": "2024-09-20T14:12:05.025Z",
  "motivoRejeicao": "AP03",
  "resultado": 1
}

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

Cuerpo

application/json

dtHrCriacaoRecorrencia

string

requerido

Recurrence creation timestamp (UTC).

Ejemplo:

"2024-09-20T09: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"

jornada

integer<int64>

requerido

Authorization journey (1..4).

Ejemplo:

2

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"

dtHrAutorizacaoRecorrencia

string

Authorization timestamp (UTC).

Ejemplo:

"2024-09-20T14:11:27.453Z"

idSolicitacaoRecorrencia

string

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

Ejemplo:

"IS0435879820240605abcd1234567"

motivoRejeicao

string

Rejection reason code (4-char; required when resultadoAutorizacao=false).

Ejemplo:

"AP03"

resultadoAutorizacao

boolean

Payer analysis result (true=Aceita, false=Rejeitada).

Ejemplo:

true

valor

number<double>

Fixed payment amount in reais (a JSON number).

Ejemplo:

550

Respuesta

dtHrValidacao

string

requerido

Validation timestamp (UTC).

Ejemplo:

"2024-09-20T14:12:05.025Z"

motivoRejeicao

string

Rejection reason code (required when resultado=0).

Ejemplo:

"AP03"

resultado

integer<int64>

Validation result (0=Invalido, 1=Valido); omitted on the 202 async ack.

Ejemplo:

1

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

Validate an inbound PIX Automatico authorization

Autorizaciones

Cuerpo

Respuesta