Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Scheduled transfers V2

List Pix scheduler executions

List Pix payment scheduler executions - scheduled Pix transfers that have run to completion. A scheduled transfer can have many executions if, for example, it is recurring.

get/pix/v2/pix/out/scheduler/:scheduler_id/executions

Query parameters

beginDatestring

Begin creation date for scheduler executions filter. Format = yyyy-mm-dd.

endDatestring

End creation date for scheduler executions filter. Format = yyyy-mm-dd.

status'PENDING' | 'SUCCESS' | 'FAIL' | 'CANCELLED' | 'PROCESSING' | 'DELIVERED'

Execution status 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

last_idinteger

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

next_pageboolean

Are tbere more results?

number_elementsnumber

Total items returned in query

page_sizenumber

Maximum elements returned per query.

Example response

{
  "last_id": 1602619,
  "items": [
    {
      "execution_id": 2,
      "execution_datetime": "2021-10-11T00:00:00.000Z",
      "status": "PENDING",
      "check_datetime": "2021-10-11T00:00:00.000Z",
      "created_at": "2024-11-14T17:54:40Z",
      "executed_at": "2024-11-14T17:54:40Z",
      "retry_datetime": "2021-10-11T00:00:00.000Z",
      "updated_at": "2024-09-12T16:46:16.43663522"
    }
  ]
}