Magento 2 Creditsafe Integration
Installation and User Guide for Magento 2 Creditsafe Integration Extension
Table of Contents
- Installation
- Installation via app/code
- Installation via Composer
- Configuration Settings for Creditsafe Integration
- General Settings
- API Configuration
- Limits and Messages Configuration
- Limits Configuration
- Emails
- Customer Configuration
- CreditSafe API Logs
- CreditSafe Information Stored Against the Customer
- Customer Verification Process
- CreditSafe Adjustment Grid
- CreditSafe Transactions Grid
- Import CreditSafe transactions in the Grid
- Frontend
- Apply for CreditSafe Application
- CreditSafe Company Application
- Successful Credit Application
Installation
-
Installation via app/code: Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
php bin/magento setup:upgrade php bin/magento setup:di:compile php bin/magento setup:static-content:deploy -
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Configuration Settings for Creditsafe Integration
Go to Admin> Stores> Configuration> Scommerce > Credit Safe
General Settings
- Enable Module - Select "Yes" or "No" to enable or disable the module.
- License Key - Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at support@scommerce-mage.com.
- Show Address Form on Registration - Set "Yes" to collect billing address from customer on user registration or signup form. If set "No" billing address won't be captured on user registration.
- Archiving Log - Set "Yes" to archive credit safe logs after a certain number of days and set "No" to turn off archiving.
- Archive Log After Number Of Days - Enter the number of days after which the logs will be archived.
API Configuration
- User Name - Enter the Creditsafe Username
- Password - Enter the Creditsafe Password. Once both username and password are entered and saved click on the "Test API Creds" button if it shown "success" in green then your credentials are correct if not then please re verify your credentials.
- Use Test Mode - Set "Yes" to enable sandbox creditsafe and set "No" to use live creditsafe.
- Enable API Logging - Set "Yes" or "No" to Enable/Disable API logging in DB
Limits and Messages Configuration
Create creditsafe rules based on your requirements.
- Type - Select the user type either "Business" or "Consumer" this rule will be created for the appropriate applicant type.
- CS Credit Limit/Score Range - Enter the credit limit or credit score range for the particular rule.
- Limit- Enter the credit limit to be assigned for this rule based on the score entered previously. If the score is in this range then the entered limit should be provided to the applicant.
- **Limit Type -**There are two main credit limit types:
- Absolute Limit: This limit is a fixed amount set by you or your business, regardless of external factors. It's directly entered into the "limit field" you mentioned.
- Percentage Limit: This limit is determined as a percentage of an external creditworthiness score. The external score typically comes from CreditSafe.
- The calculation involves: Credit Limit Received from CreditSafe (e.g., 1000) Limit Specified in the Limit Field (e.g., 50) The final credit limit is the percentage of the CreditSafe limit multiplied by the limit field value. In this example: Final Limit = 50% * 1000 = 500
- Response - Enter the response shown to the customer when they fullfill the criteria for this rule and the the limit is assigned to them
- Response Type - Choose the response type from either Success or Failure.
Similarly you can create multiple rules as per your requirements to appropriately assign the credit limits to your applicants.
Limits Configuration
- Credit Applied Message - Enter the message that will be displayed to user when they have previously applied for Creditsafe application.
Emails
- Enable Email - Select "Yes" or "No" to enable or disable the creditsafe application emails.
- Success Email Template - Select the template to be used for success emails (successful credit safe application).
- Success Email Sender - Select the Email Sender, the email to be used to send the success emails.
- Success Email Recipient - You can add an additional email where the success emails will be sent alongside the applicant.
- Fail Email Template - Select the template to be used for fail emails (failed credit safe application). This email will only be sent to the customer.
- Fail Email Sender - Select the Email Sender, the email to be used to send the failure emails.
- Fail Email Recipient - This is optional. You can add an additional email where the failure emails will be sent other than the customer. This email will be exactly same as the one sent to the customer.
- Admin Fail Email Template - Select the template to be used for fail emails (failed credit safe application) to admin. This email template is only sent to the Administrator and not the customer. It contains for details regarding the failure of the credit application.
- Admin Fail Email Sender - Select the Email Sender, the email to be used to send the failure emails to admin.
- Admin Fail Email Recipient - This is optional. You can add an additional email where the failure emails will be sent alongside the admin. This failure email will be exactly same as the one sent to administrator.
- Admin API Result Email Template - Select the template to be used for API results to admin. When the credit application occurs the requests and responses from various end points will be sent to the admin via this email template.
- Admin API Result Email Sender - Select the Email Sender, the email to be used to send API results to admin.
- Admin API Result Email Recipient - This is optional You can add an additional email where the API results will be sent alongside the admin. This email will be exactly same as the one sent to administrator contianing requests and responses of various end points hit during the credit application.
Customer Configuration
- Approval Type - Select either "disabled" "manual" or "automatic". If "disabled" is selected, the verification will be disabled. If "manual" is selected,the credtisafe applications will be only approved/verified by the magento admin. If "automatic" is selected, the credisafe applications will be automatically approved or denied based on the Credit limits and Messages Configuration.
- Allow customers to retry - If set to "Yes", customers will be able to re-apply for creditsafe application. If set to "No", once creditsafe application is submitted they won't be able to retry the application.
- Maximum number of retry allowed:- Enter the maximum number of retries for customers to check their credit limit.
- Email Sender - Select the email sender which will be used to send out applicant verification emails
- Verification Success Email Template - Select the Email template to be used for successfull applicant verification.
- Verification Rejected Email Template - Select the Email template to be used for failed applicant verification.
- Success Credit Limit message (not verified):- Enter the success credit limit message when credit check was successfull but not verified.
- Success Credit Limit message (verified)):- Enter the success credit limit message when credit check was successfull and verified.
- Failed Credit Limit Message - Enter the message that will be displayed to customer when their credit check failedbut they have retries available.
- Failed Credit Limit (no retries) - Enter the message that will be displayed to customer when their credit check failed and they have no retries available.
CreditSafe API Logs
All requests and responses with regards to creditsafe endpoints are logged into a grid. You can view the logs by going into Admin>System>CreditSafe API Logs>Credit Safe Logs.
If you further click on any of the entries it contains the information as shown in the image below:-
CreditSafe Information Stored Against the Customer
Our module adds certain fields against the customer to keep track of credit assignment and available credit limits. Following fields are added:-
- CreditSafe Credit Reference:- Credit reference number received from creditsafe upon credit application.
- Credit Limit:- The limit received from creditsafe upon succefull credit application. Maximum limit that can be used by the customer to make purchases. It does not decrease after transactions.
- Credit Balance:- The limit received from creditsafe upon succefull credit application. Maximum limit that can be used by the customer to make purchases. This value get's updated based on transactions made by the customer. for eg:- if they make purchase using the credit limit then that amount will be deducted and reflected here.
- Credit Limit Verified:- This toggle turns on when the customer verification is complete, either manual or automatic.
- Credit Limit Retry Count:- The number of times a customer has applied for credit application.
Customer Verification Process
Based on the "Approval Type" configuration described earlier, the customer's verification takes place:-
-
Automatic:- The customer verification is done automatically.
-
Manual:- When "manual" verification is selected, then it is upon the administrator to verify the customer, for eg:- asking for documents via email and verifying them in person. Once verified admin can click on the verify button or turn on the toggle in the customer page ( go to Admin>Customers>All Customers>select the customer). Once verified by using the "Verify" button, the customer get an email regarding their successful verification.
-
Disabled:- Customer verification is not required and upon successful application the credit limits are assigned to customer.
CreditSafe Adjustment Grid
CreditSafe Transactions Grid
It allows you to track and manage adjustments made to customer credit limits based on their orders and payments. With this system, you can view and manage adjustments made to customer credit limits in a single, easy-to-use grid. Easily Keep track of adjustments made to customer credit limits. Go to Admin>Sales>Creditsafe>Transactions. The grid reflects both positive and negative adjustments i.e when a customer makes a purchase using their credit limit and when they make the payment of the invoice.
Import CreditSafe transactions in the Grid
You can import transactions by either going into Admin>System>Import our by going to sales>Orders>Import from CSV. Next select the "Entity Type" as "CreditSafe Transaction Import" from the dropdown.
The format of the import file should be as shown in the image. The fields required are as follows:-
- entity_id:- Enter the id of the next transaction as per your CreditSafe Transaction Grid. For eg:- if you have 1-24 transactions then you should start the list from 25..26 and so on.
- payment_date:- Date & time of the payment received or deducted.
- adjustment_amount:- Enter a positive or negative adjustment amount. adding a positive amount will add the amout in the customers credit balanace wheras for negative amount it will deduct the amount from credit balance.
- increment_id:- Enter the order id.
- customer_email:- Enter the customer email.
- transaction_description:- You can add a description of the adjustment which will be reflected in the creditsafe transactions grid.
Frontend
Apply for CreditSafe Application
Customers can apply for creditsafe application from their My Account section using the button "Apply for Web Credit Account".
CreditSafe Company Application
Successful Credit Application
If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact support@scommerce-mage.com.