Get a Pix Schedule

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/schedules/{schedule_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/schedules/{schedule_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/schedules/{schedule_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/schedules/{schedule_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": "100.50",
  "attemptCount": 0,
  "attempts": [
    {
      "attemptedAt": "2026-08-15T06:00:02Z",
      "failureMessage": "Midaz error: balance below required (06:00 BRT attempt)",
      "failureReason": "INSUFFICIENT_FUNDS",
      "endToEndId": "E1234567820260815060011111111111",
      "initiationId": "a1111111-1111-4111-8111-111111111111",
      "transferId": "f1a2b3c4-1111-4d5e-9f6a-7b8c9d0e1f23"
    }
  ],
  "createdAt": "2026-05-26T12:30:00Z",
  "destination": {
    "account": {
      "branch": "0001",
      "number": "123456789",
      "participant": "12345678",
      "type": "CACC"
    },
    "owner": {
      "document": "52998224725",
      "name": "John Doe",
      "tradeName": "John's Business"
    },
    "key": "john.doe@example.com"
  },
  "id": "01989f9e-6508-79f8-9540-835be49fbd0d",
  "initiationId": "550e8400-e29b-41d4-a716-446655440010",
  "initiationType": "MANUAL",
  "maxAttempts": 2,
  "scheduledFor": "2026-08-15T09:00:00Z",
  "status": "SCHEDULED",
  "updatedAt": "2026-05-26T12:30:00Z",
  "cancelledAt": "2026-05-19T09:15:33Z",
  "description": "Recurring charge installment 03/12",
  "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",
  "recurrenceId": "01988a7c-1234-7abc-8def-111122223333",
  "transferId": "c8d27e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f"
}

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

schedules

{schedule_id}

Get a Pix Schedule

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/schedules/{schedule_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/schedules/{schedule_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/schedules/{schedule_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/schedules/{schedule_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": "100.50",
  "attemptCount": 0,
  "attempts": [
    {
      "attemptedAt": "2026-08-15T06:00:02Z",
      "failureMessage": "Midaz error: balance below required (06:00 BRT attempt)",
      "failureReason": "INSUFFICIENT_FUNDS",
      "endToEndId": "E1234567820260815060011111111111",
      "initiationId": "a1111111-1111-4111-8111-111111111111",
      "transferId": "f1a2b3c4-1111-4d5e-9f6a-7b8c9d0e1f23"
    }
  ],
  "createdAt": "2026-05-26T12:30:00Z",
  "destination": {
    "account": {
      "branch": "0001",
      "number": "123456789",
      "participant": "12345678",
      "type": "CACC"
    },
    "owner": {
      "document": "52998224725",
      "name": "John Doe",
      "tradeName": "John's Business"
    },
    "key": "john.doe@example.com"
  },
  "id": "01989f9e-6508-79f8-9540-835be49fbd0d",
  "initiationId": "550e8400-e29b-41d4-a716-446655440010",
  "initiationType": "MANUAL",
  "maxAttempts": 2,
  "scheduledFor": "2026-08-15T09:00:00Z",
  "status": "SCHEDULED",
  "updatedAt": "2026-05-26T12:30:00Z",
  "cancelledAt": "2026-05-19T09:15:33Z",
  "description": "Recurring charge installment 03/12",
  "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",
  "recurrenceId": "01988a7c-1234-7abc-8def-111122223333",
  "transferId": "c8d27e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f"
}

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

required

Account ID owning the schedule (UUID format)

Path Parameters

schedule_id

string

required

Schedule ID (UUID v7)

Response

accountId

string

required

Example:

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

amount

string

required

Example:

"100.50"

attemptCount

integer<int64>

required

Example:

0

attempts

object[]

required

Show child attributes

createdAt

string<date-time>

required

Example:

"2026-05-26T12:30:00Z"

destination

object

required

Show child attributes

string

required

Example:

"01989f9e-6508-79f8-9540-835be49fbd0d"

initiationId

string

required

Example:

"550e8400-e29b-41d4-a716-446655440010"

initiationType

enum<string>

required

Available options:

MANUAL,

KEY,

QR_CODE

Example:

"MANUAL"

maxAttempts

integer<int64>

required

Example:

2

scheduledFor

string<date-time>

required

Example:

"2026-08-15T09:00:00Z"

status

enum<string>

required

Available options:

SCHEDULED,

PROCESSING,

EXECUTED,

FAILED,

CANCELLED

Example:

"SCHEDULED"

updatedAt

string<date-time>

required

Example:

"2026-05-26T12:30:00Z"

cancelledAt

string<date-time>

Example:

"2026-05-19T09:15:33Z"

description

string

Example:

"Recurring charge installment 03/12"

endToEndId

string

Example:

"E1234567820260815060012345678901"

executedAt

string<date-time>

Example:

"2026-08-15T06:00:04Z"

failedAt

string<date-time>

Example:

"2026-08-15T06:00:04Z"

failureMessage

string

failureReason

enum<string>

Available options:

INSUFFICIENT_FUNDS,

BTG_REJECTED,

MIDAZ_REJECTED,

VALIDATION_FAILED,

SCHEDULE_STALE_TIMEOUT,

SCHEDULE_RETRIES_EXHAUSTED

Example:

"INSUFFICIENT_FUNDS"

firedAt

string<date-time>

Example:

"2026-08-15T06:00:04Z"

recurrenceId

string

Example:

"01988a7c-1234-7abc-8def-111122223333"

transferId

string

Example:

"c8d27e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f"

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 Schedule

Authorizations

Headers

Path Parameters

Response