setUpDirectDebitInstruction
Set up a new direct debit instruction.
Arguments
Input fields for creating a new direct debit instruction.
Possible Errors
- KT-CT-11103: Business not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3940: Invalid data.
- KT-CT-3971: Instruction owners are not valid.
- KT-CT-3979: Invalid ledger.
- KT-CT-5415: Account user not found.
- KT-CT-7899: An internal error occurred.
Allowed Viewers
Required Permissions
Can create payment instructionsQuery Complexity
1Examples
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 SetUpDirectDebitInstruction($input: SetUpDirectDebitInstructionInput!) {
setUpDirectDebitInstruction(input: $input) {
paymentInstruction {
...DirectDebitInstructionTypeFragment
}
}
}
Variables
{
"input": SetUpDirectDebitInstructionInput
}
Response
{
"data": {
"setUpDirectDebitInstruction": {
"paymentInstruction": DirectDebitInstructionType
}
}
}