List the payer's authorizations

curl --request GET \
  --url https://api.example.com/pixauto/v1/payer/authorizations \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

package main

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

func main() {

	url := "https://api.example.com/pixauto/v1/payer/authorizations"

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

	req.Header.Add("X-Account-Id", "<x-account-id>")
	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: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};

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

import requests

url = "https://api.example.com/pixauto/v1/payer/authorizations"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "items": [
    {
      "authorizedAt": "2026-08-27T19:18:38Z",
      "createdAt": "2026-08-27T19:18:38Z",
      "id": "01a044a8-f3bd-7488-a0dc-e8d4be4802be",
      "journey": "JOURNEY_1",
      "parameters": {
        "creditLineEnabled": false,
        "maximumAmount": {
          "amount": "250.00",
          "currency": "BRL"
        },
        "schedulingNotificationsEnabled": false
      },
      "recurrenceId": "RR12345678202608276bca619e690",
      "status": "APPROVED",
      "updatedAt": "2026-08-27T19:20:00Z"
    }
  ],
  "next_cursor": null,
  "prev_cursor": null
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

{
  "code": "PIX-0004",
  "message": "Invalid or expired authentication credentials.",
  "title": "Unauthorized"
}

{
  "code": "PIX-0005",
  "message": "You do not have permission to perform this operation.",
  "title": "Forbidden"
}

{
  "code": "PIX-0000",
  "message": "The server encountered an unexpected error. Please try again later.",
  "title": "Internal Server Error"
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

List the payer's authorizations

Returns the payer’s mandates. Without include_terminated it answers the ones that have NOT ENDED — the APPROVED mandates and those still AWAITING_CONCLUSION — which is the “consulta e gerenciamento de autorizações ativas” surface of Guia v1.2 §6.4; with include_terminated=true it answers that same section’s “histórico de autorizações”, the REJECTED, EXPIRED and CANCELLED mandates included.

WARNING: THE DEFAULT PAGE IS NOT THE SET OF ACTIVE MANDATES. A mandate stays AWAITING_CONCLUSION until the receiving PSP answers this end’s concession with its conclusive pain.012, and until that message arrives it is NOT active at BACEN: nothing may be debited under it (Manual de Tempos do Pix v7.0 §3.2). It is listed by default because the payer was told to wait for precisely that flow and would look for it here. Filter on status=APPROVED to read only the mandates that are in force.

The maximum amount is returned here because this is the PAYER’s own authenticated channel. Guia v1.2 §6.1 bars sharing it with the RECEIVING user and their PSP, which this surface is not.

This page does not repeat the counterparty or complete recurrence terms. It is the lifecycle and payer-parameter projection; the channel must join any richer display data from its provider/messaging integration.

Paging is by cursor. On the last page next_cursor is null, never an empty string.

GET

payer

authorizations

List the payer's authorizations

curl --request GET \
  --url https://api.example.com/pixauto/v1/payer/authorizations \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

package main

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

func main() {

	url := "https://api.example.com/pixauto/v1/payer/authorizations"

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

	req.Header.Add("X-Account-Id", "<x-account-id>")
	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: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};

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

import requests

url = "https://api.example.com/pixauto/v1/payer/authorizations"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

{
  "items": [
    {
      "authorizedAt": "2026-08-27T19:18:38Z",
      "createdAt": "2026-08-27T19:18:38Z",
      "id": "01a044a8-f3bd-7488-a0dc-e8d4be4802be",
      "journey": "JOURNEY_1",
      "parameters": {
        "creditLineEnabled": false,
        "maximumAmount": {
          "amount": "250.00",
          "currency": "BRL"
        },
        "schedulingNotificationsEnabled": false
      },
      "recurrenceId": "RR12345678202608276bca619e690",
      "status": "APPROVED",
      "updatedAt": "2026-08-27T19:20:00Z"
    }
  ],
  "next_cursor": null,
  "prev_cursor": null
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

{
  "code": "PIX-0004",
  "message": "Invalid or expired authentication credentials.",
  "title": "Unauthorized"
}

{
  "code": "PIX-0005",
  "message": "You do not have permission to perform this operation.",
  "title": "Forbidden"
}

{
  "code": "PIX-0000",
  "message": "The server encountered an unexpected error. Please try again later.",
  "title": "Internal Server Error"
}

{
  "code": "PIX-0142",
  "message": "claim_id is required",
  "title": "Invalid Claim Request",
  "fields": {},
  "headers": {},
  "paths": {},
  "query_params": {},
  "raw": {
    "message": "upstream provider returned 503",
    "status": 123
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id

string<uuid>

requerido

Non-zero UUID of the payer account selected by the calling PSP. The PSP must authorize its end user for that account before calling this API. A resource outside the selected account returns 404; a read with no records returns an empty page. See the API overview for the complete trust boundary.

Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$

Parámetros de consulta

limit

integer<int64>

predeterminado:10

Maximum number of records per page (1-100, default 10). A value outside that range, or one that is not an integer, is REFUSED — never clamped, never silently coerced.

Rango requerido: 1 <= x <= 100

cursor

string

Opaque cursor taken from a previous page's next_cursor. On the last page that value is null, never an empty string. A malformed or undecodable value is refused with 400. The cursor must be replayed against the same endpoint, with the same sort_order and the same filters used to obtain it; changing any of those starts a different query, and the previous cursor should not be reused.

Ejemplo:

"eyJ0IjoiMjAyNi0wOC0yN1QxODo0MjowMFoiLCJpIjoiMDE5OGYzYTEtN2M0Mi03ZGUxLWEwMjQtYjFmMGI3ZTljMzAxIn0="

sort_order

enum<string>

predeterminado:desc

Sort direction. An unrecognised value is refused rather than silently defaulted, because switching it mid-traversal without notice would silently reverse the page sequence the caller is walking.

Opciones disponibles:

asc,

desc

Ejemplo:

"desc"

status

string[] | null

Filter by the MANDATE's lifecycle status, the vocabulary each item's status field carries: AWAITING_CONCLUSION, APPROVED, REJECTED, EXPIRED, CANCELLED. Repeatable. A status this end does not know matches no row, which is an empty page rather than an error.

Ejemplo:

["APPROVED"]

include_terminated

boolean

predeterminado:false

Include the mandates that have ENDED — REJECTED, EXPIRED and CANCELLED — which is the full "histórico de autorizações" surface of Guia v1.2 §6.4. Absent, the page carries only the mandates that have not ended, AWAITING_CONCLUSION among them.

Ejemplo:

true

Respuesta

A page of authorizations.

items

object[]

requerido

Empty array when there are no results — never null.

Show child attributes

next_cursor

string | null

requerido

Opaque cursor for the next page. NULL on the last page, never an empty string.

Ejemplo:

"eyJ0IjoiMjAyNi0wOC0yN1QxODo0MjowMFoiLCJpIjoiMDE5OGYzYTEtN2M0Mi03ZGUxLWEwMjQtYjFmMGI3ZTljMzAxIn0="

prev_cursor

string | null

requerido

Opaque cursor for the previous page. These listings do not issue a backwards cursor, so the value is null.

DICT y claves Pix

Cobros y códigos BR

Pagos y devoluciones

API de Pix Automático

Manejo de errores

List the payer's authorizations

Autorizaciones

Encabezados

Parámetros de consulta

Respuesta