Introducción
Esta sección describe la xCash API de pasarela de pago.
xCash La API es fácil de implementar en tu software empresarial. Nuestra API utiliza URLs bien formateadas, acepta solicitudes cURL y devuelve respuestas en formato JSON.
Puedes usar la API en modo de prueba, lo que no afecta tus datos en vivo. La clave API se utiliza para autenticar la solicitud y determinar si es un pago válido o no. Para el modo de prueba, usa la URL de sandbox y, en caso de modo en vivo, usa la URL en vivo desde la sección Iniciar Pago .
Monedas Soportadas
Esta sección describe las monedas soportadas por xCash
xCash allows to make transaction with below currencies. Any new currency may update in future.
| Nombre de la Moneda | Símbolo de la Moneda | Código de la Moneda |
|---|---|---|
| United States Dollar | $ | USD |
| Peso Chileno | CLP | CLP |
Obtener la Clave API
Esta sección describe cómo puedes obtener tu clave API.
Inicia sesión en tu xCash cuenta de comerciante. If you don't have any ? Haz Clic Aquí
El siguiente paso es encontrar el Clave API menú en la barra lateral de tu panel de control. Haz clic en el menú.
Las claves API se pueden encontrar allí, que son Clave Pública y Clave Secreta. Usa estas claves para iniciar la solicitud API. Puedes generar una nueva clave API cada vez haciendo clic en Generar Clave API botón. Recuerda no compartir estas claves con nadie.
Iniciar Pago
Esta sección describe el proceso de iniciar el pago.
Para iniciar el pago, sigue el código de ejemplo y ten cuidado con los parámetros. Necesitarás hacer una solicitud con los siguientes puntos finales de la API.
Punto Final en Vivo: https://ahorapide.xyz/payment/initiate
Punto Final de Prueba: https://ahorapide.xyz/sandbox/payment/initiate
Correo de Modo de Prueba: test_mode@mail.com
Código de Verificación de Modo de Prueba: 222666
Método de Solicitud: POST
Solicita al punto final con los siguientes parámetros a continuación.
| Nombre del Parámetro | Tipo de Parámetro | Descripción |
|---|---|---|
| public_key | string (50) | Requerido Tu Clave API Pública |
| identifier | string (20) | Requerido El identificador es básicamente para identificar el pago en tu sistema |
| currency | string (4) | Requerido Código de Moneda, debe estar en mayúsculas. Por ejemplo, USD, EUR |
| amount | decimal | Requerido Monto del pago. |
| details | string (100) | Requerido Detalles de tu pago o transacción. |
| ipn_url | string | Requerido La URL de notificación de pago instantáneo. |
| success_url | string | Requerido URL de redirección de pago exitoso. |
| cancel_url | string | Requerido URL de redirección de pago cancelado. |
| site_logo | string/url | Requerido El logo de tu sitio de negocio. |
| checkout_theme | string | Opcional Tema del formulario de pago oscuro/claro. El tema predeterminado es claro |
| customer_name | string (30) | Requerido Nombre del cliente. |
| customer_email | string (30) | Requerido Correo electrónico válido del cliente. |
<?php
$parameters = [
'identifier' => 'DFU80XZIKS',
'currency' => 'USD',
'amount' => 100.00,
'details' => 'Purchase T-shirt',
'ipn_url' => 'http://example.com/ipn_url.php',
'cancel_url' => 'http://example.com/cancel_url.php',
'success_url' => 'http://example.com/success_url.php',
'public_key' => 'your_public_key',
'site_logo' => 'https://ahorapide.xyz/assets/images/logoIcon/logo.png',
'checkout_theme' => 'dark',
'customer_name' => 'John Doe',
'customer_email' => 'john@mail.com',
];
//live end point
$url = "https://ahorapide.xyz/payment/initiate";
//test end point
$url = "https://ahorapide.xyz/sandbox/payment/initiate";
$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POSTFIELDS, $parameters);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
//$result contains the response back.
?>//Error Response.
{
"error": "true",
"message": "Invalid api key"
}
//Success Response.
{
"success": "ok",
"message": "Payment Initiated. Redirect to url.",
"url":"http://example.com/initiate/payment/checkout?payment_id=eJSAASDxdrt4DASDASVNASJA7893232432cvmdsamnvASF"
}
Validar el Pago y el IPN
Esta sección describe el proceso para obtener tu notificación de pago instantáneo.
Para iniciar el pago, sigue el código de ejemplo y ten cuidado con los parámetros. Necesitarás hacer una solicitud con los siguientes puntos finales de la API.
Punto Final: La URL de IPN de tu aplicación empresarial.
Método de Solicitud: POST
Obtendrás los siguientes parámetros a continuación.
| Nombre del Parámetro | Descripción |
|---|---|
| status | Estado de éxito del pago. |
| identifier | El identificador es básicamente para identificar el pago en tu sistema. |
| signature | Una firma hash para verificar tu pago en tu sistema. |
| data | Los datos contienen información básica con comisiones, monto, moneda, ID de transacción de pago, etc. |
<?php
//Receive the response parameter
$status = $_POST['status'];
$signature = $_POST['signature'];
$identifier = $_POST['identifier'];
$data = $_POST['data'];
// Generate your signature
$customKey = $data['amount'].$identifier;
$secret = 'YOUR_SECRET_KEY';
$mySignature = strtoupper(hash_hmac('sha256', $customKey , $secret));
$myIdentifier = 'YOUR_GIVEN_IDENTIFIER';
if($status == "success" && $signature == $mySignature && $identifier == $myIdentifier){
//your operation logic
}
?>