Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
215 lines (154 sloc) 7.15 KB

Php Instapago

Documentación de la librería Instapago


Table of Contents

Información General

Credenciales de Pruebas

* keyId = 74D4A278-C3F8-4D7A-9894-FA0571D7E023
* publicKeyId = e9a5893e047b645fed12c82db877e05a

Importante: Debes solicitar las llaves públicas y privadas (publicKeyId y keyId) a Instapago. Aquí puedes encontrar mayor información.

Parámetros requeridos para crear un pago

  • card_holder: Nombre del Tarjeta habiente.
  • card_holder_id: Cédula del Tarjeta Habiente,
  • card_number: Número de la tarjeta de crédito, 16 dígitos sin separadores.
  • cvc: Código de validación de la Tarjeta de crédito.
  • expiration_date: Fecha de Vencimiento de la tarjeta. Formato MM/YYYY. Por Ejemplo: 10/2015.
  • amount: Monto a Debitar, formato: 0.00 (punto como separador decimal, sin separador de miles).
  • description: Texto con la descripción de la operación.
  • ip: Dirección IP del cliente.

De ahora en más usaremos $paymentData para referirnos a el arreglo con los parámetros antes mencionados.

$paymentData = [
  'amount' => '200',
  'description' => 'test',
  'card_holder' => 'jon doe',
  'card_holder_id' => '11111111',
  'card_number' => '4111111111111111',
  'cvc' => '123',
  'expiration' => '12/2020',
  'ip' => '127.0.0.1',
];

Retornos

Todos los métodos del api devuelven un arreglo asociativo con el siguiente esquema:

  • code: (numeric) Codigo de respuesta de Instapago.
  • msg_banco: (string) Mensaje del banco respecto a la transacción.
  • voucher: (string) Voucher (muy parecido al ticket que emite el POS en Venezuela) en html.
  • id_pago: (string) Identificador del pago en la plataforma de Instapago.
  • reference: (numeric) Referencia del pago en la red bancaria.
  • original_response: (array) Respuesta original de la plataforma de instapago.

Manejo de errores

La excepción base de la librería es \Instapago\Exceptions\InstapagoException y reporta errores generales con instapago, y de ella se derivan 5 excepciones de la siguiente manera.

  • Instapago\Exceptions\AuthException: es lanzada cuando Instapago retorna error en las credenciales.
  • Instapago\Exceptions\BankRejectException: es lanzada cuando un pago es rechazado por el banco.
  • Instapago\Exceptions\InvalidInputException: es lanzada cuando instapago rechaza la entrada de datos.
  • Instapago\Exceptions\TimeoutException: es lanzada cuando es imposible conectarse al api de Instapago y expira el tiempo de carga.
  • Instapago\Exceptions\ValidationException: es lanzada cuando la entrada de datos es inválida. (antes de ser enviada a Instapago).

Códigos de respuesta

Para todas las transacciones realizadas bajo el API de Instapago, los códigos HTTP de respuestas corresponden a los siguientes estados:

  • 201: Pago procesado con éxito.
  • 400: Error al validar los datos enviados (Adicionalmente se devuelve una cadena de caracteres con la descripción del error).
  • 401: Error de autenticación, ha ocurrido un error con las llaves utilizadas.
  • 403: Pago Rechazado por el banco.
  • 500: Ha Ocurrido un error interno dentro del servidor.
  • 503: Ha Ocurrido un error al procesar los parámetros de entrada. Revise los datos enviados y vuelva a intentarlo.

Importante: Si recibe un código de respuesta diferente a los antes descritos deben ser tomados como errores de protocolo HTTP.

Tarjetas de prueba

Para realizar las pruebas, se provee de los siguientes datos para comprobar la integración:

  • Tarjetas Aprobadas:

Pueden indicar cualquier valor para Cédula o RIF, Fecha de Vencimiento y CVC:

  • Visa: 4111111111111111
  • American Express: 378282246310005
  • MasterCard: 5105105105105100
  • Sambil: 8244001100110011
  • Rattan: 8244021100110011
  • Locatel: 8244041100110011

API

Instanciación

$api = new \Instapago\Api('<keyId>','<publicKeyId>');

Crear un Pago Directo

Efectúa un pago directo con tarjeta de crédito, los pagos directos son inmediatamente debitados del cliente y entran en el proceso bancario necesario para acreditar al beneficiario.

try{
  $api = new Api('<keyId>','<publicKeyId>');

  $respuesta = $api->directPayment($paymentData);
  // hacer algo con $respuesta
}catch(\Instapago\Exceptions\InstapagoException $e){

  echo "Ocurrió un problema procesando el pago.";
  // manejar el error 
}

Reservar un Pago

Efectúa una reserva o retención de pago en la tarjeta de crédito del cliente, la reserva diferirá los fondos por un tiempo (3 días máximo segun fuentes extraoficiales), en el plazo en el que los fondos se encuentren diferidos, ni el beneficiario ni el cliente poseen el dinero. El dinero será tramitado al beneficiario una vez completado el pago, o de lo contrario será acreditado al cliente de vuelta si no se completa durante el plazo o si se cancela el pago.

try{
  $api = new Api('<keyId>','<publicKeyId>');

  $respuesta = $api->reservePayment($paymentData);
  // hacer algo con $respuesta
}catch(\Instapago\Exceptions\InstapagoException $e){

  echo "Ocurrió un problema procesando el pago.";
  // manejar el error 
}

Completar Pago

Éste método permite cobrar fondos previamente retenidos.

  • id: Identificador único del pago.
  • amount: Monto por el cual se desea procesar el pago final.
try{
  $api = new Api('<keyId>','<publicKeyId>');

  $respuesta = $api-continuePayment([
    'id' => 'af614bca-0e2b-4232-bc8c-dbedbdf73b48',
    'amount' => '200.00'
  ]);

}catch(\Instapago\Exceptions\InstapagoException $e){
  // manejar errores
}

Información de un Pago

Consulta información sobre un pago previamente generado.

try{
  $api = new Api('<keyId>','<publicKeyId>');

  $idPago = 'af614bca-0e2b-4232-bc8c-dbedbdf73b48';
  
  $respuesta = $api->query($idPago);

}catch(\Instapago\Exceptions\InstapagoException $e){
  // manejar errores
}

Devuelve la misma respuesta que los métodos de crear pagos.

Anular Pago

Este método permite cancelar un pago, haya sido directo o retenido.

try{
  $api = new Api('<keyId>','<publicKeyId>');

  $idPago = 'af614bca-0e2b-4232-bc8c-dbedbdf73b48';

  $info = $api->cancel($idPago);
  
}catch(\Instapago\Exceptions\InstapagoException $e){
  // manejar errores
}

Devuelve la misma respuesta que los métodos de crear pagos.

Licencia

Licencia MIT ©️ 2015 Autores de la librería