Batch

The Batch endpoints support Verifone-internal bulk operations for processing merchant and POI maintenance at scale. Batches can be listed, inspected, updated, and triggered via these endpoints.

Batch operations are intended for Verifone internal use. Confirm with your Verifone integration contact before using these endpoints in your integration.

API Reference

List Batches

List batches

get

Query parameters

customerEntityUidstring · uuidOptional

The Verifone allocated unique id for this site.

Example: 14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9

orderIdstring · uuidOptional

Verifone allocated ID for the Order.

Example: 32c480b5-4dfb-4c53-959f-49edf45a0931

statusstring · enumOptional

Batch status for this request

Possible values:

pageNumberinteger · min: 1Optional

Page number for records.

Default: 1Example: 1

pageSizeinteger · min: 1 · max: 100Optional

Page size for returned records.

Default: 50Example: 50

startTimestring · date-timeOptional

The record date/time to search from.

Example: 2020-01-06T18:16:14.243Z

endTimestring · date-timeOptional

The record date/time to search to.

Example: 2020-01-06T18:16:14.243Z

populateTransactionsbooleanOptional

Whether to include transactions

Default: false

orderBystringOptional

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

Responses

201

Batch search results

application/json

400

Bad Request

application/json

401

Unauthorised Request

application/json

403

Forbidden Request.

application/json

404

Not Found Request

application/json

429

Too Many Requests

application/json

500

Internal Error

application/json

503

Service Not Available

application/json

504

Service Timeout

application/json

get

/orders/batch

HTTPcURLJavaScriptPython

GET /orders/batch HTTP/1.1
Host: api.verifone.com
Accept: */*

{
  "batches": [
    {
      "processingStatus": "SUCCESS",
      "responseFileSent": false,
      "responseFileName": "text",
      "batchId": "14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9",
      "fileCreatedDate": "2026-06-07T20:34:07.495Z",
      "filePickupDate": "2026-06-07T20:34:07.495Z",
      "fileName": "text",
      "orderType": "MerchantOrder",
      "retryCount": 0,
      "transactions": [
        {
          "orderId": "32c480b5-4dfb-4c53-959f-49edf45a0931",
          "requestId": "text",
          "entityType": "MERCHANT_COMPANY",
          "operation": "PARTIAL_UPDATE",
          "entityLogicalId": "text",
          "keyValues": "text",
          "createdDate": "2026-06-07T20:34:07.495Z",
          "status": "200",
          "response": "Merchant Entity Updated Successfully",
          "orderStatus": "DRAFT"
        }
      ],
      "completionDate": "2026-06-07T20:34:07.495Z"
    }
  ],
  "metadata": {
    "totalPages": 1,
    "pageNumber": 1,
    "pageSize": 50,
    "totalItems": 25
  }
}

---

Get Single Batch Details

Get single batch details

get

Path parameters

batchIdstring · uuidRequired

Idenitifer assigned to the order batch.

Example: 14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9

Responses

201

Details of a batch

application/json

400

Bad Request

application/json

401

Unauthorised Request

application/json

403

Forbidden Request.

application/json

404

Not Found Request

application/json

429

Too Many Requests

application/json

500

Internal Error

application/json

503

Service Not Available

application/json

504

Service Timeout

application/json

get

/orders/batch/{batchId}

HTTPcURLJavaScriptPython

GET /orders/batch/{batchId} HTTP/1.1
Host: api.verifone.com
Accept: */*

{
  "processingStatus": "SUCCESS",
  "responseFileSent": false,
  "responseFileName": "text",
  "batchId": "14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9",
  "fileCreatedDate": "2026-06-07T20:34:07.495Z",
  "filePickupDate": "2026-06-07T20:34:07.495Z",
  "fileName": "text",
  "orderType": "MerchantOrder",
  "retryCount": 0,
  "transactions": [
    {
      "orderId": "32c480b5-4dfb-4c53-959f-49edf45a0931",
      "requestId": "text",
      "entityType": "MERCHANT_COMPANY",
      "operation": "PARTIAL_UPDATE",
      "entityLogicalId": "text",
      "keyValues": "text",
      "createdDate": "2026-06-07T20:34:07.495Z",
      "status": "200",
      "response": "Merchant Entity Updated Successfully",
      "orderStatus": "DRAFT"
    }
  ],
  "completionDate": "2026-06-07T20:34:07.495Z"
}

---

Trigger Batch Operations

Trigger batch operations

post

Path parameters

batchIdstring · uuidRequired

Idenitifer assigned to the order batch.

Example: 14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9

Query parameters

notesstring · max: 100Optional

Additional information

Responses

201

Batch triggered

application/json

400

Bad Request

application/json

401

Unauthorised Request

application/json

403

Forbidden Request.

application/json

404

Not Found Request

application/json

429

Too Many Requests

application/json

500

Internal Error

application/json

503

Service Not Available

application/json

504

Service Timeout

application/json

post

/orders/batch/{batchId}

HTTPcURLJavaScriptPython

POST /orders/batch/{batchId} HTTP/1.1
Host: api.verifone.com
Accept: */*

{
  "processingStatus": "SUCCESS",
  "responseFileSent": false,
  "responseFileName": "text",
  "batchId": "14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9",
  "fileCreatedDate": "2026-06-07T20:34:07.495Z",
  "filePickupDate": "2026-06-07T20:34:07.495Z",
  "fileName": "text",
  "orderType": "MerchantOrder",
  "retryCount": 0,
  "transactions": [
    {
      "orderId": "32c480b5-4dfb-4c53-959f-49edf45a0931",
      "requestId": "text",
      "entityType": "MERCHANT_COMPANY",
      "operation": "PARTIAL_UPDATE",
      "entityLogicalId": "text",
      "keyValues": "text",
      "createdDate": "2026-06-07T20:34:07.495Z",
      "status": "200",
      "response": "Merchant Entity Updated Successfully",
      "orderStatus": "DRAFT"
    }
  ],
  "completionDate": "2026-06-07T20:34:07.495Z"
}

---

Update Batch Details

Update batch details

patch

Path parameters

batchIdstring · uuidRequired

Idenitifer assigned to the order batch.

Example: 14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9

Query parameters

notesstring · max: 100Optional

Additional information

Body

application/json

Modifiable details of a batch.

processingStatusstring · enumOptionalPossible values:

responseFileSentbooleanOptionalDefault: false

responseFileNamestring · max: 200Optional

Responses

201

Batch details updated

application/json

400

Bad Request

application/json

401

Unauthorised Request

application/json

403

Forbidden Request.

application/json

404

Not Found Request

application/json

429

Too Many Requests

application/json

500

Internal Error

application/json

503

Service Not Available

application/json

504

Service Timeout

application/json

patch

/orders/batch/{batchId}

HTTPcURLJavaScriptPython

PATCH /orders/batch/{batchId} HTTP/1.1
Host: api.verifone.com
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "processingStatus": "SUCCESS",
  "responseFileSent": false,
  "responseFileName": "text"
}

{
  "processingStatus": "SUCCESS",
  "responseFileSent": false,
  "responseFileName": "text",
  "batchId": "14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9",
  "fileCreatedDate": "2026-06-07T20:34:07.495Z",
  "filePickupDate": "2026-06-07T20:34:07.495Z",
  "fileName": "text",
  "orderType": "MerchantOrder",
  "retryCount": 0,
  "transactions": [
    {
      "orderId": "32c480b5-4dfb-4c53-959f-49edf45a0931",
      "requestId": "text",
      "entityType": "MERCHANT_COMPANY",
      "operation": "PARTIAL_UPDATE",
      "entityLogicalId": "text",
      "keyValues": "text",
      "createdDate": "2026-06-07T20:34:07.495Z",
      "status": "200",
      "response": "Merchant Entity Updated Successfully",
      "orderStatus": "DRAFT"
    }
  ],
  "completionDate": "2026-06-07T20:34:07.495Z"
}