List PIX Automatico authorizations

curl --request GET \
  --url https://api.example.com/v1/pix-automatico/authorizations \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

{
  "authorizations": [
    {
      "authorizationGiven": true,
      "frequency": 1,
      "localStatus": "Active",
      "localStatusKnown": true,
      "payer": {
        "personType": 0,
        "account": "0007654321",
        "accountType": 0,
        "agency": "0001",
        "cpfCnpj": "04623217035",
        "ibgeCode": 3550308,
        "ispb": "00038166",
        "name": "Fulano de Tal"
      },
      "recipient": {
        "cnpj": "61695227000193",
        "ispb": "04358798",
        "name": "Enel"
      },
      "recurrenceId": "RR0435879820240605njua7shf40o",
      "retry": 1,
      "stJdPi": 9,
      "stJdPiProc": 9,
      "startDate": "2024-01-10",
      "amount": 110001,
      "authorizedAt": "2024-01-06T10:00:00Z",
      "cancellations": [
        {
          "cancellationId": "IC0435879820240605abcd1234567",
          "cancelledAt": "2024-02-01T10:00:00Z",
          "reason": 0,
          "requesterDocument": "04623217035",
          "requesterType": 0,
          "cancelStatus": 0,
          "errorCode": "",
          "errorDesc": ""
        }
      ],
      "contractDesc": "Conta de energia",
      "contractNumber": "1234567890ABC",
      "debtor": {
        "cpfCnpj": "04623217035",
        "name": "Ciclano da Silva",
        "personType": 0
      },
      "endDate": "2026-01-10",
      "floorMaxAmount": 55000,
      "idReqJdPi": "52c43361-caa1-4ddb-9152-708426a25db3",
      "journey": 2,
      "payerMaxAmount": 200000,
      "requestId": "IS0435879820240605abcd1234567",
      "requestedAt": "2024-01-05T10:00:01Z",
      "situationAt": "2024-01-06T10:00:00Z",
      "updatedAt": "2024-01-06T10:00:00Z"
    }
  ],
  "jdPiAt": "2024-06-19T00:00:00Z"
}

{
  "code": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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"
  }
}

GET

pix-automatico

authorizations

List PIX Automatico authorizations

curl --request GET \
  --url https://api.example.com/v1/pix-automatico/authorizations \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

{
  "authorizations": [
    {
      "authorizationGiven": true,
      "frequency": 1,
      "localStatus": "Active",
      "localStatusKnown": true,
      "payer": {
        "personType": 0,
        "account": "0007654321",
        "accountType": 0,
        "agency": "0001",
        "cpfCnpj": "04623217035",
        "ibgeCode": 3550308,
        "ispb": "00038166",
        "name": "Fulano de Tal"
      },
      "recipient": {
        "cnpj": "61695227000193",
        "ispb": "04358798",
        "name": "Enel"
      },
      "recurrenceId": "RR0435879820240605njua7shf40o",
      "retry": 1,
      "stJdPi": 9,
      "stJdPiProc": 9,
      "startDate": "2024-01-10",
      "amount": 110001,
      "authorizedAt": "2024-01-06T10:00:00Z",
      "cancellations": [
        {
          "cancellationId": "IC0435879820240605abcd1234567",
          "cancelledAt": "2024-02-01T10:00:00Z",
          "reason": 0,
          "requesterDocument": "04623217035",
          "requesterType": 0,
          "cancelStatus": 0,
          "errorCode": "",
          "errorDesc": ""
        }
      ],
      "contractDesc": "Conta de energia",
      "contractNumber": "1234567890ABC",
      "debtor": {
        "cpfCnpj": "04623217035",
        "name": "Ciclano da Silva",
        "personType": 0
      },
      "endDate": "2026-01-10",
      "floorMaxAmount": 55000,
      "idReqJdPi": "52c43361-caa1-4ddb-9152-708426a25db3",
      "journey": 2,
      "payerMaxAmount": 200000,
      "requestId": "IS0435879820240605abcd1234567",
      "requestedAt": "2024-01-05T10:00:01Z",
      "situationAt": "2024-01-06T10:00:00Z",
      "updatedAt": "2024-01-06T10:00:00Z"
    }
  ],
  "jdPiAt": "2024-06-19T00:00:00Z"
}

{
  "code": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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.

Parámetros de consulta

flow

integer<int64>

fluxo (0=payer's PSP, 1=recipient's PSP).

Ejemplo:

1

ispb

string

The ISPB of the direct participant this listing is made AS. OPTIONAL: omit it and the listing is made on the default credential, exactly as before. Named, JDPI is asked with that participant's credential, and it answers only for what that participant holds. An ISPB this deployment does not act as is 422 PIX-0128. It is ROUTING DATA you supply, never a credential, and a token confined to one participant has to name it here. Sending it empty (ispb=) reads the same as omitting it.

Pattern: ^[0-9A-Z]{8}$

Ejemplo:

"12345678"

recipientCnpj

string

cnpjRecebedor filter (string).

Ejemplo:

"61695227000193"

payerPersonType

string

tpPessoaPagador filter (0/1; empty = no filter).

Ejemplo:

"0"

payerDocument

string

cpfCnpjPagador filter (string).

Ejemplo:

"04623217035"

payerAgency

string

nrAgenciaPagador filter (string).

Ejemplo:

"0001"

payerAccount

string

nrContaPagador filter (string).

Ejemplo:

"0007654321"

authorizationOk

string

resultadoAutorizacao filter (true/false; empty = no filter).

Ejemplo:

"true"

stJdPiProc

string

stJdPiProc filter (0..10; empty = no filter).

Ejemplo:

"9"

updatedFrom

string<date-time>

requerido

dtHrAtualizacaoRecorrenciaInicio (an RFC 3339 date-time).

Ejemplo:

"2024-01-01T00:00:00.000Z"

updatedTo

string<date-time>

requerido

dtHrAtualizacaoRecorrenciaFim (an RFC 3339 date-time).

Ejemplo:

"2024-06-19T00:00:00.000Z"

page

integer<int64>

pagina (default 1).

Ejemplo:

1

pageSize

integer<int64>

tamanhoPagina (default 50, max 100).

Ejemplo:

50

Respuesta

authorizations

object[] | null

requerido

The matching authorization snapshots.

Show child attributes

jdPiAt

string

requerido

JDPI response timestamp (dtHrJdPi, UTC).

Ejemplo:

"2024-06-19T00:00:00Z"

APIs del participante directo

APIs de participantes indirectos

List PIX Automatico authorizations

Autorizaciones

Parámetros de consulta

Respuesta