v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Scheduled transfers V2

Get scheduled transfer

Get a scheduled Pix payment.

Note: This endpoint takes an account token - an access token encoded with a Pismo accound ID.

get/pix/v2/pix/out/scheduler/{scheduler_id}

Path parameters

scheduler_idstring required

Schedule ID

Query parameters

showPreviewboolean

Should a preview of upcoming executions be presented? Default is false (no execution previews returned).

Headers

Authorizationstring required

Example:Bearer eyJhbGci...IUzUx

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

x-cidstring

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.

Response

Response Body

scheduler_idstring required

Scheduled PIX transaction ID

scheduler_creation_datetimestring

Datetime when scheduled transfer created. RFC 3339 format.

scheduler_lastupdate_datetimestring

Datetime when scheduled transfer last updated. RFC 3339 format.

amountnumber double

Fee amount.

Scheduler status

is_device_registeredboolean

Is device registered to do a Pix-out transfer? Default is true.

Example response

{
  "scheduler_id": "7b29a055-00e1-41e5-b880-aebe517b3bf6",
  "scheduler_creation_datetime": "2021-10-11T00:00:00.000Z",
  "scheduler_lastupdate_datetime": "2021-10-11T00:00:00.000Z",
  "scheduler_details": {
    "type": "RECURRING",
    "description": "Pay at end of month",
    "start_scheduler_date": "2024-06-10",
    "end_scheduler_date": "2024-06-10",
    "cycle": {
      "type": "MONTHLY",
      "count": 1
    }
  },
  "amount": 215,
  "status": "DELIVERED",
  "is_device_registered": true,
  "payee": {
    "name": "Paul Bearer",
    "document_number": "7777888hh",
    "ispb": "60701190"
  },
  "payer": {
    "name": "Paul Bearer",
    "document_number": "7777888hh",
    "ispb": "60701190"
  },
  "next_execution": {
    "check_date_time": "2021-10-11T00:00:00.000Z",
    "end_to_end_id": "E3030629420200808195101608910248",
    "executed_at": "2024-11-14T17:54:40Z",
    "execution_date_time": "2021-10-11T00:00:00.000Z",
    "execution_id": 2,
    "retry_date_time": "2021-10-11T00:00:00.000Z",
    "status": "DELIVERED"
  },
  "executions_preview": {
    "items": [
      {
        "execution_id": 2,
        "date": "2025-01-15T00:00:00.000Z"
      }
    ]
  }
}