Comercios
Reclamar fondos Pending Fund
Retira el saldo disponible de la cuenta Pending Fund (fondos pendientes) de un comercio a un método de pago registrado y recibe un ID de transacción rastreable.
POST
/
v2
/
merchant
/
claimfunds
Reclamar fondos Pending Fund
curl --request POST \
--url https://api-test.velafi.com/v2/merchant/claimfunds \
--header 'Content-Type: application/json' \
--header 'X-BH-TOKEN: <api-key>' \
--data '
{
"merchantId": 123,
"fiat": "<string>",
"amount": 123,
"userPaymentId": 123,
"clientId": "<string>"
}
'import requests
url = "https://api-test.velafi.com/v2/merchant/claimfunds"
payload = {
"merchantId": 123,
"fiat": "<string>",
"amount": 123,
"userPaymentId": 123,
"clientId": "<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({
merchantId: 123,
fiat: '<string>',
amount: 123,
userPaymentId: 123,
clientId: '<string>'
})
};
fetch('https://api-test.velafi.com/v2/merchant/claimfunds', 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/merchant/claimfunds")
.header("X-BH-TOKEN", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"merchantId\": 123,\n \"fiat\": \"<string>\",\n \"amount\": 123,\n \"userPaymentId\": 123,\n \"clientId\": \"<string>\"\n}")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"txId": 123,
"merchantId": 123,
"clientId": "<string>",
"fiat": "<string>",
"totalAmount": 123,
"amount": 123,
"fee": 123,
"userPaymentId": 123,
"createTime": "<string>"
}
}Usa este endpoint para iniciar un retiro desde la cuenta Pending Fund (fondos pendientes) de un comercio. Especifica el comercio, la moneda fiat, el monto y el ID del método de pago de destino (que puedes obtener de
GET /v2/payments). VelaFi devuelve un txId que puedes usar para dar seguimiento al retiro mediante el endpoint de registros de fondeo. Puede aplicarse una comisión según el canal de retiro.
Todas las solicitudes deben incluir el encabezado
X-BH-TOKEN y Content-Type: application/json. Las monedas admitidas actualmente son MXN y ARS.Endpoint
POST https://api.velafi.com/v2/merchant/claimfunds
Parámetros de la solicitud
number
requerido
El ID del comercio que realiza el retiro.
string
requerido
Moneda fiat que se retira. Admitidas actualmente:
MXN, ARS.number
requerido
Monto a retirar en la moneda fiat especificada.
number
requerido
ID del método de pago registrado del usuario que recibirá los fondos. Obtenlo con
GET /v2/payments.string
Tu propio identificador único para este retiro, usado para idempotencia y seguimiento.
Campos de la respuesta
number
Código de respuesta de estilo HTTP.
200 indica éxito.string
Mensaje de estado legible, p. ej.
SUCCESS.object
Mostrar campos de data
Mostrar campos de data
number
ID único de esta transacción de retiro.
number
ID del comercio que inició el retiro.
string
El identificador que proporcionaste para esta transacción.
string
Moneda fiat del retiro.
number
Monto total descontado del saldo de Pending Fund (monto + comisión).
number
Monto neto entregado al método de pago.
number
Comisión cobrada por este retiro.
number
ID del método de pago que recibe los fondos.
string
Marca de tiempo Unix (milisegundos) en que se creó el retiro.
Ejemplo
cURL
curl -X POST https://api.velafi.com/v2/merchant/claimfunds \
-H "X-BH-TOKEN: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"merchantId": 3,
"clientId": "withdraw-2024-001",
"fiat": "MXN",
"amount": 20.00,
"userPaymentId": 91
}'
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"txId": 1123123123,
"merchantId": 3,
"clientId": "withdraw-2024-001",
"fiat": "MXN",
"totalAmount": 22.00,
"amount": 20.00,
"fee": 2.00,
"userPaymentId": 91,
"createTime": "1737452292000"
}
}
Proporciona siempre un
clientId único en cada solicitud de retiro. Si se detecta un clientId duplicado, la API devuelve la transacción original en lugar de crear una nueva.⌘I
Reclamar fondos Pending Fund
curl --request POST \
--url https://api-test.velafi.com/v2/merchant/claimfunds \
--header 'Content-Type: application/json' \
--header 'X-BH-TOKEN: <api-key>' \
--data '
{
"merchantId": 123,
"fiat": "<string>",
"amount": 123,
"userPaymentId": 123,
"clientId": "<string>"
}
'import requests
url = "https://api-test.velafi.com/v2/merchant/claimfunds"
payload = {
"merchantId": 123,
"fiat": "<string>",
"amount": 123,
"userPaymentId": 123,
"clientId": "<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({
merchantId: 123,
fiat: '<string>',
amount: 123,
userPaymentId: 123,
clientId: '<string>'
})
};
fetch('https://api-test.velafi.com/v2/merchant/claimfunds', 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/merchant/claimfunds")
.header("X-BH-TOKEN", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"merchantId\": 123,\n \"fiat\": \"<string>\",\n \"amount\": 123,\n \"userPaymentId\": 123,\n \"clientId\": \"<string>\"\n}")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"txId": 123,
"merchantId": 123,
"clientId": "<string>",
"fiat": "<string>",
"totalAmount": 123,
"amount": 123,
"fee": 123,
"userPaymentId": 123,
"createTime": "<string>"
}
}