Órdenes
Confirmar una orden
Confirma una orden desde tu lado: marca como pagada una orden con pago manual o completa una orden de off-ramp ya pagada. El efecto depende de orderType.
POST
/
v2
/
order
/
confirm
Confirmar una orden
curl --request POST \
--url https://api-test.velafi.com/v2/order/confirm \
--header 'Content-Type: application/json' \
--header 'X-BH-TOKEN: <api-key>' \
--data '
{
"orderId": 123,
"orderType": "<string>",
"direction": "<string>"
}
'import requests
url = "https://api-test.velafi.com/v2/order/confirm"
payload = {
"orderId": 123,
"orderType": "<string>",
"direction": "<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({orderId: 123, orderType: '<string>', direction: '<string>'})
};
fetch('https://api-test.velafi.com/v2/order/confirm', 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/order/confirm")
.header("X-BH-TOKEN", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"orderId\": 123,\n \"orderType\": \"<string>\",\n \"direction\": \"<string>\"\n}")
.asString();{
"code": 123,
"msg": "<string>",
"data": true
}Llama a este endpoint para confirmar una orden desde tu lado. Lo que hace depende de
Para
orderType y, en las órdenes fiat_to_fiat, de direction (on_ramp u off_ramp), que es obligatorio para ese tipo:
orderType | direction | Efecto | Se acepta cuando |
|---|---|---|---|
fiat_to_crypto | — | Marca la orden como pagada (status: 50) después de que enviaste el fiat. | La orden está en status: 40 y usa un método de pago manual. Si la orden muestra status: 31, primero sube los documentos requeridos. |
crypto_to_fiat | — | Completa la orden (status: 60). | La orden está en status: 50. |
fiat_to_fiat | on_ramp | Marca el tramo de on-ramp como pagado después de que enviaste el fiat. | La orden está en status: 41, usa un método de pago manual de on-ramp, no se ha confirmado antes y ya se subieron los documentos de soporte requeridos, si los hay. |
fiat_to_fiat | off_ramp | Sin efecto; devuelve true. | Siempre. |
fiat_to_crypto y crypto_to_fiat, la acción sigue el tipo real de la orden. Las órdenes con métodos de pago automáticos pasan a pagadas mediante la integración bancaria de VelaFi y no se pueden marcar como pagadas a través de este endpoint.
Endpoint
POST https://api.velafi.com/v2/order/confirm
Usa
https://api-test.velafi.com/v2/order/confirm para pruebas en sandbox.Encabezados de la solicitud
| Encabezado | Valor |
|---|---|
X-BH-TOKEN | Tu token de GET /v2/token/generate |
Content-Type | application/json |
Parámetros del cuerpo de la solicitud
integer
requerido
El ID numérico único de la orden que quieres confirmar.
string
requerido
El tipo de la orden. Debe ser
fiat_to_crypto, crypto_to_fiat o fiat_to_fiat.string
Obligatorio solo cuando
orderType es fiat_to_fiat. Indica qué tramo confirmar: on_ramp u off_ramp.Campos de la respuesta
integer
Código de estado de la respuesta.
200 indica éxito.string
Mensaje de respuesta legible.
boolean
true si la orden se confirmó correctamente.Ejemplos
- Orden de cripto a fiat
- Orden de fiat a fiat (tramo de on-ramp)
curl -X POST "https://api.velafi.com/v2/order/confirm" \
-H "X-BH-TOKEN: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"orderId": 1123123123,
"orderType": "crypto_to_fiat"
}'
{
"code": 200,
"msg": "SUCCESS",
"data": true
}
curl -X POST "https://api.velafi.com/v2/order/confirm" \
-H "X-BH-TOKEN: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"orderId": 493829236956962817,
"orderType": "fiat_to_fiat",
"direction": "on_ramp"
}'
{
"code": 200,
"msg": "SUCCESS",
"data": true
}
Las solicitudes que no cumplen las condiciones de la tabla anterior devuelven un error. Consulta el estado actual de la orden con
GET /v2/order/detail antes de llamar a este endpoint.⌘I
Confirmar una orden
curl --request POST \
--url https://api-test.velafi.com/v2/order/confirm \
--header 'Content-Type: application/json' \
--header 'X-BH-TOKEN: <api-key>' \
--data '
{
"orderId": 123,
"orderType": "<string>",
"direction": "<string>"
}
'import requests
url = "https://api-test.velafi.com/v2/order/confirm"
payload = {
"orderId": 123,
"orderType": "<string>",
"direction": "<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({orderId: 123, orderType: '<string>', direction: '<string>'})
};
fetch('https://api-test.velafi.com/v2/order/confirm', 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/order/confirm")
.header("X-BH-TOKEN", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"orderId\": 123,\n \"orderType\": \"<string>\",\n \"direction\": \"<string>\"\n}")
.asString();{
"code": 123,
"msg": "<string>",
"data": true
}