Get a Pix Automático Authorization

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

package main

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

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{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://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{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"
  },
  "approvedAt": "2023-11-07T05:31:56Z",
  "authorizationRequestId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "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"
  },
  "externalAuthorizationId": "AUT-2026-04-001",
  "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "periodicity": {
    "type": "MONTHLY",
    "customDays": 30
  },
  "retryPolicy": "RETRY_3X_7D",
  "status": "AUTHORIZED",
  "updatedAt": "2023-11-07T05:31:56Z",
  "cancelReason": "PAYER",
  "cancellationReason": "Customer reported unauthorized charge",
  "cancellationReasonKind": "FRAUD",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "cancelledByOperatorId": "op-9",
  "expiredAt": "2023-11-07T05:31:56Z",
  "nextChargeAmount": "29.90",
  "nextChargeAt": "2023-11-07T05:31:56Z",
  "receiverMaxAmount": "500.00"
}

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

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

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

GET

recurrences

payer

authorizations

{id}

Get a Pix Automático Authorization

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

package main

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

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{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://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{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"
  },
  "approvedAt": "2023-11-07T05:31:56Z",
  "authorizationRequestId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "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"
  },
  "externalAuthorizationId": "AUT-2026-04-001",
  "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "periodicity": {
    "type": "MONTHLY",
    "customDays": 30
  },
  "retryPolicy": "RETRY_3X_7D",
  "status": "AUTHORIZED",
  "updatedAt": "2023-11-07T05:31:56Z",
  "cancelReason": "PAYER",
  "cancellationReason": "Customer reported unauthorized charge",
  "cancellationReasonKind": "FRAUD",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "cancelledByOperatorId": "op-9",
  "expiredAt": "2023-11-07T05:31:56Z",
  "nextChargeAmount": "29.90",
  "nextChargeAt": "2023-11-07T05:31:56Z",
  "receiverMaxAmount": "500.00"
}

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

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

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

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id

string<uuid>

required

Account ID (UUID format)

Path Parameters

string<uuid>

required

Authorization ID (UUID format)

Response

accountId

string

required

Example:

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

amount

object

required

Show child attributes

approvedAt

string<date-time>

required

authorizationRequestId

string

required

Example:

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

createdAt

string<date-time>

required

destination

object

required

Show child attributes

externalAuthorizationId

string

required

Example:

"AUT-2026-04-001"

string

required

Example:

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

periodicity

object

required

Show child attributes

retryPolicy

string

required

Example:

"RETRY_3X_7D"

status

enum<string>

required

Available options:

AUTHORIZED,

CANCELLED,

EXPIRED

Example:

"AUTHORIZED"

updatedAt

string<date-time>

required

cancelReason

enum<string>

Available options:

PAYER,

FRAUD,

EXPIRED,

RECEIVER

cancellationReason

string

Example:

"Customer reported unauthorized charge"

cancellationReasonKind

enum<string>

Available options:

PAYER,

FRAUD,

EXPIRED,

RECEIVER

Example:

"FRAUD"

cancelledAt

string<date-time>

cancelledByOperatorId

string

Example:

"op-9"

expiredAt

string<date-time>

nextChargeAmount

string

Example:

"29.90"

nextChargeAt

string<date-time>

receiverMaxAmount

string

Example:

"500.00"

DICT API

Claims API

MED · Infractions

MED · Fraud markers

MED · Refund requests

MED · Statistics

Transactions API

QR Codes API

Collections API

Funds Recovery API

Reconciliation API

Pix Automático API

Schedules API

Transaction Reports API

Transaction times

Webhooks API

Error handling

Get a Pix Automático Authorization

Authorizations

Headers

Path Parameters

Response