EQequalsmoney
Payment Batches

List payment batches

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

get/payment-batches

Request

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091
sort'asc' | 'desc'

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

offsetinteger

The number of items to skip before returning results.

Example:100
limitinteger

The maximum number of results to return.

Example:200
string
OR
string[]
'ordersSummary'
OR
string[]
includeHidden'true' | 'false'

Includes Payment Batches presently not otherwise visible.

'draft' | 'validated' | 'confirmed' | 'started' | 'completed' | 'failed' | 'cancelled'
OR
string[]
string
OR
string[]
searchstring

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

startDatestring

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

Example:2020-08-12
endDatestring

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

Example:2020-08-13
string
OR
string[]

Response

OK

limitinteger

The maximum number of results to return.

offsetinteger

The number of items to skip before returning results.

countinteger required

The total amount of records matching the querying when "limit" is ignored.

Example response

{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "accountId": "string",
      "name": "string",
      "createdBy": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "type": "person"
      },
      "product": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "status": "draft",
      "visible": true,
      "visibleAt": "2019-08-24T14:15:22Z",
      "confirmedBy": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "type": "person"
      },
      "confirmedAt": "2019-08-24T14:15:22Z",
      "passedMfaCheckAt": "2019-08-24T14:15:22Z",
      "riskCheckedAt": "2019-08-24T14:15:22Z",
      "ordersSentAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "alerts": [
        {
          "timestamp": "2019-08-24T14:15:22Z",
          "type": "Error",
          "code": "string",
          "message": "string"
        }
      ],
      "ordersSummary": {
        "numberOfOrders": 0,
        "uniqueCurrencyCodes": [
          "USD"
        ]
      },
      "input": {
        "format": "json",
        "status": "accepted",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.