Returns a payment multiplier as a measure of risk. The payment multiplier is the number of advance payments we require from a business as security deposit. It is hardcoded except for Limited companies (=LTDs). For LTDs the payment multiplier depends on the credit score.

Possible Errors

KT-CT-10701: Business credit checking not configured.
KT-CT-10702: Credit check failed.
KT-CT-10703: Input data is invalid.
KT-CT-1113: Disabled GraphQL field requested.
KT-CT-7899: An internal error occurred.

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can run credit check

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Query

mutation CheckBusinessCreditRisk($checkBusinessCreditRiskInput: CheckBusinessCreditRiskInput!) {
  checkBusinessCreditRisk(checkBusinessCreditRiskInput: $checkBusinessCreditRiskInput) {
    paymentMultiplier
  }
}

Variables

{
  "checkBusinessCreditRiskInput": CheckBusinessCreditRiskInput
}

Response

{
  "data": {
    "checkBusinessCreditRisk": {
      "paymentMultiplier": 26
    }
  }
}