Get a Pix Automático Authorization Request

curl --request GET \
  --url https://api.example.com/v1/recurrences/payer/authorization-requests/{id} \
  --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/v1/recurrences/payer/authorization-requests/{id}"

	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/v1/recurrences/payer/authorization-requests/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/recurrences/payer/authorization-requests/{id}"

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

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

print(response.text)

{
  "accountId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "amount": {
    "fixed": "29.90",
    "max": "500.00",
    "min": "10.00"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "destination": {
    "account": "123456",
    "accountType": "CACC",
    "bank": "30306294",
    "branch": "0001",
    "document": "11222333000181",
    "key": "contato@streaming.co",
    "name": "Streaming Co",
    "personType": "LEGAL_PERSON"
  },
  "externalRequestId": "RREC-2026-04-001",
  "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "journey": "J1",
  "periodicity": {
    "type": "MONTHLY",
    "customDays": 30
  },
  "retryPolicy": "RETRY_3X_7D",
  "status": "PENDING",
  "updatedAt": "2023-11-07T05:31:56Z",
  "validUntil": "2026-06-30T23:59:59Z",
  "acceptedMaxAmount": "500.00",
  "approvingAt": "2023-11-07T05:31:56Z",
  "cancellationCode": "ACCL",
  "cancellationRequester": "PSP_PAYEE",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "confirmedAt": "2023-11-07T05:31:56Z",
  "description": "Streaming subscription",
  "expiredAt": "2023-11-07T05:31:56Z",
  "firstChargeId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "payeeRejectionCode": "MD20",
  "payeeRejectionDescription": "<string>",
  "rejectedAt": "2023-11-07T05:31:56Z",
  "replyFailedAt": "2023-11-07T05:31:56Z",
  "replyFailureReason": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

GET

recurrences

payer

authorization-requests

{id}

Get a Pix Automático Authorization Request

curl --request GET \
  --url https://api.example.com/v1/recurrences/payer/authorization-requests/{id} \
  --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/v1/recurrences/payer/authorization-requests/{id}"

	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/v1/recurrences/payer/authorization-requests/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/recurrences/payer/authorization-requests/{id}"

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

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

print(response.text)

{
  "accountId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "amount": {
    "fixed": "29.90",
    "max": "500.00",
    "min": "10.00"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "destination": {
    "account": "123456",
    "accountType": "CACC",
    "bank": "30306294",
    "branch": "0001",
    "document": "11222333000181",
    "key": "contato@streaming.co",
    "name": "Streaming Co",
    "personType": "LEGAL_PERSON"
  },
  "externalRequestId": "RREC-2026-04-001",
  "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "journey": "J1",
  "periodicity": {
    "type": "MONTHLY",
    "customDays": 30
  },
  "retryPolicy": "RETRY_3X_7D",
  "status": "PENDING",
  "updatedAt": "2023-11-07T05:31:56Z",
  "validUntil": "2026-06-30T23:59:59Z",
  "acceptedMaxAmount": "500.00",
  "approvingAt": "2023-11-07T05:31:56Z",
  "cancellationCode": "ACCL",
  "cancellationRequester": "PSP_PAYEE",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "confirmedAt": "2023-11-07T05:31:56Z",
  "description": "Streaming subscription",
  "expiredAt": "2023-11-07T05:31:56Z",
  "firstChargeId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "payeeRejectionCode": "MD20",
  "payeeRejectionDescription": "<string>",
  "rejectedAt": "2023-11-07T05:31:56Z",
  "replyFailedAt": "2023-11-07T05:31:56Z",
  "replyFailureReason": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id

string<uuid>

requerido

Account ID (UUID format)

Parámetros de ruta

string<uuid>

requerido

Authorization Request ID (UUID format)

Respuesta

accountId

string

requerido

Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

amount

object

requerido

Show child attributes

createdAt

string<date-time>

requerido

destination

object

requerido

Show child attributes

externalRequestId

string

requerido

Ejemplo:

"RREC-2026-04-001"

string

requerido

Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

journey

string

requerido

Ejemplo:

"J1"

periodicity

object

requerido

Show child attributes

retryPolicy

string

requerido

Ejemplo:

"RETRY_3X_7D"

status

enum<string>

requerido

Opciones disponibles:

PENDING,

INITIATED,

APPROVING,

CONFIRMED,

REJECTED,

PAYMENT_FAILED,

REPLY_FAILED,

CANCELLED,

EXPIRED

Ejemplo:

"PENDING"

updatedAt

string<date-time>

requerido

validUntil

string<date-time>

requerido

Ejemplo:

"2026-06-30T23:59:59Z"

acceptedMaxAmount

string

Ejemplo:

"500.00"

approvingAt

string<date-time>

cancellationCode

string

Ejemplo:

"ACCL"

cancellationRequester

string

Ejemplo:

"PSP_PAYEE"

cancelledAt

string<date-time>

confirmedAt

string<date-time>

description

string

Ejemplo:

"Streaming subscription"

expiredAt

string<date-time>

firstChargeId

string

Ejemplo:

"019cf6ef-e418-7ced-80c0-7b9816faa798"

payeeRejectionCode

string

Ejemplo:

"MD20"

payeeRejectionDescription

string

rejectedAt

string<date-time>

replyFailedAt

string<date-time>

replyFailureReason

string

API de DICT

API de Reclamaciones

MED · Infracciones

MED · Marcadores de fraude

MED · Solicitudes de devolución

MED · Estadísticas

API de Transacciones

API de Códigos QR

API de Cobros

API de Recuperación de Fondos

API de Conciliación

API de Pix Automático

API de Programaciones

API de Informes de Transacción

Tiempos de transacciones

API de Webhooks

Manejo de errores

Eventos

Get a Pix Automático Authorization Request

Autorizaciones

Encabezados

Parámetros de ruta

Respuesta