Órdenes
Subir documentos de una orden
Adjunta una factura o documentos de soporte a una orden específica. Obligatorio cuando una orden está en estado RFI o pendiente de entrega de documentos antes de su liberación.
POST
/
v2
/
order
/
invoice
Subir documentos de una orden
curl --request POST \
--url https://api-test.velafi.com/v2/order/invoice \
--header 'Content-Type: multipart/form-data' \
--header 'X-BH-TOKEN: <api-key>' \
--form orderId=123 \
--form 'orderType=<string>' \
--form files=@example-fileimport requests
url = "https://api-test.velafi.com/v2/order/invoice"
files = { "files": ("example-file", open("example-file", "rb")) }
payload = {
"orderId": "123",
"orderType": "<string>"
}
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('orderId', '123');
form.append('orderType', '<string>');
form.append('files', '{
"fileName": "example-file"
}');
const options = {method: 'POST', headers: {'X-BH-TOKEN': '<api-key>'}};
options.body = form;
fetch('https://api-test.velafi.com/v2/order/invoice', 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/invoice")
.header("X-BH-TOKEN", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"orderId\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"orderType\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();{
"code": 123,
"msg": "<string>",
"data": true
}Algunas órdenes necesitan documentos de soporte; por ejemplo, cuando cumplimiento solicita información (
status: 11) o cuando la orden está esperando documentos de soporte (status: 31). Usa este endpoint para subir hasta cinco archivos por llamada. Los formatos aceptados son JPG, JPEG, PNG y PDF, con un tamaño máximo de 5 MB por archivo. Una carga a una orden en status: 11 la mueve a status: 12. Para órdenes fiat_to_crypto y crypto_to_fiat, una carga a una orden en status: 31 la mueve a status: 40 (pago pendiente). Una orden fiat_to_fiat muestra status: 31 solo mientras faltan sus documentos obligatorios; después de la carga muestra su estado subyacente (41 o 51). Las demás cargas en estados aceptados no cambian el estado; consulta la nota de abajo sobre qué cargas se adjuntan.
Endpoint
POST https://api.velafi.com/v2/order/invoice
Usa
https://api-test.velafi.com/v2/order/invoice para pruebas en sandbox.Headers de la solicitud
| Header | Valor |
|---|---|
X-BH-TOKEN | Tu token obtenido de GET /v2/token/generate |
Content-Type | multipart/form-data |
Parámetros de la solicitud
integer
requerido
El ID numérico de la orden a la que se deben adjuntar los documentos.
string
requerido
El tipo de la orden. Debe ser uno de
fiat_to_crypto, crypto_to_fiat o fiat_to_fiat.file
requerido
Uno o más archivos para subir. Máximo 5 archivos por solicitud. Cada archivo debe pesar como máximo 5 MB. Formatos admitidos:
jpg, jpeg, png, pdf.Campos de la respuesta
integer
Código de estado de la respuesta.
200 indica éxito.string
Mensaje de respuesta legible.
boolean
true si los documentos se subieron correctamente.Ejemplo
curl -X POST "https://api.velafi.com/v2/order/invoice" \
-H "X-BH-TOKEN: YOUR_TOKEN" \
-F "orderId=493829236956962816" \
-F "orderType=fiat_to_crypto" \
-F "files=@/path/to/invoice.pdf" \
-F "files=@/path/to/receipt.jpg"
{
"code": 200,
"msg": "SUCCESS",
"data": true
}
Las cargas solo se aceptan en estos estados: para órdenes
fiat_to_crypto y crypto_to_fiat, 11, 12, 31, 32, 40, 50 y 60; para órdenes fiat_to_fiat, 10, 11, 12, 31, 41, 51 y 60. Las cargas a órdenes en cualquier otro estado devuelven un error. Consulta el estado actual con GET /v2/order/detail antes de subir archivos.Límites de tamaño y cantidad de archivos: máximo 5 archivos por solicitud de carga, máximo 5 MB por archivo individual. Los formatos admitidos son
jpg, jpeg, png y pdf.Para órdenes
fiat_to_crypto y crypto_to_fiat fuera de un RFI (status: 11 o 12), solo la primera carga se adjunta a la orden. Las cargas posteriores siguen devolviendo data: true, pero no se adjuntan. Durante un RFI, cada carga reemplaza los archivos de RFI subidos previamente.⌘I
Subir documentos de una orden
curl --request POST \
--url https://api-test.velafi.com/v2/order/invoice \
--header 'Content-Type: multipart/form-data' \
--header 'X-BH-TOKEN: <api-key>' \
--form orderId=123 \
--form 'orderType=<string>' \
--form files=@example-fileimport requests
url = "https://api-test.velafi.com/v2/order/invoice"
files = { "files": ("example-file", open("example-file", "rb")) }
payload = {
"orderId": "123",
"orderType": "<string>"
}
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('orderId', '123');
form.append('orderType', '<string>');
form.append('files', '{
"fileName": "example-file"
}');
const options = {method: 'POST', headers: {'X-BH-TOKEN': '<api-key>'}};
options.body = form;
fetch('https://api-test.velafi.com/v2/order/invoice', 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/invoice")
.header("X-BH-TOKEN", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"orderId\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"orderType\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();{
"code": 123,
"msg": "<string>",
"data": true
}