Introducción

En nuestras API encontrarán la documentación necesaria para hacer más sencilla la integración a nuestros servicios de pago de factura del servicio de Digitel.

El API de pago de facturas de Digitel les permite integrar su aplicación a nosotros y así poder brindarles a sus clientes la opción de realizar pagos del servicio de Digitel.

Para hacer más fácil la comprensión de nuestra API, preparamos un conjunto de ejemplos de código que les permitirá entender la integración que necesiten implementar.  La información que les proporcionamos es en nuestro entorno Sandbox y el entorno Sandbox del proveedor Digitel, lo que les permitirá experimentar con la API haciendo pagos de facturas simulados para Digitel, todo esto, luego de recibir acceso a dicho ambiente.

AUTENTICACIÓN ​/digitelpostpago​/auth​/login

Cada aliado debe contar con un username y un password proporcionados por ekiipago. Al invocar este endpoint, con los datos necesarios, se devuelve un token de acceso que se debe usar para el resto de los endpoint que están protegidos.  Se utilizaría el encabezado HTTP “Autorización” en el formato Authorization: Bearer <token>.

 

Request body

{
"username": "string",
"password": "string"
}

CONSULTA ​/digitelpostpago​/consulta

Por ser un servicio de pago de factura se debe invocar el endpoint de consulta para poder obtener el monto a cancelar a través de nuestra conexión con el proveedor Digitel. El token generado en /auth se debe colocar en este endpoint para poder consumirlo.

RECARGA ​/digitelpostpago​/recarga

Este endpoint permitirá realizar pago de facturas del servicio de Digitel a través de nuestra conexión con el proveedor Digitel. El proveedor dispone de un rango de montos mínimos y máximos permitidos para hacer el pago. El token generado en /auth se debe colocar en este endpoint para poder consumirlo.

Request body

{
  "phone": "string",
  "amount": 0,
  "reference": "string",
  "channel": "string",
  "agency_reference": "string"
}

RECARGA ​/digitelpostpago​/afiliacion

Este endpoint le brinda al aliado comercial poder crear una lógica de afiliación de números de teléfonos en su app. Al usarlo, el endpoint valida si en efecto el número es válido para este servicio y puede realizar pago de facturas. El token generado en /auth se debe colocar en este endpoint para poder consumirlo.