Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The User Management section deals with endpoints related to the creation, authentication, and management of user accounts within Krepling Pay. It ensures your customers can securely register, log in, and manage their profiles.
Save New User: Registers a new user with all necessary details like name, email, and address, ensuring that users can start transactions.
Send OTP Via Email: Sends a One-Time Password to the user's email for verification purposes, enhancing security by verifying the email address ownership.
Verify OTP: Confirms the OTP provided by the user, completing the verification process and activating the user account.
User Login: Authenticates the user's credentials, granting access to their account and enabling them to perform transactions securely.
Endpoint: POST /api/Checkout/SaveNewUser
Purpose: Registers a new user in the checkout application.
Request Body:
Status 200: User added successfully.
Endpoint: POST /api/SMS/GetSixDigitOnEmail
Purpose: Sends an OTP to the user's email for verification.
Request Body:
Status 200: OTP sent successfully.
Endpoint: POST /api/SMS/VerifyOTPbyEmail
Purpose: Verifies the OTP entered by the user.
Request Body:
Status 200: OTP verified successfully.
Endpoint: POST /api/Checkout/CustomerLogin
Purpose: Authenticates and logs in the user.
Request Body:
Status 200: Login successful.
Krepling Pay introduces a cutting-edge checkout solution tailored for e-commerce success. Engineered for speed and simplicity, it offers an unparalleled checkout experience that minimizes cart abandonment and maximizes user satisfaction. With its user-friendly interface, Krepling Pay ensures a smooth and intuitive payment process for customers of all backgrounds.
Easy integration allows merchants of any size to implement Krepling Pay quickly, transforming their e-commerce platform with just a few lines of code or a simple plugin installation. Furthermore, its white-label capabilities enable merchants to offer a fully branded checkout and wallet system, reinforcing brand identity and fostering customer loyalty.
Krepling Pay employs an advanced tokenization technology to ensure the security and speed of transactions, setting a new benchmark in the e-commerce payment gateway space. This section provides a detailed technical breakdown of the tokenization process and the underlying technology that facilitates rapid and secure checkouts.
Krepling Pay operates on a state-of-the-art, API-driven architecture that facilitates real-time communication between the e-commerce platform, the payment processor, and banks. When a customer initiates a payment, Krepling Pay generates a secure token representing the payment details. This token is then used to process the payment through encrypted channels, ensuring that sensitive data is protected at every step. The payment gateway employs advanced algorithms to optimize the payment route, ensuring the fastest possible transaction time while adhering to the highest security standards.
Moreover, Krepling Pay's infrastructure is designed for scalability, capable of handling a high volume of transactions without compromising performance or security. This scalability makes Krepling Pay an ideal solution for e-commerce platforms of all sizes, from small startups to large enterprises.
When a customer enters their payment information at checkout, Krepling Pay captures the data through a secure, encrypted form. This form is directly embedded into the merchant's website, ensuring that sensitive information never touches the merchant's server, adhering to PCI DSS compliance from the outset. The captured payment information is immediately encrypted and sent to Krepling Pay's secure tokenization server. Here, the data is converted into a unique token—a string of characters that represent the payment information but have no exploitable value on their own. This process utilizes asymmetric encryption algorithms, where a public key is used to encrypt the data, and a private key, held securely on Krepling Pay's servers, is required to decrypt it. The generated token is stored in a secure, centralized vault within Krepling Pay's infrastructure. This vault is designed with multiple layers of security, including firewalls, intrusion detection systems, and round-the-clock monitoring. Access to the vault requires multi-factor authentication, ensuring that only authorized personnel can retrieve or manage tokens. For transaction processing, the token—instead of the actual payment details—is sent through the payment network. This method significantly reduces the risk of data interception or theft, as the token itself is useless if compromised. The payment processor uses the token to retrieve the original payment details from Krepling Pay's secure vault, process the payment, and then return a transaction result. Krepling Pay's tokenization is dynamic, meaning tokens can be configured to expire after a single use or after a predetermined period. This feature adds an extra layer of security by ensuring that tokens are not valid indefinitely, further reducing the potential for fraud.
Krepling Pay's digital wallet integration provides users with a seamless and secure way to store and manage their payment options. The wallet system utilizes the same tokenization technology to store credit card details, allowing users to make payments without re-entering their card information. This not only enhances user convenience but also significantly reduces the risk of data breaches, as sensitive information is never exposed during transactions.
Krepling Pay enables merchants to accept payments in multiple currencies, offering a truly global e-commerce solution. This feature is supported by dynamic currency conversion technology, which provides customers with the option to view prices and make payments in their local currency. The platform uses real-time exchange rates for currency conversion, ensuring transparency and fairness in pricing.
Beyond currency, Krepling Pay adapts to local payment preferences, displaying relevant payment methods and customizing the checkout experience to match the linguistic and cultural expectations of customers from different regions. This localization is powered by a sophisticated algorithm that analyzes the customer's location, preferred language, and historical payment data.
Krepling Pay offers comprehensive analytics and reporting tools that give merchants insights into their sales patterns, customer behavior, and payment method performance. This feature is powered by big data analytics and machine learning algorithms that process large volumes of transaction data to generate actionable insights.
Merchants have access to real-time dashboards that display key performance indicators (KPIs), sales trends, and sales. These dashboards are customizable, allowing merchants to focus on the metrics that matter most to their business.
This section emphasizes the security aspects of user accounts, including password management and account recovery options. It ensures users can maintain secure access to their accounts and recover access if necessary.
Included APIs:
Change Password: Provides users with the ability to update their password, enhancing account security.
Forget Password: Supports account recovery by initiating a password reset for users who have forgotten their login details.
POST /api/SMS/ChangeUserPasswords
Purpose: Allows users to change their account password.
Request Body:
POST /api/User/ForgotPasswordCheckout
Purpose: Initiates a password reset process for users who have forgotten their password.
Request Body:
Krepling Pay is more than just a payment gateway—it's a fully API-integrated platform ready to revolutionize the purchasing experience for your customers.
Feeling like an eager beaver? Jump into the integration process of Krepling Play to get started on WooCommerce or Magento:
Dive a little deeper and start exploring our API reference to get an idea of everything that's possible with Krepling Pay:
Before you can use Krepling Pay, you need to for an account. Upon approval, you will receive your API credentials, including your API Key and Merchant ID, which are essential for authenticating your API requests or integrating directly using a plugin.
This section serves as a comprehensive guide to help merchants understand the conventions and terminologies used throughout the API documentation. It aims to clarify the meanings of specific terms, the format of responses, and the conditions under which various HTTP status codes are returned by the server. This page is essential for developers interacting with the Krepling Pay API, as it provides the foundational knowledge needed to effectively parse responses, handle errors, and comprehend the requirements for successfully making requests to the API.
This section outlines the standard practices and rules applied in the Krepling Pay API documentation, including how merchants should interpret the API responses, the format of these responses, and the handling of request parameters.
Client/Merchant: Refers to the client application that interacts with the API.
Status: Represents the HTTP status code of the response received from the server.
Responses: Each method has predefined response scenarios, but only one response is issued per request by the server.
JSON Format: All responses from the API are provided in JSON format.
Mandatory Parameters: All request parameters are considered mandatory unless marked as [optional].
Parameter Values: The type of values accepted for a request parameter are specified. For example, [10|<any number>] indicates either the number 10 or any other number. [optional] parameters will have their default values highlighted in blue bold text.
This section categorizes and explains the HTTP status codes that the Krepling Pay API might return. This includes success codes (2XX), merchant error codes (4XX), and server error codes (5XX), each indicating different outcomes or issues encountered during the API request and response cycle.
Status codes follow standard HTTP status codes to indicate the outcome of an API request:
2XX: Indicates success of some kind.
4XX: Indicates an error occurred on the client’s part.
5XX: Indicates an error occurred on the server’s part.
200 OK
The request was successful.
201 Created
A new resource has been created successfully.
202 Accepted
The request has been accepted and queued for execution.
400 Bad Request
The server could not understand the request due to invalid syntax.
401 Authentication Failure
The request has not been applied because it lacks valid authentication credentials for the target resource.
403 Forbidden
The server understood the request but refuses to authorize it.
404 Resource Not Found
The server can't find the requested resource.
405 Method Not Allowed
The request method is known by the server but has been disabled and cannot be used.
409 Conflict
The request could not be completed due to a conflict with the current state of the target resource.
412 Prediction Failure
The server does not meet one of the preconditions that the requester put on the request.
413 Request Entity Too Large
The request is larger than the server is willing or able to process.
500 Internal Server Error
The server encountered an unexpected condition that prevented it from fulfilling the request.
501 Not Implemented
The server does not support the functionality required to fulfill the request.
503 Service Unavailable
The server is not ready to handle the request, often due to maintenance or overload.
This section focuses on managing payment cards associated with a user's account. It includes APIs for adding, retrieving, and deleting card details, allowing your customers to manage their payment methods easily.
Get User Card Details: Retrieves the saved card information for a user, facilitating a smoother checkout process by allowing users to choose from their saved cards.
Add Card Details: Allows users to add new card details to their account, expanding their options for payment methods.
Delete Card: Enables users to remove a saved card from their account, maintaining the relevance and accuracy of their payment options.
Endpoint: GET /api/Checkout/GetUserDetails
Purpose: Retrieves the user's saved card details.
Request Parameters: emailId=string
Status 200: Card details fetched successfully.
Endpoint: POST /api/Checkout/AddCardDetails
Purpose: Adds a new payment card to the user's account.
Request Body:
Status 200: Card added successfully.
POST /api/Checkout/DeleteCard
Purpose: Removes a saved card from the user's account.
Request Body:
Central to Krepling Pay, this section describes the API responsible for initiating and processing payments. It's designed to handle transactions securely, leveraging user and card details for payment completion.
Process Payment: Executes the payment process using stored payment methods, handling transactions securely and efficiently.
POST /api/Authorizations/PostECommerce
Purpose: Executes a payment transaction using the user's chosen payment method.
Request Body:
Response:
The Address Management section provides functionalities for adding, updating, and managing delivery addresses. It ensures that your customers can specify where they want their purchases delivered and manage their multiple addresses if needed.
Add Delivery Address: Lets users add a new delivery address, useful for users who have multiple shipping locations.
Get Address Details: Retrieves all saved addresses for a user, allowing them to choose a shipping address during checkout.
Update Address: Allows users to modify an existing address, keeping their delivery information up to date.
Delete Address: Users can remove an unwanted address, simplifying their address list.
Set Default Address: Designates one of the saved addresses as the default, streamlining the checkout process by pre-selecting the user's preferred shipping address.
Endpoint: POST /api/Address/AddAddress
Purpose: Adds a new delivery address for the user.
Request Body:
Status 200: Address added successfully.
Endpoint: GET /api/Address/GetAddresses
Purpose: Retrieves all saved addresses for a given user, allowing them to manage and select from multiple addresses easily. This API is particularly useful for users with multiple delivery locations or those looking to verify their saved addresses.
Request Parameters:
Type: UserId
Values: int
(The user's unique identifier)
Response:
Endpoint: POST /api/Address/UpdateAddress
Purpose: Allows users to edit their saved addresses, ensuring their delivery information is always accurate and up-to-date. This API is crucial for maintaining the integrity of user data and facilitating smooth delivery processes.
Request Details:
Method: POST
URL: api/Address/UpdateAddress
Body:
Endpoint: POST /api/Address/DeleteAddress
Purpose: Allows for the removal of a user's saved address from their account, ensuring users can manage their address book effectively.
Request Body:
POST /api/Address/SetDefaultAddress
Purpose: Designates a specific address as the default for shipping, streamlining the checkout process.
Request Body:
This guide is designed to walk you through the process in a clear, step-by-step manner, whether you choose to install the module via composer or by using a zip file. Additionally, we'll cover how to configure the Krepling Payment Method settings within your Magento admin panel.
Open your terminal or command prompt.
Navigate to the root directory of your Magento installation.
Enter the following command to install the Krepling Pay extension:
This command tells Composer, a dependency manager for PHP, to download and install the Krepling Pay module for your Magento store.
After the installation is complete, you need to integrate the extension with your Magento installation. Execute the following Magento commands one by one in your terminal:
These commands compile your Magento code, upgrade your database schema (if needed), deploy static view files, and clear the Magento cache to ensure your new module works correctly.
Log into your Magento admin panel.
Go to 'System' > 'Web Setup Wizard' > 'Module Manager' to check if the Krepling Pay module is listed and enabled.
Enter the required Merchant ID and Secret ID to activate the module fully.
Download the Krepling Pay module as a zip file and extract it.
Upload the extracted folder to your Magento server's app/code
directory. This might require FTP access or a file manager tool provided by your hosting service.
Make sure the folder structure follows the Magento standard: app/code/VendorName/ModuleName
.
Replace "VendorName" and "ModuleName" with the actual names for the Krepling Pay module.
Just like with the composer installation, run the same Magento deploy commands in your terminal to compile the code and update your Magento instance.
Again, check in your Magento admin panel if the module is active and enter the Merchant ID and Secret ID.
In your Magento admin panel, navigate through Stores
> Settings
> Configuration
> Sales
> Payment Methods
.
Scroll down to "Other Payment Methods" and find the Krepling Payment Method.
Enter your Merchant ID and Secret ID in the respective fields. These credentials are essential for processing payments through Krepling Pay.
Adjust any other settings according to your preferences.
Click on the Save Config
button to apply your changes.
After completing the setup and configuration, Krepling Pay will be available as an option on your checkout payment page. Customers can now choose Krepling Pay to complete their purchases securely and efficiently.
This guide aims to make the integration process as straightforward as possible. However, if you encounter any issues, consult the official Magento and Krepling documentation or reach out to our support team at support@krepling.com for additional assistance.
Krepling Pay's security architecture is designed with the utmost consideration for protecting sensitive payment information and ensuring the integrity of all transactions. This section breaks down the security mechanisms and technologies employed by Krepling Pay, providing a developer-friendly overview of how Krepling Pay ensures a secure e-commerce environment.
Krepling Pay utilizes industry-standard encryption protocols to secure data transmission between clients, servers, and payment processors. Data at rest is encrypted using AES-256, which is the gold standard for data encryption and ensures that sensitive information is unreadable to unauthorized users.
TLS 1.3 Implementation: Krepling Pay leverages TLS 1.3 protocols, optimizing secure data transmission with features like forward secrecy and encrypted SNI (Server Name Indication), further obfuscating and protecting data in transit.
HSTS (HTTP Strict Transport Security): Enforced to ensure client connections cannot fall back to less secure protocols and prevent SSL stripping attacks.
Krepling Pay integrates an advanced tokenization mechanism that substitutes sensitive data elements with non-sensitive equivalents, termed tokens, that have no exploitable value. This process is anchored in cryptographic hashing algorithms and a secure token vault.
Cryptographically Secure Pseudorandom Number Generation (CSPRNG): For token generation, ensuring unpredictability and resistance against prediction or manipulation.
Isolated Token Vault: Tokens are stored in an isolated, encrypted database environment with limited access, employing hardware security modules (HSMs) for cryptographic key management and storage, ensuring that even in the event of a data breach, actual payment data remains uncompromised.
Krepling Pay's fraud detection dynamically assess transaction risk in real-time, comparing against historical data and evolving threat patterns to identify and mitigate potential fraud with precision.
Behavioral Analysis & Anomaly Detection: Continuous monitoring of transaction behaviors to detect anomalies that deviate from established patterns, employing deep learning models to adapt to new fraud tactics.
Adaptive Authentication: Implementing risk-based authentication strategies, including biometric verification and behavioral biometrics, tailoring the authentication process to the assessed risk level of each transaction.
Adhering to the highest standards of regulatory compliance, Krepling Pay ensures alignment with global security benchmarks and legal frameworks.
PCI DSS Level 1 Compliance: Meeting and exceeding the strictest PCI DSS requirements for payment processors, including regular penetration testing, security audits, and ensuring all third-party services and integrations comply with these standards.
GDPR and Data Privacy Regulations: Ensuring data processing practices are in full compliance with GDPR and other relevant data protection laws, focusing on data minimization, consent management, and secure data handling practices.
Krepling Pay's checkout experience is engineered to maximize security without compromising user experience, employing several innovative features:
Seamless Integration of Secure Customer Authentication (SCA): Leveraging 3D Secure 2.0 for frictionless authentication, minimizing checkout steps while adhering to regulatory requirements for transaction authentication.
Dynamic Linking: Each transaction is cryptographically linked to specific transaction details, preventing manipulation and ensuring the integrity of the transaction from initiation to completion.
The architectural and operational security measures deployed by Krepling Pay exemplify a gold standard in payment gateway security. By leveraging cutting-edge cryptographic techniques, and stringent compliance with global security standards, Krepling Pay delivers a secure, seamless, and highly resilient e-commerce payment solution. This technical prowess not only minimizes the attack surface but also instills trust among merchants and consumers alike, reinforcing Krepling Pay's position as a leader in the secure e-commerce gateway landscape.
This guide will cover two methods of installing a WordPress plugin for Krepling Pay: using a zip file for manual installation and through the WordPress plugin search for automatic installation. Following that, we will guide you through configuring Krepling Pay within WooCommerce.
Access your WordPress dashboard.
Navigate to the left menu, select Plugins
> Add New
.
Click on the Upload Plugin
button at the top of the page.
Click Choose File
and select the Krepling Pay plugin zip file from your computer.
Click Install Now
to upload and install the plugin.
After installation, you'll be prompted to activate the plugin. Click Activate Plugin
.
Within your WordPress admin, go to Plugins
> Add New
.
Use the search box to find Krepling Pay. Note: This method works only for plugins available in the WordPress plugin directory.
Click Install Now
next to Krepling Pay.
Once installed, the button will change to Activate
. Click it to activate Krepling Pay on your site.
Navigate to WooCommerce
> Settings
> Payments
.
Find Krepling Pay
in the list and click the toggle button to enable it.
Click on “Finish set up” to enter the configuration details.
In Krepling Pay's settings, you can enable or disable the plugin.
Enter your Merchant ID and Secret ID. These are essential for processing payments.
After entering all required details, click Save Changes
.
After configuring Krepling pay, it will appear as an option on your checkout page, allowing customers to choose Krepling Pay for their purchases.
Krepling Pay's custom integration guide is tailored for merchants who have developed their own e-commerce website and seek to streamline the checkout process for their customers while minimizing cart abandonment.
Copy and paste the provided script code into your store's backend. This script manages user interactions during checkout. Make sure to replace placeholder identifiers like #submit
and #merchantId
with the actual IDs or classes corresponding to your website's elements.
Seamlessly integrate the script code within your store's checkout or payment section. This ensures a smooth transition for users during the checkout process.
When customers initiate the checkout process, the integrated script generates an iframe dynamically. This iframe loads the Krepling Pay checkout page with all the necessary parameters, including the Merchant ID, Secret Key, and product details. Users are then redirected to Krepling Pay for eventual payment processing.
Thoroughly test the integration to ensure a seamless checkout experience for your customers. Verify that users can smoothly complete transactions without any errors. If you encounter any issues or need further assistance, don't hesitate to reach out to our support team for help at support@krepling.com
Begin by creating a new Merchant Account with Krepling Pay by heading or contacting us directly at pay@krepling.com. Once you have successfully created an account with Krepling Pay, you will receive your unique Merchant ID and Secret Key via email. These credentials will be essential for the integration process.