Khipu

https://docs.khipu.com/
Admin
Khipu is a platform that facilitates secure and efficient payment processing, enabling businesses to...
Tokens:135,799
Snippets:792
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install capacitor-khipu for Capacitor 7

Source: https://docs.khipu.com/payment-solutions/instant-payments/khipu-client-capacitor

Installs the Capacitor 7 compatible version of capacitor-khipu and syncs the native projects. Use this when your app targets Capacitor 7.

```bash
npm install capacitor-khipu@cap7
npx cap sync
```

--------------------------------

### Get dependencies

Source: https://docs.khipu.com/payment-solutions/instant-payments/khipu-client-flutter

Run this command to fetch the dependencies after adding the plugin.

```bash
flutter pub get
```

--------------------------------

### Install cordova-khipu plugin

Source: https://docs.khipu.com/payment-solutions/instant-payments/khipu-client-cordova

Installs the cordova-khipu plugin. On iOS, declare the deployment-target in config.xml before running cordova platform add ios; otherwise the Podfile keeps the default value and cordova plugin add may fail with a CocoaPods error about KhipuClientIOS requiring a higher minimum deployment target. If that happens, run cordova prepare ios and retry.

```bash
cordova plugin add cordova-khipu
```

--------------------------------

### Install capacitor-khipu for Capacitor 8

Source: https://docs.khipu.com/payment-solutions/instant-payments/khipu-client-capacitor

Installs the Capacitor 8 compatible version of capacitor-khipu and syncs the native projects. Use this when your app targets Capacitor 8.

```bash
npm install capacitor-khipu
npx cap sync
```

--------------------------------

### Install capacitor-khipu for Capacitor 5 and 6

Source: https://docs.khipu.com/payment-solutions/instant-payments/khipu-client-capacitor

Installs the Capacitor 5 and 6 compatible version of capacitor-khipu and syncs the native projects. Use this when your app targets Capacitor 5 or 6.

```bash
npm install capacitor-khipu@cap6
npx cap sync
```

--------------------------------

### startOperation(options: StartOperationOptions) => Promise<KhipuResult>

Source: https://docs.khipu.com/payment-solutions/instant-payments/khipu-client-react-native

Starts a Khipu payment operation with the provided options and returns a promise that resolves to a KhipuResult.

```APIDOC
## startOperation(options: StartOperationOptions) => Promise<KhipuResult>

### Description
Starts a Khipu payment operation with the provided options and returns a promise that resolves to a KhipuResult.

### Method
startOperation

### Parameters
- **options** (StartOperationOptions) - Required - The options for the operation, including the operation ID and additional configuration.

### Returns
Promise<KhipuResult>

### Interfaces

#### KhipuResult

| Propiedad | Tipo |
|  --- | --- |
| **`operationId`** | string |
| **`exitTitle`** | string |
| **`exitMessage`** | string |
| **`exitUrl`** | string | undefined |
| **`result`** | 'OK' | 'ERROR' | 'WARNING' | 'CONTINUE' |
| **`failureReason`** | string |
| **`continueUrl`** | string |
| **`events`** | KhipuEvent[] |

#### KhipuEvent

| Propiedad | Tipo |
|  --- | --- |
| **`name`** | string |
| **`timestamp`** | string |
| **`type`** | string |

#### StartOperationOptions

| Propiedad | Tipo |
|  --- | --- |
| **`operationId`** | string |
| **`options`** | KhipuOptions |

#### KhipuOptions

| Propiedad | Tipo |
|  --- | --- |
| **`locale`** | string |
| **`title`** | string |
| **`titleImageUrl`** | string |
| **`skipExitPage`** | boolean |
| **`showFooter`** | boolean |
| **`theme`** | 'light' | 'dark' | 'system' |
| **`colors`** | KhipuColors |

#### KhipuColors

| Propiedad | Tipo |
|  --- | --- |
| **`lightBackground`** | string |
| **`lightOnBackground`** | string |
| **`lightPrimary`** | string |
| **`lightOnPrimary`** | string |
| **`lightTopBarContainer`** | string |
| **`lightOnTopBarContainer`** | string |
| **`darkBackground`** | string |
| **`darkOnBackground`** | string |
| **`darkPrimary`** | string |
| **`darkOnPrimary`** | string |
| **`darkTopBarContainer`** | string |
| **`darkOnTopBarContainer`** | string |
```

--------------------------------

### KhipuLauncher.launch

Source: https://docs.khipu.com/payment-solutions/instant-payments/khipu-client-ios

Creates an Intent to start the Khipu payment process. This function is essential for launching the Khipu payment activity.

```APIDOC
## KhipuLauncher.launch

### Description
Creates an Intent to start the payment process using the Khipu SDK. This Intent is essential for launching the Khipu payment activity.

### Method
launch

### Parameters
- **presenter** (UIViewController) - Required - The view that is present in the application just before invoking Khipu.
- **operationId** (String) - Required - The unique identifier of the payment intention.
- **options** (KhipuOptions) - Required - Configurations to customize the interface and behavior of the payment process, defined using KhipuOptions.Builder().
  - **header** (KhipuHeader) - Optional - Configures the header of the payment activity with elements such as titles and logos.
  - **topBarTitle** (String) - Optional - Title for the top bar during the payment process.
  - **topBarImageUrl** (String) - Optional - URL of the image in the top bar.
  - **topBarImageResourceName** (String) - Optional - Name of the resource in the main bundle for the image in the top bar.
  - **topBarImageScale** (CGFloat) - Optional - Value from 0.0 to 1.0, scales the top bar image.
  - **skipExitPage** (Boolean) - Required - If true, the page at the end of the payment process is omitted, whether successful or failed.
  - **skipExitSuccessPage** (Boolean) - Required - If set to true, the final page of the payment flow is omitted, but only when the payment was successful. Useful to show the success screen within your application and let Khipu handle error or failure screens.
  - **showFooter** (Boolean) - Required - If true, a message is shown at the bottom with the Khipu logo.
  - **theme** (KhipuOptions.Theme) - Required - Interface theme, can be: .system (uses dark/light theme depending on device configuration), .light (uses light theme), .dark (uses dark theme).
  - **locale** (String) - Required - Regional configuration for the interface language. Standard format combining ISO 639-1 language code and ISO 3166 country code. Example: "es_CL" for Spanish from Chile. If not sent, the client uses es_CL. Note that the Android client follows the device language, so send it explicitly if you need the same language on both platforms.
  - **colors** (KhipuColors) - Required - Allows customizing the user interface colors.
- **onComplete** ((KhipuResult) -> Void) - Optional - Callback function that will be called when the payment process finishes, providing a KhipuResult object as parameter.

### Request Example
```swift
KhipuLauncher.launch(
    presenter: self,
    operationId: "operationId",
    options: KhipuOptions.Builder()
        .setTopBarTitle("Mi App")
        .setTheme(.light)
        .build(),
    onComplete: { result in
        // Handle result
    }
)
```

### Response
No direct response. The result is delivered via the onComplete callback with a KhipuResult object.
```

--------------------------------

### Configuración de deployment target para iOS en config.xml

Source: https://docs.khipu.com/payment-solutions/instant-payments/khipu-client-cordova

Declara la preferencia 'deployment-target' para iOS en config.xml cuando se necesita un piso mayor que iOS 13.0. Debe declararse antes de agregar la plataforma iOS. En cordova-ios 7 el plugin usa CocoaPods; en cordova-ios 8, al declarar la preferencia, Cordova sincroniza el Podfile y ejecuta 'pod install', requiriendo CocoaPods instalado.

```xml
<platform name="ios">
    <preference name="deployment-target" value="14.0" />
</platform>
```

--------------------------------

### Install CocoaPods dependencies for iOS

Source: https://docs.khipu.com/payment-solutions/instant-payments/khipu-client-react-native

Installs CocoaPods dependencies for the iOS project. Run from the project root; it changes into the ios directory, updates the pod repositories, and returns to the root.

```bash
cd ios
pod install --repo-update
cd ..
```

--------------------------------

### POST /v1/cl/banking/entrepreneur/bci.cl/statements/latest

Source: https://docs.khipu.com/_bundle/apis/v1/cl/banking/entrepreneur/bci.cl/openapi.yaml?download=

Este endpoint permite obtener las transacciones más recientes de la cuenta del usuario en BCI - Pymes. Soporta tanto respuestas síncronas como asíncronas mediante el campo CallbackUrl.

```APIDOC
## [POST] /v1/cl/banking/entrepreneur/bci.cl/statements/latest

### Description
Este método se conecta a la cuenta especificada por el usuario en **BCI - Pymes** y retorna las transacciones más recientes registradas en la cuenta. El uso del campo `CallbackUrl` desencadenará un proceso asíncrono y los datos resultantes se enviarán más tarde al webhook especificado. Esta es la forma preferida de interactuar con nuestros servicios, ya que asegura que se harán todos los esfuerzos para extraer los datos y cumplir con su solicitud dentro de un plazo razonable. Si desea la respuesta de inmediato, omita el campo `CallbackUrl` pero tenga en cuenta que puede provocar tiempos de espera dependiendo del tamaño del resultado de los datos y las condiciones de la red.

### Method
POST

### Endpoint
/v1/cl/banking/entrepreneur/bci.cl/statements/latest

### Parameters
#### Request Body
- **LatestTransactionsRequest** (object) - Required - Esquema de la solicitud para obtener las transacciones más recientes. Incluye el campo `CallbackUrl` opcional para activar el proceso asíncrono.

### Request Example
{
  "callbackUrl": "https://example.com/webhook"
}

### Response
#### Success Response (200)
- **LatestTransactionsResponseSyncOk** (object) - Operación exitosa. Retorna un objeto JSON con los datos solicitados.

#### Response Example
{
  "transactions": []
}

#### Success Response (202)
- **LatestTransactionsResponseAsync** (object) - Operación exitosa. Retorna un mensaje JSON informando el resultado de la operación solicitada. La respuesta completa, con el mismo esquema que la versión síncrona, se enviará al URL de callback proporcionado.

#### Response Example
{
  "message": "Operación aceptada"
}

#### Error Response (400)
- Solicitud incorrecta

#### Error Response (401)
- No autorizado - Credenciales inválidas o faltantes

#### Error Response (404)
- No encontrado - Recurso no disponible

#### Error Response (500)
- Error en el servicio remoto :(
```

--------------------------------

### Configuración LSApplicationQueriesSchemes en Info.plist

Source: https://docs.khipu.com/payment-solutions/instant-payments/khipu-client-ios

Agrega la llave LSApplicationQueriesSchemes con un arreglo de strings con las URLs de las apps bancarias chilenas para que OpenApp pueda abrirlas.

```xml
  <key>LSApplicationQueriesSchemes</key>
  <array>
    <string>bancochilemipass2</string>
    <string>BciPassApp</string>
    <string>BICEPassApp</string>
    <string>scotiabankgo</string>
    <string>SantanderPassApp</string>
    <string>tupass</string>
    <string>bancoestado</string>
    <string>itau.cl</string>
    <string>SecurityPass</string>
  </array>
```

--------------------------------

### startOperation function signature

Source: https://docs.khipu.com/payment-solutions/instant-payments/khipu-client-react-native

Starts a Khipu payment operation. Takes a StartOperationOptions object and returns a Promise that resolves to a KhipuResult.

```typescript
startOperation(options: StartOperationOptions) => Promise<KhipuResult>
```

--------------------------------

### POST /v1/cl/services/cenhub.cl/openapi_download

Source: https://docs.khipu.com/_bundle/apis/v1/cl/services/cenhub.cl/openapi.json?download=

Documentación del endpoint para obtener el detalle de una disconformidad del CEN. Incluye el esquema de solicitud y respuesta.

```APIDOC
## POST /v1/cl/services/cenhub.cl/openapi_download

### Description
Servicio para obtener el detalle de una disconformidad del CEN. Permite consultar la información de un caso específico mediante el ID del caso o credenciales de cuenta.

### Method
POST

### Endpoint
/v1/cl/services/cenhub.cl/openapi_download

### Parameters
#### Request Body
- **RequestData** (object) - Required - Información necesaria para conectarse a la cuenta del usuario en el sitio web y extraer datos.
  - **IdCaso** (string) - Required - Filtro. ID del caso obtenido desde los servicios ActiveProcessesList o NonconformitiesList. Cuando se envía, el rendimiento mejora significativamente y no es necesario enviar otros filtros.
  - **AccountCredential** (object) - Optional - Atención: El uso de este campo es obligatorio cuando se utiliza autenticación por Api Key. Puede ser uno de:
    - **AccountLinkCredential** (object) - Utilice este valor para llamar al servicio utilizando el 'Account Link' previamente generado.
      - **AccountLink** (string) - Required - Token generado para acceder a la cuenta del sitio web.
    - **AccountAuthCredential** (object) - Valores necesarios para autenticar al usuario en el sitio web.
      - **Username** (string) - Required - Identificación del usuario con acceso a la cuenta en el sitio web (RUN, DNI).
      - **Password** (string) - Required - Contraseña de la cuenta para el sitio web.
- **CallbackUrl** (string) - Optional - URL para enviar el mensaje de respuesta utilizando un método POST.

### Request Example
{
  "RequestData": {
    "IdCaso": "735999",
    "AccountCredential": {
      "AccountLink": "dFyRCVYNM0aGb1LSR/0B8e+eSVr1Zf1xj9YHmMVoiZWk28XtWEyIxEbGXnr1EdvS+QBPzjweau7tbf5QlDv97IQ2jwfUB=="
    }
  },
  "CallbackUrl": "https://my-api.my-business.com/api/open-data-response"
}

### Response
#### Success Response (200)
- **OperationId** (string) - Identificador único de la operación.
- **Status** (string) - Estado de la operación. `OK` significa que el servicio se ha ejecutado correctamente aunque no devuelva datos. `ERROR` indica que ha ocurrido algo que ha impedido la finalización con éxito del proceso.
- **Data** (object) - Contiene el detalle de la disconformidad.
  - **DetalleDisconformidad** (object) - Detalle completo de un caso de disconformidad del CEN.
    - **DatosDelCaso** (object) - Información del caso.

#### Response Example
{
  "OperationId": "6baf6c19-e485-463b-ae24-a821b025c8a4",
  "Status": "OK",
  "Data": {
    "DetalleDisconformidad": {
      "DatosDelCaso": {}
    }
  }
}
```

--------------------------------

### Invocación de KhipuLauncher.launch

Source: https://docs.khipu.com/payment-solutions/instant-payments/khipu-client-ios

Ejemplo de cómo invocar la API de Khipu usando KhipuLauncher.launch con el presenter, operationId y opciones. El resultado se imprime en consola.

```Swift
import KhipuClientIOS


...

        KhipuLauncher.launch(
            presenter: self,
            operationId: <OperationId>,
            options: KhipuOptions.Builder()
                .build()
                ) { result in
                    print("Operation result \(result.asJson())")
                }
```
Tokens:
Raw