createPaymentSchedule
Create a new payment schedule on a ledger.
This field requires the Authorization header to be set.
Arguments
Input fields for creating a new payment schedule.
- KT-CT-1111: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-12101: Payment instruction not found.
- KT-CT-3822: Unauthorized.
- KT-CT-39103: Payment method is not valid.
- KT-CT-39106: Update time is before next available update time.
- 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-39132: Cannot specify payment_method_id when collection_method is CUSTOMER_INITIATED.
- KT-CT-39133: payment_amount is required when amount_strategy is FIXED.
- KT-CT-39134: payment_amount must not be provided when amount_strategy is not FIXED.
- KT-CT-39135: This schedule type is not permitted for the given ledger.
- KT-CT-39136: payment_method_id is required when collection_method is KRAKEN_INITIATED.
- KT-CT-39137: This trigger is not permitted for the given ledger.
- KT-CT-39138: This trigger cannot currently be used to create a payment schedule for this ledger.
- KT-CT-3923: Unauthorized.
- KT-CT-3947: An unexpected error occurred.
- 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 CreatePaymentSchedule($input: CreatePaymentScheduleInput!) {
createPaymentSchedule(input: $input) {
schedule {
...PaymentScheduleTypeFragment
}
}
}
Variables
{
"input": CreatePaymentScheduleInput
}
Response
{
"data": {
"createPaymentSchedule": {
"schedule": PaymentScheduleType
}
}
}