Get All Payments in Batch

get https://masspaysandbox.api.convera.com/MassPayments/customers/{customerId}/batches/{batchId}/payments

Returns a collection of payments from a specified batch. Payments can be filtered by status or ids where each entry is separated with a comma.

Returned list is limited to 1,000 payments and is sorted by received timestamp by default. Additional sorting can be applied using the sortBy parameter.

Path Params

customerId

string

required

customerId

batchId

string

required

batchId

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.

Responses

Language

URL


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

Choose an example:

application/json

text/json

200OK

400BadRequest

401Unauthorized

404Not Found

500Internal Server Error