Archived 2022.12.11. Content moved to CDS Guide, Scheduled Payments
For the API Get Scheduled Payments for Account, under BankingScheduledPayment, there is a
status field with description "Indicates whether the schedule is currently active". The value
SKIP is equivalent to
ACTIVE except that the customer has requested the next normal occurrence to be skipped.
The field has an enumerated value
INACTIVE whose purpose is not clear in the field description.
What does the
INACTIVE status mean for Scheduled Payments?
INACTIVE status was included for situations where a payment schedule exists, and therefore should be shared, but payment schedule has been paused or suspended for some reason.
In the API Get Scheduled Payments Bulk request, there is a field
open-status, used to filter accounts depending on whether they are
CLOSED. If this filter results in returning no corresponding scheduled payments, the HTTP status code returned should be
200 OK, and in the response payload the
scheduledPayments field is an empty array.
- CDS BankingScheduledPayment
- CDS Get Scheduled Payments for Account
- CDS Get Scheduled Payments Bulk
- CDS Get Schedule Payments for Specific Accounts