PaymentSchedules
List payment schedules
Get paginated list of payment schedules
get/payment_schedules
Query parameters
payment_schedule_idstring[]
originating_customerstring[]
to_next_schedule_datestring date-time
receiving_accountstring[]
to_next_execution_datestring date-time
receiving_customerstring[]
description_likestring
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_next_schedule_datestring date-time
account_idstring[]
from_creation_timestring date-time
descriptionstring[]
from_last_updated_timestring date-time
from_next_execution_datestring date-time
in_queueboolean
to_last_updated_timestring date-time
tenantTenantId[]
[ "abcdef_ghijkl" ]
page_tokenstring
Optional pagination token to be provided to retrieve subsequent pages, returned from previous get
Example:a8937a0d
originating_accountstring[]
sort_bystring[]
statusPaymentScheduleStatus[]
limitinteger
Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.
Example:100
to_creation_timestring date-time
customer_idstring[]
idstring[]
Response
List of payment schedules
Example response
{
"payment_schedules": [
{
"tenant": "abcdef_ghijkl",
"payment_instruction": {
"request": {
"amount": 607,
"company_entry_description": "PAYROLL",
"company_name": "Asdf Finance",
"currency": "USD",
"customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"dc_sign": "debit",
"effective_date": "2022-03-18",
"hold": {
"duration": 2
},
"originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
"reference_info": "Tempore atque et cum."
}
},
"schedule": {
"execution_time": "07:30:00"
}
}
],
"next_page_token": "a8937a0d"
}