Implementación API
Método link
La función de este método es crear links de pago o editar información de un link ya creado, por cada una de las redes mostradas en el método anterior.
Para generar un link de pago, se debe utilizar la llave previamente mencionada y el token generado en el método login y el código de la red social del método redes.
Esta implementación es para el caso en donde el comercio no está asociado a facturación según su afiliación con ebi.
URL Método en producción (POST)
Llave
La misma cadena de caracteres indicada al inicio.
Token
Valor generado en el método login.
Nombre interno
Nombre que usted desee asignar para identificar el link.
Código interno
Código único que no debe repetirse, es el código que lleva cada link al momento que se genera; podrá colocar el número que usted desee.
Este código irá en aumento por cada link que se cree.
Título
Nombre descriptivo del producto, será visible en la página creada con el link.
Descripción
Detalles del producto, será visible en la página creada con el link.
- Valor asignado del producto en venta.
- Este monto puede ser:
- Abierto: se debe colocar un 0 para que el cliente final pueda ingresar la cantidad que se desee.
- Fijo: se establece el valor a cobrar o se puede traer el valor de otro sitio con un método POST.
Estado:
- Nos indica el estado del link.
- Activo: se debe colocar un 1.
- Oculto o Bloqueado: se debe colocar un 0.
Cuotas:
Número de cuotas en las que se puede realizar el pago del producto, los códigos a utilizar estan en las siguientes tablas:
| Código | Descripción |
|---|---|
| VC00 | CONTADO |
| VC02 | 2 cuotas |
| VC03 | 3 cuotas |
| VC06 | 6 cuotas |
| Vc10 | 10 cuotas |
| VC12 | 12 cuotas |
| VC15 | 15 cuotas |
| VC18 | 18 cuotas |
| VC24 | 24 cuotas |
| VC36 | 36 cuotas |
Si cuenta con módulo de cartera, agregar los siguientes parámentros:
| Parámetro | Tipo | Descripción | Obligatorio |
|---|---|---|---|
| Cartera | int | Solo admite valores devueltos del método de carteras | NO |
| excluir_cartera | Tiny int(1) | 0 => Solo se permite los bienes de la cartera asignada 1 => Se excluye los bienes de la cartera asignada. Por defecto quedará en 0 sino se envía nada. |
NO |
Redes sociales:
Valor obtenido en el método redes, generalmente para sitios web en desarrollo se recomienda utilizar el código de Botón de Pago.
Eliminar imagen:
Si al link se le ha cargado una imagen con el método “imagen”, con este parámetro podemos eliminar la imagen cargada.
Ejemplo método link:
Respuesta obtenida
El link de pago se ha generado correctamente. Al abrirlo en algún navegador se podrá visualizar el formulario de pago.
"result": "success",
"message": "\u00a1Actualizado correctamente!",
"data": [
{
"nombre": "Bot\u00f3n de Pago",
"url": "https://link.ebi.com.gt/EBL69160gchjed358rzy/1621282737059942b/1675963122ea68ca0"
}
]
Importante:
Un link se puede inactivar por estos motivos:
- Asignación del valor 0 en el parámetro estado.
- Por 3 intentos fallidos.