Webhooks
Crear un webhook
Registra una URL de callback para recibir notificaciones de eventos en tiempo real sobre órdenes, actividad de fondeo, pagos globales, pagos con stablecoins o retiros de cripto.
POST
/
v2
/
webhook
Crear un webhook
curl --request POST \
--url https://api-test.velafi.com/v2/webhook \
--header 'Content-Type: application/json' \
--header 'X-BH-TOKEN: <api-key>' \
--data '
{
"eventType": "<string>",
"url": "<string>"
}
'import requests
url = "https://api-test.velafi.com/v2/webhook"
payload = {
"eventType": "<string>",
"url": "<string>"
}
headers = {
"X-BH-TOKEN": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-BH-TOKEN': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({eventType: '<string>', url: '<string>'})
};
fetch('https://api-test.velafi.com/v2/webhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api-test.velafi.com/v2/webhook")
.header("X-BH-TOKEN", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"eventType\": \"<string>\",\n \"url\": \"<string>\"\n}")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"webhookId": "<string>",
"eventType": "<string>",
"url": "<string>",
"status": 123,
"publicKey": "<string>"
}
}Usa este endpoint para registrar una URL de webhook a la que VelaFi llamará cuando ocurra un tipo de evento específico. Cada registro corresponde a un solo tipo de evento, así que crea webhooks separados para cada evento que quieras recibir. La solicitud se rechaza si ya existe un webhook activo para ese tipo de evento. Los webhooks pertenecen a tu cuenta, así que un webhook recibe su evento para todos los comercios de la cuenta. La respuesta incluye una
publicKey que debes guardar: se usa para verificar la firma RSA-SHA256 de todas las entregas posteriores de webhooks a este endpoint.
Todas las solicitudes deben incluir el header
X-BH-TOKEN y Content-Type: application/json. Guarda de forma segura la publicKey de la respuesta. También la devuelve Listar webhooks.Endpoint
POST https://api.velafi.com/v2/webhook
Parámetros de la solicitud
string
requerido
El tipo de evento que debe recibir este webhook. Valores aceptados:
ORDER_WEBHOOK— cambios de estado de órdenes fiat/criptoGLOBAL_PAYMENT_WEBHOOK— cambios de estado de pagos globales fiat/fiatFUNDING_WEBHOOK— actividad de la cuenta Pending FundON_RAMP_WITHDRAW_WEBHOOK— el retiro de cripto a la billetera de destino de una orden de on-ramp por API completada fue exitosoSTABLE_COIN_PAYMENT_WEBHOOK— se confirmó una orden de pago con stablecoinsCRYPTO_WITHDRAW_WEBHOOK— un retiro de cripto desde la billetera de un comercio fue exitoso, falló o se canceló
string
requerido
La URL de acceso público a la que VelaFi enviará con POST las notificaciones de eventos. Debe empezar con
http. Usa una URL https://.Campos de la respuesta
number
Código de respuesta de tipo HTTP.
200 indica éxito.string
Mensaje de estado legible, por ejemplo
SUCCESS.object
Mostrar campos de data
Mostrar campos de data
string
Identificador único de este registro de webhook.
string
El tipo de evento para el que está registrado este webhook.
string
La URL de callback registrada.
number
Estado del webhook:
10 = activo, 20 = deshabilitado, 30 = eliminado.string
Clave pública RSA codificada en Base64 que se usa para verificar el header
signature de las solicitudes de webhook entrantes. También la devuelve Listar webhooks.Ejemplo
cURL
curl -X POST https://api.velafi.com/v2/webhook \
-H "X-BH-TOKEN: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"eventType": "ORDER_WEBHOOK",
"url": "https://your-app.com/webhooks/velafi"
}'
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"webhookId": "ebab8a9663704e7cbbebe672c7c67912",
"eventType": "ORDER_WEBHOOK",
"url": "https://your-app.com/webhooks/velafi",
"status": 10,
"publicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAp/6GRTIrl+kQb9u27cGz..."
}
}
Si pierdes la
publicKey, obtenla con Listar webhooks. Consulta Configuración de webhooks para ver cómo usar la clave pública para verificar las solicitudes entrantes.⌘I
Crear un webhook
curl --request POST \
--url https://api-test.velafi.com/v2/webhook \
--header 'Content-Type: application/json' \
--header 'X-BH-TOKEN: <api-key>' \
--data '
{
"eventType": "<string>",
"url": "<string>"
}
'import requests
url = "https://api-test.velafi.com/v2/webhook"
payload = {
"eventType": "<string>",
"url": "<string>"
}
headers = {
"X-BH-TOKEN": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-BH-TOKEN': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({eventType: '<string>', url: '<string>'})
};
fetch('https://api-test.velafi.com/v2/webhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api-test.velafi.com/v2/webhook")
.header("X-BH-TOKEN", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"eventType\": \"<string>\",\n \"url\": \"<string>\"\n}")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"webhookId": "<string>",
"eventType": "<string>",
"url": "<string>",
"status": 123,
"publicKey": "<string>"
}
}