Western Union Business Solutions Logo

Become a client

Become a client

Get Batch

The Batch resource allows a Partner to get payment representation on a single payment or a collection of payments.

Table - Getting single payment

Resource Template 
                            /customers{id}/batches/{id}/payments/{id}?
fields=<paymentField[,paymentField]>
Http Method GET
Description Returns requested payment representation.
Input 
                            {
}
Output as described in Check your Payments
Output (errors) 
                            404 Not Found
 - if specified resource location is not found
 (invalid customer or batch or payment)

                          
                            400 Bad Request
 - any other error with defined error code -
                          
                            if requested payment field is not valid

Table - Getting collection of payments

Resource Template 
                            /customers{id}/batches/{id}/payments?fields=<paymentField
[
,paymentField]>&status=<paymentStatus>&ids=<id1[,id2]>
&sortBy=<paymentField,asc/desc>
Http Method GET
Description

Returns collection of payment representations.

To request payment statuses, 'ids' parameter should be submitted with comma

separated payment id values.

To request payments only in a specific status, 'status' parameter should be

submitted with valid payment status.

If a payment is in 'NotAccepted' status, an 'errorCode' field will indicate the reason.

To limit returned payment representations to only desired fields, 'fields' parameter

should be used, with comma separated list of fields to return. Id will already 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 payments sorted either by a received timestamp

(default) or by a submitted sortBy parameter.
Input 
                            {
}
Output as described in Get Collection of Payments
Output (errors) 
                            404 Not Found
- if specified resource location is not found 
(invalid customer or batch)
                          
                            400 Bad Request
- any other error with defined error code,
 for example if query parameter is invalid