setScheduleCollectionMethod
Set the collection method for an existing payment schedule.
Arguments
Input fields for setting a schedule's collection method.
- KT-CT-1111: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-12101: Payment instruction not found.
- KT-CT-3815: No active payment schedule found for this account.
- KT-CT-39102: Update time is outside the schedule's validity period.
- KT-CT-39103: Payment method is not valid.
- KT-CT-39104: Payment method does not match the schedule's type.
- KT-CT-39105: Passive payment schedules cannot be assigned an active collection method.
- KT-CT-39106: Update time is before next available update time.
- KT-CT-39107: A future scheduled payment method already exists on this schedule.
- KT-CT-39108: Provided payment method is not usable on the target ledger.
- KT-CT-39109: Payment method validity is incompatible with the schedule.
- KT-CT-3923: Unauthorized.
- KT-CT-7899: An internal error occurred.
Examples
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
mutation SetScheduleCollectionMethod($input: SetScheduleCollectionMethodInput!) {
setScheduleCollectionMethod(input: $input) {
schedule {
...PaymentScheduleTypeFragment
}
}
}
Variables
{
"input": SetScheduleCollectionMethodInput
}
Response
{
"data": {
"setScheduleCollectionMethod": {
"schedule": PaymentScheduleType
}
}
}