creditCheck - Credit check - WEBSALE Dokumentation

The creditCheck configuration node bundles all settings for credit and risk checks in the checkout. It controls whether, when and for whom checks are triggered (e.g. from a minimum basket value, only for certain countries or payment methods) and which third-party providers (e.g. creditPass) are used.

NOTE: this feature is not yet supported.

`creditCheck*` - Basic structure

The basic structure of the creditCheck node is shown below:

{
  "creditCheck": {
    "creditPass": {...}
  }
}

Parameter description

Parameter	Description
`creditPass`	Integrates a provider for credit / credit-rating checks and configures the connection.

`creditCheck.creditPass` - Provider connection

The creditPass node controls the connection to an external credit or risk check service. Among other things, this defines whether the check is active, which URL the service is contacted at, and which credentials the shop uses to authenticate. Example configuration:

{
  "active": true,
  "url": "https://api.creditpass.de/check",
  "authId": "MEIN_SHOP_ID",
  "authPw": "geheimesPasswort123",
  "taType": 1,
  "countries": [
    "general.country.de",
    "general.country.at"
  ],
  "minTotalPrice": 50.00
}

Parameter overview

Parameter	Type	Description
`active`	bool	Turns the connection to the credit / credit-rating service on or off. `false` = no creditPass checks are performed.
`url`	string	Endpoint URL of the external service that receives the credit / risk check requests.
`authId`	string	User / account ID for authentication with the provider.
`authPw`	string	Password / secret for authentication with the service provider.
`taType`	int	Identifier for the transaction type used at the provider.
`countries`	multiAssoc	List of countries for which a creditPass check should be performed. Target: `general.country`
`minTotalPrice`	float	Minimum basket total from which a check is triggered.

content - Catalogue (categories & products)customer - Customer data

⌘I

​creditCheck* - Basic structure

​creditCheck.creditPass - Provider connection

`creditCheck*` - Basic structure

`creditCheck.creditPass` - Provider connection