Become a client

Create a Buy-Into Holding Order

This action creates one or more orders with settlement details based on submitted quote(s) for specific customer(s).

Table - Create orders

Resource Template
                            
/orders
                          
Http Method POST
Description Creates one or more orders based on a submitted valid quote for a valid customer.
 
Only unique settlement currencies will be accepted. A request with duplicated settlement currencies will be rejected.
 
Items to book should follow items to quote. If there is a discrepancy in amounts to book from a quote,
the request will be rejected.
 
Returns a created order with settlement details.
 
SettlementMethod is an optional parameter, if not used default settlement as configured for a customer will be used.
Supported values are "Wire" and "ACH" (or "eDebit" which results in the same
payment method as ACH).
 
isAmountSettlement specifies if a submitted amount is in settlement or trade (default) currency.
Input
                            
{ "customerId":"<customerId>","quoteId":"<quoteId>",
"partnerReference", "<partner generated reference>",
"ordersToBook":[{"settlementCurrency":"<currencyCode>
 - currency in which order will be settled with a customer",
"settlementMethod":"<settlementMethod>
- payment method to be used to settle with a customer",
"paymentReference" :"<customer supplied reference>",
"itemsToBook":[{"amount":"<amount>
 - amount to be booked for this item",in cents, integer value>,
"tradeCurrency":"<currencyCode> - item currency",
"isAmountSettlement":"<true/false>
- specified is a submitted amount is in trade or settlement currency"}]
}]}                         
                          
Output
                            
200 OK
{ “orders” : [{
 “id”:”<orderId>”,
 "customerId":"<customerId>",
 "partnerReference", "<partner generated reference>",
"createdOn" :"<timestamp>",
 “status”:“<orderStatus>”,
"settlementCurrency":"<currencyCode>"}]}