---
updatedAt: 2026-05-04T19:18:29.000Z
agentTools:
siteIndex: https://developers.pismo.io/llms.txt
projectIndex: https://developers.pismo.io/pismo-docs/llms.txt
---
# Get scheduled transfer
Get a scheduled Pix payment.
For `ONCE` and `RECURRING` schedulers, set `showPreview=true` to include `executions_preview` (a preview of upcoming executions that will be created in the future). For `PRESET` schedulers, `executions_preview` is never returned because all executions are created upfront — retrieve them through the [List Pix scheduler executions](ref:get-scheduler-executions) endpoint instead.
**Note:** This endpoint takes an account token - an access token encoded with a Pismo accound ID.
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Instant payments - Pix payments",
"description": "API to handle Pix transactions",
"contact": {
"name": "API Support",
"url": "https://developers.pismo.io/support/"
},
"license": {
"name": "Copyright Pismo"
},
"version": "1.0"
},
"servers": [
{
"url": "https://sandbox-cdn.pismolabs.io",
"description": "Sandbox API server for testing"
},
{
"url": "https://sandbox-cdn.pismolabs.io/inst-pull-pay",
"description": "Sandbox API server for testing instant pull pay."
}
],
"tags": [
{
"name": "Scheduled transfers V2"
}
],
"components": {
"parameters": {
"AuthHeader": {
"in": "header",
"name": "Authorization",
"required": true,
"description": "Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.",
"schema": {
"type": "string",
"example": "Bearer eyJhbGci...IUzUx"
}
},
"CIDheader": {
"name": "x-cid",
"description": "The Correlation ID UUID field links related API requests and events. The `x-cid` can help the Pismo engineering team track everything related to a call. If not passed, this field is automatically generated.\n",
"in": "header",
"required": false,
"schema": {
"type": "string"
}
},
"ScheduleIdPath": {
"name": "scheduler_id",
"in": "path",
"description": "Schedule ID",
"required": true,
"schema": {
"type": "string",
"maxLength": 36
},
"example": "8675309"
},
"ShowPreviewQuery": {
"name": "showPreview",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
},
"description": "Should a preview of upcoming executions be presented? Default is `false` (no execution previews returned). Has no effect for `PRESET` schedulers, whose executions are all created upfront and available through the [List Pix scheduler executions](https://developers.pismo.io/pismo-docs/reference/get-scheduler-executions) endpoint.\n",
"example": true
}
},
"schemas": {
"Amount": {
"type": "number",
"description": "Amount to be transferred.",
"example": 1050.44
},
"customer.DetailMessage": {
"type": "object",
"properties": {
"external": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customer.ExternalMessage"
}
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customer.ParameterMessage"
}
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customer.PayloadMessage"
}
}
}
},
"customer.Error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error's code.",
"example": "EPT0001"
},
"details": {
"$ref": "#/components/schemas/customer.DetailMessage"
},
"message": {
"type": "string",
"description": "Error's message.",
"example": "User not found"
}
}
},
"customer.ExternalMessage": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "Error code.",
"example": "PBE315"
},
"message": {
"type": "string",
"description": "Error message.",
"example": "Generic error"
}
}
},
"customer.ParameterMessage": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string",
"description": "Parameter field",
"example": "Query parameter"
},
"message": {
"type": "string",
"description": "Message about parameter",
"example": "Generic error"
}
}
},
"customer.PayloadMessage": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string",
"description": "Payload parameter",
"example": "Entity.field"
},
"message": {
"type": "string",
"description": "Message about error",
"example": "Generic error"
}
}
},
"DocumentNumber": {
"type": "string",
"description": "A government document number, such as a Social Security number (US) or Cadastro de Pessoas Físicas number (Brazil). Must be numeric with 11-14 digits.\n",
"minLength": 1,
"maxLength": 14,
"example": "123412341234"
},
"EndToEndID": {
"type": "string",
"description": "This field is a Brazil Central Bank (BCB) requirement to track all steps of Pix transactions. \nBasically, there are two steps to a Pix transaction:\n 1. Initialize a transaction \n 2. Confirm a transaction\nThe `end_to_end_id` is sent to the BCB in both steps in order to identify all transaction information. \n",
"example": "E3030629420200808195101608910248"
},
"ExecutionID": {
"type": "integer",
"description": "Sequential number incremented for each scheduled transfer execution.",
"example": 2
},
"IsDeviceRegistered": {
"type": "boolean",
"description": "Is device registered to do a Pix-out transfer? Default is `true`.",
"example": true
},
"ISPB": {
"type": "string",
"description": "ISPB (Identifcador do Sistema de Pagamento Brazil) - the Brazilian Payment System ID, an 8-digit value.",
"maxLength": 8,
"example": "60701190"
},
"Name": {
"type": "string",
"description": "Name",
"maxLength": 200,
"example": "Walter Melon"
},
"ProcessingType": {
"type": "string",
"description": "Scheduler processing type:\n\n* `ONCE` - A single scheduled transfer executed on `start_scheduler_date`.\n\n* `RECURRING` - Transfers created over time according to `cycle`, from `start_scheduler_date` until `end_scheduler_date`.\n\n* `PRESET` - **(Beta)** The caller pre-establishes all executions in the `scheduler_details.executions` list. `start_scheduler_date`/`end_scheduler_date` and `cycle` are **NOT** used - the schedule window is derived from the executions' `due_date`.\n",
"enum": [
"ONCE",
"RECURRING",
"PRESET"
],
"example": "RECURRING"
},
"SchedulerDateEnd": {
"type": "string",
"description": "Date to stop the scheduled payment (maximum = 1 year). \n\nFormat = YYYY-MM-DD. \n\n**REQUIRED** for `type` = `ONCE` or `RECURRING`. \n\nMust **NOT** be passed for `type` = `PRESET`. The schedule end is derived from the latest execution `due_date`.\n",
"example": "2024-06-10"
},
"SchedulerDateStart": {
"type": "string",
"description": "Date to start the scheduled payment. \n\nFormat = YYYY-MM-DD \n\nTransfers are made at midnight on this date and, if recurring, every month until `end_scheduler_date`.\n\n**REQUIRED** for `type` = `ONCE` or `RECURRING`. \n\nMust **NOT** be passed for `type` = `PRESET`. The schedule start is derived from the earliest execution `due_date`.\n",
"example": "2024-06-10"
},
"scheduler.ExecutedAt": {
"type": "string",
"description": "Scheduled item execution time, RFC 3339 format",
"example": "2024-11-14T17:54:40Z"
},
"scheduler.Execution": {
"type": "object",
"properties": {
"check_date_time": {
"type": "string",
"description": "Datetime check_interval processed. RFC 3339 format.",
"example": "2021-10-11T00:00:00.000Z"
},
"end_to_end_id": {
"$ref": "#/components/schemas/EndToEndID"
},
"executed_at": {
"$ref": "#/components/schemas/scheduler.ExecutedAt"
},
"execution_date_time": {
"type": "string",
"description": "When the scheduler task was scheduled to run. RFC 3339 format.",
"example": "2021-10-11T00:00:00.000Z"
},
"execution_id": {
"$ref": "#/components/schemas/ExecutionID"
},
"retry_date_time": {
"type": "string",
"description": "Datetime to retry transfer after error. RFC 3339 format.",
"example": "2021-10-11T00:00:00.000Z"
},
"status": {
"$ref": "#/components/schemas/SchedulerStatus"
}
}
},
"scheduler.PayeeResponse": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/Name"
},
"document_number": {
"$ref": "#/components/schemas/DocumentNumber"
},
"ispb": {
"$ref": "#/components/schemas/ISPB"
}
}
},
"scheduler.PayerResponse": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/Name"
},
"document_number": {
"$ref": "#/components/schemas/DocumentNumber"
},
"ispb": {
"$ref": "#/components/schemas/ISPB"
}
}
},
"scheduler.SchedulerDetails": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"$ref": "#/components/schemas/ProcessingType"
},
"description": {
"type": "string",
"description": "Schedule description",
"maxLength": 200,
"example": "Pay at end of month"
},
"start_scheduler_date": {
"$ref": "#/components/schemas/SchedulerDateStart"
},
"end_scheduler_date": {
"$ref": "#/components/schemas/SchedulerDateEnd"
},
"cycle": {
"$ref": "#/components/schemas/SchedulerCycle"
}
}
},
"scheduler.SchedulerSearchResponse": {
"required": [
"scheduler_id"
],
"type": "object",
"properties": {
"scheduler_id": {
"$ref": "#/components/schemas/SchedulerID"
},
"scheduler_creation_datetime": {
"type": "string",
"description": "Datetime when scheduled transfer created. RFC 3339 format.",
"example": "2021-10-11T00:00:00.000Z"
},
"scheduler_lastupdate_datetime": {
"type": "string",
"description": "Datetime when scheduled transfer last updated. RFC 3339 format.",
"example": "2021-10-11T00:00:00.000Z"
},
"scheduler_details": {
"$ref": "#/components/schemas/scheduler.SchedulerDetails"
},
"amount": {
"$ref": "#/components/schemas/Amount"
},
"status": {
"$ref": "#/components/schemas/SchedulerStatus"
},
"is_device_registered": {
"$ref": "#/components/schemas/IsDeviceRegistered"
},
"payee": {
"$ref": "#/components/schemas/scheduler.PayeeResponse"
},
"payer": {
"$ref": "#/components/schemas/scheduler.PayerResponse"
},
"next_execution": {
"$ref": "#/components/schemas/scheduler.Execution"
},
"executions_preview": {
"$ref": "#/components/schemas/scheduler.ExecutionsPreview"
}
}
},
"scheduler.ExecutionsPreview": {
"type": "object",
"description": "Preview of upcoming executions that will be created in the future. Present only when `showPreview=true` and the scheduler `type` is `ONCE` or `RECURRING`. Not returned for `PRESET` schedulers, whose executions are all created upfront and available through the [List Pix scheduler executions](https://developers.pismo.io/pismo-docs/reference/get-scheduler-executions) endpoint.\n",
"properties": {
"has_more": {
"type": "boolean",
"description": "Are there more than 50 upcoming executions?",
"example": false
},
"items": {
"type": "array",
"maxItems": 50,
"description": "List of upcoming executions preview, limited to 50 items.",
"items": {
"$ref": "#/components/schemas/scheduler.PreviewExecution"
}
}
}
},
"scheduler.PreviewExecution": {
"type": "object",
"description": "A single upcoming execution in the preview.",
"properties": {
"execution_id": {
"$ref": "#/components/schemas/ExecutionID"
},
"date": {
"type": "string",
"description": "Scheduled date for the upcoming execution. RFC 3339 format.",
"example": "2025-01-15T00:00:00.000Z"
}
}
},
"SchedulerCycle": {
"type": "object",
"description": "Cycle property present for scheduler `type` = `RECURRING`. Defaults to `MONTHLY`.\n",
"properties": {
"type": {
"type": "string",
"description": "Recurring cycle type",
"enum": [
"DAILY",
"WEEKLY",
"MONTHLY",
"YEARLY"
],
"example": "MONTHLY"
},
"count": {
"type": "integer",
"description": "Cycle count for generating new transactions. Each daily, weekly, monthly, or yearly occurrence is counted as one cycle.",
"example": 1
}
}
},
"SchedulerID": {
"type": "string",
"description": "Scheduled PIX transaction ID",
"example": "7b29a055-00e1-41e5-b880-aebe517b3bf6"
},
"SchedulerStatus": {
"type": "string",
"description": "Scheduler status",
"enum": [
"DELIVERED",
"PROCESSING",
"CANCELLED",
"SUCCESS",
"FAIL",
"PENDING"
],
"example": "DELIVERED"
}
},
"responses": {
"400BadRequest": {
"description": "Bad request",
"headers": {
"x-cid": {
"description": "Request tracking ID.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/customer.Error"
}
}
}
},
"403Forbidden": {
"description": "Forbidden",
"headers": {
"x-cid": {
"description": "Request tracking ID.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/customer.Error"
}
}
}
},
"404NotFound": {
"description": "Not found",
"headers": {
"x-cid": {
"description": "Request tracking ID.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/customer.Error"
}
}
}
},
"500InternalServer": {
"description": "Internal Server Error",
"headers": {
"x-cid": {
"description": "Request tracking ID.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/customer.Error"
}
}
}
}
}
},
"paths": {
"/pix/v2/pix/out/scheduler/{scheduler_id}": {
"get": {
"summary": "Get scheduled transfer",
"description": "Get a scheduled Pix payment.\n\nFor `ONCE` and `RECURRING` schedulers, set `showPreview=true` to include `executions_preview` (a preview of upcoming executions that will be created in the future). For `PRESET` schedulers, `executions_preview` is never returned because all executions are created upfront — retrieve them through the [List Pix scheduler executions](https://developers.pismo.io/pismo-docs/reference/get-scheduler-executions) endpoint instead.\n\n**Note:** This endpoint takes an account token - an access token encoded with a Pismo accound ID.\n",
"operationId": "get-scheduled-pix-payment",
"tags": [
"Scheduled transfers V2"
],
"parameters": [
{
"$ref": "#/components/parameters/AuthHeader"
},
{
"$ref": "#/components/parameters/ScheduleIdPath"
},
{
"$ref": "#/components/parameters/CIDheader"
},
{
"$ref": "#/components/parameters/ShowPreviewQuery"
}
],
"responses": {
"200": {
"description": "Response Body",
"headers": {
"x-cid": {
"description": "Request tracking ID.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/scheduler.SchedulerSearchResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/400BadRequest"
},
"403": {
"$ref": "#/components/responses/403Forbidden"
},
"404": {
"$ref": "#/components/responses/404NotFound"
},
"500": {
"$ref": "#/components/responses/500InternalServer"
}
}
}
}
}
}
```