Get all Payments across all Batches

get https://masspaysandbox.api.convera.com/MassPayments/{customer}/payments

Returns a collection of payments from across a clients batch(es). Payments can be filtered by using the id and status query parameters, and by date by using dateFrom and dateTo.

Payments returned from the query;

Payment fields displayed can be controlled by the fields or verbose query parameters
Sorting default is by received timestamp. Additional sorting can be applied using the sortBy query parameter
Are limited to 1,000 payments per page

Example:
https://masspaysandbox.api.westernunion.com/MassPayments/{customer}/payments?dateFrom=2022-09-21&dateTo=2022-10-03&pageSize=100&pageNumber=1&verbose=false&status=created,processing

Path Params

customer

string

required

customer

Query Params

ids

string

Enter a single payment Id or multiple ids (separated by a comma) to return the required payment(s). Example:id=payment1, payment2, payment3

status

string

Enter a single payment status or multiple payment statuses (separated by a comma) to return all payments with the requested status(es) Example:status=created, processing, released

fields

string

Enter a single payment field or multiple payment fields (separated by a comma) to display a subset of the payment field(s). Example:fields=id, paymentReference

sortBy

string

Enter a sorting criteria. Example:id or createdOn. Default sorting criteria is by createdOn and in descending order.

dateFrom

string

Enter a date (YYYY-MM-DD) to return payment(s) which were created ‘From’ this date. When filtering by dates, the range limit is 2 years

dateTo

string

Enter a date (YYYY-MM-DD) to return payment(s) which were created “To’ this date. When filtering by dates, the range limit is 2 years

pageSize

integer

Enter the number of records that will be displayed on a page. Max Limit is 1000. Defaults to 1000 records if not specified

pageNumber

integer

Enter the page number that the query will return. Defaults to 1 if not specified

verbose

boolean

Defaults to false

Enables the return of full payment records during the search if “true” is specified. Default value is “false” and will return a condensed version of the payment record.

Responses

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://masspaysandbox.api.convera.com/MassPayments/customer/payments?verbose=false' \
3
     --header 'accept: application/json'

Choose an example:

application/json

text/json

200200 OK When Verbose is False

400BadRequest

401Unauthorized

404NotFound

default200 OK When Verbose is true