Register an inbound PIX Automatico solicitation on the PSP Pagador

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
}
'

package main

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

func main() {

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

	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("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-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/authorizations/inbound/payer/register', 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/payer/register"

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 = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

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

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

authorizations

inbound

payer

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
}
'

package main

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

func main() {

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

	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("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-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/authorizations/inbound/payer/register', 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/payer/register"

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 = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

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

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

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json

dtHrCriacaoRecorrencia

string

obrigatório

Recurrence creation timestamp (UTC).

Exemplo:

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

dtHrCriacaoSolicitacao

string

obrigatório

Solicitation creation timestamp (UTC).

Exemplo:

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

dtHrExpiracaoSolicitacao

string

obrigatório

Solicitation expiration timestamp (UTC).

Exemplo:

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

dtInicialRecorrencia

string

obrigatório

First payment date (aaaa-mm-dd).

Exemplo:

"2024-01-10"

idRecorrencia

string

obrigatório

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

Exemplo:

"RR0435879820240920njua7shf40o"

idReqJdPi

string

obrigatório

JDPI request id (36-char GUID).

Exemplo:

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

jornada

integer<int64>

obrigatório

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

Exemplo:

1

nrContrato

string

obrigatório

Contract/order identifier (35-char).

Exemplo:

"1234567890ABC"

pagador

object

obrigatório

The recurrence pagador.

Show child attributes

recebedor

object

obrigatório

The recurrence recebedor.

Show child attributes

retentativa

integer<int64>

obrigatório

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

Exemplo:

1

tpFrequencia

integer<int64>

obrigatório

Recurrence periodicity (0..4).

Exemplo:

4

descContrato

string

Free-text contract description (35-char).

Exemplo:

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

Exemplo:

"2026-01-10"

idSolicitacaoRecorrencia

string

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

Exemplo:

"IS0435879820240605abcd1234567"

pisoValorMaximo

number<double>

Receiver floor in reais (a JSON number).

Exemplo:

10.5

valor

number<double>

Fixed payment amount in reais (a JSON number).

Exemplo:

550

Resposta

dtHrSgct

string

obrigatório

SGCT registration timestamp (UTC).

Exemplo:

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

idReqJdPi

string

obrigatório

Echoed JDPI request id (36-char GUID).

Exemplo:

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

idSgct

string

obrigatório

Local SGCT authorization id (36-char GUID).

Exemplo:

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

Lançamentos

Reivindicações

Bancos

Indiretos

Transações

Limites

QR Codes

Devoluções

PIX Automatico

MED Infrações

MED Devoluções

MED Marcadores de Fraude

MED Recuperações

MED Crédito Recebido

Webhooks

Tratamento de erros

Eventos

Register an inbound PIX Automatico solicitation on the PSP Pagador

Autorizações

Corpo

Resposta