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

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

}

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

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)

{
  "accountId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "amount": "29.90",
  "attemptCount": 1,
  "attempts": [
    {
      "dayIndex": 0,
      "scheduleId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "scheduledFor": "2026-04-24T03:00:00Z",
      "attemptedAt": "2023-11-07T05:31:56Z",
      "endToEndId": "E30306294202606241200abcdef00001",
      "failureCode": "DEBIT_FAILED",
      "failureMessage": "The debit attempt could not be completed.",
      "outcome": "EXECUTED"
    }
  ],
  "authorizationRequestId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "createdAt": "2023-11-07T05:31:56Z",
  "dueDate": "2026-04-25",
  "externalChargeId": "90d0b9e1551447f695985409bf9b7fb5",
  "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "journey": "J4",
  "maxAttempts": 4,
  "status": "SCHEDULED",
  "updatedAt": "2023-11-07T05:31:56Z",
  "authorizationId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "currentDayIndex": 0,
  "currentScheduleId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "executedAt": "2023-11-07T05:31:56Z",
  "failedAt": "2023-11-07T05:31:56Z",
  "failureCode": "CHARGE_REJECTED",
  "recurrenceId": "019cf6ef-e418-7ced-80c0-7b9816faa798"
}

{
  "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

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

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

}

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

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)

{
  "accountId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "amount": "29.90",
  "attemptCount": 1,
  "attempts": [
    {
      "dayIndex": 0,
      "scheduleId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "scheduledFor": "2026-04-24T03:00:00Z",
      "attemptedAt": "2023-11-07T05:31:56Z",
      "endToEndId": "E30306294202606241200abcdef00001",
      "failureCode": "DEBIT_FAILED",
      "failureMessage": "The debit attempt could not be completed.",
      "outcome": "EXECUTED"
    }
  ],
  "authorizationRequestId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "createdAt": "2023-11-07T05:31:56Z",
  "dueDate": "2026-04-25",
  "externalChargeId": "90d0b9e1551447f695985409bf9b7fb5",
  "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "journey": "J4",
  "maxAttempts": 4,
  "status": "SCHEDULED",
  "updatedAt": "2023-11-07T05:31:56Z",
  "authorizationId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "currentDayIndex": 0,
  "currentScheduleId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
  "executedAt": "2023-11-07T05:31:56Z",
  "failedAt": "2023-11-07T05:31:56Z",
  "failureCode": "CHARGE_REJECTED",
  "recurrenceId": "019cf6ef-e418-7ced-80c0-7b9816faa798"
}

{
  "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

Charge ID (UUID format)

Response

accountId

string

required

Example:

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

amount

string

required

Example:

"29.90"

attemptCount

integer<int64>

required

Example:

1

attempts

object[]

required

Show child attributes

authorizationRequestId

string

required

Example:

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

createdAt

string<date-time>

required

dueDate

string<date>

required

Example:

"2026-04-25"

externalChargeId

string

required

Example:

"90d0b9e1551447f695985409bf9b7fb5"

string

required

Example:

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

journey

enum<string>

required

Available options:

J1,

J2,

J3,

J4

Example:

"J4"

maxAttempts

integer<int64>

required

Example:

4

status

enum<string>

required

Available options:

RECEIVED,

SCHEDULED,

EXECUTED,

FAILED,

CANCELLED

Example:

"SCHEDULED"

updatedAt

string<date-time>

required

authorizationId

string

Example:

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

cancelledAt

string<date-time>

currentDayIndex

integer<int64>

Example:

0

currentScheduleId

string

Example:

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

executedAt

string<date-time>

failedAt

string<date-time>

failureCode

string

Example:

"CHARGE_REJECTED"

recurrenceId

string

Example:

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

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 Charge

Authorizations

Headers

Path Parameters

Response