Confirm a PIX Automatico authorization

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/authorizations/{idRecorrencia}/confirm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contractNumber": "1234567890ABC",
  "frequency": 1,
  "journey": 2,
  "payer": {
    "account": "0007654321",
    "accountType": 0,
    "cpfCnpj": "04623217035",
    "ibgeCode": 3550308,
    "ispb": "00038166",
    "name": "Fulano de Tal",
    "personType": 0,
    "agency": "0001"
  },
  "recipient": {
    "cnpj": "61695227000193",
    "ispb": "04358798",
    "name": "Enel"
  },
  "startDate": "2024-01-10",
  "amount": 110001,
  "authorizedAt": "2024-01-06T10:00:00Z",
  "contractDesc": "Conta de energia",
  "createdDateTime": "2024-01-05T10:00:00Z",
  "endDate": "2026-01-10",
  "floorMaxAmount": 55000,
  "payerMaxAmount": 200000,
  "settlementConfirmedAt": "2024-01-06T10:05:00Z"
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/pix-automatico/authorizations/{idRecorrencia}/confirm"

	payload := strings.NewReader("{\n  \"contractNumber\": \"1234567890ABC\",\n  \"frequency\": 1,\n  \"journey\": 2,\n  \"payer\": {\n    \"account\": \"0007654321\",\n    \"accountType\": 0,\n    \"cpfCnpj\": \"04623217035\",\n    \"ibgeCode\": 3550308,\n    \"ispb\": \"00038166\",\n    \"name\": \"Fulano de Tal\",\n    \"personType\": 0,\n    \"agency\": \"0001\"\n  },\n  \"recipient\": {\n    \"cnpj\": \"61695227000193\",\n    \"ispb\": \"04358798\",\n    \"name\": \"Enel\"\n  },\n  \"startDate\": \"2024-01-10\",\n  \"amount\": 110001,\n  \"authorizedAt\": \"2024-01-06T10:00:00Z\",\n  \"contractDesc\": \"Conta de energia\",\n  \"createdDateTime\": \"2024-01-05T10:00:00Z\",\n  \"endDate\": \"2026-01-10\",\n  \"floorMaxAmount\": 55000,\n  \"payerMaxAmount\": 200000,\n  \"settlementConfirmedAt\": \"2024-01-06T10:05:00Z\"\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({
    contractNumber: '1234567890ABC',
    frequency: 1,
    journey: 2,
    payer: {
      account: '0007654321',
      accountType: 0,
      cpfCnpj: '04623217035',
      ibgeCode: 3550308,
      ispb: '00038166',
      name: 'Fulano de Tal',
      personType: 0,
      agency: '0001'
    },
    recipient: {cnpj: '61695227000193', ispb: '04358798', name: 'Enel'},
    startDate: '2024-01-10',
    amount: 110001,
    authorizedAt: '2024-01-06T10:00:00Z',
    contractDesc: 'Conta de energia',
    createdDateTime: '2024-01-05T10:00:00Z',
    endDate: '2026-01-10',
    floorMaxAmount: 55000,
    payerMaxAmount: 200000,
    settlementConfirmedAt: '2024-01-06T10:05:00Z'
  })
};

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

payload = {
    "contractNumber": "1234567890ABC",
    "frequency": 1,
    "journey": 2,
    "payer": {
        "account": "0007654321",
        "accountType": 0,
        "cpfCnpj": "04623217035",
        "ibgeCode": 3550308,
        "ispb": "00038166",
        "name": "Fulano de Tal",
        "personType": 0,
        "agency": "0001"
    },
    "recipient": {
        "cnpj": "61695227000193",
        "ispb": "04358798",
        "name": "Enel"
    },
    "startDate": "2024-01-10",
    "amount": 110001,
    "authorizedAt": "2024-01-06T10:00:00Z",
    "contractDesc": "Conta de energia",
    "createdDateTime": "2024-01-05T10:00:00Z",
    "endDate": "2026-01-10",
    "floorMaxAmount": 55000,
    "payerMaxAmount": 200000,
    "settlementConfirmedAt": "2024-01-06T10:05:00Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "idRecorrencia": "RR0435879820240605njua7shf40o",
  "requestedAt": "2024-01-06T10:00:01Z",
  "idReqJdPi": "52c43361-caa1-4ddb-9152-708426a25db3",
  "status": "Accepted"
}

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

{idRecorrencia}

confirm

Confirm a PIX Automatico authorization

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/authorizations/{idRecorrencia}/confirm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contractNumber": "1234567890ABC",
  "frequency": 1,
  "journey": 2,
  "payer": {
    "account": "0007654321",
    "accountType": 0,
    "cpfCnpj": "04623217035",
    "ibgeCode": 3550308,
    "ispb": "00038166",
    "name": "Fulano de Tal",
    "personType": 0,
    "agency": "0001"
  },
  "recipient": {
    "cnpj": "61695227000193",
    "ispb": "04358798",
    "name": "Enel"
  },
  "startDate": "2024-01-10",
  "amount": 110001,
  "authorizedAt": "2024-01-06T10:00:00Z",
  "contractDesc": "Conta de energia",
  "createdDateTime": "2024-01-05T10:00:00Z",
  "endDate": "2026-01-10",
  "floorMaxAmount": 55000,
  "payerMaxAmount": 200000,
  "settlementConfirmedAt": "2024-01-06T10:05:00Z"
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/pix-automatico/authorizations/{idRecorrencia}/confirm"

	payload := strings.NewReader("{\n  \"contractNumber\": \"1234567890ABC\",\n  \"frequency\": 1,\n  \"journey\": 2,\n  \"payer\": {\n    \"account\": \"0007654321\",\n    \"accountType\": 0,\n    \"cpfCnpj\": \"04623217035\",\n    \"ibgeCode\": 3550308,\n    \"ispb\": \"00038166\",\n    \"name\": \"Fulano de Tal\",\n    \"personType\": 0,\n    \"agency\": \"0001\"\n  },\n  \"recipient\": {\n    \"cnpj\": \"61695227000193\",\n    \"ispb\": \"04358798\",\n    \"name\": \"Enel\"\n  },\n  \"startDate\": \"2024-01-10\",\n  \"amount\": 110001,\n  \"authorizedAt\": \"2024-01-06T10:00:00Z\",\n  \"contractDesc\": \"Conta de energia\",\n  \"createdDateTime\": \"2024-01-05T10:00:00Z\",\n  \"endDate\": \"2026-01-10\",\n  \"floorMaxAmount\": 55000,\n  \"payerMaxAmount\": 200000,\n  \"settlementConfirmedAt\": \"2024-01-06T10:05:00Z\"\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({
    contractNumber: '1234567890ABC',
    frequency: 1,
    journey: 2,
    payer: {
      account: '0007654321',
      accountType: 0,
      cpfCnpj: '04623217035',
      ibgeCode: 3550308,
      ispb: '00038166',
      name: 'Fulano de Tal',
      personType: 0,
      agency: '0001'
    },
    recipient: {cnpj: '61695227000193', ispb: '04358798', name: 'Enel'},
    startDate: '2024-01-10',
    amount: 110001,
    authorizedAt: '2024-01-06T10:00:00Z',
    contractDesc: 'Conta de energia',
    createdDateTime: '2024-01-05T10:00:00Z',
    endDate: '2026-01-10',
    floorMaxAmount: 55000,
    payerMaxAmount: 200000,
    settlementConfirmedAt: '2024-01-06T10:05:00Z'
  })
};

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

payload = {
    "contractNumber": "1234567890ABC",
    "frequency": 1,
    "journey": 2,
    "payer": {
        "account": "0007654321",
        "accountType": 0,
        "cpfCnpj": "04623217035",
        "ibgeCode": 3550308,
        "ispb": "00038166",
        "name": "Fulano de Tal",
        "personType": 0,
        "agency": "0001"
    },
    "recipient": {
        "cnpj": "61695227000193",
        "ispb": "04358798",
        "name": "Enel"
    },
    "startDate": "2024-01-10",
    "amount": 110001,
    "authorizedAt": "2024-01-06T10:00:00Z",
    "contractDesc": "Conta de energia",
    "createdDateTime": "2024-01-05T10:00:00Z",
    "endDate": "2026-01-10",
    "floorMaxAmount": 55000,
    "payerMaxAmount": 200000,
    "settlementConfirmedAt": "2024-01-06T10:05:00Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "idRecorrencia": "RR0435879820240605njua7shf40o",
  "requestedAt": "2024-01-06T10:00:01Z",
  "idReqJdPi": "52c43361-caa1-4ddb-9152-708426a25db3",
  "status": "Accepted"
}

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

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

idRecorrencia

string

required

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

Example:

"RR0435879820240605njua7shf40o"

Body

application/json

contractNumber

string

required

Contract/order identifier (nrContrato).

Example:

"1234567890ABC"

frequency

integer<int64>

required

tpFrequencia (0..4).

Example:

1

journey

integer<int64>

required

jornada (2..4).

Example:

2

payer

object

required

The recurrence pagador (incl. name, accountType, ibgeCode).

Show child attributes

recipient

object

required

The recurrence recebedor.

Show child attributes

startDate

string

required

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

Example:

"2024-01-10"

amount

integer<int64>

Fixed payment amount in centavos (valor).

Example:

110001

authorizedAt

string

Authorization timestamp (dtHrAutorizacaoRecorrencia, UTC).

Example:

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

contractDesc

string

Free-text contract description.

Example:

"Conta de energia"

createdDateTime

string

Recurrence creation timestamp (dtHrCriacaoRecorrencia, UTC).

Example:

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

debtor

object

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

Show child attributes

endDate

string

Last payment date (dtFinalRecorrencia).

Example:

"2026-01-10"

floorMaxAmount

integer<int64>

Receiver floor in centavos (pisoValorMaximo).

Example:

55000

payerMaxAmount

integer<int64>

Payer max cap in centavos (vlrMaxPagador).

Example:

200000

settlementConfirmedAt

string

Settlement confirmation timestamp (dtHrConfirmacaoLiquidacao, UTC; required for jornada=3).

Example:

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

Response

Accepted

idRecorrencia

string

required

The recurrence id.

Example:

"RR0435879820240605njua7shf40o"

requestedAt

string

required

JDPI request timestamp (dtHrReqJdPi, UTC).

Example:

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

idReqJdPi

string

The JDPI request id (36-char GUID; omitted by 4.3.10).

Example:

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

status

string

The resulting local authorization status.

Example:

"Accepted"

Key DICT API

Key Claims API

Banks API

Indirect participants API

Transactions API

Transaction Limits API

QR Codes API

Refunds API

Pix Automático · Authorization requests

Pix Automático · Authorization management

Pix Automático · Composite QR codes

Pix Automático · Authorization events

Pix Automático · Schedule events

Pix Automático · Schedules and payment instructions

Pix Automático · Settlement

MED · Refunds

MED · Fraud markers

MED · Infractions

MED · Value recovery

Webhooks API

Error handling

Events

Confirm a PIX Automatico authorization

Authorizations

Path Parameters

Body

Response