Input fields

accountNumber : String! required

The Kraken account number.
bankDetails : BankDetailsInput

Bank details for setting up a payment instruction as part of the enrollment.
contractIdentifiersInput : ContractIdentifiersInput

Typed contract identifiers for contracts that this journey's account is subject to.
idempotencyKey : String

Optional idempotency key to prevent duplicate journey creation on retry.
instructionDetails : InstructionDetailsInput

Details of an externally created payment instruction to be recorded in Kraken.
leaveSupplierNumber : String

If this is a house move, the number of the leave supplier process associated with the move out.
note : String

Enrollment note.
paymentSchedule : PaymentScheduleDetailsInput

Details of the payment schedule(s) to be created as part of enrollment.
paymentSlipDetails : PaymentSlipDetailsInput

Payment slip details for setting up a payment instruction in the vendor's system as part of the enrollment.
salesInfo : SalesInformationInput

Sales info for this enrollment.
securityDeposit : SecurityDepositInput

Details of the security deposit to be created as part of enrollment.
storedPaymentMethodDetailsReference : String

UUID reference returned by the storeDirectDebitPaymentMethodDetails mutation. Used when bank details were pre-stored with the vendor before an account existed, e.g. during third-party SFTP enrolment.
supplyPointGroups : [SupplyPointGroup]! required

List of groups of supply points.
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.

Example

{ "accountNumber": "A-9CE4F2E4", "bankDetails": BankDetailsInput, "contractIdentifiersInput": ContractIdentifiersInput, "idempotencyKey": "establish-better-opportunity-attorney-attack", "instructionDetails": InstructionDetailsInput, "leaveSupplierNumber": "kind-clearly-report-claim-behavior", "note": "player-every-fight-month-down", "paymentSchedule": PaymentScheduleDetailsInput, "paymentSlipDetails": PaymentSlipDetailsInput, "salesInfo": SalesInformationInput, "securityDeposit": SecurityDepositInput, "storedPaymentMethodDetailsReference": "free-attention-recognize-travel-probably", "supplyPointGroups": SupplyPointGroup }