Get a Pix Schedule

Retrieve a schedule by its unique identifier. Cross-account lookups return 404 — existence is never leaked across accounts.

GET /v1/schedules/{schedule_id}

Get a Pix Schedule

cURL

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

200

{
  "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": "[e-mail]",
    "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"
}

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

schedule_id · string · required

Schedule ID (UUID v7)

Response

200

application/json

OK

accountId · string

AccountID echoes the input AccountID for audit / log correlation.

Example:

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

amount · string

Amount is the BRL amount with 2 decimal places.

Example:

"100.50"

attemptCount · integer

AttemptCount is the number of fire attempts made so far.

Example:

0

attempts · object[]

Attempts is the chronological list of failed prior fire attempts. The successful attempt is not included here; it is recorded on the schedule itself via its TransferID and EndToEndID. Empty array when no failures have been recorded.

Show child attributes

cancelledAt · string<date-time>

CancelledAt is the moment the schedule reached CANCELLED. Absent for non-CANCELLED rows.

Example:

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

createdAt · string<date-time>

CreatedAt is the persistence timestamp (ISO 8601 UTC).

Example:

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

description · string

Description is the optional human-readable transfer message.

Example:

"Recurring charge installment 03/12"

destination · object

Destination is the destination snapshot captured on the schedule.

Show child attributes

endToEndId · string

EndToEndID is the BACEN end-to-end identifier of the settled transfer (resolved via TransferID). Absent for non-EXECUTED states.

Example:

"E1234567820260815060012345678901"

executedAt · string<date-time>

ExecutedAt is the moment the schedule reached EXECUTED. Absent for non-EXECUTED rows.

Example:

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

failedAt · string<date-time>

FailedAt is the moment the schedule reached the terminal FAILED state. Absent for non-FAILED rows. Symmetric with ExecutedAt / CancelledAt.

Example:

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

failureMessage · string

FailureMessage is the free-text (PII-sanitized) human-readable failure description. Absent for non-FAILED rows.

failureReason · enum<string>

FailureReason categorizes a terminal failure. Snapshot of the latest Attempts[] entry's FailureReason. Absent for non-FAILED rows.

Available options: INSUFFICIENT_FUNDS, BTG_REJECTED, MIDAZ_REJECTED, VALIDATION_FAILED, SCHEDULE_STALE_TIMEOUT, SCHEDULE_RETRIES_EXHAUSTED

Example:

"INSUFFICIENT_FUNDS"

firedAt · string<date-time>

FiredAt is the most recent dispatch instant. Absent until the schedule starts processing (PROCESSING / EXECUTED / FAILED).

Example:

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

id · string

ID is the unique schedule identifier (UUID v7, app-generated).

Example:

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

initiationId · string

InitiationID is the payment initiation referenced at create time (audit anchor). It is never reused at fire time; each fire attempt uses its own initiation, surfaced per attempt as Attempts[].InitiationID.

Example:

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

initiationType · enum<string>

InitiationType records how the destination was captured (MANUAL, KEY, QR_CODE).

Available options: MANUAL, KEY, QR_CODE

Example:

"MANUAL"

maxAttempts · integer

MaxAttempts is the per-row retry cap accepted at create time.

Example:

2

recurrenceId · string

RecurrenceID echoes the parent recurrence anchor when the schedule was created from a recurring flow. Empty for direct POST /v1/schedules calls.

Example:

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

scheduledFor · string<date-time>

ScheduledFor is the wall-clock fire moment (ISO 8601 UTC).

Example:

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

status · enum<string>

Status is the schedule lifecycle status. Always SCHEDULED on create. Lifecycle: SCHEDULED -> PROCESSING -> EXECUTED | FAILED | CANCELLED.

Available options: SCHEDULED, PROCESSING, EXECUTED, FAILED, CANCELLED

Example:

"SCHEDULED"

transferId · string

TransferID is the identifier of the settled transfer. Populated only on EXECUTED.

Example:

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

updatedAt · string<date-time>

UpdatedAt is the last status-transition timestamp (ISO 8601 UTC).

Example:

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