Get a Pix Schedule

curl --request GET \
  --url https://api.example.com/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://api.example.com/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://api.example.com/v1/schedules/{schedule_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/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"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

GET

schedules

{schedule_id}

Get a Pix Schedule

curl --request GET \
  --url https://api.example.com/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://api.example.com/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://api.example.com/v1/schedules/{schedule_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/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"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id

string

requerido

Account ID owning the schedule (UUID format)

Parámetros de ruta

schedule_id

string

requerido

Schedule ID (UUID v7)

Respuesta

accountId

string

requerido

Ejemplo:

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

amount

string

requerido

Ejemplo:

"100.50"

attemptCount

integer<int64>

requerido

Ejemplo:

0

attempts

object[]

requerido

Show child attributes

createdAt

string<date-time>

requerido

Ejemplo:

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

destination

object

requerido

Show child attributes

string

requerido

Ejemplo:

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

initiationId

string

requerido

Ejemplo:

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

initiationType

enum<string>

requerido

Opciones disponibles:

MANUAL,

KEY,

QR_CODE

Ejemplo:

"MANUAL"

maxAttempts

integer<int64>

requerido

Ejemplo:

2

scheduledFor

string<date-time>

requerido

Ejemplo:

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

status

enum<string>

requerido

Opciones disponibles:

SCHEDULED,

PROCESSING,

EXECUTED,

FAILED,

CANCELLED

Ejemplo:

"SCHEDULED"

updatedAt

string<date-time>

requerido

Ejemplo:

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

cancelledAt

string<date-time>

Ejemplo:

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

description

string

Ejemplo:

"Recurring charge installment 03/12"

endToEndId

string

Ejemplo:

"E1234567820260815060012345678901"

executedAt

string<date-time>

Ejemplo:

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

failedAt

string<date-time>

Ejemplo:

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

failureMessage

string

failureReason

enum<string>

Opciones disponibles:

INSUFFICIENT_FUNDS,

BTG_REJECTED,

MIDAZ_REJECTED,

VALIDATION_FAILED,

SCHEDULE_STALE_TIMEOUT,

SCHEDULE_RETRIES_EXHAUSTED

Ejemplo:

"INSUFFICIENT_FUNDS"

firedAt

string<date-time>

Ejemplo:

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

recurrenceId

string

Ejemplo:

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

transferId

string

Ejemplo:

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

API de DICT

API de Reclamaciones

MED · Infracciones

MED · Marcadores de fraude

MED · Solicitudes de devolución

MED · Estadísticas

API de Transacciones

API de Códigos QR

API de Cobros

API de Recuperación de Fondos

API de Conciliación

API de Pix Automático

API de Programaciones

API de Informes de Transacción

Tiempos de transacciones

API de Webhooks

Manejo de errores

Eventos

Get a Pix Schedule

Autorizaciones

Encabezados

Parámetros de ruta

Respuesta