Western Union Business Solutions Logo

Get Started

Get Started

Get Orders for Batch

Order is used to initiate payments between a Partner and WUBS.

Order resource represents created orders for a batch, what settlements are created and in what state an order currently is.

Order can be created for a batch based on a valid quote and will be based on settlement currencies specified for the batch's payments.

Once an order is created, WUBS will initiate settlement payment(s) and will update a Partner for every order's status update if a Partner is configured as a subscriber to order status notifications.

  1. Order creation is part of Commit your Batch request

Table - Get single order

Resource Template 
/orders/{orderId}?
fields=<orderField[,orderField]>
HttpMethod GET
Description Returns requested order representation.
Input 
{
}
Output 
200 OK
{
"id":"<orderId>",
"customerId":"<customerId>",
"status":"<orderStatus>",
"createdOn" :"<timestamp>",
"lastUpdatedOn" : "<timestamp>",
"settlementCurrency":"<currencyCode>"
}
Output - (errors) 
404 Not Found - if a requested order was not found

Table - Get collection of orders

Resource Template 
/orders?fields=<orderField[,orderField]>
&status=
<orderStatus>&ids=<id1[,id2]>&
sortBy=<orderField,asc/desc>
HttpMethod GET
Description

Returns collection of order representations.

To request order statuses, 'ids' parameter should be submitted with comma separated order' id values.

To request orders only is specific status, 'status' parameter should be submitted with valid order status.

To limit returned order representations to only desired fields, 'fields' parameter should be used,

with comma separated list of fields to return. 'id' field will always be returned.

To sort output by a specific field, 'sortBy' parameter can be used (default is by Id with ascending order)

Returned list is limited to 1000 orders.

NOTE: Check URL length limitation note below.
Input 
{
}
Output 
200 OK
{
“orders”:
{
//found order
“id”:”<orderId>”,
"customerId":"<customerId>",
"partnerReference", "<partner generated reference>",
"createdOn" :"<timestamp>",
"lastUpdatedOn" : "<timestamp>",
“status”:“<orderStatus>”,
"settlementCurrency":"<currencyCode>"
},
{
// not found order
“id”:”<orderId>”,
“errorCode”:”<Not Found Error Code>”
}
]
}
Output (errors) 
400 Bad Request - if any of the input parameters is not valid