Create an offramp order

POST /v1/offramp/orders

Create an offramp order

cURL

curl --request POST \
  --url https://engine-api.shiga.io/v1/offramp/orders \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "account_name": "<string>",
  "account_number": "<string>",
  "bank_code": "<string>",
  "bank_name": "<string>",
  "customer_email": "<string>",
  "customer_id": "<string>",
  "customer_name": "<string>",
  "quote_id": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_name: '<string>',
    account_number: '<string>',
    bank_code: '<string>',
    bank_name: '<string>',
    customer_email: '<string>',
    customer_id: '<string>',
    customer_name: '<string>',
    quote_id: '<string>'
  })
};

fetch('https://engine-api.shiga.io/v1/offramp/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({
    account_name: '<string>',
    account_number: '<string>',
    bank_code: '<string>',
    bank_name: '<string>',
    customer_email: '<string>',
    customer_id: '<string>',
    customer_name: '<string>',
    quote_id: '<string>'
  })
};

fetch('https://engine-api.shiga.io/v1/offramp/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/offramp/orders")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_name\": \"<string>\",\n  \"account_number\": \"<string>\",\n  \"bank_code\": \"<string>\",\n  \"bank_name\": \"<string>\",\n  \"customer_email\": \"<string>\",\n  \"customer_id\": \"<string>\",\n  \"customer_name\": \"<string>\",\n  \"quote_id\": \"<string>\"\n}")
  .asString();

201

{
  "created_at": "<string>",
  "customer_id": "<string>",
  "deposit_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

X-API-Key · string · header · required

API key authentication

Body

application/json

Create order request

account_name · string · required

account_number · string · required

bank_code · string · required

bank_name · string · required

customer_email · string · required

customer_id · string · required

customer_name · string · required

quote_id · string · required

Response

201

application/json

Created

created_at · string

customer_id · string

deposit_address · string

destination_amount · string

Example:

"100.50"

destination_currency · string

execution_mode · string

flow_type · string

id · string

metadata · object

quoted_rate · string

Example:

"1.25"

reference · string

source_amount · string

Example:

"100.50"

source_currency · string

status · string

updated_at · string