Comercios
Listar registros de fondeo
Lista toda la actividad de la cuenta Pending Fund de un comercio, incluidos depósitos, retiros, compras de cripto, reembolsos y transferencias internas.
GET
/
v2
/
merchant
/
funding
/
records
Listar registros de fondeo
curl --request GET \
--url https://api-test.velafi.com/v2/merchant/funding/records \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchant/funding/records"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/merchant/funding/records', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/merchant/funding/records")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"currentPage": 123,
"size": 123,
"total": 123,
"record": [
{
"id": "<string>",
"merchantId": 123,
"merchantName": "<string>",
"fiat": "<string>",
"totalAmount": 123,
"amount": 123,
"fee": 123,
"refundedAmount": 123,
"paymentId": 123,
"userPaymentId": 123,
"type": "<string>",
"status": 123,
"taxId": "<string>",
"webhookInfo": "<string>",
"completedTime": "<string>",
"refundedTime": "<string>",
"createTime": "<string>",
"updateTime": "<string>",
"failCode": 123,
"failReason": "<string>"
}
]
}
}Usa este endpoint para obtener el historial completo de actividad de la cuenta Pending Fund (fondos pendientes) de un comercio. Aquí se registra cada abono y cargo, ya sea por una transferencia bancaria entrante, una compra de cripto, un retiro (claim), un reembolso o una transferencia interna entre comercios. Filtra por tipo, estado, rango de fechas o
clientId para generar reportes de conciliación o investigar transacciones específicas.
Todas las solicitudes deben incluir el header
X-BH-TOKEN con un token de negocio obtenido de GET /v2/token/generate.Endpoint
GET https://api.velafi.com/v2/merchant/funding/records
Parámetros de consulta
integer
Filtra por un ID específico de transacción de fondeo.
integer
Filtra por el ID del comercio.
string
Filtra por código de moneda fiat.
string
Filtra por tipo de transacción. Valores aceptados:
ALL— todos los tipos (predeterminado)DEPOSIT— fondos entrantes agregados a la cuentaWITHDRAW— fondos reclamados (retirados) de la cuentaBUY_CRYPTO— fondos usados para comprar criptomonedaREFUND— reembolso abonado a la cuentaTRANSFER_IN— fondos recibidos de otro comercioTRANSFER_OUT— fondos enviados a otro comercio
integer
Filtra por estado de la transacción:
0— todos (predeterminado)1— pendiente2— completado3— cancelado4— reembolsado
string
Filtra por el identificador de orden que proporcionaste como cliente.
integer
Inicio del rango de fechas como marca de tiempo Unix en milisegundos.
integer
Fin del rango de fechas como marca de tiempo Unix en milisegundos.
integer
Número de página que se va a obtener (empieza en 1). El valor predeterminado es
1.integer
Número de registros por página. El valor predeterminado es
10 y el máximo es 1000.Campos de la respuesta
number
Código de respuesta de estilo HTTP.
200 indica éxito.string
Mensaje de estado legible, por ejemplo
SUCCESS.object
Mostrar campos de data
Mostrar campos de data
number
Número de la página devuelta.
number
Número de registros en esta página.
number
Número total de registros que coinciden con la consulta.
array
Mostrar campos de cada elemento de record
Mostrar campos de cada elemento de record
string
ID único de la transacción de fondeo (txId).
number
ID del comercio al que pertenece este registro.
string
Nombre visible del comercio.
string
Moneda fiat de la transacción.
number
Monto fiat total, incluidas las comisiones.
number
Monto fiat neto (sin comisiones).
number
Comisión cobrada por la transacción.
number
Monto reembolsado, si aplica.
number
ID del canal de pago.
number
ID del método de pago del usuario.
string
Tipo de transacción:
DEPOSIT, WITHDRAW, BUY_CRYPTO, REFUND, TRANSFER_IN, TRANSFER_OUT.number
Estado:
1 = pendiente, 2 = completado, 3 = cancelado, 4 = reembolsado.string
Identificación fiscal de la entidad que deposita.
string
Cadena JSON con los datos sin procesar del webhook bancario del depósito.
string
Marca de tiempo Unix (milisegundos) en que se completó la transacción.
string
Marca de tiempo Unix (milisegundos) en que se emitió el reembolso.
string
Marca de tiempo Unix (milisegundos) en que se creó el registro.
string
Marca de tiempo Unix (milisegundos) de la última actualización del registro.
number
Código de falla legible por máquina, si aplica.
string
Descripción legible de la falla, si aplica.
Ejemplo
cURL
curl -G https://api.velafi.com/v2/merchant/funding/records \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "merchantId=3" \
--data-urlencode "fiat=MXN" \
--data-urlencode "type=DEPOSIT" \
--data-urlencode "status=2" \
--data-urlencode "pageSize=10"
Respuesta
{
"code": 200,
"msg": "SUCCESS",
"data": {
"currentPage": 1,
"size": 10,
"total": 100,
"record": [
{
"id": "1123123123",
"merchantId": 3,
"merchantName": "Example Merchant",
"fiat": "MXN",
"totalAmount": 22.00,
"amount": 20.00,
"fee": 2.00,
"refundedAmount": 0,
"paymentId": 63,
"userPaymentId": 91,
"type": "DEPOSIT",
"status": 2,
"taxId": "20000000001",
"webhookInfo": "{}",
"completedTime": "1737452344000",
"refundedTime": null,
"createTime": "1737452292000",
"updateTime": "1737452344000",
"failCode": "",
"failReason": ""
}
]
}
}
⌘I
Listar registros de fondeo
curl --request GET \
--url https://api-test.velafi.com/v2/merchant/funding/records \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchant/funding/records"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/merchant/funding/records', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/merchant/funding/records")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"currentPage": 123,
"size": 123,
"total": 123,
"record": [
{
"id": "<string>",
"merchantId": 123,
"merchantName": "<string>",
"fiat": "<string>",
"totalAmount": 123,
"amount": 123,
"fee": 123,
"refundedAmount": 123,
"paymentId": 123,
"userPaymentId": 123,
"type": "<string>",
"status": 123,
"taxId": "<string>",
"webhookInfo": "<string>",
"completedTime": "<string>",
"refundedTime": "<string>",
"createTime": "<string>",
"updateTime": "<string>",
"failCode": 123,
"failReason": "<string>"
}
]
}
}