Comercios
Listar flujos fiat
Obtén una vista de libro mayor de partida doble de todos los movimientos del saldo fiat de un comercio, incluidas las líneas de operación, los asientos de comisión y los eventos de reversión.
GET
/
v2
/
merchant
/
fiat
/
flows
Listar flujos fiat
curl --request GET \
--url https://api-test.velafi.com/v2/merchant/fiat/flows \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchant/fiat/flows"
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/fiat/flows', 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/fiat/flows")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"currentPage": 123,
"size": 123,
"total": 123,
"record": [
{
"id": 123,
"merchantId": 123,
"settingsId": 123,
"txId": "<string>",
"category": "<string>",
"flowType": "<string>",
"fiat": "<string>",
"changed": 123,
"total": 123,
"extId": "<string>",
"createTime": "<string>"
}
]
}
}Usa este endpoint para obtener un libro mayor detallado de los cambios en el saldo fiat de la cuenta de un comercio. A diferencia de los registros de fondeo (que muestran transacciones agregadas), los registros de flujo fiat muestran las líneas individuales de partida doble, incluidos los asientos de comisión por separado, los eventos de reversión y los movimientos de transferencia. Es el endpoint recomendado para construir conciliaciones de saldo en tiempo real y exportaciones contables.
Todas las solicitudes deben incluir el encabezado
X-BH-TOKEN con un token de negocio obtenido de GET /v2/token/generate.Endpoint
GET https://api.velafi.com/v2/merchant/fiat/flows
Parámetros de consulta
integer
Filtra por el ID del comercio.
string
Filtra por código de moneda fiat.
integer
Filtra por un ID de transacción de fondeo específico.
string
Filtra por tipo de flujo. Valores aceptados:
ALL: todos los tipos (predeterminado)DEPOSIT: depósito entranteWITHDRAW: retiro salienteWITHDRAW_ROLLBACK: reversión de un retiroBUY_CRYPTO: cargo por compra de criptoBUY_CRYPTO_ROLLBACK: reversión de una compra de criptoREFUND: abono por reembolsoREFUND_ROLLBACK: reversión de un reembolsoTRANSFER_IN: abono por transferencia internaTRANSFER_OUT: cargo por transferencia interna
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 quieres 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, p. ej.
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 de flujo que coinciden con la consulta.
array
Mostrar campos de cada elemento de record
Mostrar campos de cada elemento de record
number
ID único de esta línea de flujo fiat.
number
ID del comercio al que pertenece esta línea de flujo.
number
ID de la cuenta del comercio (configuración del canal de pago).
string
ID de la transacción de fondeo principal.
string
Categoría general:
TRADE, FEE o TRANSFER.string
Tipo de flujo específico (consulta los valores del parámetro de consulta arriba).
string
Moneda fiat de esta línea de flujo.
number
Monto en que cambió el saldo. Positivo = abono, negativo = cargo.
number
Saldo acumulado después de aplicar esta línea de flujo.
string
ID de referencia externa que vincula con la orden o el registro relacionado.
string
Marca de tiempo Unix (milisegundos) en que se creó la línea de flujo.
Ejemplo
cURL
curl -G https://api.velafi.com/v2/merchant/fiat/flows \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "merchantId=3" \
--data-urlencode "fiat=MXN" \
--data-urlencode "flowType=DEPOSIT" \
--data-urlencode "pageSize=10"
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"currentPage": 1,
"size": 10,
"total": 100,
"record": [
{
"id": 282,
"merchantId": 3,
"settingsId": 3,
"txId": "573901321954934784",
"category": "TRADE",
"flowType": "DEPOSIT",
"fiat": "MXN",
"changed": 105.61,
"total": 37042.07,
"extId": "573901321434841088",
"createTime": "1737452292000"
}
]
}
}
Por lo general, cada operación genera al menos dos líneas de flujo: una línea
TRADE para el monto principal y una línea FEE para la comisión. Filtra por category para separarlas en tu proceso contable.⌘I
Listar flujos fiat
curl --request GET \
--url https://api-test.velafi.com/v2/merchant/fiat/flows \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchant/fiat/flows"
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/fiat/flows', 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/fiat/flows")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"currentPage": 123,
"size": 123,
"total": 123,
"record": [
{
"id": 123,
"merchantId": 123,
"settingsId": 123,
"txId": "<string>",
"category": "<string>",
"flowType": "<string>",
"fiat": "<string>",
"changed": 123,
"total": 123,
"extId": "<string>",
"createTime": "<string>"
}
]
}
}