Get a Pix Automático Charge

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/charges/{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/charges/{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/charges/{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/charges/{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/charges/{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/charges/{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/charges/{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": "29.90",
  "attemptCount": 1,
  "attempts": [
    {
      "attemptedAt": "2023-11-07T05:31:56Z",
      "dayIndex": 0,
      "endToEndId": "E30306294202606241200abcdef00001",
      "failureCode": "DEBIT_FAILED",
      "failureMessage": "The debit attempt could not be completed.",
      "outcome": "EXECUTED",
      "scheduleId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "scheduledFor": "2026-04-24T03:00:00Z"
    }
  ],
  "authorizationId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "authorizationRequestId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "currentDayIndex": 0,
  "currentScheduleId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "dueDate": "2026-04-25",
  "executedAt": "2023-11-07T05:31:56Z",
  "externalChargeId": "90d0b9e1551447f695985409bf9b7fb5",
  "failedAt": "2023-11-07T05:31:56Z",
  "failureCode": "CHARGE_REJECTED",
  "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "journey": "J4",
  "maxAttempts": 4,
  "recurrenceId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "status": "SCHEDULED",
  "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

charges

{id}

Get a Pix Automático Charge

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/charges/{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/charges/{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/charges/{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/charges/{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/charges/{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/charges/{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/charges/{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": "29.90",
  "attemptCount": 1,
  "attempts": [
    {
      "attemptedAt": "2023-11-07T05:31:56Z",
      "dayIndex": 0,
      "endToEndId": "E30306294202606241200abcdef00001",
      "failureCode": "DEBIT_FAILED",
      "failureMessage": "The debit attempt could not be completed.",
      "outcome": "EXECUTED",
      "scheduleId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "scheduledFor": "2026-04-24T03:00:00Z"
    }
  ],
  "authorizationId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "authorizationRequestId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "currentDayIndex": 0,
  "currentScheduleId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "dueDate": "2026-04-25",
  "executedAt": "2023-11-07T05:31:56Z",
  "externalChargeId": "90d0b9e1551447f695985409bf9b7fb5",
  "failedAt": "2023-11-07T05:31:56Z",
  "failureCode": "CHARGE_REJECTED",
  "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "journey": "J4",
  "maxAttempts": 4,
  "recurrenceId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "status": "SCHEDULED",
  "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>"
}

Authorizations

Authorization

string

header

required

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

Headers

X-Account-Id

string

required

Unique identifier of the Midaz Ledger Account (UUID format).

Path Parameters

string

required

Charge ID (UUID format)

Response

accountId

string

Example:

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

amount

string

Example:

"29.90"

attemptCount

integer

Example:

1

attempts

object[]

Show child attributes

authorizationId

string

Example:

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

authorizationRequestId

string

Example:

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

cancelledAt

string<date-time>

createdAt

string<date-time>

currentDayIndex

integer

Example:

0

currentScheduleId

string

Example:

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

dueDate

string<date>

Example:

"2026-04-25"

executedAt

string<date-time>

externalChargeId

string

Example:

"90d0b9e1551447f695985409bf9b7fb5"

failedAt

string<date-time>

failureCode

string

FailureCode is the privacy-preserving generic code reported to the receiver for the charge's current outcome (e.g. CHARGE_REJECTED, OVER_LIMIT, ACCEPTED, DEBIT_FAILED). It is the ONLY code surfaced on the read API and outbound payload — the internal financial reason is never carried here (T-33 privacy boundary, rev. 10 rule #6).

Example:

"CHARGE_REJECTED"

string

Example:

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

journey

enum<string>

Available options:

J1,

J2,

J3,

J4

Example:

"J4"

maxAttempts

integer

Example:

4

recurrenceId

string

Example:

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

status

enum<string>

Available options:

RECEIVED,

SCHEDULED,

EXECUTED,

FAILED,

CANCELLED

Example:

"SCHEDULED"

updatedAt

string<date-time>

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Get a Pix Automático Charge

Authorizations

Headers

Path Parameters

Response