Create an onramp order
curl --request POST \
--url https://engine-api.shiga.io/v1/onramp/orders \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"customer_email": "<string>",
"customer_id": "<string>",
"customer_name": "<string>",
"destination_address": "<string>",
"quote_id": "<string>",
"destination_tag": "<string>"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_email: '<string>',
customer_id: '<string>',
customer_name: '<string>',
destination_address: '<string>',
quote_id: '<string>',
destination_tag: '<string>'
})
};
fetch('https://engine-api.shiga.io/v1/onramp/orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_email: '<string>',
customer_id: '<string>',
customer_name: '<string>',
destination_address: '<string>',
quote_id: '<string>',
destination_tag: '<string>'
})
};
fetch('https://engine-api.shiga.io/v1/onramp/orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://engine-api.shiga.io/v1/onramp/orders")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_email\": \"<string>\",\n \"customer_id\": \"<string>\",\n \"customer_name\": \"<string>\",\n \"destination_address\": \"<string>\",\n \"quote_id\": \"<string>\",\n \"destination_tag\": \"<string>\"\n}")
.asString();{
"account": {
"account_name": "<string>",
"account_number": "<string>",
"amount": "100.50",
"bank_code": "<string>",
"bank_name": "<string>",
"created_at": "<string>",
"expires_at": "<string>",
"id": "<string>",
"provider": "<string>",
"provider_reference": "<string>",
"reference": "<string>",
"status": "<string>",
"type": "<string>",
"updated_at": "<string>"
},
"created_at": "<string>",
"customer_id": "<string>",
"destination_address": "<string>",
"destination_amount": "100.50",
"destination_currency": "<string>",
"execution_mode": "<string>",
"flow_type": "<string>",
"id": "<string>",
"metadata": {},
"quoted_rate": "1.25",
"reference": "<string>",
"source_amount": "100.50",
"source_currency": "<string>",
"status": "<string>",
"updated_at": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Onramp
Create an onramp order
POST
/
v1
/
onramp
/
orders
Create an onramp order
curl --request POST \
--url https://engine-api.shiga.io/v1/onramp/orders \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"customer_email": "<string>",
"customer_id": "<string>",
"customer_name": "<string>",
"destination_address": "<string>",
"quote_id": "<string>",
"destination_tag": "<string>"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_email: '<string>',
customer_id: '<string>',
customer_name: '<string>',
destination_address: '<string>',
quote_id: '<string>',
destination_tag: '<string>'
})
};
fetch('https://engine-api.shiga.io/v1/onramp/orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_email: '<string>',
customer_id: '<string>',
customer_name: '<string>',
destination_address: '<string>',
quote_id: '<string>',
destination_tag: '<string>'
})
};
fetch('https://engine-api.shiga.io/v1/onramp/orders', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://engine-api.shiga.io/v1/onramp/orders")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_email\": \"<string>\",\n \"customer_id\": \"<string>\",\n \"customer_name\": \"<string>\",\n \"destination_address\": \"<string>\",\n \"quote_id\": \"<string>\",\n \"destination_tag\": \"<string>\"\n}")
.asString();{
"account": {
"account_name": "<string>",
"account_number": "<string>",
"amount": "100.50",
"bank_code": "<string>",
"bank_name": "<string>",
"created_at": "<string>",
"expires_at": "<string>",
"id": "<string>",
"provider": "<string>",
"provider_reference": "<string>",
"reference": "<string>",
"status": "<string>",
"type": "<string>",
"updated_at": "<string>"
},
"created_at": "<string>",
"customer_id": "<string>",
"destination_address": "<string>",
"destination_amount": "100.50",
"destination_currency": "<string>",
"execution_mode": "<string>",
"flow_type": "<string>",
"id": "<string>",
"metadata": {},
"quoted_rate": "1.25",
"reference": "<string>",
"source_amount": "100.50",
"source_currency": "<string>",
"status": "<string>",
"updated_at": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Authorizations
API key authentication
Body
application/json
Create order request
Response
Created
Show child attributes
Show child attributes
Example:
"100.50"
Example:
"1.25"
Example:
"100.50"
⌘I