Integraciones
Crear factura (Checkout)
Para crear una factura, primero debe obtener el ID del método de pago.
- Si siempre utiliza el mismo método de pago, solicítelo al equipo de soporte.
- Si utiliza diferentes métodos, envíe una solicitud al siguiente endpoint.
Endpoint: /v1/payment-method/list
Método: GET
Ejemplo de respuesta:
{
"data": [
{
"id": "11111",
"title": "Cards International",
"countries": ["US", "GB", "FR"],
"currencies": ["USD", "EUR"],
"icon": "",
"fields": [
{
"name": "cardNumber",
"title": "card number"
},
{
"name": "holderName",
"title": "holder name"
}
]
},
{
"id": "11117",
"title": "Alipay",
"countries": ["CN"],
"currencies": ["CNY"],
"icon": "",
"fields": []
}
]
}
Utilice el valor de id como payment_method al crear una factura.
Crear factura
Endpoint: /v1/payment/create
Método: POST
Solicitud (parámetros mínimos):
{
"amount": "10.03",
"currency": "USD",
"payment_method": "11111",
"save_card": "1",
"customer": {
"email": "[email protected]",
"name": "John Doe",
"ip": "192.168.1.1"
},
"urls": {
"success": "https://example.com/success",
"fail": "https://example.com/fail",
"notification": "https://example.com/notification"
},
"reference": "3d7d949e-94fb-4b8b-bc32-7c7f46bcd638",
"metadata": {
"key1": "value1",
"key2": "value2"
}
}
Solicitud con tarjeta guardada:
{
"amount": "10.03",
"currency": "USD",
"payment_method": "11111",
"customer": {
"email": "[email protected]",
"name": "John Doe",
"ip": "192.168.1.1"
},
"urls": {
"success": "https://example.com/success",
"fail": "https://example.com/fail",
"notification": "https://example.com/notification"
},
"reference": "3d7d949e-94fb-4b8b-bc32-7c7f46bcd638",
"card": {
"cardId": "050159eb-6af3-407c-84c0-ca1680711a77"
},
"metadata": {
"key1": "value1",
"key2": "value2"
}
}
Respuesta:
{
"data": {
"payment_id": "...",
"amount": "10.03",
"currency": "USD",
"status": "pending",
"reference": "...",
"url": "https://api.beezyycashier.com/process/...",
"method": "get"
}
}
Redirija a su cliente a la url.
Actualizar información del pago
Por ID de pago
Endpoint: /v1/payment/{payment_id}
Método: GET
Por referencia
Endpoint: /v1/payment/by-reference/{reference}
Método: GET
Ejemplo de respuesta
{
"data": {
"payment_id": "...",
"amount": "10.03",
"status": "success",
"transactions": [ ... ]
}
}
Reembolsos
Endpoint: /v1/refund/create
Método: POST
{
"reference": "...",
"payment_id": "...",
"amount": "10.03",
"currency": "USD"
}
Respuesta:
{
"data": {
"refund_id": "...",
"amount": "10.03",
"status": "success",
"message": "Reembolso aceptado"
}
}
Guardar tarjeta
Endpoint: /v1/client/card/save
Método: POST
{
"payment_method": "11111",
"customer": {
"email": "[email protected]",
"name": "John Doe",
"ip": "192.168.1.1"
},
"urls": {
"success": "https://example.com/success",
"fail": "https://example.com/fail",
"notification": "https://example.com/notification"
},
"reference": "...",
"metadata": {
"key1": "value1"
}
}
Información del cliente
Por correo electrónico:
GET: /v1/client/[email protected]
Por ID de tarjeta:
GET: /v1/client/card/{card_id}
Acciones con tarjeta
- Desactivar:
GET /v1/client/card/deactivate/{card_id} - Activar:
GET /v1/client/card/activate/{card_id}
Retiros
Individual:
POST: /v1/withdrawal/create
{
"reference": "...",
"amount": "10.03",
"currency": "USD",
"withdrawal_method_id": "22222",
"receiver": {
"cardNumber": "...",
"name": "John Doe",
"email": "[email protected]"
},
"urls": {
"notification": "https://example.com/notify"
}
}
Masivos:
POST: /v1/withdrawal/create-mass
Cuerpo: array de objetos de retiro
Por ID de stack:
GET: /v1/withdrawal/{stack_id}
Firma de notificación
Puede verificar las notificaciones mediante el encabezado de firma.
- Algoritmo:
HMAC-SHA512 - Firma:
hash_hmac('sha512', raw_request_body, project_key) - Encabezado:
signature - Para las notificaciones de retiro, utilice la clave de retiro del proyecto en lugar de la clave de pago.
- Aplique el hash al cuerpo JSON sin procesar tal como se recibió — no lo vuelva a codificar ni a formatear antes de aplicar el hash.
Ejemplos de generación de la firma
Todos los siguientes fragmentos producen la misma salida en hex en minúsculas para los mismos raw_body y project_key.
PHP
$signature = hash_hmac('sha512', $rawBody, $projectKey);
Python
import hmac
import hashlib
signature = hmac.new(
project_key.encode('utf-8'),
raw_body.encode('utf-8'),
hashlib.sha512
).hexdigest()
Go
import (
"crypto/hmac"
"crypto/sha512"
"encoding/hex"
)
mac := hmac.New(sha512.New, []byte(projectKey))
mac.Write([]byte(rawBody))
signature := hex.EncodeToString(mac.Sum(nil))
Java
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.nio.charset.StandardCharsets;
Mac mac = Mac.getInstance("HmacSHA512");
mac.init(new SecretKeySpec(
projectKey.getBytes(StandardCharsets.UTF_8),
"HmacSHA512"
));
byte[] hash = mac.doFinal(rawBody.getBytes(StandardCharsets.UTF_8));
StringBuilder sb = new StringBuilder();
for (byte b : hash) sb.append(String.format("%02x", b));
String signature = sb.toString();
Importante: raw_body debe ser exactamente los bytes leídos del cuerpo de la solicitud HTTP, antes de cualquier json_decode / json.loads. Si primero se parsea el JSON y luego se vuelve a serializar, cambiarán los espacios y el orden de las claves, por lo que la verificación de la firma fallará.