Get Started

Orders

Order statuses and examples for batch processing.

Table - Order Statuses

Committed Order has been booked, settlement initiated
Received1 Order's settlement payment has been received but not cleared yet
Funded Order's settlement payment is cleared and funds are available

Table - Examples - Batch

Get order

Request:

GET orders/TX3318327 HTTP/1.1 
Accept: application/json

Response:

HTTP/1.1 200 OK
Content-Type:
application/json; charset=utf-8
{
"id":"TX3318327",
"createdOn":"2015-09-24 19:08:19Z",
"customerId":"5678-5678-5678",
"batchId":"2345-5678-5678",
"lastUpdatedOn":"2015-09-24 19:08:19Z",
"settlementCurrency":"USD",
"status":"Committed",
"settlementMethod":"ACH"
}

1Received: currently NOT returned by the API so this indicates a future status.