Culqi PHP

Biblioteca PHP oficial de CULQI, pagos simples en tu sitio web.

Importante: Hemos descontinuado el soporte a la versión 1.0 de Culqi API para centrarnos en la nueva versión. Si estabas trabajando con la anterior versión de esta biblioteca puedes entrar al branch 1.1.1.

Nota: Esta biblioteca trabaja con la v1.2 de Culqi API.

Requisitos

• PHP 5.3 o superiores.
• Credenciales de comercio Culqi (1).

(1) Debes registrarte aquí. Luego, crear un comercio y estando en el panel, acceder a Desarrollo > API Keys.

Instalación

Vía Composer

{
  "require": {
    "culqi/culqi-php": "1.2.*"
  }
}

Y cargar todo usando el autoloader de Composer.

require 'vendor/autoload.php';

Manualmente

Clonarse el repositorio o bajarse el código fuente

$ git clone git@github.com:culqi/culqi-php.git

Ahora, incluir en la cabecera a culqi-php y también la dependencia Requests. Debes hacer el llamado correctamente a la carpeta y/o archivo dependiendo de tu estructura.

<?php
// Cargamos Requests y Culqi PHP
require 'vendor/rmccue/requests/library/Requests.php';
Requests::register_autoloader();
require 'vendor/culqi/culqi-php/lib/culqi.php';

Modo de uso

En todos ejemplos, inicialmente hay que configurar la credencial $SECRET_API_KEY y el entorno en el que nos encontramos (Integración o Producción.).

// Configurar tu API Key y autenticación
$SECRET_API_KEY = "vk9Xjpe2YZMEOSBzEwiRcPDibnx2NlPBYsusKbDobAk";
$culqi = new Culqi\Culqi(array('api_key' => $SECRET_API_KEY));

// Entorno: Integración (pruebas)
$culqi->setEnv("INTEG");

Crear un token (Usarlo SOLO en DESARROLLO)

Antes de crear un Cargo, Plan o un Suscriptor es necesario crear un token de tarjeta. Dentro de esta librería se encuentra una funcionalidad para generar 'tokens', pero solo debe ser usada para desarrollo. Lo recomendable es generar los 'tokens' con CULQI.JS cuando pases a producción, debido a que es muy importante que los datos de tarjeta sean enviados desde el dispositivo de tus clientes directamente a los servidores de Culqi, para no poner en riesgo información sensible.

Crear un cargo (Cargos)

Crear un cargo significa cobrar una venta a una tarjeta. Para esto previamente deberías obtener el token que refiera a la tarjeta de tu cliente.

// Creamos Cargo a una tarjeta
$cargo = $culqi->Cargos->create(
    array(
        "token"=> "vVhhnxxbNpFG8cfEAwhtTfK4g8sf7oOi",        
        "moneda"=> "PEN",
        "monto"=> 19900,      
        "descripcion"=> "Venta de prueba",
        "pedido"=> "PED3351",       
        "codigo_pais"=> "PE",
        "ciudad"=> "Lima",
        "usuario"=> "71701956",
        "direccion"=> "Avenida Lima 1232",      
        "telefono"=> 12313123,
        "nombres"=> "Will",
        "apellidos"=> "Muro",
        "correo_electronico"=> "wmuro@me.com"
    )
);

//Respuesta
print_r($cargo);

Crear un suscriptor a un plan (Suscripciones)

// Creando Suscriptor a un plan
$suscriptor = $culqi->Suscripciones->create(
    array(
        "token"=> "wNjBRhnEKFtBEEiRiNdTCVj7ogiNJ1Q8",
        "codigo_pais"=> "PE",
        "direccion"=> "Avenida Lima 123213",
        "ciudad"=> "Lima",
        "usuario"=> "71701956",
        "telefono"=> "1234567789",
        "nombre"=> "Brayan",
        "apellido"=> "Cruces",
        "correo_electronico"=> "brayan.cruces@culqi.com",
        "plan_id"=> "plan-basico"    
    )
);

//Respuesta
print_r($suscriptor);

Documentación

¿Necesitas más información para integrar culqi-php? La documentación completa se encuentra en https://developers.culqi.com

Tests

$ phpunit tests

Licencia

Licencia MIT. Revisar el LICENSE.md.