Khipu
The Khipu integration allows a binary from an electronic commerce to charge a client by using the Khipu SDK. This way, clients can pay with their bank accounts.
Note
The integration described in this article may not be implemented in your environment or enabled for all your clients. Contact your admin for assistance.
Technical Details
API ID | 585 |
API Code | KHIPU |
Call API version | 1 |
SDK Version | iOS: Khenshin 1.713 Android: Khenshin 7.2.2 |
App Version | iOS: [6.5.2] Android: [7.1.0]. From this version, it is necessary to have the Android plugin and Gradle's latest version. |
Available for | Android, iOS |
Use the Khipu Integration in Studio
The following functions are available for use in your legacy processes, and you can also use them as blocks in Lambda processes. Click each function to see more details.
Initialize the Khipu SDK with the required parameters. | |
Receive a payment. |
StartSdk
This function initializes the Khipu SDK with the configuration set on the input .json.
Parameter Configuration
This function requires you to run the Khipu Customization JSON with the initialization configuration for the SDK. Read Input Registers to learn more.
Function ID
Register | Value |
---|---|
110 | 1 |
Input Registers
Register | Description | Mandatory | Value |
---|---|---|---|
390 | Khipu Customization JSON. JSON used to configure the SDK's initialization parameters. | Yes | { "mainButtonStyle": 0, "credentialsSaving": true, "hideWebAddress":false, "includeSkipExitPage":true, "includeProgressDialog":true, "progressDialogResource": "", "decimalSeparator": ".", "groupingSeparator": ",", "clearCookiesBeforeStart":true, "autoSubmitWhenCompleted":true, "fontResource": "" } |
Initialization Parameters
You can configure a set of parameters to define how to initialize the SDK. See the table below to learn how to configure them.
MainButtonStyle | This parameter defines the style of the "Continue" button on every screen. Insert "0" to add the button inside the form, or insert "1" to add the button to the toolbar. |
CredentialsSaving | Boolean parameter to choose whether the user's credentials are stored or not. |
hideWebAddress | Boolean parameter used to show or hide the navigation bar. |
includeSkipExitPage | This parameter allows you to add or delete a button to cancel payments. |
includeProgressDialog | This option is unavailable. |
progressDialogResource | This option is unavailable. |
decimalSeparator | This parameter allows you to choose the decimal separator. |
groupingSeparator | This parameter allows you to choose the thousands separator. |
autoSubmitWhenCompleted | With this parameter, you can choose to move forward on a form automatically once every field is completed. |
fontResource | This option is unavailable. |
Output Registers
Register | Description | Value | ||||||
---|---|---|---|---|---|---|---|---|
112 | Call Result |
|
ApprovePayment
This function is in charge of approving payments. To run this function, it is necessary to invoke the StartSdk function first.
Parameter Configuration
This function requires you to complete the Payment ID.
Function ID
Register | Value |
---|---|
110 | 2 |
Input Registers
Register | Description | Mandatory | Value |
---|---|---|---|
390 | Payment ID | Yes | Payment ID |
Output Registers
Register | Description | Value | ||||||
---|---|---|---|---|---|---|---|---|
112 | Call Result |
| ||||||
290 | Payment Result | 0: Approved 1: Not approved | ||||||
291 | Returned URL | - |