v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Scheduled transfers V2

List scheduled Pix transfers

List scheduled Pix transfers with filtering options.

get/pix/v2/pix/out/scheduler

Query parameters

begin_datestring required

Example:2025-01-01

Beginning date filter, format = yyyy-mm-dd

end_datestring required

Example:2025-01-30

End date filter, format = yyyy-mm-dd

status'ACTIVE' | 'INACTIVE' | 'CANCELLED' | 'COMPLETED'

Scheduler status filter

type'ONCE' | 'RECURRING'

Scheduler type filter

interval'DAY' | 'WEEK' | 'MONTH'

Scheduler interval filter

perPageinteger

Example:15

Items per page

afterIdstring

Last returned item ID from response. Use this field to return more results.

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

next_pageboolean

Are tbere more results?

last_idinteger

Last returned item ID. Use this ID to get more results.

page_sizenumber

Maximum elements returned per query.

number_elementsnumber

Total items returned in query

Example response

{
  "last_id": 1602619,
  "filters": [
    {
      "label": "status",
      "value": "ACTIVE",
      "operator": "EQUAL"
    }
  ],
  "sorts": [
    {
      "field": "status",
      "order": "ASC"
    }
  ],
  "items": [
    {
      "day_type": "CALENDAR",
      "cycle": {
        "type": "MONTHLY",
        "count": 1
      },
      "is_device_registered": true,
      "end_date": "2025-11-14",
      "start_date": "2024-11-14",
      "scheduler_id": "7b29a055-00e1-41e5-b880-aebe517b3bf6",
      "status": "COMPLETED",
      "type": "RECURRING",
      "amount": 215,
      "description": "Weekly payment",
      "continue_even_failed": true,
      "execution_hour": "17:56:00",
      "retry_hour": "20:00:00",
      "check_interval": "10",
      "created_at": "2024-11-14T17:54:40Z",
      "updated_at": "2024-09-12T16:46:16.43663522"
    }
  ]
}