About Mutations
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.esbsc-kraken.systems/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 |
|---|---|
| Input fields for accepting a quote. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods purchase created. |
Mutation
mutation AcceptGoodsQuote($input: AcceptGoodsQuoteInput!) {
acceptGoodsQuote(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
goodsPurchase {
...GoodsPurchaseFragment
}
}
}Variables
{
"input": AcceptGoodsQuoteInput
}Response
{
"data": {
"acceptGoodsQuote": {
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}
}
}acceptOfferForQuoting
URL:https://api.esbsc-kraken.systems/v1/graphql/
Accept a quoting offer in an offer group.
The possible errors that can be raised are:
- KT-CT-12402: Unable to accept offer.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields for accepting a quoting offer. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Accepted quoting offer. |
Mutation
mutation AcceptOfferForQuoting($input: AcceptOfferForQuotingInput!) {
acceptOfferForQuoting(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
offer {
...OfferTypeFragment
}
}
}Variables
{
"input": AcceptOfferForQuotingInput
}Response
{
"data": {
"acceptOfferForQuoting": {
"possibleErrors": [PossibleErrorType],
"offer": OfferType
}
}
}addCampaignToAccount
Type:AddCampaignToAccount
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
| Input variables needed for adding a campaign to an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the campaign was successfully added. |
Mutation
mutation AddCampaignToAccount($input: AddCampaignToAccountInput!) {
addCampaignToAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
campaignAdded
}
}Variables
{
"input": AddCampaignToAccountInput
}Response
{
"data": {
"addCampaignToAccount": {
"possibleErrors": [PossibleErrorType],
"campaignAdded": true
}
}
}addProperty
Type:AddProperty
URL:https://api.esbsc-kraken.systems/v1/graphql/
Add a property to an account.
The possible errors that can be raised are:
- KT-CT-6623: Unauthorized.
- KT-CT-6629: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for adding a property to an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The property that was added to the account. |
Mutation
mutation AddProperty($input: AddPropertyInput!) {
addProperty(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
property {
...PropertyTypeFragment
}
}
}Variables
{
"input": AddPropertyInput
}Response
{
"data": {
"addProperty": {
"possibleErrors": [PossibleErrorType],
"property": PropertyType
}
}
}amendPayment
Type:AmendPayment
URL:https://api.esbsc-kraken.systems/v1/graphql/
Amend an existing payment.
The possible errors that can be raised are:
- KT-CT-3924: Unauthorized.
- KT-CT-4123: Unauthorized.
- KT-CT-3970: The account cannot amend payments.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for amending an existing payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation AmendPayment($input: AmendPaymentInput!) {
amendPayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...AccountPaymentTypeFragment
}
}
}Variables
{
"input": AmendPaymentInput
}Response
{
"data": {
"amendPayment": {
"possibleErrors": [PossibleErrorType],
"payment": AccountPaymentType
}
}
}backendScreenEvent
Type:BackendScreenEvent
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
| Input fields for performing a backend action. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| An action to perform. |
Mutation
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
}
}
}
}Variables
{
"input": BackendScreenEventInput
}Response
{
"data": {
"backendScreenEvent": {
"possibleErrors": [PossibleErrorType],
"action": DeeplinkActionType
}
}
}cancelEnrollment
Type:EnrollmentCancelled!
URL:https://api.esbsc-kraken.systems/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-10331: Missing required process number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation CancelEnrollment($input: CancelEnrollmentInput!) {
cancelEnrollment(input: $input) {
message
enrollmentProcess {
... on JoinSupplierProcessType {
...JoinSupplierProcessTypeFragment
}
... on OccupyPropertyProcessType {
...OccupyPropertyProcessTypeFragment
}
}
}
}Variables
{
"input": CancelEnrollmentInput
}Response
{
"data": {
"cancelEnrollment": {
"message": "abc123",
"enrollmentProcess": JoinSupplierProcessType
}
}
}cancelRepaymentRequest
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
| Input fields for cancelling a repayment request. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The cancelled repayment/refund request. |
Mutation
mutation CancelRepaymentRequest($input: CancelRepaymentRequestInputType!) {
cancelRepaymentRequest(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
repaymentRequest {
...CancelRepaymentRequestOutputTypeFragment
}
}
}Variables
{
"input": CancelRepaymentRequestInputType
}Response
{
"data": {
"cancelRepaymentRequest": {
"possibleErrors": [PossibleErrorType],
"repaymentRequest": CancelRepaymentRequestOutputType
}
}
}collectPayment
Type:CollectPayment
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
| Input fields for collecting a payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| 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
mutation CollectPayment($input: CollectPaymentInput!) {
collectPayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...AccountPaymentTypeFragment
}
}
}Variables
{
"input": CollectPaymentInput
}Response
{
"data": {
"collectPayment": {
"possibleErrors": [PossibleErrorType],
"payment": AccountPaymentType
}
}
}completeStandalonePayment
Type:CompleteStandalonePayment
URL:https://api.esbsc-kraken.systems/v1/graphql/
Complete a standalone payment.
The possible errors that can be raised are:
- KT-CT-3822: Unauthorized.
- KT-CT-3823: Unauthorized.
- KT-CT-3974: Unauthorized.
- KT-CT-3975: Unable to complete standalone payment.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for completing a standalone payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The completed standalone payment. |
Mutation
mutation CompleteStandalonePayment($input: CompleteStandalonePaymentInput!) {
completeStandalonePayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...CompleteStandalonePaymentOutputFragment
}
}
}Variables
{
"input": CompleteStandalonePaymentInput
}Response
{
"data": {
"completeStandalonePayment": {
"possibleErrors": [PossibleErrorType],
"payment": CompleteStandalonePaymentOutput
}
}
}confirmDoubleOptIn
Type:ConfirmDoubleOptIn
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The consent that was created or updated. |
Mutation
mutation ConfirmDoubleOptIn($input: ConfirmDoubleOptInInput) {
confirmDoubleOptIn(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
consent {
...ConsentTypeFragment
}
}
}Variables
{
"input": ConfirmDoubleOptInInput
}Response
{
"data": {
"confirmDoubleOptIn": {
"possibleErrors": [PossibleErrorType],
"consent": ConsentType
}
}
}createAccountPaymentSchedule
Type:CreateAccountPaymentSchedule
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
Input fields for updating a payment schedule. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| New payment schedule. |
Mutation
mutation CreateAccountPaymentSchedule($input: CreateAccountPaymentScheduleInput!) {
createAccountPaymentSchedule(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
schedule {
...PaymentScheduleTypeFragment
}
}
}Variables
{
"input": CreateAccountPaymentScheduleInput
}Response
{
"data": {
"createAccountPaymentSchedule": {
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}
}
}createAccountReference
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
| Input fields for creating an account reference. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation CreateAccountReference($input: AccountReferenceInput!) {
createAccountReference(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountReference {
...AccountReferenceTypeFragment
}
}
}Variables
{
"input": AccountReferenceInput
}Response
{
"data": {
"createAccountReference": {
"possibleErrors": [PossibleErrorType],
"accountReference": AccountReferenceType
}
}
}createComplaint
Type:CreateComplaint
URL:https://api.esbsc-kraken.systems/v1/graphql/
Create a complaint.
The possible errors that can be raised are:
- KT-CT-10801: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The complaint that has been created. |
Mutation
mutation CreateComplaint($complaint: CreateComplaintInputType!) {
createComplaint(complaint: $complaint) {
possibleErrors {
...PossibleErrorTypeFragment
}
complaint {
...ComplaintTypeFragment
}
}
}Variables
{
"complaint": CreateComplaintInputType
}Response
{
"data": {
"createComplaint": {
"possibleErrors": [PossibleErrorType],
"complaint": ComplaintType
}
}
}createContributionAgreement
Type:CreateContributionAgreement
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
Input variables needed for creating a contribution agreement on an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created contribution agreement. |
Mutation
mutation CreateContributionAgreement($input: CreateContributionAgreementInput!) {
createContributionAgreement(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
contributionAgreement {
...ContributionAgreementTypeFragment
}
}
}Variables
{
"input": CreateContributionAgreementInput
}Response
{
"data": {
"createContributionAgreement": {
"possibleErrors": [PossibleErrorType],
"contributionAgreement": ContributionAgreementType
}
}
}createCreditTransferPermission
Type:CreateCreditTransferPermission
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
Input fields to create a credit transfer permission. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Datetime when the credit transfer permission is valid. |
Mutation
mutation CreateCreditTransferPermission($input: CreateCreditTransferPermissionInput!) {
createCreditTransferPermission(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
validFrom
}
}Variables
{
"input": CreateCreditTransferPermissionInput
}Response
{
"data": {
"createCreditTransferPermission": {
"possibleErrors": [PossibleErrorType],
"validFrom": "2020-01-01T00:00:00.000Z"
}
}
}createCustomerFeedback
URL:https://api.esbsc-kraken.systems/v1/graphql/
Create unsubmitted customer feedback object.
The possible errors that can be raised are:
- KT-CT-5516: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created customer feedback object. |
Mutation
mutation CreateCustomerFeedback($input: CreateCustomerFeedbackInputType!) {
createCustomerFeedback(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
customerFeedback {
...CustomerFeedbackTypeFragment
}
}
}Variables
{
"input": CreateCustomerFeedbackInputType
}Response
{
"data": {
"createCustomerFeedback": {
"possibleErrors": [PossibleErrorType],
"customerFeedback": CustomerFeedbackType
}
}
}createEnergyAccount
Type:CreateEnergyAccount
URL:https://api.esbsc-kraken.systems/v1/graphql/
Create an account for either electricity or dual fuel.
The possible errors that can be raised are:
- KT-CT-4910: No product exists with the given input.
- KT-CT-4911: Product not available.
- KT-ES-4117: Invalid data.
- KT-ES-4111: Supply point already exists.
- KT-ES-4113: ATR not valid for contracting.
- KT-ES-7701: The affiliate client failed to meet the requirements.
- KT-ES-4121: Gas tariffs are not available.
- KT-ES-4102: Account with multiple properties.
- KT-ES-4122: Unable to create a referral.
- KT-ES-4123: Nif not found.
- KT-ES-4914: The received CUPS is invalid.
- KT-ES-7819: The request to Chipiron to get SIPS data failed.
- KT-ES-4917: The given supply point is not valid to contract.
- KT-CT-7899: An internal error occurred.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Customer's Spanish fiscal code. |
| The account number. |
| Electricity supply point agreement number. |
| Gas supply point agreement number. |
| Token for setting the initial password. |
| Id for setting the initial password. |
| Resolves whether a referral was created as part of this account creation. |
Mutation
mutation CreateEnergyAccount($input: CreateEnergyAccountInput) {
createEnergyAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountNif
accountNumber
electricityAgreementNumber
gasAgreementNumber
token
userId
referralCreated
}
}Variables
{
"input": CreateEnergyAccountInput
}Response
{
"data": {
"createEnergyAccount": {
"possibleErrors": [PossibleErrorType],
"accountNif": "abc123",
"accountNumber": "abc123",
"electricityAgreementNumber": "abc123",
"gasAgreementNumber": "abc123",
"token": "abc123",
"userId": "abc123",
"referralCreated": true
}
}
}createFormSubmission
Type:FormSubmissionOuput
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| |
| |
|
Mutation
mutation CreateFormSubmission($input: FormSubmissionInput!) {
createFormSubmission(input: $input) {
id
content
errors {
...SerializerFieldErrorsTypeFragment
}
}
}Variables
{
"input": FormSubmissionInput
}Response
{
"data": {
"createFormSubmission": {
"id": 1,
"content": {"key": "value"},
"errors": [SerializerFieldErrorsType]
}
}
}createGoodsPurchase
Type:CreateGoodsPurchase
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
| Input fields for creating a purchase without a quote. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods purchase created. |
Mutation
mutation CreateGoodsPurchase($input: CreatePurchaseInput!) {
createGoodsPurchase(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
goodsPurchase {
...GoodsPurchaseFragment
}
}
}Variables
{
"input": CreatePurchaseInput
}Response
{
"data": {
"createGoodsPurchase": {
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}
}
}createGoodsQuote
Type:CreateGoodsQuote
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
| Input fields for creating a goods quote. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods quote created for the customer. |
Mutation
mutation CreateGoodsQuote($input: CreateGoodsQuoteInput!) {
createGoodsQuote(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
goodsQuote {
...GoodsQuoteFragment
}
}
}Variables
{
"input": CreateGoodsQuoteInput
}Response
{
"data": {
"createGoodsQuote": {
"possibleErrors": [PossibleErrorType],
"goodsQuote": GoodsQuote
}
}
}createGoodsQuoteWithoutAccount
Type:CreateGoodsQuoteWithoutAccount
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
Input fields for creating a goods quote without an existing account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods quote created for the customer. |
Mutation
mutation CreateGoodsQuoteWithoutAccount($input: CreateGoodsQuoteWithoutAccountInput!) {
createGoodsQuoteWithoutAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
goodsQuote {
...GoodsQuoteFragment
}
}
}Variables
{
"input": CreateGoodsQuoteWithoutAccountInput
}Response
{
"data": {
"createGoodsQuoteWithoutAccount": {
"possibleErrors": [PossibleErrorType],
"goodsQuote": GoodsQuote
}
}
}createMfaDevice
Type:CreateMfaDevice
URL:https://api.esbsc-kraken.systems/v1/graphql/
Create MFA Device for user.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-1151: MFA device not found.
- KT-CT-1153: Unable to create MFA device.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a new multi-factor authentication device for the logged user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Email address to send the MFA code by default. |
| Phone number to send the MFA code by default. |
| Secret to setup Time-based One-Time Passwords (TOTP) in your authenticator or password manager manually. |
Mutation
mutation CreateMfaDevice($input: CreateMfaDeviceInputType!) {
createMfaDevice(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
deviceEmail
devicePhone
totpSecret
}
}Variables
{
"input": CreateMfaDeviceInputType
}Response
{
"data": {
"createMfaDevice": {
"possibleErrors": [PossibleErrorType],
"deviceEmail": "abc123",
"devicePhone": "abc123",
"totpSecret": "abc123"
}
}
}createNewAgreementFromProductSwitchProcess
Type:CreateNewAgreementFromProductSwitchProcess
URL:https://api.esbsc-kraken.systems/v1/graphql/
Create a new agreement from an existing product switch process.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4924: Unauthorized.
- KT-CT-1509: Unable to create agreement.
- KT-CT-1507: Agreement product switch date is not within the acceptable range.
- KT-CT-1510: Product switch process not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Validate the product switch flow data andcreates a ProcessSwitchProcess model. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The new agreement created. |
Mutation
mutation CreateNewAgreementFromProductSwitchProcess($input: CreateNewAgreementFromProductSwitchProcessInput!) {
createNewAgreementFromProductSwitchProcess(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
agreement {
...CommonAgreementTypeFragment
}
}
}Variables
{
"input": CreateNewAgreementFromProductSwitchProcessInput
}Response
{
"data": {
"createNewAgreementFromProductSwitchProcess": {
"possibleErrors": [PossibleErrorType],
"agreement": CommonAgreementType
}
}
}createOfferGroupForQuoting
Type:CreateOfferGroupForQuoting
URL:https://api.esbsc-kraken.systems/v1/graphql/
Create a quoting Offer Group.
The possible errors that can be raised are:
- KT-CT-12401: Unable to create offer group.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
| Input fields for creating an offer group from a list of offers. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Quoting offer group. |
Mutation
mutation CreateOfferGroupForQuoting($input: CreateOfferGroupForQuotingInput!) {
createOfferGroupForQuoting(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
offerGroup {
...OfferGroupTypeFragment
}
}
}Variables
{
"input": CreateOfferGroupForQuotingInput
}Response
{
"data": {
"createOfferGroupForQuoting": {
"possibleErrors": [PossibleErrorType],
"offerGroup": OfferGroupType
}
}
}createReferral
Type:CreateReferral
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
| Input fields for creating a referral. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The reward amount to be issued to the referred account, in smallest currency subunits. |
Mutation
mutation CreateReferral($input: CreateReferralInput!) {
createReferral(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
referredAccountRewardAmount
}
}Variables
{
"input": CreateReferralInput
}Response
{
"data": {
"createReferral": {
"possibleErrors": [PossibleErrorType],
"referredAccountRewardAmount": 1
}
}
}createSolarWalletRelationship
Type:CreateSolarWalletRelationship
URL:https://api.esbsc-kraken.systems/v1/graphql/
Create solar wallet sharing credit between a solar wallet credit ledger and spain electricity ledger.
The possible errors that can be raised are:
- KT-ES-7805: The request to create a solar wallet sharing credit between ledgers was incomplete or malformed.
- KT-CT-4123: Unauthorized.
- KT-ES-4116: Account not found.
- KT-ES-7809: There is no ledger of this type on this account..
- KT-ES-7806: Couldn't create sharing credit between ledgers because credit sharing ledger already exist.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Deprecated
The 'createSolarWalletRelationship' field is deprecated.
Use 'createCreditTransferPermission' mutation instead.
- Marked as deprecated on 2025-02-10.
- Scheduled for removal on or after 2025-08-10.
Arguments
| Name | Description |
|---|---|
Input fields for creating a solar wallet sharing credit between ledgers. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| A flag that ensures changes have been made. |
| Source account number of the solar wallet ledger. |
| Target account number of the electricity ledger. |
| Datetime when the solar wallet credit sharing ledger begins. |
| Datetime when the solar wallet credit sharing ledger ends. |
| Target account given name. |
| Credit sharing ledgers id. |
Mutation
mutation CreateSolarWalletRelationship($input: CreateSolarWalletRelationshipType!) {
createSolarWalletRelationship(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
sourceAccountNumber
targetAccountNumber
validFrom
validTo
targetGivenName
creditSharingLedgerId
}
}Variables
{
"input": CreateSolarWalletRelationshipType
}Response
{
"data": {
"createSolarWalletRelationship": {
"possibleErrors": [PossibleErrorType],
"success": true,
"sourceAccountNumber": "abc123",
"targetAccountNumber": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"targetGivenName": "abc123",
"creditSharingLedgerId": 1
}
}
}deleteMfaDevice
Type:DeleteMfaDevice
URL:https://api.esbsc-kraken.systems/v1/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.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for deleting an existing multi-factor authentication device for the logged user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Flag to indicate if the MFA device has been successfully deleted. |
Mutation
mutation DeleteMfaDevice($input: DeleteMfaDeviceInputType!) {
deleteMfaDevice(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
deviceDeleted
}
}Variables
{
"input": DeleteMfaDeviceInputType
}Response
{
"data": {
"deleteMfaDevice": {
"possibleErrors": [PossibleErrorType],
"deviceDeleted": true
}
}
}deletePushNotificationBinding
Type:DeletePushNotificationBinding
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
Input fields for deleting a push notification binding. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation DeletePushNotificationBinding($input: DeletePushNotificationBindingInput!) {
deletePushNotificationBinding(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
status
}
}Variables
{
"input": DeletePushNotificationBindingInput
}Response
{
"data": {
"deletePushNotificationBinding": {
"possibleErrors": [PossibleErrorType],
"status": "SUCCESSFUL"
}
}
}endContributionAgreement
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
| Input variables needed for ending a contribution agreement on an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created contribution agreement. |
Mutation
mutation EndContributionAgreement($input: EndContributionAgreementInput!) {
endContributionAgreement(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
contributionAgreement {
...ContributionAgreementTypeFragment
}
}
}Variables
{
"input": EndContributionAgreementInput
}Response
{
"data": {
"endContributionAgreement": {
"possibleErrors": [PossibleErrorType],
"contributionAgreement": ContributionAgreementType
}
}
}enrollAccountInLoyaltyProgram
Type:EnrollAccountInLoyaltyProgram
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
The account number to enroll in the loyalty program. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Outcome of the loyalty points campaign enrollment. |
Mutation
mutation EnrollAccountInLoyaltyProgram($input: EnrollAccountInLoyaltyProgramInput!) {
enrollAccountInLoyaltyProgram(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
outcome {
...EnrollAccountInLoyaltyProgramOutcomeFragment
}
}
}Variables
{
"input": EnrollAccountInLoyaltyProgramInput
}Response
{
"data": {
"enrollAccountInLoyaltyProgram": {
"possibleErrors": [PossibleErrorType],
"outcome": EnrollAccountInLoyaltyProgramOutcome
}
}
}forceReauthentication
URL:https://api.esbsc-kraken.systems/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 object argument to the force-reauthentication mutation. |
Return fields
| Name | Description |
|---|---|
| Reports whether the mutation applied successfully. Should always be 'true'. |
| The time at which forced reauthentication is effective. Kraken and refresh tokens issued before this time will be invalid. |
Mutation
mutation ForceReauthentication($input: ForceReauthenticationInput!) {
forceReauthentication(input: $input) {
tokensInvalidated
effectiveAt
}
}Variables
{
"input": ForceReauthenticationInput
}Response
{
"data": {
"forceReauthentication": {
"tokensInvalidated": true,
"effectiveAt": "2020-01-01T00:00:00.000Z"
}
}
}getEmbeddedSecretForNewPaymentInstruction
Type:GetEmbeddedSecretForNewPaymentInstruction
URL:https://api.esbsc-kraken.systems/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 fields for getting the client secret for an embedded new card payment method form. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation GetEmbeddedSecretForNewPaymentInstruction($input: GetEmbeddedSecretForNewPaymentInstructionInput!) {
getEmbeddedSecretForNewPaymentInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
secretKey
}
}Variables
{
"input": GetEmbeddedSecretForNewPaymentInstructionInput
}Response
{
"data": {
"getEmbeddedSecretForNewPaymentInstruction": {
"possibleErrors": [PossibleErrorType],
"secretKey": "abc123"
}
}
}getEmbeddedSecretForNewPaymentInstructionWithoutAccount
Type:GetEmbeddedSecretForNewPaymentInstructionWithoutAccount
URL:https://api.esbsc-kraken.systems/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 fields for getting the client secret for an embedded new card payment method form. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The client secret needed to create a new stored payment instruction. |
Mutation
mutation GetEmbeddedSecretForNewPaymentInstructionWithoutAccount($input: GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput!) {
getEmbeddedSecretForNewPaymentInstructionWithoutAccount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
secretKey
}
}Variables
Response
{
"data": {
"getEmbeddedSecretForNewPaymentInstructionWithoutAccount": {
"possibleErrors": [PossibleErrorType],
"secretKey": "abc123"
}
}
}getHostedUrlForNewPaymentInstruction
Type:GetHostedUrlForNewPaymentInstruction
URL:https://api.esbsc-kraken.systems/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 fields for getting the external URL for setting up a payment instruction. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| URL at which payment instruction can be set up. |
Mutation
mutation GetHostedUrlForNewPaymentInstruction($input: GetHostedUrlForNewPaymentInstructionInput!) {
getHostedUrlForNewPaymentInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
url
}
}Variables
{
"input": GetHostedUrlForNewPaymentInstructionInput
}Response
{
"data": {
"getHostedUrlForNewPaymentInstruction": {
"possibleErrors": [PossibleErrorType],
"url": "abc123"
}
}
}initiateHostedStandalonePayment
Type:InitiateHostedStandalonePayment
URL:https://api.esbsc-kraken.systems/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 fields for initiating a standalone payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The details required to refer to and complete a hosted payment. |
Mutation
mutation InitiateHostedStandalonePayment($input: InitiateHostedStandalonePaymentInput!) {
initiateHostedStandalonePayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...InitiateHostedStandalonePaymentOutputFragment
}
}
}Variables
{
"input": InitiateHostedStandalonePaymentInput
}Response
{
"data": {
"initiateHostedStandalonePayment": {
"possibleErrors": [PossibleErrorType],
"payment": InitiateHostedStandalonePaymentOutput
}
}
}initiateProductSwitch
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
| Instigate a product switch for a specific supply point given a valid product and account number. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The selected product for a specific product switch. |
| The date at which the product switch becomes effective. |
Mutation
mutation InitiateProductSwitch($input: InitiateProductSwitchInput!) {
initiateProductSwitch(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
productCode
switchDate
}
}Variables
{
"input": InitiateProductSwitchInput
}Response
{
"data": {
"initiateProductSwitch": {
"possibleErrors": [PossibleErrorType],
"productCode": "abc123",
"switchDate": "2020-01-01"
}
}
}initiateStandalonePayment
Type:InitiateStandalonePayment
URL:https://api.esbsc-kraken.systems/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 fields for initiating a standalone payment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation InitiateStandalonePayment($input: InitiateStandalonePaymentInput!) {
initiateStandalonePayment(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
payment {
...InitiateStandalonePaymentOutputFragment
}
}
}Variables
{
"input": InitiateStandalonePaymentInput
}Response
{
"data": {
"initiateStandalonePayment": {
"possibleErrors": [PossibleErrorType],
"payment": InitiateStandalonePaymentOutput
}
}
}invalidatePaymentInstruction
Type:InvalidatePaymentInstruction
URL:https://api.esbsc-kraken.systems/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 fields for invalidating a payment instruction from an embedded form. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation InvalidatePaymentInstruction($input: InvalidatePaymentInstructionInput!) {
invalidatePaymentInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
instruction {
...InvalidatePaymentInstructionOutputFragment
}
}
}Variables
{
"input": InvalidatePaymentInstructionInput
}Response
{
"data": {
"invalidatePaymentInstruction": {
"possibleErrors": [PossibleErrorType],
"instruction": InvalidatePaymentInstructionOutput
}
}
}invalidatePreSignedToken
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation InvalidatePreSignedToken($input: InvalidatePreSignedTokenInput!) {
invalidatePreSignedToken(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
token {
...PreSignedTokenFragment
}
}
}Variables
{
"input": InvalidatePreSignedTokenInput
}Response
{
"data": {
"invalidatePreSignedToken": {
"possibleErrors": [PossibleErrorType],
"token": PreSignedToken
}
}
}joinSupplierAcceptTermsAndConditions
Type:JoinSupplierAcceptTermsAndConditions
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Indicator that the mutation has completed successfully. |
Mutation
mutation JoinSupplierAcceptTermsAndConditions($input: JoinSupplierAcceptTermsAndConditionsInput!) {
joinSupplierAcceptTermsAndConditions(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": JoinSupplierAcceptTermsAndConditionsInput
}Response
{
"data": {
"joinSupplierAcceptTermsAndConditions": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}linkUserToLine
URL:https://api.esbsc-kraken.systems/v1/graphql/
Link an account user and line user together.
Arguments
| Name | Description |
|---|---|
| Input fields to link an account user with LINE. |
Return fields
| Name | Description |
|---|
Mutation
mutation LinkUserToLine($input: LinkUserToLineInput!) {
linkUserToLine(input: $input) {
... on LineLinkRedirectResponse {
...LineLinkRedirectResponseFragment
}
... on LinkTokenNotFound {
...LinkTokenNotFoundFragment
}
... on AlreadyLinkedError {
...AlreadyLinkedErrorFragment
}
}
}Variables
{
"input": LinkUserToLineInput
}Response
{
"data": {
"linkUserToLine": LineLinkRedirectResponse
}
}masqueradeAuthentication
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
| The masquerade token issued by the support site. |
| The ID of the AccountUser to masquerade as. |
Return fields
| Name | Description |
|---|---|
| A Kraken Token that can be used to authenticate to the API, masquerading as the desired user. |
| A list of any errors that occurred while running this mutation. |
Mutation
mutation MasqueradeAuthentication(
$masqueradeToken: String!,
$userId: String!
) {
masqueradeAuthentication(
masqueradeToken: $masqueradeToken,
userId: $userId
) {
token
errors {
...ErrorTypeFragment
}
}
}Variables
{
"masqueradeToken": "abc123",
"userId": "abc123"
}Response
{
"data": {
"masqueradeAuthentication": {
"token": "abc123",
"errors": [ErrorType]
}
}
}obtainKrakenToken
URL:https://api.esbsc-kraken.systems/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 fields that can be used to obtain a Json Web Token (JWT) for authentication to the API. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The Kraken Token. Can be used in the |
| The body payload of the Kraken Token. The same information can be obtained by using JWT decoding tools on the value of the |
| A token that can be used in a subsequent call to |
| A Unix timestamp representing the point in time at which the refresh token will expire. |
Mutation
mutation ObtainKrakenToken($input: ObtainJSONWebTokenInput!) {
obtainKrakenToken(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
token
payload
refreshToken
refreshExpiresIn
}
}Variables
{
"input": ObtainJSONWebTokenInput
}Response
{
"data": {
"obtainKrakenToken": {
"possibleErrors": [PossibleErrorType],
"token": "abc123",
"payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"refreshToken": "abc123",
"refreshExpiresIn": 1
}
}
}processOrder
Type:ProcessOrderOutput!
URL:https://api.esbsc-kraken.systems/v1/graphql/
Process an Order
The possible errors that can be raised are:
- KT-CT-1605: Invalid input.
- KT-CT-7701: The affiliate organisation was not found.
- KT-CT-8906: Opportunity not found.
- KT-CT-12701: Invalid sales channel code.
- KT-CT-13102: Invalid order data.
- KT-CT-13103: Unprocessable order.
- KT-CT-13104: Conflicting order.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Mutation
mutation ProcessOrder($input: ProcessOrderInput!) {
processOrder(input: $input) {
status
identifier
}
}Variables
{
"input": ProcessOrderInput
}Response
{
"data": {
"processOrder": {
"status": "PENDING",
"identifier": NonEmptyString
}
}
}purchaseVoucher
Type:PurchaseVoucher
URL:https://api.esbsc-kraken.systems/v1/graphql/
Purchase a voucher.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| The voucher purchase created from the mutation. |
Mutation
mutation PurchaseVoucher($input: PurchaseVoucherInput!) {
purchaseVoucher(input: $input) {
voucherPurchase {
...VoucherPurchaseTypeFragment
}
}
}Variables
{
"input": PurchaseVoucherInput
}Response
{
"data": {
"purchaseVoucher": {
"voucherPurchase": VoucherPurchaseType
}
}
}redeemLoyaltyPointsForAccountCredit
Type:RedeemLoyaltyPointsForAccountCredit
URL:https://api.esbsc-kraken.systems/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 fields for redeeming Loyalty Points. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The number of loyalty points that were redeemed. |
Mutation
mutation RedeemLoyaltyPointsForAccountCredit($input: RedeemLoyaltyPointsInput!) {
redeemLoyaltyPointsForAccountCredit(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
pointsRedeemed
}
}Variables
{
"input": RedeemLoyaltyPointsInput
}Response
{
"data": {
"redeemLoyaltyPointsForAccountCredit": {
"possibleErrors": [PossibleErrorType],
"pointsRedeemed": 1
}
}
}redeemReferralClaimCode
URL:https://api.esbsc-kraken.systems/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 fields for redeeming referral code. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether or not the request was successful. |
Mutation
mutation RedeemReferralClaimCode($input: RedeemReferralClaimCodeInput!) {
redeemReferralClaimCode(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": RedeemReferralClaimCodeInput
}Response
{
"data": {
"redeemReferralClaimCode": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}regenerateSecretKey
Type:RegenerateSecretKey
URL:https://api.esbsc-kraken.systems/v1/graphql/
Regenerate the live secret key for the authenticated user.
Return fields
| Name | Description |
|---|---|
| The generated key value, which is only ever available once (here). |
| The currently authenticated user. |
Mutation
mutation RegenerateSecretKey {
regenerateSecretKey {
key
viewer {
...EspAccountUserTypeFragment
}
}
}Response
{
"data": {
"regenerateSecretKey": {
"key": "abc123",
"viewer": EspAccountUserType
}
}
}registerEvChargerLead
URL:https://api.esbsc-kraken.systems/v1/graphql/
Register an EV Charger lead to Zoho.
The possible errors that can be raised are:
- KT-ES-7803: The request to Chipiron was incomplete or malformed.
- KT-ES-7804: The request to Chipiron caused a conflict - might you be trying to create a duplicate?
- KT-ES-7802: The request to Chipiron was not fulfilled correctly.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| True if the lead was registered successfully. |
Mutation
mutation RegisterEvChargerLead($lead: EVChargerLeadZohoType) {
registerEvChargerLead(lead: $lead) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"lead": EVChargerLeadZohoType
}Response
{
"data": {
"registerEvChargerLead": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}registerPushNotificationBinding
Type:RegisterPushNotificationBinding
URL:https://api.esbsc-kraken.systems/v1/graphql/
Register a device token to be used for push notifications for an app.
This field requires the Authorization header to be set.
Arguments
| Name | Description |
|---|---|
Input fields for creating an push notification binding. |
Return fields
| Name | Description |
|---|---|
| Override Field to add additional attributes and extend description with possible_errors |
Mutation
mutation RegisterPushNotificationBinding($input: RegisterPushNotificationBindingInput!) {
registerPushNotificationBinding(input: $input) {
pushNotificationBinding {
...PushNotificationBindingTypeFragment
}
}
}Variables
{
"input": RegisterPushNotificationBindingInput
}Response
{
"data": {
"registerPushNotificationBinding": {
"pushNotificationBinding": PushNotificationBindingType
}
}
}registerSolarSimulatorDirectSale
Type:SolarSimulatorDirectSaleOutput
URL:https://api.esbsc-kraken.systems/v1/graphql/
Create a solar direct sale.
The possible errors that can be raised are:
- KT-ES-7803: The request to Chipiron was incomplete or malformed.
- KT-ES-7802: The request to Chipiron was not fulfilled correctly.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Name of the lead as saved in Chipiron. |
| Surname of the lead as saved in Chipiron. |
| Phone number of the lead as saved in Chipiron. |
| Email of the lead as saved in Chipiron. |
| Street of the lead as saved in Chipiron. |
| Address of the lead saved in chipiron. |
| Details of the lead saved in chipiron. |
| Direct sale details saved in chipiron. |
Mutation
mutation RegisterSolarSimulatorDirectSale($input: SolarSimulatorDirectSaleInput) {
registerSolarSimulatorDirectSale(input: $input) {
firstName
lastName
phone
email
fullAddress
address {
...SolarSimulatorLeadAddressFragment
}
details {
...SolarSimulatorLeadDetailsFragment
}
directSale {
...SolarSimulatorDirectSaleDirectSaleFragment
}
}
}Variables
{
"input": SolarSimulatorDirectSaleInput
}Response
{
"data": {
"registerSolarSimulatorDirectSale": {
"firstName": "abc123",
"lastName": "abc123",
"phone": "abc123",
"email": "abc123",
"fullAddress": "abc123",
"address": SolarSimulatorLeadAddress,
"details": SolarSimulatorLeadDetails,
"directSale": SolarSimulatorDirectSaleDirectSale
}
}
}registerSolarSimulatorLead
URL:https://api.esbsc-kraken.systems/v1/graphql/
Create a solar lead.
The possible errors that can be raised are:
- KT-ES-7803: The request to Chipiron was incomplete or malformed.
- KT-ES-7802: The request to Chipiron was not fulfilled correctly.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Name of the lead as saved in Chipiron. |
| Surname of the lead as saved in Chipiron. |
| Phone number of the lead as saved in Chipiron. |
| Email of the lead as saved in Chipiron. |
| Street of the lead as saved in Chipiron. |
| Address of the lead saved in chipiron. |
| Details of the lead saved in chipiron. |
Mutation
mutation RegisterSolarSimulatorLead($input: SolarSimulatorLeadInput) {
registerSolarSimulatorLead(input: $input) {
firstName
lastName
phone
email
fullAddress
address {
...SolarSimulatorLeadAddressFragment
}
details {
...SolarSimulatorLeadDetailsFragment
}
}
}Variables
{
"input": SolarSimulatorLeadInput
}Response
{
"data": {
"registerSolarSimulatorLead": {
"firstName": "abc123",
"lastName": "abc123",
"phone": "abc123",
"email": "abc123",
"fullAddress": "abc123",
"address": SolarSimulatorLeadAddress,
"details": SolarSimulatorLeadDetails
}
}
}requestDoubleOptIn
Type:RequestDoubleOptIn
URL:https://api.esbsc-kraken.systems/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-9023: Consent already accepted.
- KT-CT-1199: Too many requests.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The consent that was created or updated. |
Mutation
mutation RequestDoubleOptIn($input: DoubleOptInInput) {
requestDoubleOptIn(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
consent {
...ConsentTypeFragment
}
}
}Variables
{
"input": DoubleOptInInput
}Response
{
"data": {
"requestDoubleOptIn": {
"possibleErrors": [PossibleErrorType],
"consent": ConsentType
}
}
}requestPasswordReset
Type:RequestPasswordResetOutputType
URL:https://api.esbsc-kraken.systems/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 fields for requesting a password reset email. |
Return fields
| Name | Description |
|---|---|
| The email that requested a password reset email. |
Mutation
mutation RequestPasswordReset($input: RequestPasswordResetInput!) {
requestPasswordReset(input: $input) {
email
}
}Variables
{
"input": RequestPasswordResetInput
}Response
{
"data": {
"requestPasswordReset": {
"email": "abc123"
}
}
}requestPrintedBill
Type:RequestPrintedBill
URL:https://api.esbsc-kraken.systems/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 fields to request a printed bill. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the request was successful. |
Mutation
mutation RequestPrintedBill($input: RequestPrintedBillInput!) {
requestPrintedBill(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": RequestPrintedBillInput
}Response
{
"data": {
"requestPrintedBill": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}resetPassword
Type:ResetPasswordMutationPayload
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| |
|
Mutation
mutation ResetPassword($input: ResetPasswordMutationInput!) {
resetPassword(input: $input) {
errors {
...SerializerFieldErrorsTypeFragment
}
clientMutationId
}
}Variables
{
"input": ResetPasswordMutationInput
}Response
{
"data": {
"resetPassword": {
"errors": [SerializerFieldErrorsType],
"clientMutationId": "abc123"
}
}
}resetUserPassword
URL:https://api.esbsc-kraken.systems/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 fields for resetting an account user's password. |
Return fields
| Name | Description |
|---|---|
| The ID of the user whose password was changed. |
| True if the password update was successful, false otherwise. Deprecated The 'passwordUpdated' field is deprecated. |
| A list of messages of which password validations the new password failed against if applicable. Deprecated The 'failureReasons' field is deprecated. |
| A list of codes of which password validation the new password failed against if applicable.
One of:
- Deprecated The 'failureCodes' field is deprecated. |
Mutation
mutation ResetUserPassword($input: ResetUserPasswordInput!) {
resetUserPassword(input: $input) {
userId
passwordUpdated
failureReasons
failureCodes
}
}Variables
{
"input": ResetUserPasswordInput
}Response
{
"data": {
"resetUserPassword": {
"userId": "abc123",
"passwordUpdated": true,
"failureReasons": ["abc123"],
"failureCodes": ["abc123"]
}
}
}scheduleQuoteFollowUp
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Whether the message was scheduled successfully. |
Mutation
mutation ScheduleQuoteFollowUp($input: QuoteShareInput!) {
scheduleQuoteFollowUp(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": QuoteShareInput
}Response
{
"data": {
"scheduleQuoteFollowUp": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}setLoyaltyPointsUser
Type:SetLoyaltyPointsUser
URL:https://api.esbsc-kraken.systems/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 fields for saving the Loyalty Points user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| ID of the new Loyalty Points user. |
Mutation
mutation SetLoyaltyPointsUser($input: SetLoyaltyPointsUserInput!) {
setLoyaltyPointsUser(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
newLoyaltyPointsUserId
}
}Variables
{
"input": SetLoyaltyPointsUserInput
}Response
{
"data": {
"setLoyaltyPointsUser": {
"possibleErrors": [PossibleErrorType],
"newLoyaltyPointsUserId": "abc123"
}
}
}setUpDirectDebitInstruction
Type:SetUpDirectDebitInstruction
URL:https://api.esbsc-kraken.systems/v1/graphql/
Set up a new direct debit instruction.
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-3971: Instruction owners 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 fields for creating a new direct debit instruction |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation SetUpDirectDebitInstruction($input: SetUpDirectDebitInstructionInput!) {
setUpDirectDebitInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
paymentInstruction {
...DirectDebitInstructionTypeFragment
}
}
}Variables
{
"input": SetUpDirectDebitInstructionInput
}Response
{
"data": {
"setUpDirectDebitInstruction": {
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}
}
}setUpDirectDebitInstructionForBusiness
Type:SetUpDirectDebitInstructionForBusiness
URL:https://api.esbsc-kraken.systems/v1/graphql/
Set up a new direct debit instruction for a business.
The possible errors that can be raised are:
- KT-CT-3940: Invalid data.
- KT-CT-3956: Temporary error occurred.
- KT-CT-11107: Unauthorized.
- KT-CT-3948: Could not set up direct debit instruction.
- KT-CT-3971: Instruction owners 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 fields for creating a new direct debit instruction |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The created direct debit instruction. |
Mutation
mutation SetUpDirectDebitInstructionForBusiness($input: SetUpDirectDebitInstructionForBusinessInput!) {
setUpDirectDebitInstructionForBusiness(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
paymentInstruction {
...DirectDebitInstructionTypeFragment
}
}
}Variables
{
"input": SetUpDirectDebitInstructionForBusinessInput
}Response
{
"data": {
"setUpDirectDebitInstructionForBusiness": {
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}
}
}setUpDirectDebitInstructionFromStoredDetails
Type:SetUpDirectDebitInstructionFromStoredDetails
URL:https://api.esbsc-kraken.systems/v1/graphql/
Set up a new direct debit instruction from stored details.
The possible errors that can be raised are:
- KT-CT-3956: Temporary error occurred.
- KT-CT-3948: Could not set up direct debit instruction.
- KT-CT-3971: Instruction owners are not valid.
- KT-CT-5415: Account user not found.
- KT-CT-11103: Business not found.
- KT-CT-4123: 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 fields for creating a new direct debit instruction from stored details. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The payment instruction that was created from stored details. |
Mutation
mutation SetUpDirectDebitInstructionFromStoredDetails($input: SetUpDirectDebitInstructionFromStoredDetailsInput!) {
setUpDirectDebitInstructionFromStoredDetails(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
paymentInstruction {
...DirectDebitInstructionTypeFragment
}
}
}Variables
{
"input": SetUpDirectDebitInstructionFromStoredDetailsInput
}Response
{
"data": {
"setUpDirectDebitInstructionFromStoredDetails": {
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}
}
}shareGoodsQuote
Type:ShareGoodsQuote
URL:https://api.esbsc-kraken.systems/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 fields for sharing a quote. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods quote shared. |
Mutation
mutation ShareGoodsQuote($input: ShareGoodsQuoteInput!) {
shareGoodsQuote(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
share {
...GoodsQuoteShareFragment
}
}
}Variables
{
"input": ShareGoodsQuoteInput
}Response
{
"data": {
"shareGoodsQuote": {
"possibleErrors": [PossibleErrorType],
"share": GoodsQuoteShare
}
}
}startCustomerVerification
Type:StartCustomerVerification
URL:https://api.esbsc-kraken.systems/v1/graphql/
Start the customer verification using the provided verification method.
The possible errors that can be raised are:
- KT-CT-1701: Brand does not exist.
- KT-CT-4194: Verification type not supported yet.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The newly created verification process. |
Mutation
mutation StartCustomerVerification($input: StartCustomerVerificationInput!) {
startCustomerVerification(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
verificationProcess {
...VerificationProcessFragment
}
}
}Variables
{
"input": StartCustomerVerificationInput
}Response
{
"data": {
"startCustomerVerification": {
"possibleErrors": [PossibleErrorType],
"verificationProcess": VerificationProcess
}
}
}storeDirectDebitPaymentMethodDetails
Type:StoreDirectDebitPaymentMethodDetails
URL:https://api.esbsc-kraken.systems/v1/graphql/
Store bank details with the vendor.
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-3956: Temporary error occurred.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
Store bank details with the vendor. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation StoreDirectDebitPaymentMethodDetails($input: StoreDirectDebitPaymentMethodDetailsInput!) {
storeDirectDebitPaymentMethodDetails(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
storedPaymentMethodDetailsReference
}
}Variables
{
"input": StoreDirectDebitPaymentMethodDetailsInput
}Response
{
"data": {
"storeDirectDebitPaymentMethodDetails": {
"possibleErrors": [PossibleErrorType],
"storedPaymentMethodDetailsReference": "abc123"
}
}
}storePaymentInstruction
URL:https://api.esbsc-kraken.systems/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 fields for storing a new payment instruction created through the embedded process. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The stored payment instruction. |
Mutation
mutation StorePaymentInstruction($input: StorePaymentInstructionInput!) {
storePaymentInstruction(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
paymentInstruction {
...PaymentInstructionTypeFragment
}
}
}Variables
{
"input": StorePaymentInstructionInput
}Response
{
"data": {
"storePaymentInstruction": {
"possibleErrors": [PossibleErrorType],
"paymentInstruction": PaymentInstructionType
}
}
}submitCustomerFeedback
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation SubmitCustomerFeedback($input: CustomerFeedbackInputType!) {
submitCustomerFeedback(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
customerFeedback {
...CustomerFeedbackTypeFragment
}
}
}Variables
{
"input": CustomerFeedbackInputType
}Response
{
"data": {
"submitCustomerFeedback": {
"possibleErrors": [PossibleErrorType],
"customerFeedback": CustomerFeedbackType
}
}
}submitRepaymentRequest
URL:https://api.esbsc-kraken.systems/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-3926: Unauthorized.
- 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 fields for requesting a repayment. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The newly created repayment request. |
Mutation
mutation SubmitRepaymentRequest($input: RequestRepaymentInputType!) {
submitRepaymentRequest(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
repaymentRequest {
...RequestRepaymentOutputTypeFragment
}
}
}Variables
{
"input": RequestRepaymentInputType
}Response
{
"data": {
"submitRepaymentRequest": {
"possibleErrors": [PossibleErrorType],
"repaymentRequest": RequestRepaymentOutputType
}
}
}terminateCreditTransferPermission
Type:TerminateCreditTransferPermission
URL:https://api.esbsc-kraken.systems/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 fields for terminating a credit transfer permission. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Datetime when the credit transfer permission ends. |
Mutation
mutation TerminateCreditTransferPermission($input: TerminateCreditTransferPermissionInput!) {
terminateCreditTransferPermission(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
validTo
}
}Variables
{
"input": TerminateCreditTransferPermissionInput
}Response
{
"data": {
"terminateCreditTransferPermission": {
"possibleErrors": [PossibleErrorType],
"validTo": "2020-01-01T00:00:00.000Z"
}
}
}terminateSolarWalletRelationship
Type:TerminateSolarWalletRelationship
URL:https://api.esbsc-kraken.systems/v1/graphql/
Terminate solar wallet sharing credit between a solar wallet credit ledger and spain electricity ledger.
The possible errors that can be raised are:
- KT-ES-4116: Account not found.
- KT-ES-7807: The request to terminate a solar wallet sharing credit between ledgers was incomplete or malformed.
- KT-ES-7808: Couldn't stop sharing credit between ledgers because credit sharing ledger doesn't exist.
- KT-ES-7809: There is no ledger of this type on this account..
- KT-CT-4123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Deprecated
The 'terminateSolarWalletRelationship' field is deprecated.
Use 'terminateCreditTransferPermission' mutation instead.
- Marked as deprecated on 2025-02-10.
- Scheduled for removal on or after 2025-08-10.
Arguments
| Name | Description |
|---|---|
Input fields for terminaring solar wallet sharing credit between ledgers. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| A flag that ensures changes have been made. |
| Source account number of the solar wallet ledger. |
| Target account number of the electricity ledger. |
| Datetime when the solar wallet credit sharing ledger ends. |
| Target account given name. |
| Credit sharing ledgers id. |
Mutation
mutation TerminateSolarWalletRelationship($input: TerminateSolarWalletRelationshipType!) {
terminateSolarWalletRelationship(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
sourceAccountNumber
targetAccountNumber
validTo
targetGivenName
creditSharingLedgerId
}
}Variables
{
"input": TerminateSolarWalletRelationshipType
}Response
{
"data": {
"terminateSolarWalletRelationship": {
"possibleErrors": [PossibleErrorType],
"success": true,
"sourceAccountNumber": "abc123",
"targetAccountNumber": "abc123",
"validTo": "2020-01-01T00:00:00.000Z",
"targetGivenName": "abc123",
"creditSharingLedgerId": 1
}
}
}transferLoyaltyPointsBetweenUsers
Type:TransferLoyaltyPointsBetweenUsers
URL:https://api.esbsc-kraken.systems/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 fields for transferring Loyalty Points. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The number of loyalty points that were transferred. |
Mutation
mutation TransferLoyaltyPointsBetweenUsers($input: TransferLoyaltyPointsBetweenUsersInput!) {
transferLoyaltyPointsBetweenUsers(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
pointsTransferred
}
}Variables
{
"input": TransferLoyaltyPointsBetweenUsersInput
}Response
{
"data": {
"transferLoyaltyPointsBetweenUsers": {
"possibleErrors": [PossibleErrorType],
"pointsTransferred": 1
}
}
}unlinkUserFromLine
Type:UnlinkUserFromLineResponse!
URL:https://api.esbsc-kraken.systems/v1/graphql/
Unlink an account user and line together.
Return fields
| Name | Description |
|---|
Mutation
mutation UnlinkUserFromLine {
unlinkUserFromLine {
... on LineUnlinkedResponse {
...LineUnlinkedResponseFragment
}
... on LinkTokenNotFound {
...LinkTokenNotFoundFragment
}
... on LineCommonError {
...LineCommonErrorFragment
}
}
}Response
{
"data": {
"unlinkUserFromLine": LineUnlinkedResponse
}
}updateAccountBillingAddress
Type:UpdateAccountBillingAddress
URL:https://api.esbsc-kraken.systems/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 variables needed for updating an account billing address. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The updated account. |
Mutation
mutation UpdateAccountBillingAddress($input: AccountBillingAddressInput!) {
updateAccountBillingAddress(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountFragment
}
}
}Variables
{
"input": AccountBillingAddressInput
}Response
{
"data": {
"updateAccountBillingAddress": {
"possibleErrors": [PossibleErrorType],
"account": Account
}
}
}updateAccountBillingEmail
Type:UpdateAccountBillingEmail
URL:https://api.esbsc-kraken.systems/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 fields for updating billing email for an account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Account that was changed. |
Mutation
mutation UpdateAccountBillingEmail($input: UpdateAccountBillingEmailInput!) {
updateAccountBillingEmail(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountInterfaceFragment
}
}
}Variables
{
"input": UpdateAccountBillingEmailInput
}Response
{
"data": {
"updateAccountBillingEmail": {
"possibleErrors": [PossibleErrorType],
"account": AccountInterface
}
}
}updateAccountConsents
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
| The account number to update consents for. |
| Consents to update for account. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Consents linked to this account. |
Mutation
mutation UpdateAccountConsents(
$accountNumber: String!,
$consents: [ConsentInput]!
) {
updateAccountConsents(
accountNumber: $accountNumber,
consents: $consents
) {
possibleErrors {
...PossibleErrorTypeFragment
}
consents {
...ConsentTypeFragment
}
}
}Variables
{
"accountNumber": "abc123",
"consents": ConsentInput
}Response
{
"data": {
"updateAccountConsents": {
"possibleErrors": [PossibleErrorType],
"consents": ConsentType
}
}
}updateAccountReference
URL:https://api.esbsc-kraken.systems/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 fields for updating an account reference. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation UpdateAccountReference($input: AccountReferenceInput!) {
updateAccountReference(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountReference {
...AccountReferenceTypeFragment
}
}
}Variables
{
"input": AccountReferenceInput
}Response
{
"data": {
"updateAccountReference": {
"possibleErrors": [PossibleErrorType],
"accountReference": AccountReferenceType
}
}
}updateAccountUser
Type:UpdateAccountUser
URL:https://api.esbsc-kraken.systems/v1/graphql/
Update an account.
The possible errors that can be raised are:
- KT-ES-5410: 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 fields for updating user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Updated user. |
Mutation
mutation UpdateAccountUser($input: UpdateAccountUserInput) {
updateAccountUser(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
viewer {
...EspAccountUserTypeFragment
}
}
}Variables
{
"input": UpdateAccountUserInput
}Response
{
"data": {
"updateAccountUser": {
"possibleErrors": [PossibleErrorType],
"viewer": EspAccountUserType
}
}
}updateAccountUserConsents
Type:UpdateAccountUserConsents
URL:https://api.esbsc-kraken.systems/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 to update for account user. |
| User number of the account user to update consents for. Only needed if the viewer is an organization. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| All the consents for an account user. |
Mutation
mutation UpdateAccountUserConsents(
$consents: [ConsentTypeInput],
$userNumber: String
) {
updateAccountUserConsents(
consents: $consents,
userNumber: $userNumber
) {
possibleErrors {
...PossibleErrorTypeFragment
}
accountUserConsents {
...AccountUserConsentsFragment
}
}
}Variables
{
"consents": ConsentTypeInput,
"userNumber": "abc123"
}Response
{
"data": {
"updateAccountUserConsents": {
"possibleErrors": [PossibleErrorType],
"accountUserConsents": AccountUserConsents
}
}
}updateActivePurchase
Type:UpdateActivePurchase
URL:https://api.esbsc-kraken.systems/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 fields for updating an active purchase. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Goods purchase updated. |
Mutation
mutation UpdateActivePurchase($input: UpdatePurchaseInput!) {
updateActivePurchase(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
goodsPurchase {
...GoodsPurchaseFragment
}
}
}Variables
{
"input": UpdatePurchaseInput
}Response
{
"data": {
"updateActivePurchase": {
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}
}
}updateAutoTopUpAmount
URL:https://api.esbsc-kraken.systems/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-4123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for updating the auto-top-up amount for a schedule. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The new schedule created. |
Mutation
mutation UpdateAutoTopUpAmount($input: UpdateAutoTopUpAmountInput!) {
updateAutoTopUpAmount(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
schedule {
...PaymentScheduleTypeFragment
}
}
}Variables
{
"input": UpdateAutoTopUpAmountInput
}Response
{
"data": {
"updateAutoTopUpAmount": {
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}
}
}updateBillingAddress
Type:UpdateBillingAddress
URL:https://api.esbsc-kraken.systems/v1/graphql/
Updates billing address details.
The possible errors that can be raised are:
- KT-ES-4118: Invalid data.
- 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 |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| A flag that ensures changes have been made. |
Mutation
mutation UpdateBillingAddress($input: UpdateAccountBillingAddressInput) {
updateBillingAddress(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": UpdateAccountBillingAddressInput
}Response
{
"data": {
"updateBillingAddress": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}updateBillingDetails
Type:UpdateBillingDetails
URL:https://api.esbsc-kraken.systems/v1/graphql/
Updates billing details.
The possible errors that can be raised are:
- KT-ES-4119: Invalid data.
- KT-ES-1130: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| A flag that ensures changes have been made. |
Mutation
mutation UpdateBillingDetails($input: UpdateAccountBillingDetailsInput) {
updateBillingDetails(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"input": UpdateAccountBillingDetailsInput
}Response
{
"data": {
"updateBillingDetails": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}updateCommsDeliveryPreference
Type:UpdateCommsDeliveryPreference
URL:https://api.esbsc-kraken.systems/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 fields for updating comms delivery preferences for an account |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation UpdateCommsDeliveryPreference($input: UpdateCommsDeliveryPreferenceInput!) {
updateCommsDeliveryPreference(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountInterfaceFragment
}
}
}Variables
{
"input": UpdateCommsDeliveryPreferenceInput
}Response
{
"data": {
"updateCommsDeliveryPreference": {
"possibleErrors": [PossibleErrorType],
"account": AccountInterface
}
}
}updateCommsPreferences
Type:UpdateAccountUserCommsPreferencesMutationPayload
URL:https://api.esbsc-kraken.systems/v1/graphql/
Update the comms preferences of the account user (the authenticated user).
Arguments
| Name | Description |
|---|---|
Return fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Mutation
mutation UpdateCommsPreferences($input: UpdateAccountUserCommsPreferencesMutationInput!) {
updateCommsPreferences(input: $input) {
isOptedInToClientMessages
isOptedInToOfferMessages
isOptedInToRecommendedMessages
isOptedInToUpdateMessages
isOptedInToThirdPartyMessages
isOptedInMeterReadingConfirmations
isOptedInToSmsMessages
isUsingInvertedEmailColours
fontSizeMultiplier
emailFormat
preferredHoldMusic
errors {
...ErrorTypeFragment
}
commsPreferences {
...AccountUserCommsPreferencesFragment
}
clientMutationId
}
}Variables
{
"input": UpdateAccountUserCommsPreferencesMutationInput
}Response
{
"data": {
"updateCommsPreferences": {
"isOptedInToClientMessages": true,
"isOptedInToOfferMessages": true,
"isOptedInToRecommendedMessages": true,
"isOptedInToUpdateMessages": true,
"isOptedInToThirdPartyMessages": true,
"isOptedInMeterReadingConfirmations": true,
"isOptedInToSmsMessages": true,
"isUsingInvertedEmailColours": true,
"fontSizeMultiplier": 1.0,
"emailFormat": "abc123",
"preferredHoldMusic": "abc123",
"errors": [ErrorType],
"commsPreferences": AccountUserCommsPreferences,
"clientMutationId": "abc123"
}
}
}updateDocumentAccessibilityPreference
Type:UpdateDocumentAccessibilityPreference!
URL:https://api.esbsc-kraken.systems/v1/graphql/
Update the document accessibility preference for an account.
The possible errors that can be raised are:
- 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 |
|---|---|
Input fields for updating document accessibility preference for an account |
Return fields
| Name | Description |
|---|
Mutation
mutation UpdateDocumentAccessibilityPreference($input: UpdateDocumentAccessibilityPreferenceInput!) {
updateDocumentAccessibilityPreference(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
account {
...AccountFragment
}
}
}Variables
{
"input": UpdateDocumentAccessibilityPreferenceInput
}Response
{
"data": {
"updateDocumentAccessibilityPreference": {
"possibleErrors": [PossibleErrorType],
"account": Account
}
}
}updateMetadata
Type:UpdateMetadata
URL:https://api.esbsc-kraken.systems/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 fields for updating metadata. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation UpdateMetadata($input: MetadataInput!) {
updateMetadata(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
metadata {
...MetadataFragment
}
}
}Variables
{
"input": MetadataInput
}Response
{
"data": {
"updateMetadata": {
"possibleErrors": [PossibleErrorType],
"metadata": Metadata
}
}
}updatePassword
Type:UpdatePassword
URL:https://api.esbsc-kraken.systems/v1/graphql/
Update password of the authenticated user
This field requires the Authorization header to be set.
The possible errors that can be raised are:
- KT-CT-5460: Old password is invalid.
- KT-CT-5450: Password is invalid.
- KT-CT-1113: Disabled GraphQL field requested.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The currently authenticated user. This field requires the |
Mutation
mutation UpdatePassword($input: UpdatePasswordInput) {
updatePassword(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
viewer {
...EspAccountUserTypeFragment
}
}
}Variables
{
"input": UpdatePasswordInput
}Response
{
"data": {
"updatePassword": {
"possibleErrors": [PossibleErrorType],
"viewer": EspAccountUserType
}
}
}updatePaymentDetails
Type:UpdatePaymentDetails
URL:https://api.esbsc-kraken.systems/v1/graphql/
Updates payment details.
The possible errors that can be raised are:
- KT-ES-4120: Invalid data.
- KT-ES-1130: Unauthorized.
- KT-ES-3910: Payment instruction couldn't be created or was cancelled.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| A flag that ensures changes have been made. |
Mutation
mutation UpdatePaymentDetails($newPaymentDetails: UpdateAccountPaymentInput) {
updatePaymentDetails(newPaymentDetails: $newPaymentDetails) {
possibleErrors {
...PossibleErrorTypeFragment
}
success
}
}Variables
{
"newPaymentDetails": UpdateAccountPaymentInput
}Response
{
"data": {
"updatePaymentDetails": {
"possibleErrors": [PossibleErrorType],
"success": true
}
}
}updateUser
Type:UpdateUserMutation
URL:https://api.esbsc-kraken.systems/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 fields for updating user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
|
Mutation
mutation UpdateUser($input: UpdateUserInput!) {
updateUser(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
viewer {
...EspAccountUserTypeFragment
}
}
}Variables
{
"input": UpdateUserInput
}Response
{
"data": {
"updateUser": {
"possibleErrors": [PossibleErrorType],
"viewer": EspAccountUserType
}
}
}updateUserDetails
Type:UpdateAccountUserMutationPayload
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
|
Mutation
mutation UpdateUserDetails($input: UpdateAccountUserMutationInput!) {
updateUserDetails(input: $input) {
givenName
familyName
pronouns
mobile
email
dateOfBirth
landline
errors {
...ErrorTypeFragment
}
clientMutationId
}
}Variables
{
"input": UpdateAccountUserMutationInput
}Response
{
"data": {
"updateUserDetails": {
"givenName": "abc123",
"familyName": "abc123",
"pronouns": "abc123",
"mobile": "abc123",
"email": "abc123",
"dateOfBirth": "2020-01-01",
"landline": "abc123",
"errors": [ErrorType],
"clientMutationId": "abc123"
}
}
}validateMfaDevice
Type:ValidateMfaDevice
URL:https://api.esbsc-kraken.systems/v1/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.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
| Input fields for validating a new multi-factor authentication device for the logged user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Flag to indicate if the device has been verified, so it can be used for MFA. |
Mutation
mutation ValidateMfaDevice($input: ValidateMfaDeviceInputType!) {
validateMfaDevice(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
deviceIsValid
}
}Variables
{
"input": ValidateMfaDeviceInputType
}Response
{
"data": {
"validateMfaDevice": {
"possibleErrors": [PossibleErrorType],
"deviceIsValid": true
}
}
}verifyCustomer
Type:VerifyCustomer
URL:https://api.esbsc-kraken.systems/v1/graphql/
Verify a customer using the provided verification code and type.
The possible errors that can be raised are:
- KT-CT-4191: Error while verifying the customer.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Arguments
| Name | Description |
|---|---|
|
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| The currently authenticated user. |
Mutation
mutation VerifyCustomer($input: VerifyCustomerInput!) {
verifyCustomer(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
user {
...EspAccountUserTypeFragment
}
}
}Variables
{
"input": VerifyCustomerInput
}Response
{
"data": {
"verifyCustomer": {
"possibleErrors": [PossibleErrorType],
"user": EspAccountUserType
}
}
}verifyIdentity
Type:VerifyIdentity
URL:https://api.esbsc-kraken.systems/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 |
|---|---|
| Details about the user to be verified. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| An expiring token that can be used to request to update the user's email address. |
Mutation
mutation VerifyIdentity($input: VerifyIdentityInput!) {
verifyIdentity(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
token
}
}Variables
{
"input": VerifyIdentityInput
}Response
{
"data": {
"verifyIdentity": {
"possibleErrors": [PossibleErrorType],
"token": "abc123"
}
}
}Authentication Server
createMfaDevice
Type:CreateMfaDevice
URL:https://auth.esbsc-kraken.systems/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.
Deprecated
The 'createMfaDevice' field is deprecated.
Schema is being removed, but will be available in the main API site.
- Marked as deprecated on 2025-10-15.
- Scheduled for removal on or after 2025-10-30.
Arguments
| Name | Description |
|---|---|
| Input fields for creating a new multi-factor authentication device for the logged user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Email address to send the MFA code by default. |
| Phone number to send the MFA code by default. |
| Secret to setup Time-based One-Time Passwords (TOTP) in your authenticator or password manager manually. |
Mutation
mutation CreateMfaDevice($input: CreateMfaDeviceInputType!) {
createMfaDevice(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
deviceEmail
devicePhone
totpSecret
}
}Variables
{
"input": CreateMfaDeviceInputType
}Response
{
"data": {
"createMfaDevice": {
"possibleErrors": [PossibleErrorType],
"deviceEmail": "abc123",
"devicePhone": "abc123",
"totpSecret": "abc123"
}
}
}deleteMfaDevice
Type:DeleteMfaDevice
URL:https://auth.esbsc-kraken.systems/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.
Deprecated
The 'deleteMfaDevice' field is deprecated.
Schema is being removed, but will be available in the main API site.
- Marked as deprecated on 2025-10-15.
- Scheduled for removal on or after 2025-10-30.
Arguments
| Name | Description |
|---|---|
| Input fields for deleting an existing multi-factor authentication device for the logged user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Flag to indicate if the MFA device has been successfully deleted. |
Mutation
mutation DeleteMfaDevice($input: DeleteMfaDeviceInputType!) {
deleteMfaDevice(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
deviceDeleted
}
}Variables
{
"input": DeleteMfaDeviceInputType
}Response
{
"data": {
"deleteMfaDevice": {
"possibleErrors": [PossibleErrorType],
"deviceDeleted": true
}
}
}validateMfaDevice
Type:ValidateMfaDevice
URL:https://auth.esbsc-kraken.systems/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.
Deprecated
The 'validateMfaDevice' field is deprecated.
Schema is being removed, but will be available in the main API site.
- Marked as deprecated on 2025-10-15.
- Scheduled for removal on or after 2025-10-30.
Arguments
| Name | Description |
|---|---|
| Input fields for validating a new multi-factor authentication device for the logged user. |
Return fields
| Name | Description |
|---|---|
| Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
| Flag to indicate if the device has been verified, so it can be used for MFA. |
Mutation
mutation ValidateMfaDevice($input: ValidateMfaDeviceInputType!) {
validateMfaDevice(input: $input) {
possibleErrors {
...PossibleErrorTypeFragment
}
deviceIsValid
}
}Variables
{
"input": ValidateMfaDeviceInputType
}Response
{
"data": {
"validateMfaDevice": {
"possibleErrors": [PossibleErrorType],
"deviceIsValid": true
}
}
}