COMENZAR
Punto de enlace de la API https://bank.fpagos.com/
La API de Fpagos le permitirá crear enlaces de pago que funcionarán como un validador y procesador de pagos en línea. Para usar esta API, necesita un Token. Puede obtenerlo desde el sitio web https://fcliente.fpagos.com de forma gratuita.
Autenticación
Fpagos utiliza Token para permitir el acceso a la API. Puedes registrar una empresa y obtener el Token Fpagos en nuestra área de clientes: https://fcliente.fpagos.com,
Fpagos espera que la clave de API se incluya en todas las solicitudes de API al servidor en un encabezado similar al siguiente:
"Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ8.eyJ1c2VyIjp7ImlkIjoxLCJub21icmUiOiJlbCAyIiwiZW1haWwiOiJjcmlzdGlhbjczNjhAZ21haWwuY29tIn0wImlhjCI6MTYzNjg0NTkyNX0.-_44gqYj5UKZKfK7cHjJLy3crXweDa5_PX1Ge9eAi3Y"
obtener enlace de pago
/*Javascript - Ejemplo de código usando Jquery/Ajax*/
var settings = {
"url": "https://bank.fpagos.com/api/create_link",
"method": "POST",
"headers": {
"Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ8.eyJ1c2VyIjp7ImlkIjoxLCJub21icmUiOiJlbCAyIiwiZW1haWwiOiJjcmlzdGlhbjczNjhAZ21haWwuY29tIn0wImlhjCI6MTYzNjg0NTkyNX0.-_44gqYj5UKZKfK7cHjJLy3crXweDa5_PX1Ge9eAi3Y",
"Content-Type": "application/x-www-form-urlencoded"
},
"data": {
"nu_orden":"0000001",
"monto": "10",
"redireccion": "https://fpagos.com/completed"
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
Para obtener el enlace, debe realizar una consulta al siguiente URL:
https://bank.fpagos.com/api/create_link
Ejemplo de resultado:
{
"link": "https:///bank.fpagos.com/pago?tokeni=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImlkX2VtcHJlc2EiOjE1LCJtb250byI6IjAuNSJ9LCJpYXQiOjE2NDExNTk0MzksImV4cCI6MTY0MTIwMjYzOX0.gE7m8axqPy8JUxfueg_pjOxPSOvnUUYdVw1PqQiOkFA",
"estatus": "success",
"caducidad": "Mon Jan 03 2022 05:37:19 GMT-0400 (Venezuela Time)"
}
PARÁMETROS DEL CUERPO
Campo | Tipo | Descripción |
---|---|---|
nu_orden | String | (opcional) identificador de laorden de compra. |
monto | String | Monto total a pagar en Bs. |
redireccion | String | Enlace al que los usuarios serán redirigidos después de completar un pago. |
Errores
La API de Fpagos utiliza los siguientes códigos de error:
Código de error | Descripción |
---|---|
001 | Faltan algunos parámetros. Este error aparece cuando no se pasa todos los parámetros obligatorios. |
002 |
El monto debe ser superior a 0.1. Este error aparece cuando el precio es inferior a 0.1
|
003 |
monto no válido Este error aparece si el precio tiene un formato incorrecto.
|
Estatus de error 403 - Prohibido | Token de API no válido. Este error ocurre cuando el token no existe o ha caducado. |
EJEMPLO JAVASCRIPT
Ejemplo de Javascript usando Jquery
var settings = {
"url": "https://bank.fpagos.com/api/create_link",
"method": "POST",
"timeout": 0,
"headers": {
"Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ8.eyJ1c2VyIjp7ImlkIjoxLCJub21icmUiOiJlbCAyIiwiZW1haWwiOiJjcmlzdGlhbjczNjhAZ21haWwuY29tIn0wImlhjCI6MTYzNjg0NTkyNX0.-_44gqYj5UKZKfK7cHjJLy3crXweDa5_PX1Ge9eAi3Y",
"Content-Type": "application/x-www-form-urlencoded"
},
"data": {
"nu_orden": "00001",
"monto": "10"
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
EJEMPLO PYTHON
Ejemplo de Python usando requests
import requests
url = "https://bank.fpagos.com/api/create_link"
payload='nu_orden=00001&monto=10'
headers = {
'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ8.eyJ1c2VyIjp7ImlkIjoxLCJub21icmUiOiJlbCAyIiwiZW1haWwiOiJjcmlzdGlhbjczNjhAZ21haWwuY29tIn0wImlhjCI6MTYzNjg0NTkyNX0.-_44gqYj5UKZKfK7cHjJLy3crXweDa5_PX1Ge9eAi3Y',
'Content-Type': 'application/x-www-form-urlencoded'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
EJEMPLO PHP - cURL
Ejemplo de PHP usando cURL
'https://bank.fpagos.com/api/create_link',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'nu_orden=00001&monto=10',
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ8.eyJ1c2VyIjp7ImlkIjoxLCJub21icmUiOiJlbCAyIiwiZW1haWwiOiJjcmlzdGlhbjczNjhAZ21haWwuY29tIn0wImlhjCI6MTYzNjg0NTkyNX0.-_44gqYj5UKZKfK7cHjJLy3crXweDa5_PX1Ge9eAi3Y',
'Content-Type: application/x-www-form-urlencoded'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Webhook
Webhook (también conocido como devolución de llamada web) es un método simple que facilita que una aplicación o sistema brinde información en tiempo real cada vez que ocurre un evento, es decir, es una forma de recibir datos de forma pasiva entre dos sistemas a través de un HTTP.
Webhooks notifications can be configured for one or more companies created in https://fcliente.fpagos.com
Se pueden configurar notificaciones de webhooks para una o más empresas creadas en https://fcliente.fpagos.com
Requisitos
1. Debe crear una aplicación que pueda recibir solicitudes POST.
2. Debes configurar la URL de la aplicación en https://fcliente.fpagos.com en la sección empresas.
Funcionamiento
Cuando se realiza una compra, su aplicación recibirá una respuesta con los siguientes parámetros:
#Request Webhook
{
nu_orden: '00001',
empresa_id: '1',
monto: 10,
nu_referencia: '0050924121765',
retenido: false,
completed: true
}
Campo | Tipo | Descripción |
---|---|---|
nu_orden | String | Este parámetro devuelve el número de orden de dicha compra. |
empresa_id | String | Este parámetro devuelve el id de la empresa desde la que se realizó la compra. |
monto | Float | Este parámetro devuelve el monto de la compra. |
nu_referencia | String | Este parámetro devuelve el número de referencia de la transferencia que muestra el banco. |
retenido | Bool | Este parámetro devuelve verdadero si el pago ha sido retenido. |
completado | Bool | Este parámetro devuelve verdadero si el pago se completó con éxito. |