Órdenes
Listar órdenes
Obtén una lista paginada de órdenes de un solo tipo por solicitud. Filtra por estado y rango de fechas. Admite los tres tipos de orden.
GET
/
v2
/
orders
Listar órdenes
curl --request GET \
--url https://api-test.velafi.com/v2/orders \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/orders"
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/orders', 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/orders")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"data.currentPage": 123,
"data.size": 123,
"data.total": 123,
"data.record": [
{
"orderId": "<string>",
"clientId": "<string>",
"merchantId": 123,
"paymentId": 123,
"country": "<string>",
"crypto": "<string>",
"fiat": "<string>",
"orderType": "<string>",
"orderPrice": "<string>",
"cryptoAmount": "<string>",
"fiatAmount": "<string>",
"fiatFee": "<string>",
"orderStatus": 123,
"hasRefund": 123,
"createTime": "<string>",
"completedTime": "<string>",
"onRampMerchantId": 123,
"onRampPaymentId": 123,
"onRampCountry": "<string>",
"onRampFiat": "<string>",
"onRampFiatAmount": "<string>",
"onRampFiatFee": "<string>",
"offRampMerchantId": 123,
"offRampPaymentId": 123,
"offRampCountry": "<string>",
"offRampFiat": "<string>",
"offRampFiatAmount": "<string>",
"offRampFiatFee": "<string>"
}
]
}
}Usa este endpoint para obtener una lista paginada de órdenes de un solo tipo por solicitud:
fiat_to_crypto, crypto_to_fiat o fiat_to_fiat. Aplica filtros para acotar los resultados por estado o rango de fechas. Los resultados se ordenan por completedTime, de la más reciente a la más antigua. El esquema de cada registro de la respuesta varía entre las órdenes de una sola moneda y las órdenes fiat a fiat; la estructura sigue el mismo patrón que el endpoint de detalle de una orden. Úsalo para paneles de conciliación, flujos de reportes y monitoreo proactivo de órdenes que requieren acción.
Endpoint
GET https://api.velafi.com/v2/orders
Usa
https://api-test.velafi.com/v2/orders para pruebas en sandbox.Parámetros de consulta
string
requerido
Tipo de orden que quieres listar. Uno de
fiat_to_crypto, crypto_to_fiat o fiat_to_fiat.integer
Filtra por código de estado de la orden.
0 (el valor predeterminado) devuelve todos los estados. Usa los códigos listados en Estados de la orden. Para fiat_to_fiat, el filtro compara contra el estado almacenado y no contra el reportado: 10, 11, 12, 60 y 72 coinciden exactamente, mientras que 31, 41, 51, 71 y 90 no coinciden exactamente con el orderStatus reportado. Consulta Filtrar por estado.string
Inicio del filtro de rango de fechas como marca de tiempo Unix en milisegundos (p. ej.,
"1700000000000"). Para órdenes fiat_to_crypto y crypto_to_fiat el rango se compara contra el completedTime de la orden; para órdenes fiat_to_fiat, contra su hora de última actualización.string
Fin del filtro de rango de fechas como marca de tiempo Unix en milisegundos (p. ej.,
"1800000000000"). Se compara contra la misma marca de tiempo que startTime.integer
Número de página que quieres obtener. El valor predeterminado es
1.integer
Número de registros por página. El valor predeterminado es
10. El máximo es 100.Campos de la respuesta
integer
Código de estado de la respuesta.
200 indica éxito.string
Mensaje de respuesta legible.
object
Conjunto de resultados paginado.
Mostrar campos de data
Mostrar campos de data
integer
Número de la página devuelta.
integer
Número de registros por página.
integer
Total de órdenes que coinciden en todas las páginas.
array
Arreglo de objetos con el resumen de cada orden. Los campos varían según
orderType.Mostrar Campos del registro fiat a cripto / cripto a fiat
Mostrar Campos del registro fiat a cripto / cripto a fiat
string
ID único de la orden.
string
Tu ID de referencia personalizado de la orden.
integer
ID del comercio de esta orden.
integer
ID del método de pago usado en esta orden.
string
Nombre del país de esta orden.
string
Símbolo de la criptomoneda (p. ej.,
"USDT").string
Código de la moneda fiat (p. ej.,
"MXN").string
Tipo de orden:
fiat_to_crypto o crypto_to_fiat.string
Tipo de cambio al crear la orden.
string
Monto en cripto de esta orden.
string
Monto en fiat de esta orden.
string
Comisión cobrada en fiat.
integer
Código de estado actual de la orden.
integer
1 si se emitió un reembolso para esta orden; 0 en caso contrario.string
Marca de tiempo Unix (milisegundos) de la creación de la orden.
string
Marca de tiempo Unix (milisegundos) en que la orden llegó a un estado final. Hasta entonces, es igual a
createTime.Mostrar Campos del registro fiat a fiat
Mostrar Campos del registro fiat a fiat
string
ID único de la orden.
string
Tu ID de referencia personalizado de la orden.
integer
ID del comercio del tramo de on-ramp.
integer
ID del método de pago del tramo de on-ramp.
string
País del tramo de on-ramp.
string
Moneda fiat recaudada en el on-ramp.
string
Monto recaudado en el on-ramp.
string
Comisión del tramo de on-ramp.
integer
ID del comercio del tramo de off-ramp.
integer
ID del pago del beneficiario del tramo de off-ramp.
string
País del tramo de off-ramp.
string
Moneda fiat entregada en el off-ramp.
string
Monto entregado en el off-ramp.
string
Comisión del tramo de off-ramp.
string
Tipo de cambio entre monedas al crear la orden.
integer
Código de estado actual de la orden.
string
Marca de tiempo Unix (milisegundos) de la creación de la orden.
string
Marca de tiempo Unix (milisegundos) en que se completó la orden.
Ejemplos
- Órdenes fiat a cripto
- Órdenes fiat a fiat
curl -X GET "https://api.velafi.com/v2/orders?orderType=fiat_to_crypto&orderStatus=60¤tPage=1&pageSize=10" \
-H "X-BH-TOKEN: YOUR_TOKEN"
{
"code": 200,
"msg": "SUCCESS",
"data": {
"size": 10,
"currentPage": 1,
"total": 1,
"record": [
{
"orderId": "493829236956962816",
"clientId": "f_c_0250222004",
"merchantId": 3,
"paymentId": 0,
"country": "Mexico",
"crypto": "USDT",
"fiat": "MXN",
"orderType": "fiat_to_crypto",
"orderPrice": "21.4104",
"cryptoAmount": "5.1376",
"fiatAmount": "110",
"fiatFee": "0",
"orderStatus": 60,
"hasRefund": 0,
"createTime": "1740214865000",
"completedTime": "1740214866000"
}
]
}
}
curl -X GET "https://api.velafi.com/v2/orders?orderType=fiat_to_fiat&startTime=1740000000000&endTime=1741000000000¤tPage=1&pageSize=10" \
-H "X-BH-TOKEN: YOUR_TOKEN"
{
"code": 200,
"msg": "SUCCESS",
"data": {
"size": 10,
"currentPage": 1,
"total": 1,
"record": [
{
"orderId": "494541042692263936",
"clientId": "c_f_0250224003",
"onRampMerchantId": 3,
"onRampPaymentId": 17,
"onRampCountry": "Mexico",
"onRampFiat": "MXN",
"onRampFiatAmount": "110",
"onRampFiatFee": "1",
"offRampCountry": "Argentina",
"offRampMerchantId": 4,
"offRampPaymentId": 134,
"offRampFiat": "ARS",
"offRampFiatAmount": "6156.3",
"offRampFiatFee": "1",
"orderPrice": "55.9664",
"orderStatus": 31,
"createTime": "1740384573000",
"completedTime": "1740384573000"
}
]
}
}
⌘I
Listar órdenes
curl --request GET \
--url https://api-test.velafi.com/v2/orders \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/orders"
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/orders', 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/orders")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"data.currentPage": 123,
"data.size": 123,
"data.total": 123,
"data.record": [
{
"orderId": "<string>",
"clientId": "<string>",
"merchantId": 123,
"paymentId": 123,
"country": "<string>",
"crypto": "<string>",
"fiat": "<string>",
"orderType": "<string>",
"orderPrice": "<string>",
"cryptoAmount": "<string>",
"fiatAmount": "<string>",
"fiatFee": "<string>",
"orderStatus": 123,
"hasRefund": 123,
"createTime": "<string>",
"completedTime": "<string>",
"onRampMerchantId": 123,
"onRampPaymentId": 123,
"onRampCountry": "<string>",
"onRampFiat": "<string>",
"onRampFiatAmount": "<string>",
"onRampFiatFee": "<string>",
"offRampMerchantId": 123,
"offRampPaymentId": 123,
"offRampCountry": "<string>",
"offRampFiat": "<string>",
"offRampFiatAmount": "<string>",
"offRampFiatFee": "<string>"
}
]
}
}