---
title: "Get Scheduled Bill Payments"
method: POST
path: "/getScheduledBillPayments"
tags: ["Transactions"]
---

# Get Scheduled Bill Payments

`POST /getScheduledBillPayments`

Use the Get Scheduled Bill Payments endpoint to retrieve the scheduled (recurrent) and future (non-recurrent) bill payments for the specified account. This endpoint returns the next-scheduled payments and all future payments that have a process date of today or later.

You can control the pagination as follows:
- Scheduled payments — `recordCntScheduled` and `pageScheduled`
- Future payments — `recordCntFuture` and `pageFuture`
- Both scheduled and future payments — `recordCnt` and `page`.

See <a href="ref:record-set-paging" target="_blank">Record-Set Pagination</a> for instructions on using the paging parameters.

## Response `default`

- object
  - `status_code` integer, nullable, required — The response status code. May return a string for some statuses.
  - `status` string, nullable, required — The condition of a process or response
  - `processing_time` number, float, nullable, required — The time elapsed in processing the transaction
  - `echo` object, nullable, required — A structure that contains transaction ID information
    - `transaction_id` string, nullable, required — An ID that represents an API transaction
    - `provider_timestamp` string, date-time, nullable, required — Store a related timestamp for reporting and troubleshooting purposes
    - `provider_transaction_id` string, nullable, required — Secondary transaction identifier (generated by a provider)
  - `system_timestamp` string, date-time, nullable, required — A system generated timestamp
  - `rtoken` string, nullable, required — A system-generated ID used for tracking
  - `errors` string[] — A list of errors generated while the request was processed
  - `response_data` object, nullable, required — A structure for the response data. It can be empty but usually will contain information.
    - `scheduled_payments` object[], required — List of scheduled payments
      - `account_number` string, required — The account number for the scheduled payment
      - `address_1` string, nullable, required — Address for the payment
      - `address_2` string, nullable, required — Additional address info for the payment
      - `biller_id` integer, required — The biller ID associated with the payment
      - `city` string, nullable, required — City for the address info
      - `name` string, nullable, required — Name for the scheduled payment
      - `nickname` string, nullable, required — A nickname for the scheduled payment
      - `phone` string, nullable, required — Phone associated with the scheduled payment
      - `postal_code` string, nullable, required — Postal code for the address info
      - `state_province` string, nullable, required — State or province for the address info
      - `type` string, required — The bill payment type
      - `frequency_type` string, nullable, required — How frequent the payment is scheduled
      - `next_date` string, date, nullable, required — The next date for which a payment is scheduled
      - `stop_date` string, date, nullable, required — Payments will not be scheduled after this date
      - `amount` number, float, required — The amount of the payment
    - `found` integer, required — The number of scheduled payments found
    - `future_scheduled_payments` object[], required — List of future scheduled payments
      - `pmt_ref_no` string, required — A system-generated number to identify the customer account. Maps to `PRN` and `prn`.
      - `billpay_transaction_id` string, required — An ID assigned to a bill payment transaction
      - `amount` string, required — The amount of the future scheduled bill payment
      - `process_date` string, nullable, required — The date that the future scheduled bill payment will be processed
      - `biller_id` string, required — The biller ID associated with the future scheduled bill payment
      - `name` string, nullable, required — Name for the future scheduled scheduled bill payment
      - `nickname` string, nullable, required — A nickname for the future scheduled bill payment
      - `status` string, required — Status of the future scheduled bill payment
      - `type` string, required — The bill payment type
      - `external_trans_id` string, nullable, required — User-supplied identifier for a transaction, if any.
      - `printed_date` string, nullable, required — The date the bill payment will be sent
    - `page` integer, required — The page number to be retrieved in the context of recordset paging
    - `page_scheduled` integer — The page number to be retrieved for scheduled bill payments
    - `page_future` integer — The page number to be retrieved for future scheduled bill payments
    - `total_record_count` integer, required — Sum of scheduled payments and future scheduled payments
    - `number_of_pages` integer, required — Total number of pages for scheduled payments and future scheduled payments
    - `total_record_count_scheduled` integer — Number of records for scheduled payments
    - `number_of_pages_scheduled` integer — Total number of pages for the scheduled payments
    - `total_record_count_future` integer — Number of records for future scheduled payments
    - `number_of_pages_future` integer — Total number of pages for the future scheduled payments

---

[API](https://skmtc.net/galileo-ft/apis/program-api.md) · [All operations](https://skmtc.net/galileo-ft/apis/program-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/galileo-ft/program-api/revisions/bcd728f97a18/schema)