List Pix Schedules
curl --request GET \
--url https://plugin-pix-indirect.api.lerian.net/v1/schedules \
--header 'Authorization: Bearer <token>' \
--header 'X-Account-Id: <x-account-id>'import requests
url = "https://plugin-pix-indirect.api.lerian.net/v1/schedules"
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/schedules', 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/schedules",
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/schedules"
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/schedules")
.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/schedules")
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{
"items": [
{
"accountId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
"amount": "100.50",
"attemptCount": 0,
"attempts": [
{
"attemptedAt": "2026-08-15T06:00:02Z",
"endToEndId": "E1234567820260815060011111111111",
"failureMessage": "Midaz error: balance below required (06:00 BRT attempt)",
"failureReason": "INSUFFICIENT_FUNDS",
"initiationId": "a1111111-1111-4111-8111-111111111111",
"transferId": "f1a2b3c4-1111-4d5e-9f6a-7b8c9d0e1f23"
}
],
"cancelledAt": "2026-05-19T09:15:33Z",
"createdAt": "2026-05-26T12:30:00Z",
"description": "Recurring charge installment 03/12",
"destination": {
"account": {
"branch": "0001",
"number": "123456789",
"participant": "12345678",
"type": "CACC"
},
"key": "john.doe@example.com",
"owner": {
"document": "12345678901",
"name": "John Doe",
"tradeName": "John's Business"
}
},
"endToEndId": "E1234567820260815060012345678901",
"executedAt": "2026-08-15T06:00:04Z",
"failedAt": "2026-08-15T06:00:04Z",
"failureMessage": "<string>",
"failureReason": "INSUFFICIENT_FUNDS",
"firedAt": "2026-08-15T06:00:04Z",
"id": "01989f9e-6508-79f8-9540-835be49fbd0d",
"initiationId": "550e8400-e29b-41d4-a716-446655440010",
"initiationType": "MANUAL",
"maxAttempts": 2,
"recurrenceId": "01988a7c-1234-7abc-8def-111122223333",
"scheduledFor": "2026-08-15T09:00:00Z",
"status": "SCHEDULED",
"transferId": "c8d27e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f",
"updatedAt": "2026-05-26T12:30:00Z"
}
],
"limit": 10,
"page": 1,
"total": 42
}{
"code": "<string>",
"title": "<string>",
"message": "<string>"
}{
"code": "<string>",
"title": "<string>",
"message": "<string>"
}{
"code": "<string>",
"title": "<string>",
"message": "<string>"
}{
"code": "<string>",
"title": "<string>",
"message": "<string>"
}List Pix Schedules
List schedules belonging to the caller’s account with optional status filter and pagination.
GET
/
v1
/
schedules
List Pix Schedules
curl --request GET \
--url https://plugin-pix-indirect.api.lerian.net/v1/schedules \
--header 'Authorization: Bearer <token>' \
--header 'X-Account-Id: <x-account-id>'import requests
url = "https://plugin-pix-indirect.api.lerian.net/v1/schedules"
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/schedules', 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/schedules",
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/schedules"
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/schedules")
.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/schedules")
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{
"items": [
{
"accountId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
"amount": "100.50",
"attemptCount": 0,
"attempts": [
{
"attemptedAt": "2026-08-15T06:00:02Z",
"endToEndId": "E1234567820260815060011111111111",
"failureMessage": "Midaz error: balance below required (06:00 BRT attempt)",
"failureReason": "INSUFFICIENT_FUNDS",
"initiationId": "a1111111-1111-4111-8111-111111111111",
"transferId": "f1a2b3c4-1111-4d5e-9f6a-7b8c9d0e1f23"
}
],
"cancelledAt": "2026-05-19T09:15:33Z",
"createdAt": "2026-05-26T12:30:00Z",
"description": "Recurring charge installment 03/12",
"destination": {
"account": {
"branch": "0001",
"number": "123456789",
"participant": "12345678",
"type": "CACC"
},
"key": "john.doe@example.com",
"owner": {
"document": "12345678901",
"name": "John Doe",
"tradeName": "John's Business"
}
},
"endToEndId": "E1234567820260815060012345678901",
"executedAt": "2026-08-15T06:00:04Z",
"failedAt": "2026-08-15T06:00:04Z",
"failureMessage": "<string>",
"failureReason": "INSUFFICIENT_FUNDS",
"firedAt": "2026-08-15T06:00:04Z",
"id": "01989f9e-6508-79f8-9540-835be49fbd0d",
"initiationId": "550e8400-e29b-41d4-a716-446655440010",
"initiationType": "MANUAL",
"maxAttempts": 2,
"recurrenceId": "01988a7c-1234-7abc-8def-111122223333",
"scheduledFor": "2026-08-15T09:00:00Z",
"status": "SCHEDULED",
"transferId": "c8d27e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f",
"updatedAt": "2026-05-26T12:30:00Z"
}
],
"limit": 10,
"page": 1,
"total": 42
}{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Unique identifier of the Midaz Ledger Account (UUID format).
Query Parameters
Filter by schedule status
Available options:
SCHEDULED, PROCESSING, EXECUTED, FAILED, CANCELLED Maximum number of items per page.
Required range:
1 <= x <= 100Page number for pagination.
Required range:
x >= 1Response
OK
Items contains the schedule rows for the current page.
Show child attributes
Show child attributes
Limit is the maximum number of items per page.
Example:
10
Page is the current page number (1-based).
Example:
1
Total is the total count of schedules matching the filter, across all pages, scoped to the caller's X-Account-Id.
Example:
42
Was this page helpful?
⌘I

