Sign in

v1

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

List account scheduled transfers

Retrieve an account's scheduled transfers.

get/pix/v1/pix/out/accounts/{account_id}/schedules

Path parameters

account_idinteger required

Pismo account ID.

Query parameters

perPageinteger
Example:15

Items per page

lastEvaluatedCreationDatetimestring

This is the last_evaluated_creation_datetime field in the returned result and is used to get the next page of results in a subsequent request. RFC 3339 format. For example - "2023-04-12T23:20:50.52Z".

schedulerIdstring

Schedule ID filter

scheduleCreationBeginDatetimestring

Schedule creation datetime begin filter. RFC 3339 value, for example: 2023-04-12T23:20:50.52Z.

scheduleCreationEndDatetimestring

Schedule creation datetime end filter. RFC 3339 value, for example: 2023-04-12T23:20:50.52Z.

scheduleBeginDatetimestring

Schedule datetime begin filter. RFC 3339 value, for example: 2023-04-12T23:20:50.52Z.

scheduleEndDatetimestring

Schedule datetime end filter. RFC 3339 value, for example: 2023-04-12T23:20:50.52Z.

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.

Response

Response Body

last_evaluated_creation_datetimestring

Last evaluated creation date time. Used to fetch the next page of results.

RFC 3339 value, i.e., "2023-04-12T23:20:50.52Z".

per_pageinteger required

Maximum number of items per page

total_itemsinteger required

Total number of items

Example response

{
  "items": [
    {
      "amount": 215,
      "cancel_datetime": "2020-08-13T13:49:03.000Z",
      "end_to_end_id": "E3030629420200808195101608910248",
      "payee": {
        "document_number": "7777888hh",
        "ispb": "60701190",
        "name": "Paul Bearer"
      },
      "schedule_creation_datetime": "2020-08-13T13:49:03.000Z",
      "schedule_datetime": "2020-08-13T13:49:03.000Z",
      "schedule_id": "7b29a055-00e1-41e5-b880-aebe517b3bf6",
      "status": "SCHEDULED"
    }
  ],
  "per_page": 15,
  "total_items": 100
}