Orders
Upload Order Documents
Attach invoice or supporting documents to a specific order. Required when an order is in RFI status or pending document submission before release.
POST
/
v2
/
order
/
invoice
Upload Order Documents
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
}Certain orders need supporting documents — for example, when compliance requests information (
status: 11) or when the order is waiting for supporting documents (status: 31). Use this endpoint to upload up to five files per call. Accepted formats are JPG, JPEG, PNG, and PDF, with a maximum size of 5 MB per file. An upload to an order in status: 11 moves it to status: 12. For fiat_to_crypto and crypto_to_fiat orders, an upload to an order in status: 31 moves it to status: 40 (pending payment). A fiat_to_fiat order shows status: 31 only while its required documents are missing; after the upload it shows its underlying status (41 or 51). Other uploads in accepted statuses do not change the status; see the note below on which uploads are attached.
Endpoint
POST https://api.velafi.com/v2/order/invoice
Use
https://api-test.velafi.com/v2/order/invoice for sandbox testing.Request Headers
| Header | Value |
|---|---|
X-BH-TOKEN | Your token from GET /v2/token/generate |
Content-Type | multipart/form-data |
Request Parameters
integer
required
The numeric ID of the order to which the documents should be attached.
string
required
The type of the order. Must be one of
fiat_to_crypto, crypto_to_fiat, or fiat_to_fiat.file
required
One or more files to upload. Maximum 5 files per request. Each file must be at most 5 MB. Supported formats:
jpg, jpeg, png, pdf.Response Fields
integer
Response status code.
200 indicates success.string
Human-readable response message.
boolean
true if the documents were successfully uploaded.Example
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
}
Uploads are accepted only in these statuses: for
fiat_to_crypto and crypto_to_fiat orders, 11, 12, 31, 32, 40, 50, and 60; for fiat_to_fiat orders, 10, 11, 12, 31, 41, 51, and 60. Uploads to orders in any other status return an error. Check the current status with GET /v2/order/detail before uploading.File size and count limits: maximum 5 files per upload request, maximum 5 MB per individual file. Supported formats are
jpg, jpeg, png, and pdf.For
fiat_to_crypto and crypto_to_fiat orders outside an RFI (status: 11 or 12), only the first upload is attached to the order. Later uploads still return data: true but are not attached. During an RFI, each upload replaces the previously uploaded RFI files.Was this page helpful?
⌘I
Upload Order Documents
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
}