API

Para realizar solicitudes de pago mediante la API es necesario primero que genere un Token. En este caso, lo deberá hacer a través del método obtener_token.

El inicio de la solicitud a través de API requiere que posea credenciales de firma para su Organismo.

La ventaja de este tipo de integración, es que puede generar operaciones sin interacción del contribuyente, porque no deberá ser redireccionado a nuestra platafroma y la podrá generar de forma totalmente automatizada.

Por motivos de seguridad, este de tipo de integración no admite el pago con tarjetas de crédito y/o débito directamente enviándolos a la API. Si desea habilitar al contribuyente a pagar por estos medios de pago, deberá usar el QR generado.


El proceso para generar operaciones será el siguiente:

  • En base a las credenciales recibidas, se obtiene el Token mediante una petición SOAP al método de la API obtener_token como se indicó más arriba.
    Recuerde que el Token se consume en cada solicitud y/o invocación a un método del Webservice.
  • Con el Token generado, se deberá obtener la lista de medios de pago disponibles para que el usuario seleccione entre ellos cual va a utilizar. Esto se hace mediante un llamado obtener_entidades_pago (este paso puede evitarse si ya tiene la lista de medios de pago guardada o si según su lógica de negocio tiene pre-definido el médio de pago a seleccionar o si desea utilizar la forma de pago Combinada.
  • Con el Token generado y la forma de pago ya definida, deberá realizar una llamada al método solicitud_pago de la API, este método retornará la información del pago creado junto con el PDF de la boleta de pago que el usuario necesitará para abonarla.
    Puede utilizar de la repuesta solamente el código de barras y el código QR para embeberlo en su propio diseño de boleta de pago.
Forma de pago combinada
La forma de pago Combinada, le permitirá habilitar el cobro de una operación por las diferentes formas soportadas por la plataforma. De esta manera con la misma boleta, se podrá cobrar en efectivo y homebanking. Y el uso junto con el QR habilita el pago con tarjetas de crédito o débito.

Código fuente de ejemplo - SDK PHP

En nuestro repositorio podrá encontrar un ejemplo de cómo obtener su token y hacer la petición para generar la boleta de pago.

https://github.com/epagos/api_php/tree/master/api