Common
Operations common to all orders.
By passing in the appropriate options, you can search for available orders in the system.
Optional search string for looking up order by ID.
Pass an optional search string for looking up order by status.
An order will be in one of the following states.
pass an optional search string for looking up order by type. Defaults to MerchantOrder.
MerchantOrderPossible values: The filter by date type.
createdDatePossible values: List of the User ID corresponding to the User who created or modified the order.
04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1The record date/time to search from.
2020-01-06T18:16:14.243ZThe record date/time to search to.
2020-01-06T18:16:14.243ZTime status detailed status last changed.
2020-01-06T18:16:14.243ZThe primary merchant name, e.g. "McDonalds".
^(?!\\s*$).+The Verifone allocated unique ID for this merchant company.
14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9The Verifone assigned IDs corresponding to the Merchant Company.
14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9The estate customer entity UUIDs for the portfolio.
14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9The Verifone allocated unique id for this site.
14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9Page number for records.
1Example: 1Page size for returned records.
50Example: 50The ordering of the returned results.
The field to order by. Valid fields are: createdBy, createdDate, modifiedDate, merchantName, status
The signing provider for the order.
Used in combination with merchant-company-entity to find the first instore order.
Pass an optional group name to filter orders by group.
An optional boolean flag. When set to true, validates the presence of groupName, merchantCompanyName, and siteName against the Entity Service. Orders failing validation are removed from the response.
search results matching criteria
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Too Many Requests
Internal Error
Service Not Available
Service Timeout
GET /orders HTTP/1.1
Host: api.verifone.com
Accept: */*
{
"orders": [
{
"orderReference": "ORD-1234",
"customerEntityUid": "123e4567-e89b-12d3-a456-426614174000",
"requestedDate": "2026-01-01T00:00:00.000Z",
"deferredOrderProcessingDate": "2026-06-20T09:00:00Z",
"poRef": "85219587",
"paymentDetails": "[Circular Reference]",
"notes": "Current in draft, caller got busy, callback anothertime.",
"additionalOrderData": [
{
"variableName": "VAT_ID or BAX_ID",
"variableValue": "1234566"
}
],
"packageDetails": "[Circular Reference]",
"contract": {
"brokerId": "text",
"legalStructure": "PROPRIETOR_OWN_BEHALF",
"contacts": [
{
"contact": {
"contactType": "BUSINESS",
"name": {
"firstName": "text",
"lastName": "text",
"prefix": "text",
"alternateFullName": "text",
"middleName": "text",
"suffix": "text"
},
"phoneNumbers": [
{
"callingCode": "text",
"value": "text",
"extension": "text",
"isPrimary": false,
"phoneType": "HOME"
}
],
"email": "name@gmail.com",
"businessTitle": "text",
"passportId": "text",
"nationality": "text",
"additionalNationalities": [
"text"
],
"nationalIdentifer": "text"
},
"addressDetails": {
"receiverName": "text",
"addressLine1": "213 Miller Street",
"addressLine2": "North Sydney",
"addressLine3": "text",
"poBox": "K1234",
"city": "York",
"countrySubdivision": "Georgia",
"postCode": "2061",
"country": "AUS",
"timeZone": "text"
},
"dateOfBirth": "2026-01-01",
"placeOfBirth": "text",
"isIDCheckRequired": false,
"isContractSignatureRequired": false,
"isLegalRepresentative": false,
"isAuthorizedRepresentative": false,
"isBeneficiaryOwner": false,
"isPoliticallyExposed": false,
"representativeType": "GENERAL_COMMERCIAL_POWER"
}
],
"settlementAccount": {
"currency": "AED",
"accountHolderType": "BUSINESS",
"description": "Coffee Supreme Trading",
"nickname": "Store 1 Account",
"country": "AUS",
"accountName": "text",
"iban": "text",
"bic": "CTBAAU2SXXX"
},
"domesticSettlementAccount": {
"currency": "AED",
"accountHolderType": "BUSINESS",
"description": "Coffee Supreme Trading",
"nickname": "Store 1 Account",
"accountName": "Coffee Supreme LTD",
"sortCode": "301105",
"bsb": 22039,
"routingTransitNumber": "247484410",
"accountNumberType": "DEFAULT",
"accountNumber": "23008275"
},
"serviceStartDate": "2026-01-01T00:00:00.000Z",
"terminalRentalStartDate": "2026-01-01T00:00:00.000Z",
"proprietorAct": true,
"documents": [
{
"documentId": "123e4567-e89b-12d3-a456-426614174000",
"documentName": "text",
"displayName": "text",
"status": "PENDING_UPLOAD",
"allowedContentTypes": [
"application/pdf"
],
"allowedContentLength": 2097152,
"contact": {
"contactType": "BUSINESS",
"name": {
"firstName": "text",
"lastName": "text",
"prefix": "text",
"alternateFullName": "text",
"middleName": "text",
"suffix": "text"
},
"phoneNumbers": [
{
"callingCode": "text",
"value": "text",
"extension": "text",
"isPrimary": false,
"phoneType": "HOME"
}
],
"email": "name@gmail.com",
"businessTitle": "text",
"passportId": "text",
"nationality": "text",
"additionalNationalities": [
"text"
],
"nationalIdentifer": "text"
},
"uploadedDate": "2026-01-01T00:00:00.000Z",
"modifiedDate": "2026-01-01T00:00:00.000Z"
}
],
"replacementAgreement": {
"contractNumber": "text",
"devices": [
{
"serialNumber": "text",
"deviceModel": "text"
}
]
}
},
"entityUid": "14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9",
"shippingAddress": {
"contact": {
"contactType": "BUSINESS",
"name": {
"firstName": "text",
"lastName": "text",
"prefix": "text",
"alternateFullName": "text",
"middleName": "text",
"suffix": "text"
},
"phoneNumbers": [
{
"callingCode": "text",
"value": "text",
"extension": "text",
"isPrimary": false,
"phoneType": "HOME"
}
],
"email": "name@gmail.com",
"businessTitle": "text"
},
"vfiSiteId": "text",
"storeNumber": "text",
"governmentOwned": true,
"governmentCountry": "AUS",
"receiverName": "text",
"addressLine1": "213 Miller Street",
"addressLine2": "North Sydney",
"addressLine3": "text",
"poBox": "K1234",
"city": "York",
"countrySubdivision": "Georgia",
"postCode": "2061",
"country": "AUS",
"timeZone": "text"
},
"billingAddress": {
"contact": {
"contactType": "BUSINESS",
"name": {
"firstName": "text",
"lastName": "text",
"prefix": "text",
"alternateFullName": "text",
"middleName": "text",
"suffix": "text"
},
"phoneNumbers": [
{
"callingCode": "text",
"value": "text",
"extension": "text",
"isPrimary": false,
"phoneType": "HOME"
}
],
"email": "name@gmail.com",
"businessTitle": "text"
},
"vfiSiteId": "text",
"storeNumber": "text",
"governmentOwned": true,
"governmentCountry": "AUS",
"receiverName": "text",
"addressLine1": "213 Miller Street",
"addressLine2": "North Sydney",
"addressLine3": "text",
"poBox": "K1234",
"city": "York",
"countrySubdivision": "Georgia",
"postCode": "2061",
"country": "AUS",
"timeZone": "text"
},
"requestedDateOfShipment": "2026-01-01T00:00:00.000Z",
"pois": "[Circular Reference]",
"merchantId": "text",
"orderId": "32c480b5-4dfb-4c53-959f-49edf45a0931",
"status": "DRAFT",
"createdUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"createdBy": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"modifiedUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"modifiedBy": "text",
"modifiedDate": "2026-01-01T00:00:00.000Z",
"orderType": "POIOrder",
"merchantCompanyEntityUid": "14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9",
"merchant": {
"merchantName": "text"
},
"internal": {
"oracleOrderNumber": 1,
"oracleShippingTrackingReference": "text",
"kycReportUid": "123e4567-e89b-12d3-a456-426614174000",
"tokenScopeUid": "123e4567-e89b-12d3-a456-426614174000",
"extendedDetails": {
"status": "DRAFT",
"code": "text",
"information": "text",
"lastChangeTime": "2020-01-06T18:16:14.243Z",
"canCancel": true
},
"orderStats": {
"minsSinceCreatedToLastUpdate": 0,
"minsSinceLastStatusUpdate": 0
},
"vmssApplication": {
"visaStatus": "NA ",
"visaMatches": 1,
"mcdStatus": "NA ",
"mcdMatches": 1,
"mcdTransactionReference": "text"
},
"salesforceApplicationId": "text",
"signingInformation": {
"provider": "SIGNICAT",
"providerRef": "text",
"signedFileUrl": "text",
"signingRequests": [
{
"providerRef": "text",
"contact": {
"contactType": "BUSINESS",
"name": {
"firstName": "text",
"lastName": "text",
"prefix": "text",
"alternateFullName": "text",
"middleName": "text",
"suffix": "text"
},
"phoneNumbers": [
{
"callingCode": "text",
"value": "text",
"extension": "text",
"isPrimary": false,
"phoneType": "HOME"
}
],
"email": "name@gmail.com",
"businessTitle": "text"
},
"signed": false,
"signedDateTime": "2026-01-01T00:00:00.000Z",
"signingLink": "text"
}
]
},
"econtractNotificationReminder": {
"lastNotificationSentDateTime": "2026-01-01T00:00:00.000Z",
"notificationCount": 1,
"templateName": "text",
"notifications": [
{
"sentDateTime": "2026-01-01T00:00:00.000Z",
"template": "text",
"responseReferenceId": "text"
}
]
},
"draftNotificationReminder": {
"lastNotificationSentDateTime": "2026-01-01T00:00:00.000Z",
"notificationCount": 1,
"templateName": "text",
"notifications": [
{
"sentDateTime": "2026-01-01T00:00:00.000Z",
"template": "text",
"responseReferenceId": "text"
}
]
},
"notificationReminders": {
"econtract": {
"lastNotificationSentDateTime": "2026-01-01T00:00:00.000Z",
"notificationCount": 1,
"templateName": "text",
"notifications": [
{
"sentDateTime": "2026-01-01T00:00:00.000Z",
"template": "text",
"responseReferenceId": "text"
}
]
},
"draft": {
"lastNotificationSentDateTime": "2026-01-01T00:00:00.000Z",
"notificationCount": 1,
"templateName": "text",
"notifications": [
{
"sentDateTime": "2026-01-01T00:00:00.000Z",
"template": "text",
"responseReferenceId": "text"
}
]
},
"docRequired": {
"lastNotificationSentDateTime": "2026-01-01T00:00:00.000Z",
"notificationCount": 1,
"templateName": "text",
"notifications": [
{
"sentDateTime": "2026-01-01T00:00:00.000Z",
"template": "text",
"responseReferenceId": "text"
}
]
}
},
"customerOrderLink": {
"orderLink": "https://example.com",
"linkInitiatorUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"linkInitiatorUsername": "text",
"linkReceiverUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"linkReceiverUsername": "text",
"linkSendTime": "2026-01-01T00:00:00.000Z",
"linkOpendByCustomerTime": "2026-01-01T00:00:00.000Z",
"customerUpdateTime": "2026-01-01T00:00:00.000Z"
},
"cancellationHistory": [
{
"cancelReasonEnum": "ADMIN_REASON",
"cancelAdditionalReason": "text",
"cancelledUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"cancelledBy": "text",
"cancelledDate": "2026-01-01T00:00:00.000Z"
}
],
"externalOnboarding": "[Circular Reference]"
}
}
],
"metadata": {
"totalPages": 1,
"pageNumber": 1,
"pageSize": 50,
"totalItems": 25
}
}By passing in the appropriate options, you can search for creators based upon the search criteria.
Optional search string for looking up order by ID.
Pass an optional search string for looking up order by status.
pass an optional search string for looking up order by type. Defaults to MerchantOrder.
MerchantOrderPossible values: The filter by date type.
createdDatePossible values: List of the User ID corresponding to the User who created or modified the order.
04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1The record date/time to search from.
2020-01-06T18:16:14.243ZThe record date/time to search to.
2020-01-06T18:16:14.243ZThe primary merchant name, e.g. "McDonalds".
^(?!\\s*$).+The Verifone allocated unique ID for this merchant company.
14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9The Verifone assigned IDs corresponding to the Merchant Company.
14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9The estate customer entity UUIDs for the portfolio.
14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9The Verifone allocated unique id for this site.
14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9Search results matching criteria.
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Too Many Requests
Internal Error
Service Not Available
Service Timeout
GET /orders/creators HTTP/1.1
Host: api.verifone.com
Accept: */*
{
"creators": [
{
"userUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"name": "John Smith"
}
]
}By passing in the appropriate options, you can search for metadata based upon the search criteria.
Optional search string for looking up order by ID.
Pass an optional search string for looking up order by status.
pass an optional search string for looking up order by type. Defaults to MerchantOrder.
MerchantOrderPossible values: The filter by date type.
createdDatePossible values: List of the User ID corresponding to the User who created or modified the order.
04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1The record date/time to search from.
2020-01-06T18:16:14.243ZThe record date/time to search to.
2020-01-06T18:16:14.243ZThe primary merchant name, e.g. "McDonalds".
^(?!\\s*$).+The Verifone allocated unique ID for this merchant company.
14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9The Verifone assigned IDs corresponding to the Merchant Company.
14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9The estate customer entity UUIDs for the portfolio.
14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9The Verifone allocated unique id for this site.
14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9Search results matching criteria.
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Too Many Requests
Internal Error
Service Not Available
Service Timeout
GET /orders/metadata HTTP/1.1
Host: api.verifone.com
Accept: */*
{
"creators": [
{
"userUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"name": "John Smith"
}
]
}Get the first order which was boarded for a company
The Verifone allocated unique id for this site.
14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9The Verifone allocated unique ID for this merchant company.
14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9Used in combination with merchant-company-entity to find the first instore order.
Search results matching criteria.
Supports returning oneOf the possible order types. The returned value will contain the orderType.
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Too Many Requests
Internal Error
Service Not Available
Service Timeout
GET /entities/{customerEntityUid}/orders/{merchantCompanyEntityUid}/first HTTP/1.1
Host: api.verifone.com
Accept: */*
{
"orderReference": "ORD-1234",
"customerEntityUid": "123e4567-e89b-12d3-a456-426614174000",
"requestedDate": "2026-01-01T00:00:00.000Z",
"deferredOrderProcessingDate": "2026-06-20T09:00:00Z",
"poRef": "85219587",
"paymentDetails": {
"paymentType": "CREDIT"
},
"notes": "Current in draft, caller got busy, callback anothertime.",
"additionalOrderData": [
{
"variableName": "VAT_ID or BAX_ID",
"variableValue": "1234566"
}
],
"packageDetails": {
"portfolioUid": "32c480b5-4dfb-4c53-959f-49edf45a0931",
"basePackageBundle": {
"packageBundleId": "PREMIUM-36MONTH",
"price": "20.50"
},
"servicePackages": "[Circular Reference]",
"deliveryPackage": {
"packageBundleId": "PREMIUM-36MONTH",
"adjustedPrices": [
{
"priceModel": "MONTHLY_FEE",
"price": "20.50"
}
],
"additionalPackageData": [
{
"variableName": "VAT_ID or BAX_ID",
"variableValue": "1234566"
}
]
}
},
"contract": {
"brokerId": "text",
"legalStructure": "PROPRIETOR_OWN_BEHALF",
"contacts": [
{
"contact": {
"contactType": "BUSINESS",
"name": {
"firstName": "text",
"lastName": "text",
"prefix": "text",
"alternateFullName": "text",
"middleName": "text",
"suffix": "text"
},
"phoneNumbers": [
{
"callingCode": "text",
"value": "text",
"extension": "text",
"isPrimary": false,
"phoneType": "HOME"
}
],
"email": "name@gmail.com",
"businessTitle": "text",
"passportId": "text",
"nationality": "text",
"additionalNationalities": [
"text"
],
"nationalIdentifer": "text"
},
"addressDetails": {
"receiverName": "text",
"addressLine1": "213 Miller Street",
"addressLine2": "North Sydney",
"addressLine3": "text",
"poBox": "K1234",
"city": "York",
"countrySubdivision": "Georgia",
"postCode": "2061",
"country": "AUS",
"timeZone": "text"
},
"dateOfBirth": "2026-01-01",
"placeOfBirth": "text",
"isIDCheckRequired": false,
"isContractSignatureRequired": false,
"isLegalRepresentative": false,
"isAuthorizedRepresentative": false,
"isBeneficiaryOwner": false,
"isPoliticallyExposed": false,
"representativeType": "GENERAL_COMMERCIAL_POWER"
}
],
"settlementAccount": {
"currency": "AED",
"accountHolderType": "BUSINESS",
"description": "Coffee Supreme Trading",
"nickname": "Store 1 Account",
"country": "AUS",
"accountName": "text",
"iban": "text",
"bic": "CTBAAU2SXXX"
},
"domesticSettlementAccount": {
"currency": "AED",
"accountHolderType": "BUSINESS",
"description": "Coffee Supreme Trading",
"nickname": "Store 1 Account",
"accountName": "Coffee Supreme LTD",
"sortCode": "301105",
"bsb": 22039,
"routingTransitNumber": "247484410",
"accountNumberType": "DEFAULT",
"accountNumber": "23008275"
},
"serviceStartDate": "2026-01-01T00:00:00.000Z",
"terminalRentalStartDate": "2026-01-01T00:00:00.000Z",
"proprietorAct": true,
"documents": [
{
"documentId": "123e4567-e89b-12d3-a456-426614174000",
"documentName": "text",
"displayName": "text",
"status": "PENDING_UPLOAD",
"allowedContentTypes": [
"application/pdf"
],
"allowedContentLength": 2097152,
"contact": {
"contactType": "BUSINESS",
"name": {
"firstName": "text",
"lastName": "text",
"prefix": "text",
"alternateFullName": "text",
"middleName": "text",
"suffix": "text"
},
"phoneNumbers": [
{
"callingCode": "text",
"value": "text",
"extension": "text",
"isPrimary": false,
"phoneType": "HOME"
}
],
"email": "name@gmail.com",
"businessTitle": "text",
"passportId": "text",
"nationality": "text",
"additionalNationalities": [
"text"
],
"nationalIdentifer": "text"
},
"uploadedDate": "2026-01-01T00:00:00.000Z",
"modifiedDate": "2026-01-01T00:00:00.000Z"
}
],
"replacementAgreement": {
"contractNumber": "text",
"devices": [
{
"serialNumber": "text",
"deviceModel": "text"
}
]
}
},
"entityUid": "14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9",
"shippingAddress": {
"contact": {
"contactType": "BUSINESS",
"name": {
"firstName": "text",
"lastName": "text",
"prefix": "text",
"alternateFullName": "text",
"middleName": "text",
"suffix": "text"
},
"phoneNumbers": [
{
"callingCode": "text",
"value": "text",
"extension": "text",
"isPrimary": false,
"phoneType": "HOME"
}
],
"email": "name@gmail.com",
"businessTitle": "text"
},
"vfiSiteId": "text",
"storeNumber": "text",
"governmentOwned": true,
"governmentCountry": "AUS",
"receiverName": "text",
"addressLine1": "213 Miller Street",
"addressLine2": "North Sydney",
"addressLine3": "text",
"poBox": "K1234",
"city": "York",
"countrySubdivision": "Georgia",
"postCode": "2061",
"country": "AUS",
"timeZone": "text"
},
"billingAddress": {
"contact": {
"contactType": "BUSINESS",
"name": {
"firstName": "text",
"lastName": "text",
"prefix": "text",
"alternateFullName": "text",
"middleName": "text",
"suffix": "text"
},
"phoneNumbers": [
{
"callingCode": "text",
"value": "text",
"extension": "text",
"isPrimary": false,
"phoneType": "HOME"
}
],
"email": "name@gmail.com",
"businessTitle": "text"
},
"vfiSiteId": "text",
"storeNumber": "text",
"governmentOwned": true,
"governmentCountry": "AUS",
"receiverName": "text",
"addressLine1": "213 Miller Street",
"addressLine2": "North Sydney",
"addressLine3": "text",
"poBox": "K1234",
"city": "York",
"countrySubdivision": "Georgia",
"postCode": "2061",
"country": "AUS",
"timeZone": "text"
},
"requestedDateOfShipment": "2026-01-01T00:00:00.000Z",
"pois": [
"[Circular Reference]"
],
"merchantId": "text",
"orderId": "32c480b5-4dfb-4c53-959f-49edf45a0931",
"status": "DRAFT",
"createdUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"createdBy": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"modifiedUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"modifiedBy": "text",
"modifiedDate": "2026-01-01T00:00:00.000Z",
"orderType": "POIOrder",
"merchantCompanyEntityUid": "14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9",
"merchant": {
"merchantName": "text"
},
"internal": {
"oracleOrderNumber": 1,
"oracleShippingTrackingReference": "text",
"kycReportUid": "123e4567-e89b-12d3-a456-426614174000",
"tokenScopeUid": "123e4567-e89b-12d3-a456-426614174000",
"extendedDetails": {
"status": "DRAFT",
"code": "text",
"information": "text",
"lastChangeTime": "2020-01-06T18:16:14.243Z",
"canCancel": true
},
"orderStats": {
"minsSinceCreatedToLastUpdate": 0,
"minsSinceLastStatusUpdate": 0
},
"vmssApplication": {
"visaStatus": "NA ",
"visaMatches": 1,
"mcdStatus": "NA ",
"mcdMatches": 1,
"mcdTransactionReference": "text"
},
"salesforceApplicationId": "text",
"signingInformation": {
"provider": "SIGNICAT",
"providerRef": "text",
"signedFileUrl": "text",
"signingRequests": [
{
"providerRef": "text",
"contact": {
"contactType": "BUSINESS",
"name": {
"firstName": "text",
"lastName": "text",
"prefix": "text",
"alternateFullName": "text",
"middleName": "text",
"suffix": "text"
},
"phoneNumbers": [
{
"callingCode": "text",
"value": "text",
"extension": "text",
"isPrimary": false,
"phoneType": "HOME"
}
],
"email": "name@gmail.com",
"businessTitle": "text"
},
"signed": false,
"signedDateTime": "2026-01-01T00:00:00.000Z",
"signingLink": "text"
}
]
},
"econtractNotificationReminder": {
"lastNotificationSentDateTime": "2026-01-01T00:00:00.000Z",
"notificationCount": 1,
"templateName": "text",
"notifications": [
{
"sentDateTime": "2026-01-01T00:00:00.000Z",
"template": "text",
"responseReferenceId": "text"
}
]
},
"draftNotificationReminder": {
"lastNotificationSentDateTime": "2026-01-01T00:00:00.000Z",
"notificationCount": 1,
"templateName": "text",
"notifications": [
{
"sentDateTime": "2026-01-01T00:00:00.000Z",
"template": "text",
"responseReferenceId": "text"
}
]
},
"notificationReminders": {
"econtract": {
"lastNotificationSentDateTime": "2026-01-01T00:00:00.000Z",
"notificationCount": 1,
"templateName": "text",
"notifications": [
{
"sentDateTime": "2026-01-01T00:00:00.000Z",
"template": "text",
"responseReferenceId": "text"
}
]
},
"draft": {
"lastNotificationSentDateTime": "2026-01-01T00:00:00.000Z",
"notificationCount": 1,
"templateName": "text",
"notifications": [
{
"sentDateTime": "2026-01-01T00:00:00.000Z",
"template": "text",
"responseReferenceId": "text"
}
]
},
"docRequired": {
"lastNotificationSentDateTime": "2026-01-01T00:00:00.000Z",
"notificationCount": 1,
"templateName": "text",
"notifications": [
{
"sentDateTime": "2026-01-01T00:00:00.000Z",
"template": "text",
"responseReferenceId": "text"
}
]
}
},
"customerOrderLink": {
"orderLink": "https://example.com",
"linkInitiatorUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"linkInitiatorUsername": "text",
"linkReceiverUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"linkReceiverUsername": "text",
"linkSendTime": "2026-01-01T00:00:00.000Z",
"linkOpendByCustomerTime": "2026-01-01T00:00:00.000Z",
"customerUpdateTime": "2026-01-01T00:00:00.000Z"
},
"cancellationHistory": [
{
"cancelReasonEnum": "ADMIN_REASON",
"cancelAdditionalReason": "text",
"cancelledUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"cancelledBy": "text",
"cancelledDate": "2026-01-01T00:00:00.000Z"
}
],
"externalOnboarding": {
"provider": "BANKAXEPT",
"agreementId": "123e4567-e89b-12d3-a456-426614174000",
"agreementStatus": "text"
}
}
}Get a single order by Order Id
Verifone allocated ID for the Order.
32c480b5-4dfb-4c53-959f-49edf45a0931search results matching criteria
Supports returning oneOf the possible order types. The returned value will contain the orderType.
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Too Many Requests
Internal Error
Service Not Available
Service Timeout
GET /orders/{orderId} HTTP/1.1
Host: api.verifone.com
Accept: */*
{
"orderReference": "ORD-1234",
"customerEntityUid": "123e4567-e89b-12d3-a456-426614174000",
"requestedDate": "2026-01-01T00:00:00.000Z",
"deferredOrderProcessingDate": "2026-06-20T09:00:00Z",
"poRef": "85219587",
"paymentDetails": {
"paymentType": "CREDIT"
},
"notes": "Current in draft, caller got busy, callback anothertime.",
"additionalOrderData": [
{
"variableName": "VAT_ID or BAX_ID",
"variableValue": "1234566"
}
],
"packageDetails": {
"portfolioUid": "32c480b5-4dfb-4c53-959f-49edf45a0931",
"basePackageBundle": {
"packageBundleId": "PREMIUM-36MONTH",
"price": "20.50"
},
"servicePackages": "[Circular Reference]",
"deliveryPackage": {
"packageBundleId": "PREMIUM-36MONTH",
"adjustedPrices": [
{
"priceModel": "MONTHLY_FEE",
"price": "20.50"
}
],
"additionalPackageData": [
{
"variableName": "VAT_ID or BAX_ID",
"variableValue": "1234566"
}
]
}
},
"contract": {
"brokerId": "text",
"legalStructure": "PROPRIETOR_OWN_BEHALF",
"contacts": [
{
"contact": {
"contactType": "BUSINESS",
"name": {
"firstName": "text",
"lastName": "text",
"prefix": "text",
"alternateFullName": "text",
"middleName": "text",
"suffix": "text"
},
"phoneNumbers": [
{
"callingCode": "text",
"value": "text",
"extension": "text",
"isPrimary": false,
"phoneType": "HOME"
}
],
"email": "name@gmail.com",
"businessTitle": "text",
"passportId": "text",
"nationality": "text",
"additionalNationalities": [
"text"
],
"nationalIdentifer": "text"
},
"addressDetails": {
"receiverName": "text",
"addressLine1": "213 Miller Street",
"addressLine2": "North Sydney",
"addressLine3": "text",
"poBox": "K1234",
"city": "York",
"countrySubdivision": "Georgia",
"postCode": "2061",
"country": "AUS",
"timeZone": "text"
},
"dateOfBirth": "2026-01-01",
"placeOfBirth": "text",
"isIDCheckRequired": false,
"isContractSignatureRequired": false,
"isLegalRepresentative": false,
"isAuthorizedRepresentative": false,
"isBeneficiaryOwner": false,
"isPoliticallyExposed": false,
"representativeType": "GENERAL_COMMERCIAL_POWER"
}
],
"settlementAccount": {
"currency": "AED",
"accountHolderType": "BUSINESS",
"description": "Coffee Supreme Trading",
"nickname": "Store 1 Account",
"country": "AUS",
"accountName": "text",
"iban": "text",
"bic": "CTBAAU2SXXX"
},
"domesticSettlementAccount": {
"currency": "AED",
"accountHolderType": "BUSINESS",
"description": "Coffee Supreme Trading",
"nickname": "Store 1 Account",
"accountName": "Coffee Supreme LTD",
"sortCode": "301105",
"bsb": 22039,
"routingTransitNumber": "247484410",
"accountNumberType": "DEFAULT",
"accountNumber": "23008275"
},
"serviceStartDate": "2026-01-01T00:00:00.000Z",
"terminalRentalStartDate": "2026-01-01T00:00:00.000Z",
"proprietorAct": true,
"documents": [
{
"documentId": "123e4567-e89b-12d3-a456-426614174000",
"documentName": "text",
"displayName": "text",
"status": "PENDING_UPLOAD",
"allowedContentTypes": [
"application/pdf"
],
"allowedContentLength": 2097152,
"contact": {
"contactType": "BUSINESS",
"name": {
"firstName": "text",
"lastName": "text",
"prefix": "text",
"alternateFullName": "text",
"middleName": "text",
"suffix": "text"
},
"phoneNumbers": [
{
"callingCode": "text",
"value": "text",
"extension": "text",
"isPrimary": false,
"phoneType": "HOME"
}
],
"email": "name@gmail.com",
"businessTitle": "text",
"passportId": "text",
"nationality": "text",
"additionalNationalities": [
"text"
],
"nationalIdentifer": "text"
},
"uploadedDate": "2026-01-01T00:00:00.000Z",
"modifiedDate": "2026-01-01T00:00:00.000Z"
}
],
"replacementAgreement": {
"contractNumber": "text",
"devices": [
{
"serialNumber": "text",
"deviceModel": "text"
}
]
}
},
"entityUid": "14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9",
"shippingAddress": {
"contact": {
"contactType": "BUSINESS",
"name": {
"firstName": "text",
"lastName": "text",
"prefix": "text",
"alternateFullName": "text",
"middleName": "text",
"suffix": "text"
},
"phoneNumbers": [
{
"callingCode": "text",
"value": "text",
"extension": "text",
"isPrimary": false,
"phoneType": "HOME"
}
],
"email": "name@gmail.com",
"businessTitle": "text"
},
"vfiSiteId": "text",
"storeNumber": "text",
"governmentOwned": true,
"governmentCountry": "AUS",
"receiverName": "text",
"addressLine1": "213 Miller Street",
"addressLine2": "North Sydney",
"addressLine3": "text",
"poBox": "K1234",
"city": "York",
"countrySubdivision": "Georgia",
"postCode": "2061",
"country": "AUS",
"timeZone": "text"
},
"billingAddress": {
"contact": {
"contactType": "BUSINESS",
"name": {
"firstName": "text",
"lastName": "text",
"prefix": "text",
"alternateFullName": "text",
"middleName": "text",
"suffix": "text"
},
"phoneNumbers": [
{
"callingCode": "text",
"value": "text",
"extension": "text",
"isPrimary": false,
"phoneType": "HOME"
}
],
"email": "name@gmail.com",
"businessTitle": "text"
},
"vfiSiteId": "text",
"storeNumber": "text",
"governmentOwned": true,
"governmentCountry": "AUS",
"receiverName": "text",
"addressLine1": "213 Miller Street",
"addressLine2": "North Sydney",
"addressLine3": "text",
"poBox": "K1234",
"city": "York",
"countrySubdivision": "Georgia",
"postCode": "2061",
"country": "AUS",
"timeZone": "text"
},
"requestedDateOfShipment": "2026-01-01T00:00:00.000Z",
"pois": [
"[Circular Reference]"
],
"merchantId": "text",
"orderId": "32c480b5-4dfb-4c53-959f-49edf45a0931",
"status": "DRAFT",
"createdUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"createdBy": "text",
"createdDate": "2026-01-01T00:00:00.000Z",
"modifiedUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"modifiedBy": "text",
"modifiedDate": "2026-01-01T00:00:00.000Z",
"orderType": "POIOrder",
"merchantCompanyEntityUid": "14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9",
"merchant": {
"merchantName": "text"
},
"internal": {
"oracleOrderNumber": 1,
"oracleShippingTrackingReference": "text",
"kycReportUid": "123e4567-e89b-12d3-a456-426614174000",
"tokenScopeUid": "123e4567-e89b-12d3-a456-426614174000",
"extendedDetails": {
"status": "DRAFT",
"code": "text",
"information": "text",
"lastChangeTime": "2020-01-06T18:16:14.243Z",
"canCancel": true
},
"orderStats": {
"minsSinceCreatedToLastUpdate": 0,
"minsSinceLastStatusUpdate": 0
},
"vmssApplication": {
"visaStatus": "NA ",
"visaMatches": 1,
"mcdStatus": "NA ",
"mcdMatches": 1,
"mcdTransactionReference": "text"
},
"salesforceApplicationId": "text",
"signingInformation": {
"provider": "SIGNICAT",
"providerRef": "text",
"signedFileUrl": "text",
"signingRequests": [
{
"providerRef": "text",
"contact": {
"contactType": "BUSINESS",
"name": {
"firstName": "text",
"lastName": "text",
"prefix": "text",
"alternateFullName": "text",
"middleName": "text",
"suffix": "text"
},
"phoneNumbers": [
{
"callingCode": "text",
"value": "text",
"extension": "text",
"isPrimary": false,
"phoneType": "HOME"
}
],
"email": "name@gmail.com",
"businessTitle": "text"
},
"signed": false,
"signedDateTime": "2026-01-01T00:00:00.000Z",
"signingLink": "text"
}
]
},
"econtractNotificationReminder": {
"lastNotificationSentDateTime": "2026-01-01T00:00:00.000Z",
"notificationCount": 1,
"templateName": "text",
"notifications": [
{
"sentDateTime": "2026-01-01T00:00:00.000Z",
"template": "text",
"responseReferenceId": "text"
}
]
},
"draftNotificationReminder": {
"lastNotificationSentDateTime": "2026-01-01T00:00:00.000Z",
"notificationCount": 1,
"templateName": "text",
"notifications": [
{
"sentDateTime": "2026-01-01T00:00:00.000Z",
"template": "text",
"responseReferenceId": "text"
}
]
},
"notificationReminders": {
"econtract": {
"lastNotificationSentDateTime": "2026-01-01T00:00:00.000Z",
"notificationCount": 1,
"templateName": "text",
"notifications": [
{
"sentDateTime": "2026-01-01T00:00:00.000Z",
"template": "text",
"responseReferenceId": "text"
}
]
},
"draft": {
"lastNotificationSentDateTime": "2026-01-01T00:00:00.000Z",
"notificationCount": 1,
"templateName": "text",
"notifications": [
{
"sentDateTime": "2026-01-01T00:00:00.000Z",
"template": "text",
"responseReferenceId": "text"
}
]
},
"docRequired": {
"lastNotificationSentDateTime": "2026-01-01T00:00:00.000Z",
"notificationCount": 1,
"templateName": "text",
"notifications": [
{
"sentDateTime": "2026-01-01T00:00:00.000Z",
"template": "text",
"responseReferenceId": "text"
}
]
}
},
"customerOrderLink": {
"orderLink": "https://example.com",
"linkInitiatorUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"linkInitiatorUsername": "text",
"linkReceiverUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"linkReceiverUsername": "text",
"linkSendTime": "2026-01-01T00:00:00.000Z",
"linkOpendByCustomerTime": "2026-01-01T00:00:00.000Z",
"customerUpdateTime": "2026-01-01T00:00:00.000Z"
},
"cancellationHistory": [
{
"cancelReasonEnum": "ADMIN_REASON",
"cancelAdditionalReason": "text",
"cancelledUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"cancelledBy": "text",
"cancelledDate": "2026-01-01T00:00:00.000Z"
}
],
"externalOnboarding": {
"provider": "BANKAXEPT",
"agreementId": "123e4567-e89b-12d3-a456-426614174000",
"agreementStatus": "text"
}
}
}Request an Order to be cancelled, note depending on status of the order this may not be allowed.
Verifone allocated ID for the Order.
32c480b5-4dfb-4c53-959f-49edf45a0931Reason for order cancellation.
Free-Form reason for order cancellation.
Unique identifier (UUID) of the user who performed the cancellation.
04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1The username of the person who's UID is represented, e.g. "John/Jane Smith".
Date and time when the order was cancelled, in UTC.
Order Cancellation Requested
No content
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Operation Not Allowed
Request Not Acceptable
Too Many Requests
Internal Error
Service Not Available
Service Timeout
POST /orders/{orderId}/cancel HTTP/1.1
Host: api.verifone.com
Content-Type: application/json
Accept: */*
Content-Length: 189
{
"cancelReasonEnum": "ADMIN_REASON",
"cancelAdditionalReason": "text",
"cancelledUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
"cancelledBy": "text",
"cancelledDate": "2026-01-01T00:00:00.000Z"
}No content
Submit Draft Order for processing
Verifone allocated ID for the Order.
32c480b5-4dfb-4c53-959f-49edf45a0931An optional header indicating whether to validate the acquirer.
An optional header indicating whether to validate account details against GIACT.
An optional header indicating to the client to validate the merchant details stored in the order against Verifone Identity Service.
Order submitted
No content
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Too Many Requests
Internal Error
Service Not Available
Service Timeout
POST /orders/drafts/{orderId} HTTP/1.1
Host: api.verifone.com
Accept: */*
No content
Delete a Draft Order (only if in draft state)
Verifone allocated ID for the Order.
32c480b5-4dfb-4c53-959f-49edf45a0931Order Deleted
No content
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Too Many Requests
Internal Error
Service Not Available
Service Timeout
DELETE /orders/drafts/{orderId} HTTP/1.1
Host: api.verifone.com
Accept: */*
No content
Triggers the econtract provider to send a reminder for pending signature.
Verifone allocated ID for the Order.
32c480b5-4dfb-4c53-959f-49edf45a0931Resend request accepted.
No content
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Too Many Requests
Internal Error
Service Not Available
Service Timeout
POST /orders/{orderId}/econtracts/sendReminder HTTP/1.1
Host: api.verifone.com
Accept: */*
No content
Download econtract PDF
Verifone allocated ID for the Order.
32c480b5-4dfb-4c53-959f-49edf45a0931trueContract file
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Too Many Requests
Internal Error
Service Not Available
Service Timeout
GET /orders/{orderId}/econtracts/download?signed=true HTTP/1.1
Host: api.verifone.com
Accept: */*
binaryTriggers to resend the welcome letter to customer.
Verifone allocated ID for the Order.
32c480b5-4dfb-4c53-959f-49edf45a0931Resend welcome letter
No content
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Too Many Requests
Internal Error
Service Not Available
Service Timeout
POST /orders/{orderId}/resendWelcomeLetter HTTP/1.1
Host: api.verifone.com
Accept: */*
No content
Starts the bulk order upload process. Provide the customer, file type and file name — the service will respond with a secure upload link and a reference ID. Use the upload link to upload your file, then use the reference ID to submit it for processing.
Request body for bulk order upload initiation.
Verifone customer entity ID for whom the bulk order is being uploaded.
Type of the file being uploaded (e.g. CSV, XLSX).
Name of the file being uploaded.
Bulk upload initiated successfully.
Response containing the pre-signed S3 URL and transaction ID for the bulk upload.
Reference ID to be used when submitting via POST /orders/bulk/submit.
Secure upload link for direct file upload from the client.
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Too Many Requests
Internal Error
Service Not Available
Service Timeout
POST /orders/bulk/upload-url HTTP/1.1
Host: api.verifone.com
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"customerEntityId": "text",
"fileType": "text",
"fileName": "text"
}{
"transactionId": "text",
"s3Url": "text"
}Submits the uploaded file for processing. Provide the reference ID received from POST /orders/bulk/upload-url — the service will scan the file and, if clean, move it to the target location for processing. If the file is found to be infected it will be rejected.
Request body for bulk order upload submission.
Reference ID returned from POST /orders/bulk/upload-url.
File is clean and has been successfully submitted for processing.
No content
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Conflict — virus scan still pending after retries exhausted.
Unprocessable Entity — file is infected and has been rejected.
Too Many Requests
Internal Error
Service Not Available
Service Timeout
POST /orders/bulk/submit HTTP/1.1
Host: api.verifone.com
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"transactionId": "text"
}No content
Resolves POI UIDs from one or more merchant identifiers. At least one query parameter must be provided. Parameters are grouped into three resolution paths: Path 1 (merchantId), Path 2 (entity identifiers — AND-combinable), Path 3 (estateManagementId). merchantId + altVfiEntityId is also supported.
Acquirer MID stored on Payment Provider Contract (Path 1).
Verifone gateway MID (ISO8583 DE42) (Path 2).
Site reference ID (Path 2).
Alias for siteReferenceId — same Entity Service param (Path 2).
Merchant name (Path 2).
Site name (Path 2).
Estate management ID — resolves POI and parent entity directly (Path 3).
POI lookup result.
Response for POI lookup by merchant identifiers.
Merchant name.
Site name.
Site reference ID.
Alias for siteReferenceId.
Acquirer MID from Payment Provider Contract.
Verifone gateway MID (ISO8583 DE42).
entityUid of the ancestor MERCHANT_COMPANY entity.
entityUid of the resolved site.
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Unprocessable Entity — conflicting or ambiguous identifiers.
Too Many Requests
Internal Error
Service Not Available
Service Timeout
GET /pois/lookup HTTP/1.1
Host: api.verifone.com
Accept: */*
{
"merchantName": "text",
"siteName": "text",
"siteReferenceId": "text",
"storeNumber": "text",
"merchantId": "text",
"altVfiEntityId": "text",
"merchantCompanyUid": "123e4567-e89b-12d3-a456-426614174000",
"entityUid": "123e4567-e89b-12d3-a456-426614174000",
"pois": [
{
"poiUid": "123e4567-e89b-12d3-a456-426614174000",
"estateManagementId": "text",
"poiName": "text"
}
]
}Triggers to send the order link to customer.
Verifone allocated ID for the Order.
32c480b5-4dfb-4c53-959f-49edf45a0931UI-generated link that helps the customer land on the correct step in the order page's stepper. This link ensures the customer can update their order by navigating directly to the relevant section.
Sent Customer Order Link
No content
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
Too Many Requests
Internal Error
Service Not Available
Service Timeout
POST /orders/sendCustomerOrderLink HTTP/1.1
Host: api.verifone.com
Content-Type: application/json
Accept: */*
Content-Length: 84
{
"orderId": "32c480b5-4dfb-4c53-959f-49edf45a0931",
"orderLink": "https://example.com"
}No content
Validates whether the customer order link is still active or has expired after the customer clicks on it. This API checks the validity of the order link and determines if the customer can proceed with their order.
Verifone allocated ID for the Order.
32c480b5-4dfb-4c53-959f-49edf45a0931The order link is valid and can be used.
No content
Bad Request
Unauthorised Request
Forbidden Request.
Not Found Request
The order link has expired and is no longer usable.
Too Many Requests
Internal Error
Service Not Available
Service Timeout
POST /orders/validateCustomerOrderLink HTTP/1.1
Host: api.verifone.com
Content-Type: application/json
Accept: */*
Content-Length: 50
{
"orderId": "32c480b5-4dfb-4c53-959f-49edf45a0931"
}No content
Last updated
Was this helpful?