List payment batches beta

Retrieve paginated list of all payment batches for your account, filtered using the query parameters.

SecurityCommonAuth
Request
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
sort
string
Default: "desc"

Determines whether the page of items are sorted in ascending or descending order.

Enum: "asc" "desc"
offset
integer
Default: 0

The number of items to skip before returning results.

Example: offset=100
limit
integer [ 1 .. 1000 ]
Default: 100

The maximum number of results to return.

Example: limit=200
string or Array of strings

A comma-separated set of payment batch ids to filter by.

string or Array of strings
Value: "ordersSummary"
includeHidden
string

Includes Payment Batches presently not otherwise visible.

Enum: "true" "false"
string or Array of strings
Enum: "draft" "validated" "confirmed" "started" "completed" "failed" "cancelled"
string or Array of strings

A comma-separated set of createdBy ids to filter by.

search
string [ 3 .. 100 ] characters

Search term to find payment batches by name, order ID, or payment reference.

startDate
string

The earliest date from which to retrieve records (includes records on this date).

Example: startDate=2020-08-12
endDate
string

The latest date until which to retrieve records (includes records on this date).

Example: endDate=2020-08-13
string or Array of strings

A comma-separated set of order ids - returns batches containing these orders.

Responses
200

OK

get/payment-batches
Request samples 
Response samples 
application/json
{
  • "limit": 200,
  • "offset": 100,
  • "count": 67,
  • "rows": [
    ]
}