Skip to main content
GET
/
payment_schedules
List payment schedules
curl --request GET \
  --url https://api.synctera.com/v2/payment_schedules
{
  "payment_schedules": [
    {
      "description": "<string>",
      "payment_instruction": {
        "request": {
          "amount": 607,
          "currency": "USD",
          "customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
          "dc_sign": "debit",
          "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
          "receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
          "company_entry_description": "PAYROLL",
          "company_name": "Asdf Finance",
          "effective_date": "2022-03-18",
          "external_data": {},
          "final_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "hold": {
            "amount": 123,
            "duration": 2
          },
          "is_same_day": true,
          "memo": "<string>",
          "reference_info": "Tempore atque et cum.",
          "risk": {
            "client_ip": "<string>"
          },
          "sec_code": "WEB"
        },
        "type": "ACH"
      },
      "schedule": {
        "frequency": "DAILY",
        "interval": 183,
        "start_date": "2023-12-25",
        "count": 2,
        "end_date": "2023-12-25",
        "start_search": "BACKWARD"
      },
      "tenant": "abcdef_ghijkl",
      "creation_time": "2023-11-07T05:31:56Z",
      "last_updated_time": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": {},
      "next_payment_date": {
        "execution_date": "2023-12-25",
        "scheduled_date": "2023-12-25"
      },
      "status": "ACTIVE"
    }
  ],
  "next_page_token": "a8937a0d"
}

Query Parameters

​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

​
account_id
string<uuid>[]
​
customer_id
string<uuid>[]
​
description
string[]
​
description_like
string

Case insensitive wildcard search for description, wildcards can be specified with '*'. Wildcards at both the start and the end of the input is assumed.

​
from_creation_time
string<date-time>
​
from_last_updated_time
string<date-time>
​
from_next_execution_date
string<date-time>
​
from_next_schedule_date
string<date-time>
​
id
string<uuid>[]
​
in_queue
boolean
​
originating_account
string<uuid>[]
​
originating_customer
string<uuid>[]
​
payment_schedule_id
string<uuid>[]
​
receiving_account
string<uuid>[]
​
receiving_customer
string<uuid>[]
​
sort_by
enum<string>[]
Available options:
payment_type:asc,
payment_type:desc,
creation_time:asc,
creation_time:desc
​
status
enum<string>[]

Status of the payment schedule.

Available options:
ACTIVE,
EXPIRED,
CANCELLED,
ERRORED
​
tenant
string[]

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

​
to_creation_time
string<date-time>
​
to_last_updated_time
string<date-time>
​
to_next_execution_date
string<date-time>
​
to_next_schedule_date
string<date-time>

Response

List of payment schedules

​
payment_schedules
object[]
required

Array of payment schedules.

​
next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"