Schedules

List account schedules

List account schedules with paging and filter options.

get/v1/accounts/{accountId}/schedules

Request

  • Base URL
    https://sandbox.pismolabs.io/scheduler-payments
  • URL
    https://sandbox.pismolabs.io/scheduler-payments/v1/accounts/{accountId}/schedules
  • Auth
    HTTP bearer

Response

Request was processed successfully.

has_nextboolean

Is there a next page?

next_cursorstring

Cursor value to apply in a subsequent query to continue pagination

countinteger

Number of items

Example response

{
  "has_next": true,
  "next_cursor": "c737895c-8159-4c0c-a92a-a4f8600bff37",
  "count": 1,
  "items": [
    {
      "schedule_id": "eec3df75-629d-43dc-8eb7-e3b186188341",
      "schedule_kind": "SINGLE",
      "description": "Custom purchase",
      "schedule_details": {
        "type": "RECURRING",
        "interval": "DAILY",
        "day_type": "CALENDAR_DAY",
        "start_date": "2023-01-02T07:00:00.000Z",
        "end_date": "2023-01-02T07:00:00.000Z",
        "retries": {
          "interval_recurrence": 5,
          "number_of_attempts": 5
        },
        "statement": {
          "id": 1234455
        }
      },
      "account_id": 8675309,
      "status": "COMPLETED",
      "created_at": "2023-01-02T07:35:05.125Z",
      "metadata": {
        "any-key": "any-value"
      },
      "pismo_metadata": {
        "any-key": "any-value"
      },
      "processing_code": "219803",
      "processing_codes": {
        "credit": "219803",
        "debit": "219803"
      },
      "amount": 100.23,
      "currency_code": "BRL",
      "restrictions": {
        "minimum_daily_available": 100.23,
        "minimum_monthly_average_available": 100.23,
        "minimum_days_account_inactivity": 5
      },
      "strategy": "SWEEP",
      "transfers": [
        {
          "description": "Transfer to savings account",
          "amount": 100.23,
          "metadata": {
            "any-key": "any-value"
          },
          "to": {
            "account_id": 8675309,
            "processing_code": "219803"
          },
          "from": {
            "account_id": 8675309,
            "processing_code": "219803"
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.