Get Orders

get https://masspaysandbox.api.convera.com/MassPayments/orders

Returns a collection of orders representations specified by the caller. Response can be customized using the fields query parameter e.g. fields=customerId,status returns a list of order IDs and their corresponding customerId and status.

Query can be filtered using the status, ids or date parameters. The dateFrom and dateTo parameters can be used to search for up to 2 consecutive years worth of data up to 7 years in the past.

Returned list is limited to 10,000 payments or 2Mb (whichever comes first) and is sorted by received timestamp by default. Additional sorting can be applied using the sortBy parameter.

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

Responses

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://masspaysandbox.api.convera.com/MassPayments/orders \
3
     --header 'accept: application/json'

Choose an example:

application/json

text/json

200OK

400BadRequest

401Unauthorized

404Not Found

500Internal Server Error