Obtener una autorización de Pix Automático

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>'

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)

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));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Account-Id: <x-account-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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))

}

HttpResponse<String> response = Unirest.get("https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{id}")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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",
  "cancellationReason": "Customer reported unauthorized charge",
  "cancellationReasonKind": "FRAUD",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "cancelledByOperatorId": "op-9",
  "createdAt": "2023-11-07T05:31:56Z",
  "destination": {
    "account": "123456",
    "accountType": "CACC",
    "bank": "30306294",
    "branch": "0001",
    "document": "12345678000199",
    "key": "contato@streaming.co",
    "name": "Streaming Co",
    "personType": "LEGAL_PERSON"
  },
  "expiredAt": "2023-11-07T05:31:56Z",
  "externalAuthorizationId": "AUT-2026-04-001",
  "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "nextChargeAmount": "29.90",
  "nextChargeAt": "2023-11-07T05:31:56Z",
  "periodicity": {
    "customDays": 30,
    "type": "MONTHLY"
  },
  "receiverMaxAmount": "500.00",
  "retryPolicy": "RETRY_3X_7D",
  "status": "AUTHORIZED",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

GET

recurrences

payer

authorizations

{id}

Obtener una autorización de Pix Automático

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>'

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)

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));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Account-Id: <x-account-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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))

}

HttpResponse<String> response = Unirest.get("https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{id}")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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",
  "cancellationReason": "Customer reported unauthorized charge",
  "cancellationReasonKind": "FRAUD",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "cancelledByOperatorId": "op-9",
  "createdAt": "2023-11-07T05:31:56Z",
  "destination": {
    "account": "123456",
    "accountType": "CACC",
    "bank": "30306294",
    "branch": "0001",
    "document": "12345678000199",
    "key": "contato@streaming.co",
    "name": "Streaming Co",
    "personType": "LEGAL_PERSON"
  },
  "expiredAt": "2023-11-07T05:31:56Z",
  "externalAuthorizationId": "AUT-2026-04-001",
  "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "nextChargeAmount": "29.90",
  "nextChargeAt": "2023-11-07T05:31:56Z",
  "periodicity": {
    "customDays": 30,
    "type": "MONTHLY"
  },
  "receiverMaxAmount": "500.00",
  "retryPolicy": "RETRY_3X_7D",
  "status": "AUTHORIZED",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

Autorizaciones

Authorization

string

header

requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Encabezados

X-Account-Id

string

requerido

Identificador único de la cuenta del Ledger de Midaz (formato UUID).

Parámetros de ruta

string

requerido

ID de la autorización (formato UUID)

Respuesta

accountId

string

Ejemplo:

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

amount

object

Show child attributes

approvedAt

string<date-time>

authorizationRequestId

string

Ejemplo:

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

cancelReason

enum<string>

Opciones disponibles:

PAYER,

FRAUD,

EXPIRED,

RECEIVER

cancellationReason

string

CancellationReason es la justificación en texto libre registrada al momento de cancelar (obligatoria para FRAUD). Nil cuando no está presente.

Ejemplo:

"Customer reported unauthorized charge"

cancellationReasonKind

enum<string>

CancellationReasonKind es el motivo de cancelación estructurado (PAYER, FRAUD, EXPIRED, RECEIVER). Nil cuando la autorización no fue cancelada.

Opciones disponibles:

PAYER,

FRAUD,

EXPIRED,

RECEIVER

Ejemplo:

"FRAUD"

cancelledAt

string<date-time>

cancelledByOperatorId

string

CancelledByOperatorID es el operador que realizó una cancelación por FRAUD. Nil para cancelaciones iniciadas por el pagador o por el sistema.

Ejemplo:

"op-9"

createdAt

string<date-time>

destination

object

Show child attributes

expiredAt

string<date-time>

externalAuthorizationId

string

Ejemplo:

"AUT-2026-04-001"

string

Ejemplo:

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

nextChargeAmount

string

Ejemplo:

"29.90"

nextChargeAt

string<date-time>

periodicity

object

Show child attributes

receiverMaxAmount

string

Ejemplo:

"500.00"

retryPolicy

string

Ejemplo:

"RETRY_3X_7D"

status

enum<string>

Opciones disponibles:

AUTHORIZED,

CANCELLED,

EXPIRED

Ejemplo:

"AUTHORIZED"

updatedAt

string<date-time>

⌘I

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado (mensajería nativa)

Obtener una autorización de Pix Automático

Autorizaciones

Encabezados

Parámetros de ruta

Respuesta