Integrations
Implementation Guide
Implementing is simple
Implementing Khipu
Implementing Khipu in your business is a 100% self-managed process. Nevertheless, we know that questions can always arise both in the API Rest integration process and in the configuration of the payment account(s).
While questions can always arise, which can be clarified through our Help section (button in the lower right corner), in the following lines we will explain in the simplest way possible what the main steps are to start receiving payments with Khipu.
Generally speaking, the process can be divided into four main parts:
The integration of the API Rest for the process of collections and payments.
The configuration of the payment account and other details.
The graphic material.
The integration of the reconciliations to the company’s accounting system via web services (optional but recommended).
REST API integration
The complete documentation can be found here, where you will find:
An introduction to the process of creation, payment, and validation.
Relevant definitions for understanding the document.
Using the Rest API to create charges and receive payments.
Advanced uses of the Rest API
How to create the testing environment and move to production.
How to install the libraries in the language you need (we have libraries in the following programming languages: PHP, Ruby, Java, .NET).
API reference.
How to sign the requests to the API.
Integration with mobile applications (Android and iOS).
Given our experience, we can say that, in general, an integration takes between 2 weeks and 1 month, depending on the amount of time you dedicate to this task and your prior experience with the Khipu API or similar ones.
Creation of the billing account in Developer mode
Khipu does not have a separate test version from the production version. It uses the API and servers of the main platform. For development testing, a 'developer charging account' is used.
When you have finished the integration in developer mode, you just need to create a production charging account and make the changes to the charging account ID and its secret key in the endpoint you created during the process. With just this, the platform will be ready to start producing.
Production billing account setup and other details
To receive payments with Khipu, the first thing you need to do is create your payment account. There are two methods to create the payment account. The first is without having previously created a user account, and the second is with a user account that has been previously created.
Option 1: Without having a user account
The first thing you need to do is create your user account here
Then to create the payment account, log in to your newly created account and go to the "I pay" section and click on "Create new payment account". You will need to choose the country and select the type of Account for commercial use.
Here you will start a four-step process:
Creation of your account.
Selection of your bank (where you will receive the money collected and then reported by Khipu).
Validation of your bank account (you will make a payment for the minimum amount allowed by your bank, which will be refunded to you on the next business day).
Sign the Contract: Accept the terms of the Mandate so that Khipu can collect funds on behalf of the business and report them the next business day.
With this, you will have created your user account and your first payment account, which you will be able to associate, with its credentials, to the endpoint you will have created in the development and integration stage of Khipu.
Option 2: You already have the billing account created.
Depending on your business, you may need to create more than one payment account. Whether it's because you want to receive money from different product lines, in different bank accounts, or because you want to have different pricing plans.
If that's the case, once inside the platform, you can create a new payment account. In the Yo Cobro section, select Collect as New Payment Account, and you will start the same 4-step process described in option 1. If you enter an account that is already verified in our system, you will not go through the transfer process to validate your account.
Other settings
In your user account, it will be important for you to enter your company's logo. This is done in Settings / User Profile. The ideal dimensions for the image are 120 x 120 pixels.
You will be able to create one or more billing accounts. For each of them, it will be important that you make a good configuration. You can make these configurations in the section «Billing Account Options« of the respective "I Charge" account.
Here are some concepts that may be useful for configuring the billing account(s):
Bank account to receive payments: You can create bank accounts and use one at a time. The creation requires you to make a payment, for the minimum amount allowed by your bank, through the platform, which will be refunded to you the next business day. Khipu will make the disbursement of the collected money to this account. Just like in the account validation process, disbursements are made the next business day.
Billing and contact information: In order for you to receive an invoice instead of a receipt that is subject to Khipu's commission, it is important that you configure this section by filling in your billing, contact, and business information.
Charging plan: Here you can view the plan associated with that billing account. You can change it whenever you want from here.
Users of this billing account: You can set up users with profiles with different access levels (Administrator, commercial or seller). The profile is selected, and the user's email address is indicated. It is important that this user has created their user account in Khipu.
Email notifications: There are various important events during the process (payment notifications, copy of the payment receipt, daily summary of payments received, monthly summary of payments received, contingency information). Here you enter the email addresses that wish to receive these notifications.
Payment receipt: Allows configurations such as whether you want the payer to receive the receipt or not, or if you want the collector's email to appear on the payment receipt. By default, the receipt will be sent to the payer.
To integrate Khipu into your website: (In this section, you will find valuable information for API integration)
Collector ID and key: Must be entered in the merchant's endpoint.
Instant payment notifications: Where the website URL of the merchant is indicated to receive notifications.
URL to receive the daily disbursement report: This is used to receive disbursement data through web services and thus automatically update the accounting and administrative information in the merchant's ERP.
URL to receive daily transaction reports: To receive the report via web services.
Integration of the expense reports into the accounting system of the business (optional, recommended)
An important part of digital transformation implies that the end-to-end processes are as automated as possible, allowing for agility, cost reduction, and reduction of human errors resulting from manual activities.
In the case of Khipu, since our beginnings, we have made it possible to send notifications automatically with the details of each reimbursement made to the checking account associated with your billing account.
The integration of reimbursement reports into the commerce's accounting system, while optional, is an important part of our value proposition.
More and more businesses are carrying out this development, because thanks to this, they manage to automate their accounting and administrative processes.
The information to integrate reimbursements into the accounting system can be found here, in the API documentation.
Graphic material
We want the integration of Khipu in your business to be a complete success. And since we know that making a good impression is important, we have taken care to provide you simply with our logo and icon for different uses. We also want the Khipu payment button to stand out on your site's checkout page, so we are providing you with different types of payment buttons for you to choose the one you like best.