Deprecated API

The following endpoints are deprecated and will be removed in a future release. They remain functional for backwards compatibility but should not be used in new integrations.

Deprecated endpoints no longer receive updates or bug fixes. New features are only available on the current endpoints.

Migration Summary

Deprecated endpoint	Notes
GET /orders/creators	No direct replacement — use GET /orders with appropriate filters to retrieve orders by creator

Migration Notes

GET /orders/creators → GET /orders

This endpoint returned a list of order creators. Use GET /orders with the appropriate query parameters to filter and retrieve orders — the response includes creator metadata. Update any calls that iterate over /orders/creators to instead query /orders with relevant filters such as date range or status.

Deprecated API Reference

Get Order Creators (deprecated)

Deprecated

Get the list of the creators for the orders

get

By passing in the appropriate options, you can search for creators based upon the search criteria.

Query parameters

orderReferencestringOptional

Optional search string for looking up order by ID.

statusstring · enumOptional

Pass an optional search string for looking up order by status.

Possible values:

orderTypestring · enumOptional

pass an optional search string for looking up order by type. Defaults to MerchantOrder.

Default: MerchantOrderPossible values:

filterDateTypestring · enumOptional

The filter by date type.

Default: createdDatePossible values:

userUidsstring · uuid[]Optional

List of the User ID corresponding to the User who created or modified the order.

Example: 04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1

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

merchantCompanystring · min: 1 · max: 100Optional

The primary merchant name, e.g. "McDonalds".

Pattern: ^(?!\\s*$).+

merchantCompanyEntityUidstring · uuidOptional

The Verifone allocated unique ID for this merchant company.

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

merchantCompanyEntityUidsstring · uuid[]Optional

The Verifone assigned IDs corresponding to the Merchant Company.

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

customerEntityUidsstring · uuid[]Optional

The estate customer entity UUIDs for the portfolio.

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

customerEntityUidstring · uuidOptional

The Verifone allocated unique id for this site.

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

Responses

200

Search results matching criteria.

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/creators

HTTPcURLJavaScriptPython

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

{
  "creators": [
    {
      "userUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
      "name": "John Smith"
    }
  ]
}