GET /orders/batch

List batches

Servers

Query parameters

Name Type Required Description
startTime String No

The record date/time to search from.

orderId String No

Verifone allocated ID for the Order

populateTransactions Boolean No

Whether to include transactions

Default value: false

pageNumber Integer No

Page number for records.

Default value: 1

orderBy String No

The field to order by.Supports startTime,endTime,status,customerEntityUid

status String No

Batch status for this request

Valid values:

  • "PENDING"
  • "DUPLICATE_FILE_NAME"
  • "INPROGRESS"
  • "CORRUPT_FILE"
  • "PARTIAL_SUCCESS"
  • "FORCE_STOPPED"
  • "TX_COMPLETED"
  • "NO_FILES_RECEIVED"
  • "SUCCESS"
pageSize Integer No

Page size for returned records.

Default value: 50

endTime String No

The record date/time to search to.

customerEntityUid String No

The estate customer entity UUID for the portfolio.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.