List scheduled payments

curl --request GET \
  --url https://api.panoflow.io/v1/scheduled-payments \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.panoflow.io/v1/scheduled-payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "object": "list",
  "has_more": false,
  "next_cursor": null,
  "total_count": 2,
  "data": [
    {
      "id": "sch_01JC8XE6SZAEAVSNTCPM5Q1NXW",
      "object": "scheduled_payment",
      "name": "Warehouse rent",
      "status": "active",
      "recipient_id": "rcp_01JCQY77ZXYYK596NGYA1DQ91K",
      "counterparty_name": "Garki Properties",
      "bank_account": {
        "account_number": "0021345516",
        "bank_code": "221",
        "bank_name": "Stanbic IBTC",
        "account_name": "GARKI PROPERTIES LTD"
      },
      "source_account": {
        "id": "acc_01JCWPQ5E6EYCNDY0YP57RCYBV",
        "name": "Naira · Main",
        "currency": "NGN",
        "account_number_last4": "6789"
      },
      "amount": {
        "amount": 275000000,
        "currency": "NGN"
      },
      "narration": "Warehouse rent",
      "schedule": {
        "frequency": "monthly",
        "interval": 3,
        "day_of_month": 1,
        "start_on": "2027-01-01"
      },
      "schedule_description": "Every 3 months",
      "next_run_on": "2027-01-01",
      "next_transfer_id": "trf_01JCNPZX45HY43KWJRP1XPA7Z3",
      "run_count": 0,
      "created_by": {
        "type": "user",
        "id": "usr_01JCMZ9J92V81E5128Q6RW31FZ",
        "name": "Adaeze Okafor"
      },
      "created_at": "2026-10-28T08:40:00Z",
      "updated_at": "2026-10-28T08:40:00Z"
    },
    {
      "id": "sch_01JC1RNJ47E65GH2BH8VGS9ZM5",
      "object": "scheduled_payment",
      "name": "Diesel supply",
      "status": "paused",
      "recipient_id": "rcp_01JCS3C4DWA7N36096Q14DR9GP",
      "counterparty_name": "Total Energies",
      "bank_account": {
        "account_number": "1013377920",
        "bank_code": "057",
        "bank_name": "Zenith Bank",
        "account_name": "TOTAL ENERGIES MARKETING NIG PLC"
      },
      "source_account": {
        "id": "acc_01JCWPQ5E6EYCNDY0YP57RCYBV",
        "name": "Naira · Main",
        "currency": "NGN",
        "account_number_last4": "6789"
      },
      "amount": {
        "amount": 60000000,
        "currency": "NGN"
      },
      "narration": "Diesel supply",
      "schedule": {
        "frequency": "weekly",
        "interval": 1,
        "day_of_week": "monday",
        "start_on": "2026-08-03"
      },
      "schedule_description": "Every Monday",
      "last_run": {
        "on": "2026-10-26",
        "transfer_id": "trf_01JCQKFBF5KZNWJ47TAN9ZT24M",
        "status": "completed",
        "response_code": "00",
        "response_message": "Approved or completed successfully"
      },
      "run_count": 13,
      "created_by": {
        "type": "user",
        "id": "usr_01JC9NGK80Y3ZH6DZJJXXX7CK5",
        "name": "Tunde Bakare"
      },
      "created_at": "2026-07-30T10:00:00Z",
      "updated_at": "2026-10-28T08:45:00Z"
    }
  ]
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

GET

scheduled-payments

List scheduled payments

curl --request GET \
  --url https://api.panoflow.io/v1/scheduled-payments \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.panoflow.io/v1/scheduled-payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "object": "list",
  "has_more": false,
  "next_cursor": null,
  "total_count": 2,
  "data": [
    {
      "id": "sch_01JC8XE6SZAEAVSNTCPM5Q1NXW",
      "object": "scheduled_payment",
      "name": "Warehouse rent",
      "status": "active",
      "recipient_id": "rcp_01JCQY77ZXYYK596NGYA1DQ91K",
      "counterparty_name": "Garki Properties",
      "bank_account": {
        "account_number": "0021345516",
        "bank_code": "221",
        "bank_name": "Stanbic IBTC",
        "account_name": "GARKI PROPERTIES LTD"
      },
      "source_account": {
        "id": "acc_01JCWPQ5E6EYCNDY0YP57RCYBV",
        "name": "Naira · Main",
        "currency": "NGN",
        "account_number_last4": "6789"
      },
      "amount": {
        "amount": 275000000,
        "currency": "NGN"
      },
      "narration": "Warehouse rent",
      "schedule": {
        "frequency": "monthly",
        "interval": 3,
        "day_of_month": 1,
        "start_on": "2027-01-01"
      },
      "schedule_description": "Every 3 months",
      "next_run_on": "2027-01-01",
      "next_transfer_id": "trf_01JCNPZX45HY43KWJRP1XPA7Z3",
      "run_count": 0,
      "created_by": {
        "type": "user",
        "id": "usr_01JCMZ9J92V81E5128Q6RW31FZ",
        "name": "Adaeze Okafor"
      },
      "created_at": "2026-10-28T08:40:00Z",
      "updated_at": "2026-10-28T08:40:00Z"
    },
    {
      "id": "sch_01JC1RNJ47E65GH2BH8VGS9ZM5",
      "object": "scheduled_payment",
      "name": "Diesel supply",
      "status": "paused",
      "recipient_id": "rcp_01JCS3C4DWA7N36096Q14DR9GP",
      "counterparty_name": "Total Energies",
      "bank_account": {
        "account_number": "1013377920",
        "bank_code": "057",
        "bank_name": "Zenith Bank",
        "account_name": "TOTAL ENERGIES MARKETING NIG PLC"
      },
      "source_account": {
        "id": "acc_01JCWPQ5E6EYCNDY0YP57RCYBV",
        "name": "Naira · Main",
        "currency": "NGN",
        "account_number_last4": "6789"
      },
      "amount": {
        "amount": 60000000,
        "currency": "NGN"
      },
      "narration": "Diesel supply",
      "schedule": {
        "frequency": "weekly",
        "interval": 1,
        "day_of_week": "monday",
        "start_on": "2026-08-03"
      },
      "schedule_description": "Every Monday",
      "last_run": {
        "on": "2026-10-26",
        "transfer_id": "trf_01JCQKFBF5KZNWJ47TAN9ZT24M",
        "status": "completed",
        "response_code": "00",
        "response_message": "Approved or completed successfully"
      },
      "run_count": 13,
      "created_by": {
        "type": "user",
        "id": "usr_01JC9NGK80Y3ZH6DZJJXXX7CK5",
        "name": "Tunde Bakare"
      },
      "created_at": "2026-07-30T10:00:00Z",
      "updated_at": "2026-10-28T08:45:00Z"
    }
  ]
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

X-Request-Id

string

Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always our own req_… id. We log your value with the request as client_request_id, so support can find a request by either id. A longer value is refused with 400 parameter_invalid.

Maximum string length: 128

Query Parameters

limit

integer

default:25

Page size, 1–100.

Required range: 1 <= x <= 100

after

string

Cursor from the previous page's next_cursor. Returns older items. Don't send with before.

before

string

Cursor for the reverse direction: returns the items newer than this one. The page is still sorted newest first; has_more and next_cursor then continue in the same (newer) direction, so pass next_cursor as before to keep paging towards the newest items. Don't send with after.

include

enum<string>

Set to total_count to add total_count to the list response.

Available options:

total_count

status

string[]

Comma-separated ScheduledPaymentStatus values. Default active,paused.

Example:

["active", "paused"]

recipient_id

string

Schedules paying this recipient.

source_account_id

string

Schedules paying from this account.

Response

A page of scheduled payments.

Cursor page. Domain files compose this with allOf and set data.items.

object

string

required

Allowed value: "list"

data

object[]

required

Scheduled payments.

Show child attributes

has_more

boolean

required

True when another page exists.

next_cursor

string | null

Cursor for the next page in the same direction: pass it as after if this page was read with after (or no cursor), as before if it was read with before. Null when has_more is false.

total_count

integer

Only when include=total_count was sent.

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

List scheduled payments

Authorizations

Headers

Query Parameters

Response