Mutations

In this section

About Mutations
API Site
acceptGoodsQuote
addCampaignToAccount
amendPayment
backendScreenEvent
cancelEnrollment
cancelRepaymentRequest
collectPayment
confirmDoubleOptIn
createAccountPaymentSchedule
createAccountReference
createContributionAgreement
createCreditTransferPermission
createDirectDebitInstructionAndSchedule
createDirectDebitPaymentSchedule
createFormSubmission
createGoodsPurchase
createGoodsQuote
createGoodsQuoteWithoutAccount
createReferral
createServiceOrder
deletePushNotificationBinding
endContributionAgreement
enrollAccountInLoyaltyProgram
exchangeMeter
forceMoveIn
forceReauthentication
getEmbeddedSecretForNewPaymentInstruction
getEmbeddedSecretForNewPaymentInstructionWithoutAccount
getHostedUrlForNewPaymentInstruction
initiateHostedStandalonePayment
initiateProductSwitch
initiateStandalonePayment
insertUserPsrRecords
installMeter
invalidatePaymentInstruction
invalidatePreSignedToken
joinSupplierAcceptTermsAndConditions
linkUserToLine
masqueradeAuthentication
modifyMeter
moveInCreateCustomer
moveOut
obtainKrakenToken
redeemLoyaltyPointsForAccountCredit
redeemReferralClaimCode
regenerateSecretKey
registerEmail
registerPushNotificationBinding
requestDoubleOptIn
requestPasswordReset
requestPrintedBill
resetPassword
resetUserPassword
scheduleQuoteFollowUp
sendPreSignedTokenEmail
setLoyaltyPointsUser
setUpDirectDebitInstruction
shareGoodsQuote
storePaymentInstruction
submitCustomerFeedback
submitMeterReading
submitRepaymentRequest
switchAccountToMeasuredTariff
terminateCreditTransferPermission
transferLoyaltyPointsBetweenUsers
unlinkUserFromLine
updateAccountAddress
updateAccountBillingAddress
updateAccountBillingEmail
updateAccountConsents
updateAccountReference
updateAccountUserConsents
updateActivePurchase
updateAutoTopUpAmount
updateBlackholeEmail
updateCommsDeliveryPreference
updateCommsPreferences
updateEmailAndPassword
updateMetadata
updateNumberOfOccupants
updatePassword
updatePaymentSchedule
updatePropertyType
updateUser
updateUserDetails
verifyIdentity
verifyIdentityFallback
Authentication Server
createMfaDevice
deleteMfaDevice
validateMfaDevice

Every GraphQL schema has a root type for both queries and mutations. The mutation type defines GraphQL operations that change data on the server. It is analogous to performing HTTP verbs such as POST, PATCH, and DELETE.

API Site

acceptGoodsQuote

Type:AcceptGoodsQuote

URL:https://api.st.test-kraken.tech/v1/graphql/

Accept a goods quote.

The possible errors that can be raised are:

KT-CT-8223: Unauthorized.
KT-CT-8201: Received an invalid quoteId.
KT-CT-8224: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AcceptGoodsQuoteInput!`)	Input fields for accepting a quote.

input (AcceptGoodsQuoteInput!)

Input fields for accepting a quote.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

The 'possibleErrors' field is deprecated.

Please use the 'possibleErrors' query or the 'X-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

goodsPurchase (GoodsPurchase)

Goods purchase created.

mutation AcceptGoodsQuote($input: AcceptGoodsQuoteInput!) {
  acceptGoodsQuote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    goodsPurchase {
      ...GoodsPurchaseFragment
    }
  }
}

{
  "input": AcceptGoodsQuoteInput
}

{
  "data": {
    "acceptGoodsQuote": {
      "possibleErrors": [PossibleErrorType],
      "goodsPurchase": GoodsPurchase
    }
  }
}

addCampaignToAccount

Type:AddCampaignToAccount

URL:https://api.st.test-kraken.tech/v1/graphql/

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-7427: No campaign found with given slug.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AddCampaignToAccountInput!`)	Input variables needed for adding a campaign to an account.

input (AddCampaignToAccountInput!)

Input variables needed for adding a campaign to an account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

campaignAdded (Boolean)

Whether the campaign was successfully added.

mutation AddCampaignToAccount($input: AddCampaignToAccountInput!) {
  addCampaignToAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    campaignAdded
  }
}

{
  "input": AddCampaignToAccountInput
}

{
  "data": {
    "addCampaignToAccount": {
      "possibleErrors": [PossibleErrorType],
      "campaignAdded": true
    }
  }
}

amendPayment

Type:AmendPayment

URL:https://api.st.test-kraken.tech/v1/graphql/

Amend an existing payment.

The possible errors that can be raised are:

KT-CT-3924: Unauthorized.
KT-CT-4123: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AmendPaymentInput!`)	Input fields for amending an existing payment.

input (AmendPaymentInput!)

Input fields for amending an existing payment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

payment (AccountPaymentType)

mutation AmendPayment($input: AmendPaymentInput!) {
  amendPayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...AccountPaymentTypeFragment
    }
  }
}

{
  "input": AmendPaymentInput
}

{
  "data": {
    "amendPayment": {
      "possibleErrors": [PossibleErrorType],
      "payment": AccountPaymentType
    }
  }
}

backendScreenEvent

Type:BackendScreenEvent

URL:https://api.st.test-kraken.tech/v1/graphql/

Look up an event to perform from its event_id, and return the next action to perform.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-8002: No event found.
KT-CT-8003: Event has no execute function.
KT-CT-8004: Error executing event in the backend.
KT-CT-8007: Incorrect or missing parameters for backend screen event.
KT-GB-9310: Account ineligible for joining Octoplus.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

Name	Description
`input` (`BackendScreenEventInput!`)	Input fields for performing a backend action.

input (BackendScreenEventInput!)

Input fields for performing a backend action.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

action (ActionType)

An action to perform.

mutation BackendScreenEvent($input: BackendScreenEventInput!) {
  backendScreenEvent(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    action {
      ... on DeeplinkActionType {
        ...DeeplinkActionTypeFragment
      }
      ... on LinkActionType {
        ...LinkActionTypeFragment
      }
      ... on BackendScreenEventActionType {
        ...BackendScreenEventActionTypeFragment
      }
      ... on CloseActionType {
        ...CloseActionTypeFragment
      }
      ... on ScreenActionType {
        ...ScreenActionTypeFragment
      }
    }
  }
}

{
  "input": BackendScreenEventInput
}

{
  "data": {
    "backendScreenEvent": {
      "possibleErrors": [PossibleErrorType],
      "action": DeeplinkActionType
    }
  }
}

cancelEnrollment

Type:EnrollmentCancelled!

URL:https://api.st.test-kraken.tech/v1/graphql/

Cancel an enrollment for an account and a set of supply points.

The possible errors that can be raised are:

KT-CT-10312: Mutation not enabled in this environment.
KT-CT-10318: Enrollment process not found.
KT-CT-10319: Enrollment process failed to cancel.
KT-CT-10320: Enrollment process not cancellable.
KT-CT-10321: Enrollment cancellation workflow not defined.
KT-CT-10323: Enrollment process failed to cancel.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CancelEnrollmentInput!`)

input (CancelEnrollmentInput!)

Return fields

Name	Description

mutation CancelEnrollment($input: CancelEnrollmentInput!) {
  cancelEnrollment(input: $input) {
    message
    enrollmentProcess {
      ... on JoinSupplierProcessType {
        ...JoinSupplierProcessTypeFragment
      }
      ... on OccupyPropertyProcessType {
        ...OccupyPropertyProcessTypeFragment
      }
    }
  }
}

{
  "input": CancelEnrollmentInput
}

{
  "data": {
    "cancelEnrollment": {
      "message": "abc123",
      "enrollmentProcess": JoinSupplierProcessType
    }
  }
}

cancelRepaymentRequest

Type:CancelRepaymentRequest

URL:https://api.st.test-kraken.tech/v1/graphql/

Cancel a repayment or refund request.

The possible errors that can be raised are:

KT-CT-4231: Unauthorized.
KT-CT-3930: The repayment or refund request does not exist.
KT-CT-3931: This repayment or refund request cannot be cancelled.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

Name	Description
`input` (`CancelRepaymentRequestInputType!`)	Input fields for cancelling a repayment request.

input (CancelRepaymentRequestInputType!)

Input fields for cancelling a repayment request.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

repaymentRequest (CancelRepaymentRequestOutputType)

The cancelled repayment/refund request.

mutation CancelRepaymentRequest($input: CancelRepaymentRequestInputType!) {
  cancelRepaymentRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    repaymentRequest {
      ...CancelRepaymentRequestOutputTypeFragment
    }
  }
}

{
  "input": CancelRepaymentRequestInputType
}

{
  "data": {
    "cancelRepaymentRequest": {
      "possibleErrors": [PossibleErrorType],
      "repaymentRequest": CancelRepaymentRequestOutputType
    }
  }
}

collectPayment

Type:CollectPayment

URL:https://api.st.test-kraken.tech/v1/graphql/

Attempt to collect a one-off payment. If an instruction type is provided and there is an existing payment instruction, the payment can be collected immediately. A request to collect a payment at a future date can also be made, in which case the instruction input type is not necessary, but an instruction must exist at the specified collection date for the payment to be collected successfully.

The possible errors that can be raised are:

KT-CT-3932: Invalid data.
KT-CT-3820: Received both ledger ID and number.
KT-CT-3821: Received neither ledger ID nor ledger number.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CollectPaymentInput!`)	Input fields for collecting a payment.

input (CollectPaymentInput!)

Input fields for collecting a payment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

payment (AccountPaymentType)

Details about the collected payment. Note that we might not be able to collect the payment (e.g. if there is no usable payment instruction), in which case the status of the returned payment might be failed or cancelled.

mutation CollectPayment($input: CollectPaymentInput!) {
  collectPayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...AccountPaymentTypeFragment
    }
  }
}

{
  "input": CollectPaymentInput
}

{
  "data": {
    "collectPayment": {
      "possibleErrors": [PossibleErrorType],
      "payment": AccountPaymentType
    }
  }
}

confirmDoubleOptIn

Type:ConfirmDoubleOptIn

URL:https://api.st.test-kraken.tech/v1/graphql/

Confirm a double opt in

The possible errors that can be raised are:

KT-CT-9016: Consent management not enabled.
KT-CT-9020: Invalid consent expiring token.
KT-CT-9021: Consent expiring token not found.
KT-CT-9022: Consent for given token already accepted.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`ConfirmDoubleOptInInput`)

input (ConfirmDoubleOptInInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

consent (ConsentType)

The consent that was created or updated.

mutation ConfirmDoubleOptIn($input: ConfirmDoubleOptInInput) {
  confirmDoubleOptIn(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    consent {
      ...ConsentTypeFragment
    }
  }
}

{
  "input": ConfirmDoubleOptInInput
}

{
  "data": {
    "confirmDoubleOptIn": {
      "possibleErrors": [PossibleErrorType],
      "consent": ConsentType
    }
  }
}

createAccountPaymentSchedule

Type:CreateAccountPaymentSchedule

URL:https://api.st.test-kraken.tech/v1/graphql/

Replace an existing payment schedule with a new one that updates either the payment amount or payment day.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-3815: No active payment schedule found for this account.
KT-CT-3822: Unauthorized.
KT-CT-3923: Unauthorized.
KT-CT-3941: Invalid data.
KT-CT-3942: An unexpected error occurred.
KT-CT-3947: An unexpected error occurred.
KT-CT-3960: Invalid value for payment day.
KT-CT-3961: Cannot update plan-associated payment schedule.
KT-CT-3962: No new value provided to update payment schedule.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreateAccountPaymentScheduleInput!`)	Input fields for updating a payment schedule.

input (CreateAccountPaymentScheduleInput!)

Input fields for updating a payment schedule.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

schedule (PaymentScheduleType!)

New payment schedule.

mutation CreateAccountPaymentSchedule($input: CreateAccountPaymentScheduleInput!) {
  createAccountPaymentSchedule(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    schedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

{
  "input": CreateAccountPaymentScheduleInput
}

{
  "data": {
    "createAccountPaymentSchedule": {
      "possibleErrors": [PossibleErrorType],
      "schedule": PaymentScheduleType
    }
  }
}

createAccountReference

Type:CreateAccountReference

URL:https://api.st.test-kraken.tech/v1/graphql/

Create an account reference.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-8310: Invalid data.
KT-CT-8311: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`AccountReferenceInput!`)	Input fields for creating an account reference.

input (AccountReferenceInput!)

Input fields for creating an account reference.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountReference (AccountReferenceType)

mutation CreateAccountReference($input: AccountReferenceInput!) {
  createAccountReference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountReference {
      ...AccountReferenceTypeFragment
    }
  }
}

{
  "input": AccountReferenceInput
}

{
  "data": {
    "createAccountReference": {
      "possibleErrors": [PossibleErrorType],
      "accountReference": AccountReferenceType
    }
  }
}

createContributionAgreement

Type:CreateContributionAgreement

URL:https://api.st.test-kraken.tech/v1/graphql/

Create a contribution agreement for an account.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-9601: Invalid data.
KT-CT-9602: Unable to create contribution agreement.
KT-CT-9605: Contribution amount cannot be 0 or negative.
KT-CT-9606: Scheme is not accepting contributions at this time.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreateContributionAgreementInput!`)	Input variables needed for creating a contribution agreement on an account.

input (CreateContributionAgreementInput!)

Input variables needed for creating a contribution agreement on an account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

contributionAgreement (ContributionAgreementType)

The created contribution agreement.

mutation CreateContributionAgreement($input: CreateContributionAgreementInput!) {
  createContributionAgreement(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    contributionAgreement {
      ...ContributionAgreementTypeFragment
    }
  }
}

{
  "input": CreateContributionAgreementInput
}

{
  "data": {
    "createContributionAgreement": {
      "possibleErrors": [PossibleErrorType],
      "contributionAgreement": ContributionAgreementType
    }
  }
}

createCreditTransferPermission

Type:CreateCreditTransferPermission

URL:https://api.st.test-kraken.tech/v1/graphql/

Create a credit transfer permission.

The possible errors that can be raised are:

KT-CT-3822: Unauthorized.
KT-CT-3827: The ledger is not valid.
KT-CT-3828: At least one of the provided ledgers must be a credit storage ledger.
KT-CT-3829: The credit transfer permission already exists.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreateCreditTransferPermissionInput!`)	Input fields to create a credit transfer permission.

input (CreateCreditTransferPermissionInput!)

Input fields to create a credit transfer permission.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

validFrom (DateTime)

Datetime when the credit transfer permission is valid.

mutation CreateCreditTransferPermission($input: CreateCreditTransferPermissionInput!) {
  createCreditTransferPermission(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    validFrom
  }
}

{
  "input": CreateCreditTransferPermissionInput
}

{
  "data": {
    "createCreditTransferPermission": {
      "possibleErrors": [PossibleErrorType],
      "validFrom": "2020-01-01T00:00:00.000Z"
    }
  }
}

createDirectDebitInstructionAndSchedule

Type:CreateDirectDebitInstructionAndSchedule

URL:https://api.st.test-kraken.tech/v1/graphql/

Create direct debit payment instructions and schedule

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-CT-1128: Unauthorized.
KT-CT-3947: An unexpected error occurred.
KT-CT-3948: Could not set up direct debit instruction.
KT-GB-3930: Invalid data.
KT-CT-3964: Could not create payment schedule on ledger with future payment schedules.
KT-CT-3965: Payments list is empty. Unable to create payments for payment schedule.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreateDirectDebitInstructionAndScheduleInput!`)	Input fields for creating a payment schedule with a direct debit.

input (CreateDirectDebitInstructionAndScheduleInput!)

Input fields for creating a payment schedule with a direct debit.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

paymentInstruction (PaymentInstructionType!)

The payment instruction.

paymentSchedule (PaymentScheduleType!)

The payment schedule.

mutation CreateDirectDebitInstructionAndSchedule($input: CreateDirectDebitInstructionAndScheduleInput!) {
  createDirectDebitInstructionAndSchedule(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentInstruction {
      ...PaymentInstructionTypeFragment
    }
    paymentSchedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

{
  "input": CreateDirectDebitInstructionAndScheduleInput
}

{
  "data": {
    "createDirectDebitInstructionAndSchedule": {
      "possibleErrors": [PossibleErrorType],
      "paymentInstruction": PaymentInstructionType,
      "paymentSchedule": PaymentScheduleType
    }
  }
}

createDirectDebitPaymentSchedule

Type:CreateDirectDebitPaymentSchedule

URL:https://api.st.test-kraken.tech/v1/graphql/

Create direct debit payment schedule

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-CT-1128: Unauthorized.
KT-GB-3931: Invalid data for payment schedule input.
KT-CT-3964: Could not create payment schedule on ledger with future payment schedules.
KT-CT-3965: Payments list is empty. Unable to create payments for payment schedule.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreateDirectDebitPaymentScheduleInput!`)	Input fields for creating a payment schedule.

input (CreateDirectDebitPaymentScheduleInput!)

Input fields for creating a payment schedule.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

paymentSchedule (PaymentScheduleType!)

The payment schedule.

mutation CreateDirectDebitPaymentSchedule($input: CreateDirectDebitPaymentScheduleInput!) {
  createDirectDebitPaymentSchedule(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentSchedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

{
  "input": CreateDirectDebitPaymentScheduleInput
}

{
  "data": {
    "createDirectDebitPaymentSchedule": {
      "possibleErrors": [PossibleErrorType],
      "paymentSchedule": PaymentScheduleType
    }
  }
}

createFormSubmission

Type:FormSubmissionOuput

URL:https://api.st.test-kraken.tech/v1/graphql/

Create a "form submission" entity. This is only meant to be used as a quick way of putting together a form and submit data for it, in the form of JSON - it is not expected that all form submissions will come through this path.

This field requires the Authorization header to be set.

Arguments

Name Description

Name	Description
`input` (`FormSubmissionInput!`)

input (FormSubmissionInput!)

Return fields

Name Description

Name	Description
`id` (`Int`)
`content` (`JSONString`)
`errors` (`[SerializerFieldErrorsType]`)

id (Int)

content (JSONString)

errors ([SerializerFieldErrorsType])

mutation CreateFormSubmission($input: FormSubmissionInput!) {
  createFormSubmission(input: $input) {
    id
    content
    errors {
      ...SerializerFieldErrorsTypeFragment
    }
  }
}

{
  "input": FormSubmissionInput
}

{
  "data": {
    "createFormSubmission": {
      "id": 1,
      "content": {"key": "value"},
      "errors": [SerializerFieldErrorsType]
    }
  }
}

createGoodsPurchase

Type:CreateGoodsPurchase

URL:https://api.st.test-kraken.tech/v1/graphql/

Create a goods purchase.

The possible errors that can be raised are:

KT-CT-8206: Invalid data.
KT-CT-1131: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreatePurchaseInput!`)	Input fields for creating a purchase without a quote.

input (CreatePurchaseInput!)

Input fields for creating a purchase without a quote.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

goodsPurchase (GoodsPurchase)

Goods purchase created.

mutation CreateGoodsPurchase($input: CreatePurchaseInput!) {
  createGoodsPurchase(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    goodsPurchase {
      ...GoodsPurchaseFragment
    }
  }
}

{
  "input": CreatePurchaseInput
}

{
  "data": {
    "createGoodsPurchase": {
      "possibleErrors": [PossibleErrorType],
      "goodsPurchase": GoodsPurchase
    }
  }
}

createGoodsQuote

Type:CreateGoodsQuote

URL:https://api.st.test-kraken.tech/v1/graphql/

Create a goods quote.

The possible errors that can be raised are:

KT-CT-8202: Invalid data.
KT-CT-8205: Unable to create quote.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreateGoodsQuoteInput!`)	Input fields for creating a goods quote.

input (CreateGoodsQuoteInput!)

Input fields for creating a goods quote.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

goodsQuote (GoodsQuote)

Goods quote created for the customer.

mutation CreateGoodsQuote($input: CreateGoodsQuoteInput!) {
  createGoodsQuote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    goodsQuote {
      ...GoodsQuoteFragment
    }
  }
}

{
  "input": CreateGoodsQuoteInput
}

{
  "data": {
    "createGoodsQuote": {
      "possibleErrors": [PossibleErrorType],
      "goodsQuote": GoodsQuote
    }
  }
}

createGoodsQuoteWithoutAccount

Type:CreateGoodsQuoteWithoutAccount

URL:https://api.st.test-kraken.tech/v1/graphql/

Create a goods quote without an account.

The possible errors that can be raised are:

KT-CT-8202: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreateGoodsQuoteWithoutAccountInput!`)	Input fields for creating a goods quote without an existing account.

input (CreateGoodsQuoteWithoutAccountInput!)

Input fields for creating a goods quote without an existing account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

goodsQuote (GoodsQuote)

Goods quote created for the customer.

mutation CreateGoodsQuoteWithoutAccount($input: CreateGoodsQuoteWithoutAccountInput!) {
  createGoodsQuoteWithoutAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    goodsQuote {
      ...GoodsQuoteFragment
    }
  }
}

{
  "input": CreateGoodsQuoteWithoutAccountInput
}

{
  "data": {
    "createGoodsQuoteWithoutAccount": {
      "possibleErrors": [PossibleErrorType],
      "goodsQuote": GoodsQuote
    }
  }
}

createReferral

Type:CreateReferral

URL:https://api.st.test-kraken.tech/v1/graphql/

Create an account referral using an email address, personal link or code.This is for customers to refer other customers so it only works with friend referrals and not partner referrals.

The possible errors that can be raised are:

KT-CT-6723: Unauthorized.
KT-CT-6710: Unable to create referral.
KT-CT-6711: Accounts may not self-refer.
KT-CT-6713: Referring and referred account brands do not match.
KT-CT-6712: Invalid reference.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`CreateReferralInput!`)	Input fields for creating a referral.

input (CreateReferralInput!)

Input fields for creating a referral.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

referredAccountRewardAmount (Int)

The reward amount to be issued to the referred account, in smallest currency subunits.

mutation CreateReferral($input: CreateReferralInput!) {
  createReferral(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    referredAccountRewardAmount
  }
}

{
  "input": CreateReferralInput
}

{
  "data": {
    "createReferral": {
      "possibleErrors": [PossibleErrorType],
      "referredAccountRewardAmount": 1
    }
  }
}

createServiceOrder

Type:CreateServiceOrder

URL:https://api.st.test-kraken.tech/v1/graphql/

Create a service order for a property.

Arguments

Name Description

Name	Description
`input` (`CreateServiceOrderInput!`)	Input fields for apply for meter.

input (CreateServiceOrderInput!)

Input fields for apply for meter.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

serviceOrder (ServiceOrderType)

The service order that was created.

mutation CreateServiceOrder($input: CreateServiceOrderInput!) {
  createServiceOrder(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    serviceOrder {
      ...ServiceOrderTypeFragment
    }
  }
}

{
  "input": CreateServiceOrderInput
}

{
  "data": {
    "createServiceOrder": {
      "possibleErrors": [PossibleErrorType],
      "serviceOrder": ServiceOrderType
    }
  }
}

deletePushNotificationBinding

Type:DeletePushNotificationBinding

URL:https://api.st.test-kraken.tech/v1/graphql/

Delete a device token used for push notifications.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-CT-5411: Invalid token or no push notification binding found for the given account user.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`DeletePushNotificationBindingInput!`)	Input fields for deleting a push notification binding.

input (DeletePushNotificationBindingInput!)

Input fields for deleting a push notification binding.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

status (DeletePushNotificationBindingOutput)

mutation DeletePushNotificationBinding($input: DeletePushNotificationBindingInput!) {
  deletePushNotificationBinding(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    status
  }
}

{
  "input": DeletePushNotificationBindingInput
}

{
  "data": {
    "deletePushNotificationBinding": {
      "possibleErrors": [PossibleErrorType],
      "status": "SUCCESSFUL"
    }
  }
}

endContributionAgreement

Type:EndContributionAgreement

URL:https://api.st.test-kraken.tech/v1/graphql/

End a contribution agreement for an account.

The possible errors that can be raised are:

KT-CT-9603: Unable to find contribution agreement.
KT-CT-4123: Unauthorized.
KT-CT-9604: Unable to end contribution agreement.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`EndContributionAgreementInput!`)	Input variables needed for ending a contribution agreement on an account.

input (EndContributionAgreementInput!)

Input variables needed for ending a contribution agreement on an account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

contributionAgreement (ContributionAgreementType)

The created contribution agreement.

mutation EndContributionAgreement($input: EndContributionAgreementInput!) {
  endContributionAgreement(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    contributionAgreement {
      ...ContributionAgreementTypeFragment
    }
  }
}

{
  "input": EndContributionAgreementInput
}

{
  "data": {
    "endContributionAgreement": {
      "possibleErrors": [PossibleErrorType],
      "contributionAgreement": ContributionAgreementType
    }
  }
}

enrollAccountInLoyaltyProgram

Type:EnrollAccountInLoyaltyProgram

URL:https://api.st.test-kraken.tech/v1/graphql/

Enroll users account in Loyalty program.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-9213: ineligible loyalty points enrollment.
KT-CT-9210: Unhandled Loyalty Points exception.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`EnrollAccountInLoyaltyProgramInput!`)	The account number to enroll in the loyalty program.

input (EnrollAccountInLoyaltyProgramInput!)

The account number to enroll in the loyalty program.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

outcome (EnrollAccountInLoyaltyProgramOutcome)

Outcome of the loyalty points campaign enrollment.

mutation EnrollAccountInLoyaltyProgram($input: EnrollAccountInLoyaltyProgramInput!) {
  enrollAccountInLoyaltyProgram(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    outcome {
      ...EnrollAccountInLoyaltyProgramOutcomeFragment
    }
  }
}

{
  "input": EnrollAccountInLoyaltyProgramInput
}

{
  "data": {
    "enrollAccountInLoyaltyProgram": {
      "possibleErrors": [PossibleErrorType],
      "outcome": EnrollAccountInLoyaltyProgramOutcome
    }
  }
}

exchangeMeter

Type:ExchangeMeter

URL:https://api.st.test-kraken.tech/v1/graphql/

Exchange meter for a property.

The possible errors that can be raised are:

KT-GB-11001: Could not validate meter.
KT-GB-11002: Unable to exchange meter.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

Name	Description
`input` (`ExchangeMeterInputType!`)	Input fields for meter exchange.

input (ExchangeMeterInputType!)

Input fields for meter exchange.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

meter (WaterMeterType)

The newly installed meter.

mutation ExchangeMeter($input: ExchangeMeterInputType!) {
  exchangeMeter(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    meter {
      ...WaterMeterTypeFragment
    }
  }
}

{
  "input": ExchangeMeterInputType
}

{
  "data": {
    "exchangeMeter": {
      "possibleErrors": [PossibleErrorType],
      "meter": WaterMeterType
    }
  }
}

forceMoveIn

Type:ForceMoveIn

URL:https://api.st.test-kraken.tech/v1/graphql/

Move in a named customer into the viewer's property, for the viewer to be forced out of the property.

Deprecated

The 'forceMoveIn' field is deprecated.

Please use the `moveOut` mutation instead.

- Marked as deprecated on 2024-05-07.
- Scheduled for removal on or after 2025-08-01.

Arguments

Name Description

Name	Description
`input` (`ForceMoveInInput!`)	Input fields for triggering force move in process.

input (ForceMoveInInput!)

Input fields for triggering force move in process.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountType)

The account initiating the force move in.

mutation ForceMoveIn($input: ForceMoveInInput!) {
  forceMoveIn(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

{
  "input": ForceMoveInInput
}

{
  "data": {
    "forceMoveIn": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountType
    }
  }
}

forceReauthentication

Type:ForceReauthentication

URL:https://api.st.test-kraken.tech/v1/graphql/

Force users of Kraken Tokens and refresh tokens issued to the viewer to reauthenticate.

Calling this mutation will cause all Kraken Tokens and refresh tokens issued to the authenticated viewer before the mutation was called to become invalid.

Arguments

Name Description

input (ForceReauthenticationInput!)

Input object argument to the force-reauthentication mutation.

Return fields

Name Description

tokensInvalidated (Boolean!)

Reports whether the mutation applied successfully. Should always be 'true'.

effectiveAt (DateTime!)

The time at which forced reauthentication is effective. Kraken and refresh tokens issued before this time will be invalid.

mutation ForceReauthentication($input: ForceReauthenticationInput!) {
  forceReauthentication(input: $input) {
    tokensInvalidated
    effectiveAt
  }
}

{
  "input": ForceReauthenticationInput
}

{
  "data": {
    "forceReauthentication": {
      "tokensInvalidated": true,
      "effectiveAt": "2020-01-01T00:00:00.000Z"
    }
  }
}

getEmbeddedSecretForNewPaymentInstruction

Type:GetEmbeddedSecretForNewPaymentInstruction

URL:https://api.st.test-kraken.tech/v1/graphql/

Get the client secret needed to create a new payment instruction using an embedded form.

The possible errors that can be raised are:

KT-CT-4177: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-3820: Received both ledger ID and number.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (GetEmbeddedSecretForNewPaymentInstructionInput!)

Input fields for getting the client secret for an embedded new card payment method form.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

secretKey (String)

mutation GetEmbeddedSecretForNewPaymentInstruction($input: GetEmbeddedSecretForNewPaymentInstructionInput!) {
  getEmbeddedSecretForNewPaymentInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    secretKey
  }
}

{
  "input": GetEmbeddedSecretForNewPaymentInstructionInput
}

{
  "data": {
    "getEmbeddedSecretForNewPaymentInstruction": {
      "possibleErrors": [PossibleErrorType],
      "secretKey": "abc123"
    }
  }
}

getEmbeddedSecretForNewPaymentInstructionWithoutAccount

Type:GetEmbeddedSecretForNewPaymentInstructionWithoutAccount

URL:https://api.st.test-kraken.tech/v1/graphql/

Get the client secret needed to create a new payment instruction using an embedded form without tying it to a customer.

Arguments

Name Description

input (GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput!)

Input fields for getting the client secret for an embedded new card payment method form.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

secretKey (String)

The client secret needed to create a new stored payment instruction.

mutation GetEmbeddedSecretForNewPaymentInstructionWithoutAccount($input: GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput!) {
  getEmbeddedSecretForNewPaymentInstructionWithoutAccount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    secretKey
  }
}

{
  "input": GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput
}

{
  "data": {
    "getEmbeddedSecretForNewPaymentInstructionWithoutAccount": {
      "possibleErrors": [PossibleErrorType],
      "secretKey": "abc123"
    }
  }
}

getHostedUrlForNewPaymentInstruction

Type:GetHostedUrlForNewPaymentInstruction

URL:https://api.st.test-kraken.tech/v1/graphql/

Get the external URL where the user can set up a payment instruction.

The possible errors that can be raised are:

KT-CT-1128: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (GetHostedUrlForNewPaymentInstructionInput!)

Input fields for getting the external URL for setting up a payment instruction.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

url (String)

URL at which payment instruction can be set up.

mutation GetHostedUrlForNewPaymentInstruction($input: GetHostedUrlForNewPaymentInstructionInput!) {
  getHostedUrlForNewPaymentInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    url
  }
}

{
  "input": GetHostedUrlForNewPaymentInstructionInput
}

{
  "data": {
    "getHostedUrlForNewPaymentInstruction": {
      "possibleErrors": [PossibleErrorType],
      "url": "abc123"
    }
  }
}

initiateHostedStandalonePayment

Type:InitiateHostedStandalonePayment

URL:https://api.st.test-kraken.tech/v1/graphql/

Initiate a standalone payment and return the url where the customer can complete it.

The possible errors that can be raised are:

KT-CT-1128: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-3943: Invalid ledger.
KT-CT-3957: No collection method provided.
KT-CT-3958: Provide either ledger ID or ledger number.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InitiateHostedStandalonePaymentInput!)

Input fields for initiating a standalone payment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

payment (InitiateHostedStandalonePaymentOutput)

The details required to refer to and complete a hosted payment.

mutation InitiateHostedStandalonePayment($input: InitiateHostedStandalonePaymentInput!) {
  initiateHostedStandalonePayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...InitiateHostedStandalonePaymentOutputFragment
    }
  }
}

{
  "input": InitiateHostedStandalonePaymentInput
}

{
  "data": {
    "initiateHostedStandalonePayment": {
      "possibleErrors": [PossibleErrorType],
      "payment": InitiateHostedStandalonePaymentOutput
    }
  }
}

initiateProductSwitch

Type:InitiateProductSwitch

URL:https://api.st.test-kraken.tech/v1/graphql/

Do a product switch for a user.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4619: Quote with given code not found.
KT-CT-4624: Unable to accept the given product code.
KT-CT-4924: Unauthorized.
KT-CT-4626: No product selected for the given quote code.
KT-CT-4719: No supply point found for identifier provided.
KT-CT-1509: Unable to create agreement.
KT-CT-1507: Agreement product switch date is not within the acceptable range.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InitiateProductSwitchInput!)

Instigate a product switch for a specific supply point given a valid product and account number.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

productCode (String!)

The selected product for a specific product switch.

switchDate (Date!)

The date at which the product switch becomes effective.

mutation InitiateProductSwitch($input: InitiateProductSwitchInput!) {
  initiateProductSwitch(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    productCode
    switchDate
  }
}

{
  "input": InitiateProductSwitchInput
}

{
  "data": {
    "initiateProductSwitch": {
      "possibleErrors": [PossibleErrorType],
      "productCode": "abc123",
      "switchDate": "2020-01-01"
    }
  }
}

initiateStandalonePayment

Type:InitiateStandalonePayment

URL:https://api.st.test-kraken.tech/v1/graphql/

Initiate a standalone payment and return the client secret required to complete it.

The possible errors that can be raised are:

KT-CT-3820: Received both ledger ID and number.
KT-CT-4177: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-3943: Invalid ledger.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InitiateStandalonePaymentInput!)

Input fields for initiating a standalone payment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

payment (InitiateStandalonePaymentOutput)

mutation InitiateStandalonePayment($input: InitiateStandalonePaymentInput!) {
  initiateStandalonePayment(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    payment {
      ...InitiateStandalonePaymentOutputFragment
    }
  }
}

{
  "input": InitiateStandalonePaymentInput
}

{
  "data": {
    "initiateStandalonePayment": {
      "possibleErrors": [PossibleErrorType],
      "payment": InitiateStandalonePaymentOutput
    }
  }
}

insertUserPsrRecords

Type:InsertUserPSRRecords

URL:https://api.st.test-kraken.tech/v1/graphql/

Insert special circumstance priority services for the user. This mutation replaces all the active PSR records with the given input. Make sure to include all existing PSR records for the user if you do not intend to deactivate any records.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-GB-5415: The requested PSR record type is not valid.
KT-GB-5411: Failed to update special circumstance record.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input ([SpecialCircumstanceRecordInput]!)

List of input fields for a user's Priority Service Records (PSR).

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

records ([SpecialCircumstanceRecordType])

List of special circumstance records for the user.

mutation InsertUserPsrRecords($input: [SpecialCircumstanceRecordInput]!) {
  insertUserPsrRecords(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    records {
      ...SpecialCircumstanceRecordTypeFragment
    }
  }
}

{
  "input": SpecialCircumstanceRecordInput
}

{
  "data": {
    "insertUserPsrRecords": {
      "possibleErrors": [PossibleErrorType],
      "records": [SpecialCircumstanceRecordType]
    }
  }
}

installMeter

Type:InstallMeter

URL:https://api.st.test-kraken.tech/v1/graphql/

Install meter on an unmetered property.

The possible errors that can be raised are:

KT-GB-11001: Could not validate meter.
KT-GB-11003: Unable to install meter.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InstallMeterInputType!)

Input fields for meter installation.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

meter (WaterMeterType)

The newly installed meter.

mutation InstallMeter($input: InstallMeterInputType!) {
  installMeter(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    meter {
      ...WaterMeterTypeFragment
    }
  }
}

{
  "input": InstallMeterInputType
}

{
  "data": {
    "installMeter": {
      "possibleErrors": [PossibleErrorType],
      "meter": WaterMeterType
    }
  }
}

invalidatePaymentInstruction

Type:InvalidatePaymentInstruction

URL:https://api.st.test-kraken.tech/v1/graphql/

Invalidate an existing instruction.

The possible errors that can be raised are:

KT-CT-3926: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (InvalidatePaymentInstructionInput!)

Input fields for invalidating a payment instruction from an embedded form.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

instruction (InvalidatePaymentInstructionOutput)

mutation InvalidatePaymentInstruction($input: InvalidatePaymentInstructionInput!) {
  invalidatePaymentInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    instruction {
      ...InvalidatePaymentInstructionOutputFragment
    }
  }
}

{
  "input": InvalidatePaymentInstructionInput
}

{
  "data": {
    "invalidatePaymentInstruction": {
      "possibleErrors": [PossibleErrorType],
      "instruction": InvalidatePaymentInstructionOutput
    }
  }
}

invalidatePreSignedToken

Type:InvalidatePreSignedToken

URL:https://api.st.test-kraken.tech/v1/graphql/

Invalidate a previously-issued pre-signed token.

The possible errors that can be raised are:

KT-CT-1129: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (InvalidatePreSignedTokenInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

token (PreSignedToken)

mutation InvalidatePreSignedToken($input: InvalidatePreSignedTokenInput!) {
  invalidatePreSignedToken(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token {
      ...PreSignedTokenFragment
    }
  }
}

{
  "input": InvalidatePreSignedTokenInput
}

{
  "data": {
    "invalidatePreSignedToken": {
      "possibleErrors": [PossibleErrorType],
      "token": PreSignedToken
    }
  }
}

joinSupplierAcceptTermsAndConditions

Type:JoinSupplierAcceptTermsAndConditions

URL:https://api.st.test-kraken.tech/v1/graphql/

Accept terms and conditions for a join supplier process.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-4501: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (JoinSupplierAcceptTermsAndConditionsInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean)

Indicator that the mutation has completed successfully.

mutation JoinSupplierAcceptTermsAndConditions($input: JoinSupplierAcceptTermsAndConditionsInput!) {
  joinSupplierAcceptTermsAndConditions(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": JoinSupplierAcceptTermsAndConditionsInput
}

{
  "data": {
    "joinSupplierAcceptTermsAndConditions": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

linkUserToLine

Type:LinkUserToLineResponse!

URL:https://api.st.test-kraken.tech/v1/graphql/

Link an account user and line user together.

Arguments

Name Description

input (LinkUserToLineInput!)

Input fields to link an account user with LINE.

Return fields

Name	Description

mutation LinkUserToLine($input: LinkUserToLineInput!) {
  linkUserToLine(input: $input) {
    ... on LineLinkRedirectResponse {
      ...LineLinkRedirectResponseFragment
    }
    ... on LinkTokenNotFound {
      ...LinkTokenNotFoundFragment
    }
    ... on AlreadyLinkedError {
      ...AlreadyLinkedErrorFragment
    }
  }
}

{
  "input": LinkUserToLineInput
}

{
  "data": {
    "linkUserToLine": LineLinkRedirectResponse
  }
}

masqueradeAuthentication

Type:MasqueradeAuthentication

URL:https://api.st.test-kraken.tech/v1/graphql/

Provide a temporary token to get an auth token. This is intended to allow support users to view customer data through the brand interface.

Arguments

Name Description

masqueradeToken (String!)

The masquerade token issued by the support site.

userId (String!)

The ID of the AccountUser to masquerade as.

Return fields

Name Description

token (String)

A Kraken Token that can be used to authenticate to the API, masquerading as the desired user.

errors ([ErrorType])

A list of any errors that occurred while running this mutation.

mutation MasqueradeAuthentication(
  $masqueradeToken: String!,
  $userId: String!
) {
  masqueradeAuthentication(
    masqueradeToken: $masqueradeToken,
    userId: $userId
  ) {
    token
    errors {
      ...ErrorTypeFragment
    }
  }
}

{
  "masqueradeToken": "abc123",
  "userId": "abc123"
}

{
  "data": {
    "masqueradeAuthentication": {
      "token": "abc123",
      "errors": [ErrorType]
    }
  }
}

modifyMeter

Type:ModifyMeter

URL:https://api.st.test-kraken.tech/v1/graphql/

Modify meter details

The possible errors that can be raised are:

KT-GB-11001: Could not validate meter.
KT-GB-11005: Could not modify meter.
KT-GB-11006: Water meter cannot be found with the provided identifiers.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (ModifyMeterInput!)

Input fields for modifying a meters' details.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

meter (WaterMeterType)

The meter to modify.

mutation ModifyMeter($input: ModifyMeterInput!) {
  modifyMeter(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    meter {
      ...WaterMeterTypeFragment
    }
  }
}

{
  "input": ModifyMeterInput
}

{
  "data": {
    "modifyMeter": {
      "possibleErrors": [PossibleErrorType],
      "meter": WaterMeterType
    }
  }
}

moveInCreateCustomer

Type:MoveInCreateCustomer

URL:https://api.st.test-kraken.tech/v1/graphql/

Create customer as part of a move in process.

The possible errors that can be raised are:

KT-GB-5416: Invalid data.
KT-CT-5450: Password is invalid.
KT-CT-4111: Unable to use given email address.
KT-GB-6633: An error occurred when trying to process this house move.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (MoveInCreateCustomerInput!)

Customer's personal details.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountNumber (String!)

The account number we created.

mutation MoveInCreateCustomer($input: MoveInCreateCustomerInput!) {
  moveInCreateCustomer(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountNumber
  }
}

{
  "input": MoveInCreateCustomerInput
}

{
  "data": {
    "moveInCreateCustomer": {
      "possibleErrors": [PossibleErrorType],
      "accountNumber": "abc123"
    }
  }
}

moveOut

Type:MoveOut

URL:https://api.st.test-kraken.tech/v1/graphql/

Trigger a move out of a property for an account.Optionally provide details of the next property to trigger a move within.

The possible errors that can be raised are:

KT-GB-6628: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (MoveOutInput!)

Input fields for triggering move out process.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountType)

The account initiating the move out.

mutation MoveOut($input: MoveOutInput!) {
  moveOut(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

{
  "input": MoveOutInput
}

{
  "data": {
    "moveOut": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountType
    }
  }
}

obtainKrakenToken

Type:ObtainKrakenJSONWebToken

URL:https://api.st.test-kraken.tech/v1/graphql/

Create a Kraken Token (JWT) for authentication.

Provide the required input fields to obtain the token.

The token should be used as the Authorization header for any authenticated requests.

The possible errors that can be raised are:

KT-CT-1135: Invalid data.
KT-CT-1134: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (ObtainJSONWebTokenInput!)

Input fields that can be used to obtain a Json Web Token (JWT) for authentication to the API.

Return fields

Name	Description
`possibleErrors` (`[PossibleErrorType]`)	Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. Please use the 'possibleErrors' query or the 'X-Possible-Errors' header instead. - Marked as deprecated on 2025-01-31. - Scheduled for removal on or after 2025-03-01.
`token` (`String!`)	The Kraken Token. Can be used in the `Authorization` header for subsequent calls to the API to access protected resources.
`payload` (`GenericScalar!`)	The body payload of the Kraken Token. The same information can be obtained by using JWT decoding tools on the value of the `token` field.
`refreshToken` (`String`)	A token that can be used in a subsequent call to `obtainKrakenToken` to get a new Kraken Token with the same access conditions after the previous one has expired.
`refreshExpiresIn` (`Int`)	A Unix timestamp representing the point in time at which the refresh token will expire.

mutation ObtainKrakenToken($input: ObtainJSONWebTokenInput!) {
  obtainKrakenToken(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token
    payload
    refreshToken
    refreshExpiresIn
  }
}

{
  "input": ObtainJSONWebTokenInput
}

{
  "data": {
    "obtainKrakenToken": {
      "possibleErrors": [PossibleErrorType],
      "token": "abc123",
      "payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
      "refreshToken": "abc123",
      "refreshExpiresIn": 1
    }
  }
}

redeemLoyaltyPointsForAccountCredit

Type:RedeemLoyaltyPointsForAccountCredit

URL:https://api.st.test-kraken.tech/v1/graphql/

Redeem the passed number of Loyalty Points as account credit.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-9201: No Loyalty Point ledger found for the user.
KT-CT-9202: Loyalty Points adapter not configured.
KT-CT-9203: No ledger entries for the ledger.
KT-CT-9205: Insufficient Loyalty Points.
KT-CT-9206: Indivisible points.
KT-CT-9204: Negative or zero points set.
KT-CT-9208: Invalid posted at datetime.
KT-CT-9209: Negative Loyalty Points balance.
KT-CT-9210: Unhandled Loyalty Points exception.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (RedeemLoyaltyPointsInput!)

Input fields for redeeming Loyalty Points.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

pointsRedeemed (Int)

The number of loyalty points that were redeemed.

mutation RedeemLoyaltyPointsForAccountCredit($input: RedeemLoyaltyPointsInput!) {
  redeemLoyaltyPointsForAccountCredit(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    pointsRedeemed
  }
}

{
  "input": RedeemLoyaltyPointsInput
}

{
  "data": {
    "redeemLoyaltyPointsForAccountCredit": {
      "possibleErrors": [PossibleErrorType],
      "pointsRedeemed": 1
    }
  }
}

redeemReferralClaimCode

Type:RedeemReferralClaimCode

URL:https://api.st.test-kraken.tech/v1/graphql/

Redeem the referral claim code from certain referral scheme.

The possible errors that can be raised are:

KT-CT-6723: Unauthorized.
KT-CT-6724: Referral claim code not found.
KT-CT-6725: Referral claim code redeeming error.
KT-CT-6726: Referral claim code has already been redeemed.
KT-CT-6727: Referral claim code is not available.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (RedeemReferralClaimCodeInput!)

Input fields for redeeming referral code.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean!)

Whether or not the request was successful.

mutation RedeemReferralClaimCode($input: RedeemReferralClaimCodeInput!) {
  redeemReferralClaimCode(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": RedeemReferralClaimCodeInput
}

{
  "data": {
    "redeemReferralClaimCode": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

regenerateSecretKey

Type:RegenerateSecretKey

URL:https://api.st.test-kraken.tech/v1/graphql/

Regenerate the live secret key for the authenticated user.

Return fields

Name Description

key (String!)

The generated key value, which is only ever available once (here).

viewer (AccountUserType)

The currently authenticated user.

mutation RegenerateSecretKey {
  regenerateSecretKey {
    key
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

{
  "data": {
    "regenerateSecretKey": {
      "key": "abc123",
      "viewer": AccountUserType
    }
  }
}

registerEmail

Type:RegisterEmail

URL:https://api.st.test-kraken.tech/v1/graphql/

Registers the email of a user in the registration journey who currently has a placeholder (blackhole) email.

The possible errors that can be raised are:

KT-GB-5412: User already has an email address.
KT-GB-5413: Invalid inputs for updating a blackhole email.
KT-CT-1133: Unable to request password reset email.
KT-CT-10006: Account not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RegisterEmailInput!)

Input fields for assigning email address to an account user.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

blackholeEmailAccountUser (BlackholeEmailAccountUserType)

Details of an account user who has updated their blackhole email.

mutation RegisterEmail($input: RegisterEmailInput!) {
  registerEmail(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    blackholeEmailAccountUser {
      ...BlackholeEmailAccountUserTypeFragment
    }
  }
}

{
  "input": RegisterEmailInput
}

{
  "data": {
    "registerEmail": {
      "possibleErrors": [PossibleErrorType],
      "blackholeEmailAccountUser": BlackholeEmailAccountUserType
    }
  }
}

registerPushNotificationBinding

Type:RegisterPushNotificationBinding

URL:https://api.st.test-kraken.tech/v1/graphql/

This field requires the Authorization header to be set.

Arguments

Name Description

input (RegisterPushNotificationBindingInput!)

Input fields for creating an push notification binding.

Return fields

Name Description

pushNotificationBinding (PushNotificationBindingType)

Override Field to add additional attributes and extend description with possible_errors

mutation RegisterPushNotificationBinding($input: RegisterPushNotificationBindingInput!) {
  registerPushNotificationBinding(input: $input) {
    pushNotificationBinding {
      ...PushNotificationBindingTypeFragment
    }
  }
}

{
  "input": RegisterPushNotificationBindingInput
}

{
  "data": {
    "registerPushNotificationBinding": {
      "pushNotificationBinding": PushNotificationBindingType
    }
  }
}

requestDoubleOptIn

Type:RequestDoubleOptIn

URL:https://api.st.test-kraken.tech/v1/graphql/

Request a double opt in

The possible errors that can be raised are:

KT-CT-9019: Invalid input.
KT-CT-9018: Account not found.
KT-CT-1111: Unauthorized.
KT-CT-9016: Consent management not enabled.
KT-CT-9017: Consent type not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (DoubleOptInInput)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

consent (ConsentType)

The consent that was created or updated.

mutation RequestDoubleOptIn($input: DoubleOptInInput) {
  requestDoubleOptIn(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    consent {
      ...ConsentTypeFragment
    }
  }
}

{
  "input": DoubleOptInInput
}

{
  "data": {
    "requestDoubleOptIn": {
      "possibleErrors": [PossibleErrorType],
      "consent": ConsentType
    }
  }
}

requestPasswordReset

Type:RequestPasswordResetOutputType

URL:https://api.st.test-kraken.tech/v1/graphql/

Provide the email address of an account user to send them an email with instructions on how to reset their password.

The possible errors that can be raised are:

KT-CT-1133: Unable to request password reset email.
KT-CT-11331: Invalid input data.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (RequestPasswordResetInput!)

Input fields for requesting a password reset email.

Return fields

Name Description

email (String)

The email that requested a password reset email.

mutation RequestPasswordReset($input: RequestPasswordResetInput!) {
  requestPasswordReset(input: $input) {
    email
  }
}

{
  "input": RequestPasswordResetInput
}

{
  "data": {
    "requestPasswordReset": {
      "email": "abc123"
    }
  }
}

requestPrintedBill

Type:RequestPrintedBill

URL:https://api.st.test-kraken.tech/v1/graphql/

Request an issued bill to be printed and (re)posted to billing address of the account.

The possible errors that can be raised are:

KT-CT-3824: Unauthorized.
KT-CT-9705: The billing document has not been issued.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RequestPrintedBillInput!)

Input fields to request a printed bill.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean)

Whether the request was successful.

mutation RequestPrintedBill($input: RequestPrintedBillInput!) {
  requestPrintedBill(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": RequestPrintedBillInput
}

{
  "data": {
    "requestPrintedBill": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

resetPassword

Type:ResetPasswordMutationPayload

URL:https://api.st.test-kraken.tech/v1/graphql/

Reset the password of an account user indicated by the userId to the value supplied.

Deprecated

The 'resetPassword' field is deprecated.

Please use `resetUserPassword` instead.

- Marked as deprecated on 2024-12-04.
- Scheduled for removal on or after 2025-06-01.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/81/

Arguments

Name Description

input (ResetPasswordMutationInput!)

Return fields

Name Description

errors ([SerializerFieldErrorsType])

clientMutationId (String)

mutation ResetPassword($input: ResetPasswordMutationInput!) {
  resetPassword(input: $input) {
    errors {
      ...SerializerFieldErrorsTypeFragment
    }
    clientMutationId
  }
}

{
  "input": ResetPasswordMutationInput
}

{
  "data": {
    "resetPassword": {
      "errors": [SerializerFieldErrorsType],
      "clientMutationId": "abc123"
    }
  }
}

resetUserPassword

Type:ResetUserPasswordOutput

URL:https://api.st.test-kraken.tech/v1/graphql/

Reset the password of an account user.

Raises KT-CT-5450 if password validation fails. Inspect the validationErrors extension to get the exact validation error:

json { "data": {"resetUserPassword": null}, "errors": [ { "message": "Password is invalid.", "path": ["resetUserPassword"], "extensions": { "errorType": "VALIDATION", "errorCode": "KT-CT-5450", "errorDescription": "Given password fails password policy requirements.", "validationErrors": [ { "code": "password_too_short", "message": "This password is too short. It must contain at least 7 characters.", "inputPath": ["input", "password"] }, { "code": "password_too_common", "message": "This password is too common.", "inputPath": ["input", "password"] } ] } } ] }

The validation error's code can be any of - password_too_short - password_too_common - password_reused - password_matches_current - password_has_too_few_numeric_characters - password_has_too_few_special_characters - password_has_too_few_lowercase_characters - password_has_too_few_uppercase_characters - password_contains_account_number - password_contains_part_of_email_address

The possible errors that can be raised are:

KT-CT-4125: Unauthorized.
KT-CT-1132: Unauthorized.
KT-CT-5450: Password is invalid.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (ResetUserPasswordInput!)

Input fields for resetting an account user's password.

Return fields

Name	Description
`userId` (`ID!`)	The ID of the user whose password was changed.
`passwordUpdated` (`Boolean`)	True if the password update was successful, false otherwise. Deprecated The 'passwordUpdated' field is deprecated. Please handle the KT-CT-5450 error instead. Note that the KT-CT-5450 error will not be raised if you request any of the `failureCodes`, `failureReasons`, or `passwordUpdated` fields. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-10-04.
`failureReasons` (`[String]`)	A list of messages of which password validations the new password failed against if applicable. Deprecated The 'failureReasons' field is deprecated. Please handle the KT-CT-5450 error and inspect the `validationErrors[].message` extension instead. Note that the KT-CT-5450 error will not be raised if you request any of the `failureCodes`, `failureReasons`, or `passwordUpdated` fields. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-10-04.
`failureCodes` (`[String]`)	A list of codes of which password validation the new password failed against if applicable. One of: - `password_too_short` - `password_too_common` - `password_reused` - `password_matches_current` - `password_has_too_few_numeric_characters` - `password_has_too_few_special_characters` - `password_has_too_few_lowercase_characters` - `password_has_too_few_uppercase_characters` - `password_contains_account_number` - `password_contains_part_of_email_address` Deprecated The 'failureCodes' field is deprecated. Please handle the KT-CT-5450 error and inspect the `validationErrors[].code` extension instead. Note that the KT-CT-5450 error will not be raised if you request any of the `failureCodes`, `failureReasons`, or `passwordUpdated` fields. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-10-04.

mutation ResetUserPassword($input: ResetUserPasswordInput!) {
  resetUserPassword(input: $input) {
    userId
    passwordUpdated
    failureReasons
    failureCodes
  }
}

{
  "input": ResetUserPasswordInput
}

{
  "data": {
    "resetUserPassword": {
      "userId": "abc123",
      "passwordUpdated": true,
      "failureReasons": ["abc123"],
      "failureCodes": ["abc123"]
    }
  }
}

scheduleQuoteFollowUp

Type:ScheduleQuoteFollowUp

URL:https://api.st.test-kraken.tech/v1/graphql/

Schedule a quote follow-up to the provided recipient.

The possible errors that can be raised are:

KT-CT-4619: Quote with given code not found.
KT-CT-4632: Invalid recipient information.
KT-CT-4633: Mutation not enabled in this environment.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (QuoteShareInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean!)

Whether the message was scheduled successfully.

mutation ScheduleQuoteFollowUp($input: QuoteShareInput!) {
  scheduleQuoteFollowUp(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": QuoteShareInput
}

{
  "data": {
    "scheduleQuoteFollowUp": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

sendPreSignedTokenEmail

Type:SendOneTimeLoginEmail

URL:https://api.st.test-kraken.tech/v1/graphql/

Send a pre-signed token email to log in to consumer site.

The possible errors that can be raised are:

KT-CT-4122: Invalid email.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (SendOneTimeLoginEmailInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

status (String)

The result of the operation.

mutation SendPreSignedTokenEmail($input: SendOneTimeLoginEmailInput!) {
  sendPreSignedTokenEmail(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    status
  }
}

{
  "input": SendOneTimeLoginEmailInput
}

{
  "data": {
    "sendPreSignedTokenEmail": {
      "possibleErrors": [PossibleErrorType],
      "status": "abc123"
    }
  }
}

setLoyaltyPointsUser

Type:SetLoyaltyPointsUser

URL:https://api.st.test-kraken.tech/v1/graphql/

Set the Loyalty Point user for the account.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-9210: Unhandled Loyalty Points exception.
KT-CT-9214: Couldn't assign user loyalty points role.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (SetLoyaltyPointsUserInput!)

Input fields for saving the Loyalty Points user.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

newLoyaltyPointsUserId (String)

ID of the new Loyalty Points user.

mutation SetLoyaltyPointsUser($input: SetLoyaltyPointsUserInput!) {
  setLoyaltyPointsUser(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    newLoyaltyPointsUserId
  }
}

{
  "input": SetLoyaltyPointsUserInput
}

{
  "data": {
    "setLoyaltyPointsUser": {
      "possibleErrors": [PossibleErrorType],
      "newLoyaltyPointsUserId": "abc123"
    }
  }
}

setUpDirectDebitInstruction

Type:SetUpDirectDebitInstruction

URL:https://api.st.test-kraken.tech/v1/graphql/

Set up a new direct debit instruction.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

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-5415: Account user not found.
KT-CT-11103: Business not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SetUpDirectDebitInstructionInput!)

Input fields for creating a new direct debit instruction

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

paymentInstruction (DirectDebitInstructionType)

mutation SetUpDirectDebitInstruction($input: SetUpDirectDebitInstructionInput!) {
  setUpDirectDebitInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentInstruction {
      ...DirectDebitInstructionTypeFragment
    }
  }
}

{
  "input": SetUpDirectDebitInstructionInput
}

{
  "data": {
    "setUpDirectDebitInstruction": {
      "possibleErrors": [PossibleErrorType],
      "paymentInstruction": DirectDebitInstructionType
    }
  }
}

shareGoodsQuote

Type:ShareGoodsQuote

URL:https://api.st.test-kraken.tech/v1/graphql/

Share a goods quote.

The possible errors that can be raised are:

KT-CT-4122: Invalid email.
KT-CT-8203: Received an invalid quote code.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (ShareGoodsQuoteInput!)

Input fields for sharing a quote.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

share (GoodsQuoteShare)

Goods quote shared.

mutation ShareGoodsQuote($input: ShareGoodsQuoteInput!) {
  shareGoodsQuote(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    share {
      ...GoodsQuoteShareFragment
    }
  }
}

{
  "input": ShareGoodsQuoteInput
}

{
  "data": {
    "shareGoodsQuote": {
      "possibleErrors": [PossibleErrorType],
      "share": GoodsQuoteShare
    }
  }
}

storePaymentInstruction

Type:StorePaymentInstruction

URL:https://api.st.test-kraken.tech/v1/graphql/

Store a new payment instruction created through the embedded process.

The possible errors that can be raised are:

KT-CT-3820: Received both ledger ID and number.
KT-CT-4177: Unauthorized.
KT-CT-3822: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (StorePaymentInstructionInput!)

Input fields for storing a new payment instruction created through the embedded process.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

paymentInstruction (PaymentInstructionType)

The stored payment instruction.

mutation StorePaymentInstruction($input: StorePaymentInstructionInput!) {
  storePaymentInstruction(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentInstruction {
      ...PaymentInstructionTypeFragment
    }
  }
}

{
  "input": StorePaymentInstructionInput
}

{
  "data": {
    "storePaymentInstruction": {
      "possibleErrors": [PossibleErrorType],
      "paymentInstruction": PaymentInstructionType
    }
  }
}

submitCustomerFeedback

Type:SubmitCustomerFeedback

URL:https://api.st.test-kraken.tech/v1/graphql/

Submit customer feedback.

The possible errors that can be raised are:

KT-CT-5514: Unable to submit feedback.
KT-CT-5511: The feedback_id should be provided for feedback source.
KT-CT-5512: The feedback doesn't match the account.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (CustomerFeedbackInputType!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

customerFeedback (CustomerFeedbackType)

mutation SubmitCustomerFeedback($input: CustomerFeedbackInputType!) {
  submitCustomerFeedback(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    customerFeedback {
      ...CustomerFeedbackTypeFragment
    }
  }
}

{
  "input": CustomerFeedbackInputType
}

{
  "data": {
    "submitCustomerFeedback": {
      "possibleErrors": [PossibleErrorType],
      "customerFeedback": CustomerFeedbackType
    }
  }
}

submitMeterReading

Type:SubmitMeterReading

URL:https://api.st.test-kraken.tech/v1/graphql/

Customer can submit a meter reading.

The possible errors that can be raised are:

KT-GB-6414: Meter reading could not be updated. Input not valid.
KT-CT-6422: Reading will be held.
KT-CT-6424: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (SubmitMeterReadingInputType!)

Input fields for submitting a meter reading.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

reading (ReadingType)

The submitted reading.

mutation SubmitMeterReading($input: SubmitMeterReadingInputType!) {
  submitMeterReading(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    reading {
      ...ReadingTypeFragment
    }
  }
}

{
  "input": SubmitMeterReadingInputType
}

{
  "data": {
    "submitMeterReading": {
      "possibleErrors": [PossibleErrorType],
      "reading": ReadingType
    }
  }
}

submitRepaymentRequest

Type:SubmitRepaymentRequest

URL:https://api.st.test-kraken.tech/v1/graphql/

Submit a repayment request.

The possible errors that can be raised are:

KT-CT-1132: Unauthorized.
KT-CT-3820: Received both ledger ID and number.
KT-CT-3821: Received neither ledger ID nor ledger number.
KT-CT-3927: Invalid Amount.
KT-CT-3928: Idempotency key used for another repayment request.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (RequestRepaymentInputType!)

Input fields for requesting a repayment.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

repaymentRequest (RequestRepaymentOutputType)

The newly created repayment request.

mutation SubmitRepaymentRequest($input: RequestRepaymentInputType!) {
  submitRepaymentRequest(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    repaymentRequest {
      ...RequestRepaymentOutputTypeFragment
    }
  }
}

{
  "input": RequestRepaymentInputType
}

{
  "data": {
    "submitRepaymentRequest": {
      "possibleErrors": [PossibleErrorType],
      "repaymentRequest": RequestRepaymentOutputType
    }
  }
}

switchAccountToMeasuredTariff

Type:SwitchAccountToMeasuredTariff

URL:https://api.st.test-kraken.tech/v1/graphql/

Switch an account to a measured tariff (if possible).

This field requires the Authorization header to be set.

Arguments

Name Description

input (SwitchAccountToMeasuredTariffInput!)

Input fields for switching an account to a measured tariff.

Return fields

Name Description

account (AccountType!)

Account that was switched to a measured tariff.

mutation SwitchAccountToMeasuredTariff($input: SwitchAccountToMeasuredTariffInput!) {
  switchAccountToMeasuredTariff(input: $input) {
    account {
      ...AccountTypeFragment
    }
  }
}

{
  "input": SwitchAccountToMeasuredTariffInput
}

{
  "data": {
    "switchAccountToMeasuredTariff": {
      "account": AccountType
    }
  }
}

terminateCreditTransferPermission

Type:TerminateCreditTransferPermission

URL:https://api.st.test-kraken.tech/v1/graphql/

Terminate credit transfer permission.

The possible errors that can be raised are:

KT-CT-3822: Unauthorized.
KT-CT-3825: Credit transfer permission not found.
KT-CT-3827: The ledger is not valid.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (TerminateCreditTransferPermissionInput!)

Input fields for terminating a credit transfer permission.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

validTo (DateTime)

Datetime when the credit transfer permission ends.

mutation TerminateCreditTransferPermission($input: TerminateCreditTransferPermissionInput!) {
  terminateCreditTransferPermission(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    validTo
  }
}

{
  "input": TerminateCreditTransferPermissionInput
}

{
  "data": {
    "terminateCreditTransferPermission": {
      "possibleErrors": [PossibleErrorType],
      "validTo": "2020-01-01T00:00:00.000Z"
    }
  }
}

transferLoyaltyPointsBetweenUsers

Type:TransferLoyaltyPointsBetweenUsers

URL:https://api.st.test-kraken.tech/v1/graphql/

Transfer Loyalty Point from one account user to another.

The possible errors that can be raised are:

KT-CT-1111: Unauthorized.
KT-CT-9205: Insufficient Loyalty Points.
KT-CT-9204: Negative or zero points set.
KT-CT-9208: Invalid posted at datetime.
KT-CT-9209: Negative Loyalty Points balance.
KT-CT-9210: Unhandled Loyalty Points exception.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (TransferLoyaltyPointsBetweenUsersInput!)

Input fields for transferring Loyalty Points.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

pointsTransferred (Int)

The number of loyalty points that were transferred.

mutation TransferLoyaltyPointsBetweenUsers($input: TransferLoyaltyPointsBetweenUsersInput!) {
  transferLoyaltyPointsBetweenUsers(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    pointsTransferred
  }
}

{
  "input": TransferLoyaltyPointsBetweenUsersInput
}

{
  "data": {
    "transferLoyaltyPointsBetweenUsers": {
      "possibleErrors": [PossibleErrorType],
      "pointsTransferred": 1
    }
  }
}

unlinkUserFromLine

Type:UnlinkUserFromLineResponse!

URL:https://api.st.test-kraken.tech/v1/graphql/

Unlink an account user and line together.

Return fields

Name	Description

mutation UnlinkUserFromLine {
  unlinkUserFromLine {
    ... on LineUnlinkedResponse {
      ...LineUnlinkedResponseFragment
    }
    ... on LinkTokenNotFound {
      ...LinkTokenNotFoundFragment
    }
    ... on LineCommonError {
      ...LineCommonErrorFragment
    }
  }
}

{
  "data": {
    "unlinkUserFromLine": LineUnlinkedResponse
  }
}

updateAccountAddress

Type:UpdateAccountAddress

URL:https://api.st.test-kraken.tech/v1/graphql/

Update the billing address of given account.

The possible errors that can be raised are:

KT-CT-4178: No account found with given account number.
KT-CT-4411: Address in db is structured, cannot accept unstructured address fields.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (UpdateAccountAddressInput!)

Input fields for updating billing address of account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountType)

The updated account.

viewer (AccountUserType)

The currently authenticated user.

This field requires the Authorization header to be set.

mutation UpdateAccountAddress($input: UpdateAccountAddressInput!) {
  updateAccountAddress(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

{
  "input": UpdateAccountAddressInput
}

{
  "data": {
    "updateAccountAddress": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountType,
      "viewer": AccountUserType
    }
  }
}

updateAccountBillingAddress

Type:UpdateAccountBillingAddress

URL:https://api.st.test-kraken.tech/v1/graphql/

Update the account billing address.

The possible errors that can be raised are:

KT-CT-4145: Invalid address.
KT-CT-7123: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (AccountBillingAddressInput!)

Input variables needed for updating an account billing address.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountType)

The updated account.

mutation UpdateAccountBillingAddress($input: AccountBillingAddressInput!) {
  updateAccountBillingAddress(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountTypeFragment
    }
  }
}

{
  "input": AccountBillingAddressInput
}

{
  "data": {
    "updateAccountBillingAddress": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountType
    }
  }
}

updateAccountBillingEmail

Type:UpdateAccountBillingEmail

URL:https://api.st.test-kraken.tech/v1/graphql/

Update account billing email.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-4122: Invalid email.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAccountBillingEmailInput!)

Input fields for updating billing email for an account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountInterface)

Account that was changed.

mutation UpdateAccountBillingEmail($input: UpdateAccountBillingEmailInput!) {
  updateAccountBillingEmail(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountInterfaceFragment
    }
  }
}

{
  "input": UpdateAccountBillingEmailInput
}

{
  "data": {
    "updateAccountBillingEmail": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountInterface
    }
  }
}

updateAccountConsents

Type:UpdateAccountConsents

URL:https://api.st.test-kraken.tech/v1/graphql/

Update the consents of an account

The possible errors that can be raised are:

KT-CT-9014: Duplicate consent.
KT-CT-9016: Consent management not enabled.
KT-CT-9017: Consent type not found.
KT-CT-9018: Account not found.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

accountNumber (String!)

The account number to update consents for.

consents ([ConsentInput]!)

Consents to update for account.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

consents ([ConsentType!]!)

Consents linked to this account.

mutation UpdateAccountConsents(
  $accountNumber: String!,
  $consents: [ConsentInput]!
) {
  updateAccountConsents(
    accountNumber: $accountNumber,
    consents: $consents
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    consents {
      ...ConsentTypeFragment
    }
  }
}

{
  "accountNumber": "abc123",
  "consents": ConsentInput
}

{
  "data": {
    "updateAccountConsents": {
      "possibleErrors": [PossibleErrorType],
      "consents": ConsentType
    }
  }
}

updateAccountReference

Type:UpdateAccountReference

URL:https://api.st.test-kraken.tech/v1/graphql/

Update an account reference.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-8310: Invalid data.
KT-CT-8311: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (AccountReferenceInput!)

Input fields for updating an account reference.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountReference (AccountReferenceType)

mutation UpdateAccountReference($input: AccountReferenceInput!) {
  updateAccountReference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountReference {
      ...AccountReferenceTypeFragment
    }
  }
}

{
  "input": AccountReferenceInput
}

{
  "data": {
    "updateAccountReference": {
      "possibleErrors": [PossibleErrorType],
      "accountReference": AccountReferenceType
    }
  }
}

updateAccountUserConsents

Type:UpdateAccountUserConsents

URL:https://api.st.test-kraken.tech/v1/graphql/

Update the consents of an account user (the authenticated user)

The possible errors that can be raised are:

KT-CT-9014: Duplicate consent.
KT-CT-9016: Consent management not enabled.
KT-CT-9017: Consent type not found.
KT-CT-1111: Unauthorized.
KT-CT-5421: Account user not found.
KT-CT-5422: Invalid data.
KT-CT-1605: Invalid input.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

consents ([ConsentTypeInput])

Consents to update for account user.

userNumber (String)

User number of the account user to update consents for. Only needed if the viewer is an organization.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

accountUserConsents (AccountUserConsents)

All the consents for an account user.

mutation UpdateAccountUserConsents(
  $consents: [ConsentTypeInput],
  $userNumber: String
) {
  updateAccountUserConsents(
    consents: $consents,
    userNumber: $userNumber
  ) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    accountUserConsents {
      ...AccountUserConsentsFragment
    }
  }
}

{
  "consents": ConsentTypeInput,
  "userNumber": "abc123"
}

{
  "data": {
    "updateAccountUserConsents": {
      "possibleErrors": [PossibleErrorType],
      "accountUserConsents": AccountUserConsents
    }
  }
}

updateActivePurchase

Type:UpdateActivePurchase

URL:https://api.st.test-kraken.tech/v1/graphql/

Update an active purchase.

The possible errors that can be raised are:

KT-CT-8225: Received an invalid purchaseId.
KT-CT-8226: The provided purchase is not active.
KT-CT-8206: Invalid data.
KT-CT-8227: Available grants could not be applied.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdatePurchaseInput!)

Input fields for updating an active purchase.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

goodsPurchase (GoodsPurchase)

Goods purchase updated.

mutation UpdateActivePurchase($input: UpdatePurchaseInput!) {
  updateActivePurchase(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    goodsPurchase {
      ...GoodsPurchaseFragment
    }
  }
}

{
  "input": UpdatePurchaseInput
}

{
  "data": {
    "updateActivePurchase": {
      "possibleErrors": [PossibleErrorType],
      "goodsPurchase": GoodsPurchase
    }
  }
}

updateAutoTopUpAmount

Type:UpdateAutoTopUpAmount

URL:https://api.st.test-kraken.tech/v1/graphql/

Change the auto top up amount for the payment schedule.

The possible errors that can be raised are:

KT-CT-3815: No active payment schedule found for this account.
KT-CT-3941: Invalid data.
KT-CT-3942: An unexpected error occurred.
KT-CT-3947: An unexpected error occurred.
KT-CT-3953: The payment schedule is not a balance triggered schedule.
KT-CT-3820: Received both ledger ID and number.
KT-CT-3821: Received neither ledger ID nor ledger number.
KT-CT-3822: Unauthorized.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAutoTopUpAmountInput!)

Input fields for updating the auto-top-up amount for a schedule.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

schedule (PaymentScheduleType)

The new schedule created.

mutation UpdateAutoTopUpAmount($input: UpdateAutoTopUpAmountInput!) {
  updateAutoTopUpAmount(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    schedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

{
  "input": UpdateAutoTopUpAmountInput
}

{
  "data": {
    "updateAutoTopUpAmount": {
      "possibleErrors": [PossibleErrorType],
      "schedule": PaymentScheduleType
    }
  }
}

updateBlackholeEmail

Type:UpdateBlackholeEmail

URL:https://api.st.test-kraken.tech/v1/graphql/

Update the email address of an account user that currently has a blackhole email.

The possible errors that can be raised are:

KT-GB-5412: User already has an email address.
KT-GB-5413: Invalid inputs for updating a blackhole email.
KT-CT-1133: Unable to request password reset email.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateBlackholeEmailInput!)

Input fields for assigning email address to an account user.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

blackholeEmailAccountUser (BlackholeEmailAccountUserType)

Details of an account user who has updated their blackhole email.

blackholeEmailAccount (BlackholeEmailAccountType)

Details of an account of an account user updating their blackhole email.

mutation UpdateBlackholeEmail($input: UpdateBlackholeEmailInput!) {
  updateBlackholeEmail(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    blackholeEmailAccountUser {
      ...BlackholeEmailAccountUserTypeFragment
    }
    blackholeEmailAccount {
      ...BlackholeEmailAccountTypeFragment
    }
  }
}

{
  "input": UpdateBlackholeEmailInput
}

{
  "data": {
    "updateBlackholeEmail": {
      "possibleErrors": [PossibleErrorType],
      "blackholeEmailAccountUser": BlackholeEmailAccountUserType,
      "blackholeEmailAccount": BlackholeEmailAccountType
    }
  }
}

updateCommsDeliveryPreference

Type:UpdateCommsDeliveryPreference

URL:https://api.st.test-kraken.tech/v1/graphql/

Update account communication delivery preference.

The possible errors that can be raised are:

KT-CT-4123: Unauthorized.
KT-CT-4136: Cannot set comms preference to email when account has no email.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateCommsDeliveryPreferenceInput!)

Input fields for updating comms delivery preferences for an account

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

account (AccountInterface)

mutation UpdateCommsDeliveryPreference($input: UpdateCommsDeliveryPreferenceInput!) {
  updateCommsDeliveryPreference(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    account {
      ...AccountInterfaceFragment
    }
  }
}

{
  "input": UpdateCommsDeliveryPreferenceInput
}

{
  "data": {
    "updateCommsDeliveryPreference": {
      "possibleErrors": [PossibleErrorType],
      "account": AccountInterface
    }
  }
}

updateCommsPreferences

Type:UpdateAccountUserCommsPreferencesMutation

URL:https://api.st.test-kraken.tech/v1/graphql/

Update the comms preferences of the account user (the authenticated user).

The possible errors that can be raised are:

KT-GB-5414: The given preferences are not valid.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateAccountUserCommsPreferencesInput!)

Input fields for updating an account user's comms preferences.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

commsPreferences (AccountUserCommsPreferencesType)

Details of comms preferences set up for a user.

mutation UpdateCommsPreferences($input: UpdateAccountUserCommsPreferencesInput!) {
  updateCommsPreferences(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    commsPreferences {
      ...AccountUserCommsPreferencesTypeFragment
    }
  }
}

{
  "input": UpdateAccountUserCommsPreferencesInput
}

{
  "data": {
    "updateCommsPreferences": {
      "possibleErrors": [PossibleErrorType],
      "commsPreferences": AccountUserCommsPreferencesType
    }
  }
}

updateEmailAndPassword

Type:UpdateEmailAndPassword

URL:https://api.st.test-kraken.tech/v1/graphql/

Update the email address and password of an account user.

The possible errors that can be raised are:

KT-CT-5413: Invalid data.
KT-CT-5414: Invalid data.
KT-CT-5450: Password is invalid.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateEmailAndPasswordInput!)

Input fields to update email and password.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

success (Boolean)

Whether the sign up was successful.

mutation UpdateEmailAndPassword($input: UpdateEmailAndPasswordInput!) {
  updateEmailAndPassword(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    success
  }
}

{
  "input": UpdateEmailAndPasswordInput
}

{
  "data": {
    "updateEmailAndPassword": {
      "possibleErrors": [PossibleErrorType],
      "success": true
    }
  }
}

updateMetadata

Type:UpdateMetadata

URL:https://api.st.test-kraken.tech/v1/graphql/

Update metadata on an object.

The possible errors that can be raised are:

KT-CT-4323: Unauthorized.
KT-CT-8413: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (MetadataInput!)

Input fields for updating metadata.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

metadata (Metadata)

mutation UpdateMetadata($input: MetadataInput!) {
  updateMetadata(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    metadata {
      ...MetadataFragment
    }
  }
}

{
  "input": MetadataInput
}

{
  "data": {
    "updateMetadata": {
      "possibleErrors": [PossibleErrorType],
      "metadata": Metadata
    }
  }
}

updateNumberOfOccupants

Type:UpdateNumberOfOccupants

URL:https://api.st.test-kraken.tech/v1/graphql/

Update number of occupants for a property.

The possible errors that can be raised are:

KT-CT-6628: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (UpdateNumberOfOccupantsInput!)

Input fields for updating property details.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

propertyId (ID!)

Property id.

mutation UpdateNumberOfOccupants($input: UpdateNumberOfOccupantsInput!) {
  updateNumberOfOccupants(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    propertyId
  }
}

{
  "input": UpdateNumberOfOccupantsInput
}

{
  "data": {
    "updateNumberOfOccupants": {
      "possibleErrors": [PossibleErrorType],
      "propertyId": "abc123"
    }
  }
}

updatePassword

Type:UpdatePassword

URL:https://api.st.test-kraken.tech/v1/graphql/

Update password of the authenticated user

This field requires the Authorization header to be set.

Arguments

Name Description

input (UpdatePasswordInput)

Return fields

Name Description

viewer (AccountUserType)

The currently authenticated user.

This field requires the Authorization header to be set.

mutation UpdatePassword($input: UpdatePasswordInput) {
  updatePassword(input: $input) {
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

{
  "input": UpdatePasswordInput
}

{
  "data": {
    "updatePassword": {
      "viewer": AccountUserType
    }
  }
}

updatePaymentSchedule

Type:UpdatePaymentSchedule

URL:https://api.st.test-kraken.tech/v1/graphql/

Update a payment schedule for an account.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-CT-1128: Unauthorized.
KT-CT-3966: Payment schedule does not exist.
KT-CT-3942: An unexpected error occurred.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdatePaymentScheduleInput!)

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

paymentSchedule (PaymentScheduleType!)

The updated payment schedule.

mutation UpdatePaymentSchedule($input: UpdatePaymentScheduleInput!) {
  updatePaymentSchedule(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    paymentSchedule {
      ...PaymentScheduleTypeFragment
    }
  }
}

{
  "input": UpdatePaymentScheduleInput
}

{
  "data": {
    "updatePaymentSchedule": {
      "possibleErrors": [PossibleErrorType],
      "paymentSchedule": PaymentScheduleType
    }
  }
}

updatePropertyType

Type:UpdatePropertyType

URL:https://api.st.test-kraken.tech/v1/graphql/

Update the property type of a property.

The possible errors that can be raised are:

KT-GB-5418: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (UpdatePropertyTypeInput!)

Input fields for updating property details.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

propertyId (ID!)

Property id.

mutation UpdatePropertyType($input: UpdatePropertyTypeInput!) {
  updatePropertyType(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    propertyId
  }
}

{
  "input": UpdatePropertyTypeInput
}

{
  "data": {
    "updatePropertyType": {
      "possibleErrors": [PossibleErrorType],
      "propertyId": "abc123"
    }
  }
}

updateUser

Type:UpdateUserMutation

URL:https://api.st.test-kraken.tech/v1/graphql/

Update the account user details of the authenticated user.

Only one name field can be updated per day, other fields can be updated freely. This prevents users from switching accounts to someone else (usually when moving homes). All account changes should be handled by operations or the move out journey. New customers are exempt from this rule for the first 31 days.

This field requires the Authorization header to be set.

The possible errors that can be raised are:

KT-CT-5413: Invalid data.
KT-CT-5414: Invalid data.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-1111: Unauthorized.
KT-CT-1112: 'Authorization' header not provided.

Arguments

Name Description

input (UpdateUserInput!)

Input fields for updating user.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

viewer (AccountUserType)

mutation UpdateUser($input: UpdateUserInput!) {
  updateUser(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    viewer {
      ...AccountUserTypeFragment
    }
  }
}

{
  "input": UpdateUserInput
}

{
  "data": {
    "updateUser": {
      "possibleErrors": [PossibleErrorType],
      "viewer": AccountUserType
    }
  }
}

updateUserDetails

Type:UpdateAccountUserMutationPayload

URL:https://api.st.test-kraken.tech/v1/graphql/

DEPRECATED: Please use updateUser instead

Update the account user details of the authenticated user. Only one field can be updated per day. This prevents users from switching accounts to someone else (usually when moving homes) All account changes should be handled by operations or the move out journey. New customers are exempt from this rule for the first 31 days.

Deprecated

The 'updateUserDetails' field is deprecated.

Please use the 'updateUser' mutation instead.

- Marked as deprecated on 2020-10-02.
- Scheduled for removal on or after 2023-04-06.

Arguments

Name Description

input (UpdateAccountUserMutationInput!)

Return fields

Name	Description
`givenName` (`String`)
`familyName` (`String`)
`pronouns` (`String`)
`mobile` (`String`)
`email` (`String`)
`dateOfBirth` (`Date`)
`landline` (`String`)
`errors` (`[ErrorType]`)
`clientMutationId` (`String`)

mutation UpdateUserDetails($input: UpdateAccountUserMutationInput!) {
  updateUserDetails(input: $input) {
    givenName
    familyName
    pronouns
    mobile
    email
    dateOfBirth
    landline
    errors {
      ...ErrorTypeFragment
    }
    clientMutationId
  }
}

{
  "input": UpdateAccountUserMutationInput
}

{
  "data": {
    "updateUserDetails": {
      "givenName": "abc123",
      "familyName": "abc123",
      "pronouns": "abc123",
      "mobile": "abc123",
      "email": "abc123",
      "dateOfBirth": "2020-01-01",
      "landline": "abc123",
      "errors": [ErrorType],
      "clientMutationId": "abc123"
    }
  }
}

verifyIdentity

Type:VerifyIdentity

URL:https://api.st.test-kraken.tech/v1/graphql/

Provide identifying information about an account and user to get a scoped token that will permit access to associate an email address with the account’s user.

The possible errors that can be raised are:

KT-CT-1145: Account/user details do not match.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (VerifyIdentityInput!)

Details about the user to be verified.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

token (String!)

An expiring token that can be used to request to update the user's email address.

mutation VerifyIdentity($input: VerifyIdentityInput!) {
  verifyIdentity(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token
  }
}

{
  "input": VerifyIdentityInput
}

{
  "data": {
    "verifyIdentity": {
      "possibleErrors": [PossibleErrorType],
      "token": "abc123"
    }
  }
}

verifyIdentityFallback

Type:VerifyIdentityFallback

URL:https://api.st.test-kraken.tech/v1/graphql/

Verify the identity of a user by checking their family name, first line of address and postcode. This is a fallback mutation that should only be used if the user does not have an account number or account user ID.

The possible errors that can be raised are:

KT-CT-1145: Account/user details do not match.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (VerifyIdentityFallbackInput!)

Details about the user to be verified.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

token (String!)

An expiring token that can be used to request to update the user's email address.

mutation VerifyIdentityFallback($input: VerifyIdentityFallbackInput!) {
  verifyIdentityFallback(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    token
  }
}

{
  "input": VerifyIdentityFallbackInput
}

{
  "data": {
    "verifyIdentityFallback": {
      "possibleErrors": [PossibleErrorType],
      "token": "abc123"
    }
  }
}

Authentication Server

createMfaDevice

Type:CreateMfaDevice

URL:https://auth.st.test-kraken.tech/graphql/

Create MFA Device for user.

The possible errors that can be raised are:

KT-CT-1128: Unauthorized.
KT-CT-1153: Unable to create MFA device.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (CreateMfaDeviceInputType!)

Input fields for creating a new multi-factor authentication device for the logged user.

Return fields

Name	Description
`possibleErrors` (`[PossibleErrorType]`)	Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. Please use the 'possibleErrors' query or the 'X-Possible-Errors' header instead. - Marked as deprecated on 2025-01-31. - Scheduled for removal on or after 2025-03-01.
`deviceEmail` (`String`)	Email address to send the MFA code by default.
`devicePhone` (`String`)	Phone number to send the MFA code by default.
`totpSecret` (`String`)	Secret to setup Time-based One-Time Passwords (TOTP) in your authenticator or password manager manually.

mutation CreateMfaDevice($input: CreateMfaDeviceInputType!) {
  createMfaDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    deviceEmail
    devicePhone
    totpSecret
  }
}

{
  "input": CreateMfaDeviceInputType
}

{
  "data": {
    "createMfaDevice": {
      "possibleErrors": [PossibleErrorType],
      "deviceEmail": "abc123",
      "devicePhone": "abc123",
      "totpSecret": "abc123"
    }
  }
}

deleteMfaDevice

Type:DeleteMfaDevice

URL:https://auth.st.test-kraken.tech/graphql/

Delete MFA Device for user.

The possible errors that can be raised are:

KT-CT-1150: MFA device not found.
KT-CT-1154: Unable to delete MFA device.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (DeleteMfaDeviceInputType!)

Input fields for deleting an existing multi-factor authentication device for the logged user.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

deviceDeleted (Boolean)

Flag to indicate if the MFA device has been successfully deleted.

mutation DeleteMfaDevice($input: DeleteMfaDeviceInputType!) {
  deleteMfaDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    deviceDeleted
  }
}

{
  "input": DeleteMfaDeviceInputType
}

{
  "data": {
    "deleteMfaDevice": {
      "possibleErrors": [PossibleErrorType],
      "deviceDeleted": true
    }
  }
}

validateMfaDevice

Type:ValidateMfaDevice

URL:https://auth.st.test-kraken.tech/graphql/

Validate MFA Device for user.

The possible errors that can be raised are:

KT-CT-1150: MFA device not found.
KT-CT-1151: MFA device not found.
KT-CT-1152: Invalid MFA token.
KT-CT-1155: Enabled backup device is needed.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (ValidateMfaDeviceInputType!)

Input fields for validating a new multi-factor authentication device for the logged user.

Return fields

Name Description

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

deviceIsValid (Boolean)

Flag to indicate if the device has been verified, so it can be used for MFA.

mutation ValidateMfaDevice($input: ValidateMfaDeviceInputType!) {
  validateMfaDevice(input: $input) {
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
    deviceIsValid
  }
}

{
  "input": ValidateMfaDeviceInputType
}

{
  "data": {
    "validateMfaDevice": {
      "possibleErrors": [PossibleErrorType],
      "deviceIsValid": true
    }
  }
}

Mutations

API Site

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation

Variables

Response

Arguments

Return fields

Mutation