Common

Operations common to all orders.

Get the list of all orders

get

By passing in the appropriate options, you can search for available orders in the system.

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:

detailedStatusstring · enumOptional

An order will be in one of the following states.

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

lastChangeTimestring · date-timeOptional

Time status detailed status last changed.

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

pageNumberinteger · min: 1Optional

Page number for records.

Default: 1Example: 1

pageSizeinteger · min: 1 · max: 100Optional

Page size for returned records.

Default: 50Example: 50

orderstring · enumOptional

The ordering of the returned results.

Possible values:

orderBystringOptional

The field to order by. Valid fields are: createdBy, createdDate, modifiedDate, merchantName, status

signingProviderstring · enumOptional

The signing provider for the order.

Possible values:

portfolioTypestring · enumOptional

Used in combination with merchant-company-entity to find the first instore order.

Possible values:

groupNamestring · min: 1Optional

Pass an optional group name to filter orders by group.

checkPresenceInEntitybooleanOptional

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.

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

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

{
  "orders": [
    {
      "orderReference": "ORD-1234",
      "customerEntityUid": "123e4567-e89b-12d3-a456-426614174000",
      "requestedDate": "2026-06-14T07:28:55.082Z",
      "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": [
          {
            "packageBundleId": "PREMIUM-36MONTH",
            "adjustedPrices": [
              {
                "priceModel": "MONTHLY_FEE",
                "price": "20.50"
              }
            ],
            "processorParameters": {
              "processor": "TSYS_US",
              "tidList": [
                "1004631982",
                "1004631983",
                "1004631984"
              ]
            },
            "additionalPackageData": [
              {
                "variableName": "VAT_ID or BAX_ID",
                "variableValue": "1234566"
              }
            ],
            "threeDSMerchantIdentifiers": {
              "merchantId": "541734",
              "paymentType": "AFFIRM"
            }
          }
        ],
        "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-06-14",
            "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-06-14T07:28:55.082Z",
        "terminalRentalStartDate": "2026-06-14T07:28:55.082Z",
        "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-06-14T07:28:55.082Z",
            "modifiedDate": "2026-06-14T07:28:55.082Z"
          }
        ],
        "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-06-14T07:28:55.082Z",
      "pois": [
        {
          "type": "UNSPECIFIED",
          "poiId": "text",
          "subPoiId": "text",
          "altVfiPoiId": "1004631982",
          "estateManagementId": "text",
          "estateManagementQrCode": "iVBORw0KGgoAAAANSUhEUgAAAWYAAACeCAYAAAABkKDWAAAAAXNSR0I.....",
          "serialNumber": "text",
          "laneInformation": {
            "customerLaneId": "text",
            "customerLaneDesignator": "text",
            "laneNotes": "text"
          },
          "networkConfig": {
            "ipAddress": "text",
            "ipGateway": "text",
            "subnetMask": "text",
            "networkPrefix": "text",
            "dns1": "text",
            "dns2": "text",
            "wifiSSID": "text",
            "wifiPassword": "text",
            "wpaEncryptionMethod": "text"
          },
          "name": "text",
          "description": "text",
          "status": "ACTIVE",
          "cutoverTime": "17:00",
          "poiUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
          "acquirerPoiIds": [
            {
              "variableName": "VAT_ID or BAX_ID",
              "variableValue": "1234566"
            }
          ],
          "poiLabels": [
            "text"
          ],
          "activationCode": "89EG-1A5F-P3T2",
          "vhqCustomerId": "text",
          "vhqUrl": "https://qa.apac.verifonehq.net"
        }
      ],
      "merchantId": "text",
      "orderId": "32c480b5-4dfb-4c53-959f-49edf45a0931",
      "status": "DRAFT",
      "createdUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
      "createdBy": "text",
      "createdDate": "2026-06-14T07:28:55.082Z",
      "modifiedUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
      "modifiedBy": "text",
      "modifiedDate": "2026-06-14T07:28:55.082Z",
      "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-06-14T07:28:55.082Z",
              "signingLink": "text"
            }
          ]
        },
        "econtractNotificationReminder": {
          "lastNotificationSentDateTime": "2026-06-14T07:28:55.082Z",
          "notificationCount": 1,
          "templateName": "text",
          "notifications": [
            {
              "sentDateTime": "2026-06-14T07:28:55.082Z",
              "template": "text",
              "responseReferenceId": "text"
            }
          ]
        },
        "draftNotificationReminder": {
          "lastNotificationSentDateTime": "2026-06-14T07:28:55.082Z",
          "notificationCount": 1,
          "templateName": "text",
          "notifications": [
            {
              "sentDateTime": "2026-06-14T07:28:55.082Z",
              "template": "text",
              "responseReferenceId": "text"
            }
          ]
        },
        "notificationReminders": {
          "econtract": {
            "lastNotificationSentDateTime": "2026-06-14T07:28:55.082Z",
            "notificationCount": 1,
            "templateName": "text",
            "notifications": [
              {
                "sentDateTime": "2026-06-14T07:28:55.082Z",
                "template": "text",
                "responseReferenceId": "text"
              }
            ]
          },
          "draft": {
            "lastNotificationSentDateTime": "2026-06-14T07:28:55.082Z",
            "notificationCount": 1,
            "templateName": "text",
            "notifications": [
              {
                "sentDateTime": "2026-06-14T07:28:55.082Z",
                "template": "text",
                "responseReferenceId": "text"
              }
            ]
          },
          "docRequired": {
            "lastNotificationSentDateTime": "2026-06-14T07:28:55.082Z",
            "notificationCount": 1,
            "templateName": "text",
            "notifications": [
              {
                "sentDateTime": "2026-06-14T07:28:55.082Z",
                "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-06-14T07:28:55.082Z",
          "linkOpendByCustomerTime": "2026-06-14T07:28:55.082Z",
          "customerUpdateTime": "2026-06-14T07:28:55.082Z"
        },
        "cancellationHistory": [
          {
            "cancelReasonEnum": "ADMIN_REASON",
            "cancelAdditionalReason": "text",
            "cancelledUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
            "cancelledBy": "text",
            "cancelledDate": "2026-06-14T07:28:55.082Z"
          }
        ],
        "externalOnboarding": {
          "provider": "BANKAXEPT",
          "agreementId": "123e4567-e89b-12d3-a456-426614174000",
          "agreementStatus": "text"
        }
      }
    }
  ],
  "metadata": {
    "totalPages": 1,
    "pageNumber": 1,
    "pageSize": 50,
    "totalItems": 25
  }
}

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

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

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

Get the list of the searchable metadata for querying orders

get

By passing in the appropriate options, you can search for metadata 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/metadata

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

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

Get a First Company order

get

Get the first order which was boarded for a company

Path parameters

customerEntityUidstring · uuidRequired

The Verifone allocated unique id for this site.

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

merchantCompanyEntityUidstring · uuidRequired

The Verifone allocated unique ID for this merchant company.

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

Query parameters

portfolioTypestring · enumOptional

Used in combination with merchant-company-entity to find the first instore order.

Possible values:

Responses

200

Search results matching criteria.

application/json

Supports returning oneOf the possible order types. The returned value will contain the orderType.

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

/entities/{customerEntityUid}/orders/{merchantCompanyEntityUid}/first

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-06-14T07:28:55.082Z",
  "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": [
      {
        "packageBundleId": "PREMIUM-36MONTH",
        "adjustedPrices": [
          {
            "priceModel": "MONTHLY_FEE",
            "price": "20.50"
          }
        ],
        "processorParameters": {
          "processor": "TSYS_US",
          "tidList": [
            "1004631982",
            "1004631983",
            "1004631984"
          ]
        },
        "additionalPackageData": [
          {
            "variableName": "VAT_ID or BAX_ID",
            "variableValue": "1234566"
          }
        ],
        "threeDSMerchantIdentifiers": {
          "merchantId": "541734",
          "paymentType": "AFFIRM"
        }
      }
    ],
    "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-06-14",
        "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-06-14T07:28:55.082Z",
    "terminalRentalStartDate": "2026-06-14T07:28:55.082Z",
    "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-06-14T07:28:55.082Z",
        "modifiedDate": "2026-06-14T07:28:55.082Z"
      }
    ],
    "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-06-14T07:28:55.082Z",
  "pois": [
    {
      "type": "UNSPECIFIED",
      "poiId": "text",
      "subPoiId": "text",
      "altVfiPoiId": "1004631982",
      "estateManagementId": "text",
      "estateManagementQrCode": "iVBORw0KGgoAAAANSUhEUgAAAWYAAACeCAYAAAABkKDWAAAAAXNSR0I.....",
      "serialNumber": "text",
      "laneInformation": {
        "customerLaneId": "text",
        "customerLaneDesignator": "text",
        "laneNotes": "text"
      },
      "networkConfig": {
        "ipAddress": "text",
        "ipGateway": "text",
        "subnetMask": "text",
        "networkPrefix": "text",
        "dns1": "text",
        "dns2": "text",
        "wifiSSID": "text",
        "wifiPassword": "text",
        "wpaEncryptionMethod": "text"
      },
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "cutoverTime": "17:00",
      "poiUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
      "acquirerPoiIds": [
        {
          "variableName": "VAT_ID or BAX_ID",
          "variableValue": "1234566"
        }
      ],
      "poiLabels": [
        "text"
      ],
      "activationCode": "89EG-1A5F-P3T2",
      "vhqCustomerId": "text",
      "vhqUrl": "https://qa.apac.verifonehq.net"
    }
  ],
  "merchantId": "text",
  "orderId": "32c480b5-4dfb-4c53-959f-49edf45a0931",
  "status": "DRAFT",
  "createdUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
  "createdBy": "text",
  "createdDate": "2026-06-14T07:28:55.082Z",
  "modifiedUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
  "modifiedBy": "text",
  "modifiedDate": "2026-06-14T07:28:55.082Z",
  "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-06-14T07:28:55.082Z",
          "signingLink": "text"
        }
      ]
    },
    "econtractNotificationReminder": {
      "lastNotificationSentDateTime": "2026-06-14T07:28:55.082Z",
      "notificationCount": 1,
      "templateName": "text",
      "notifications": [
        {
          "sentDateTime": "2026-06-14T07:28:55.082Z",
          "template": "text",
          "responseReferenceId": "text"
        }
      ]
    },
    "draftNotificationReminder": {
      "lastNotificationSentDateTime": "2026-06-14T07:28:55.082Z",
      "notificationCount": 1,
      "templateName": "text",
      "notifications": [
        {
          "sentDateTime": "2026-06-14T07:28:55.082Z",
          "template": "text",
          "responseReferenceId": "text"
        }
      ]
    },
    "notificationReminders": {
      "econtract": {
        "lastNotificationSentDateTime": "2026-06-14T07:28:55.082Z",
        "notificationCount": 1,
        "templateName": "text",
        "notifications": [
          {
            "sentDateTime": "2026-06-14T07:28:55.082Z",
            "template": "text",
            "responseReferenceId": "text"
          }
        ]
      },
      "draft": {
        "lastNotificationSentDateTime": "2026-06-14T07:28:55.082Z",
        "notificationCount": 1,
        "templateName": "text",
        "notifications": [
          {
            "sentDateTime": "2026-06-14T07:28:55.082Z",
            "template": "text",
            "responseReferenceId": "text"
          }
        ]
      },
      "docRequired": {
        "lastNotificationSentDateTime": "2026-06-14T07:28:55.082Z",
        "notificationCount": 1,
        "templateName": "text",
        "notifications": [
          {
            "sentDateTime": "2026-06-14T07:28:55.082Z",
            "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-06-14T07:28:55.082Z",
      "linkOpendByCustomerTime": "2026-06-14T07:28:55.082Z",
      "customerUpdateTime": "2026-06-14T07:28:55.082Z"
    },
    "cancellationHistory": [
      {
        "cancelReasonEnum": "ADMIN_REASON",
        "cancelAdditionalReason": "text",
        "cancelledUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
        "cancelledBy": "text",
        "cancelledDate": "2026-06-14T07:28:55.082Z"
      }
    ],
    "externalOnboarding": {
      "provider": "BANKAXEPT",
      "agreementId": "123e4567-e89b-12d3-a456-426614174000",
      "agreementStatus": "text"
    }
  }
}

Get a single order

get

Get a single order by Order Id

Path parameters

orderIdstring · uuidRequired

Verifone allocated ID for the Order.

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

Responses

200

search results matching criteria

application/json

Supports returning oneOf the possible order types. The returned value will contain the orderType.

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/{orderId}

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

{
  "orderReference": "ORD-1234",
  "customerEntityUid": "123e4567-e89b-12d3-a456-426614174000",
  "requestedDate": "2026-06-14T07:28:55.082Z",
  "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": [
      {
        "packageBundleId": "PREMIUM-36MONTH",
        "adjustedPrices": [
          {
            "priceModel": "MONTHLY_FEE",
            "price": "20.50"
          }
        ],
        "processorParameters": {
          "processor": "TSYS_US",
          "tidList": [
            "1004631982",
            "1004631983",
            "1004631984"
          ]
        },
        "additionalPackageData": [
          {
            "variableName": "VAT_ID or BAX_ID",
            "variableValue": "1234566"
          }
        ],
        "threeDSMerchantIdentifiers": {
          "merchantId": "541734",
          "paymentType": "AFFIRM"
        }
      }
    ],
    "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-06-14",
        "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-06-14T07:28:55.082Z",
    "terminalRentalStartDate": "2026-06-14T07:28:55.082Z",
    "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-06-14T07:28:55.082Z",
        "modifiedDate": "2026-06-14T07:28:55.082Z"
      }
    ],
    "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-06-14T07:28:55.082Z",
  "pois": [
    {
      "type": "UNSPECIFIED",
      "poiId": "text",
      "subPoiId": "text",
      "altVfiPoiId": "1004631982",
      "estateManagementId": "text",
      "estateManagementQrCode": "iVBORw0KGgoAAAANSUhEUgAAAWYAAACeCAYAAAABkKDWAAAAAXNSR0I.....",
      "serialNumber": "text",
      "laneInformation": {
        "customerLaneId": "text",
        "customerLaneDesignator": "text",
        "laneNotes": "text"
      },
      "networkConfig": {
        "ipAddress": "text",
        "ipGateway": "text",
        "subnetMask": "text",
        "networkPrefix": "text",
        "dns1": "text",
        "dns2": "text",
        "wifiSSID": "text",
        "wifiPassword": "text",
        "wpaEncryptionMethod": "text"
      },
      "name": "text",
      "description": "text",
      "status": "ACTIVE",
      "cutoverTime": "17:00",
      "poiUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
      "acquirerPoiIds": [
        {
          "variableName": "VAT_ID or BAX_ID",
          "variableValue": "1234566"
        }
      ],
      "poiLabels": [
        "text"
      ],
      "activationCode": "89EG-1A5F-P3T2",
      "vhqCustomerId": "text",
      "vhqUrl": "https://qa.apac.verifonehq.net"
    }
  ],
  "merchantId": "text",
  "orderId": "32c480b5-4dfb-4c53-959f-49edf45a0931",
  "status": "DRAFT",
  "createdUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
  "createdBy": "text",
  "createdDate": "2026-06-14T07:28:55.082Z",
  "modifiedUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
  "modifiedBy": "text",
  "modifiedDate": "2026-06-14T07:28:55.082Z",
  "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-06-14T07:28:55.082Z",
          "signingLink": "text"
        }
      ]
    },
    "econtractNotificationReminder": {
      "lastNotificationSentDateTime": "2026-06-14T07:28:55.082Z",
      "notificationCount": 1,
      "templateName": "text",
      "notifications": [
        {
          "sentDateTime": "2026-06-14T07:28:55.082Z",
          "template": "text",
          "responseReferenceId": "text"
        }
      ]
    },
    "draftNotificationReminder": {
      "lastNotificationSentDateTime": "2026-06-14T07:28:55.082Z",
      "notificationCount": 1,
      "templateName": "text",
      "notifications": [
        {
          "sentDateTime": "2026-06-14T07:28:55.082Z",
          "template": "text",
          "responseReferenceId": "text"
        }
      ]
    },
    "notificationReminders": {
      "econtract": {
        "lastNotificationSentDateTime": "2026-06-14T07:28:55.082Z",
        "notificationCount": 1,
        "templateName": "text",
        "notifications": [
          {
            "sentDateTime": "2026-06-14T07:28:55.082Z",
            "template": "text",
            "responseReferenceId": "text"
          }
        ]
      },
      "draft": {
        "lastNotificationSentDateTime": "2026-06-14T07:28:55.082Z",
        "notificationCount": 1,
        "templateName": "text",
        "notifications": [
          {
            "sentDateTime": "2026-06-14T07:28:55.082Z",
            "template": "text",
            "responseReferenceId": "text"
          }
        ]
      },
      "docRequired": {
        "lastNotificationSentDateTime": "2026-06-14T07:28:55.082Z",
        "notificationCount": 1,
        "templateName": "text",
        "notifications": [
          {
            "sentDateTime": "2026-06-14T07:28:55.082Z",
            "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-06-14T07:28:55.082Z",
      "linkOpendByCustomerTime": "2026-06-14T07:28:55.082Z",
      "customerUpdateTime": "2026-06-14T07:28:55.082Z"
    },
    "cancellationHistory": [
      {
        "cancelReasonEnum": "ADMIN_REASON",
        "cancelAdditionalReason": "text",
        "cancelledUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
        "cancelledBy": "text",
        "cancelledDate": "2026-06-14T07:28:55.082Z"
      }
    ],
    "externalOnboarding": {
      "provider": "BANKAXEPT",
      "agreementId": "123e4567-e89b-12d3-a456-426614174000",
      "agreementStatus": "text"
    }
  }
}

Request Order to be cancelled

post

Request an Order to be cancelled, note depending on status of the order this may not be allowed.

Path parameters

orderIdstring · uuidRequired

Verifone allocated ID for the Order.

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

Body

cancelReasonEnumstring · enumRequired

Reason for order cancellation.

Possible values:

cancelAdditionalReasonstringOptional

Free-Form reason for order cancellation.

cancelledUserUidstring · uuidOptional

Unique identifier (UUID) of the user who performed the cancellation.

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

cancelledBystring · min: 1Optional

The username of the person who's UID is represented, e.g. "John/Jane Smith".

cancelledDatestring · date-timeOptional

Date and time when the order was cancelled, in UTC.

Responses

204

Order Cancellation Requested

400

Bad Request

application/json

401

Unauthorised Request

application/json

403

Forbidden Request.

application/json

404

Not Found Request

application/json

405

Operation Not Allowed

application/json

406

Request Not Acceptable

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/{orderId}/cancel

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-06-14T07:28:55.082Z"
}

No content

Submit Draft Order for processing

post

Submit Draft Order for processing

Path parameters

orderIdstring · uuidRequired

Verifone allocated ID for the Order.

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

Header parameters

validateAcquirerbooleanOptional

An optional header indicating whether to validate the acquirer.

validateACHbooleanOptional

An optional header indicating whether to validate account details against GIACT.

validateCompanyIdentitybooleanOptional

An optional header indicating to the client to validate the merchant details stored in the order against Verifone Identity Service.

Responses

204

Order submitted

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/drafts/{orderId}"

POST /orders/drafts/{orderId}" HTTP/1.1
Host: api.verifone.com
Accept: */*

No content

Delete a Draft Order

delete

Delete a Draft Order (only if in draft state)

Path parameters

orderIdstring · uuidRequired

Verifone allocated ID for the Order.

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

Responses

204

Order Deleted

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

delete

/orders/drafts/{orderId}"

DELETE /orders/drafts/{orderId}" HTTP/1.1
Host: api.verifone.com
Accept: */*

No content

Send Econtract reminder

post

Triggers the econtract provider to send a reminder for pending signature.

Path parameters

orderIdstring · uuidRequired

Verifone allocated ID for the Order.

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

Responses

202

Resend request accepted.

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/{orderId}/econtracts/sendReminder

POST /orders/{orderId}/econtracts/sendReminder HTTP/1.1
Host: api.verifone.com
Accept: */*

No content

Download Econtract

get

Download econtract PDF

Path parameters

orderIdstring · uuidRequired

Verifone allocated ID for the Order.

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

Query parameters

signedbooleanRequiredDefault: true

Responses

200

Contract file

application/pdf:

Responsestring · binary

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/{orderId}/econtracts/download

GET /orders/{orderId}/econtracts/download?signed=true HTTP/1.1
Host: api.verifone.com
Accept: */*

binary

Resend welcome letter

post

Triggers to resend the welcome letter to customer.

Path parameters

orderIdstring · uuidRequired

Verifone allocated ID for the Order.

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

Responses

202

Resend welcome letter

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/{orderId}/resendWelcomeLetter

POST /orders/{orderId}/resendWelcomeLetter HTTP/1.1
Host: api.verifone.com
Accept: */*

No content

Initiate bulk order upload

post

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.

Body

Request body for bulk order upload initiation.

customerEntityIdstringRequired

Verifone customer entity ID for whom the bulk order is being uploaded.

fileTypestringRequired

Type of the file being uploaded (e.g. CSV, XLSX).

fileNamestringRequired

Name of the file being uploaded.

Responses

200

Bulk upload initiated successfully.

application/json

Response containing the pre-signed S3 URL and transaction ID for the bulk upload.

transactionIdstringOptional

Reference ID to be used when submitting via POST /orders/bulk/submit.

s3UrlstringOptional

Secure upload link for direct file upload from the client.

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/bulk/upload-url

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"
}

Submit bulk order upload for processing

post

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.

Body

Request body for bulk order upload submission.

transactionIdstringRequired

Reference ID returned from POST /orders/bulk/upload-url.

Responses

200

File is clean and has been successfully submitted for processing.

No content

400

Bad Request

application/json

401

Unauthorised Request

application/json

403

Forbidden Request.

application/json

404

Not Found Request

application/json

409

Conflict — virus scan still pending after retries exhausted.

application/json

422

Unprocessable Entity — file is infected and has been rejected.

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/bulk/submit

POST /orders/bulk/submit HTTP/1.1
Host: api.verifone.com
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "transactionId": "text"
}

No content

Lookup POIs by merchant identifiers

get

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.

Query parameters

merchantIdstringOptional

Acquirer MID stored on Payment Provider Contract (Path 1).

altVfiEntityIdstringOptional

Verifone gateway MID (ISO8583 DE42) (Path 2).

siteReferenceIdstringOptional

Site reference ID (Path 2).

storeNumberstringOptional

Alias for siteReferenceId — same Entity Service param (Path 2).

merchantNamestringOptional

Merchant name (Path 2).

siteNamestringOptional

Site name (Path 2).

estateManagementIdstringOptional

Estate management ID — resolves POI and parent entity directly (Path 3).

Responses

200

POI lookup result.

application/json

Response for POI lookup by merchant identifiers.

merchantNamestringOptional

Merchant name.

siteNamestringOptional

Site name.

siteReferenceIdstringOptional

Site reference ID.

storeNumberstringOptional

Alias for siteReferenceId.

merchantIdstringOptional

Acquirer MID from Payment Provider Contract.

altVfiEntityIdstringOptional

Verifone gateway MID (ISO8583 DE42).

merchantCompanyUidstring · uuidOptional

entityUid of the ancestor MERCHANT_COMPANY entity.

entityUidstring · uuidOptional

entityUid of the resolved site.

400

Bad Request

application/json

401

Unauthorised Request

application/json

403

Forbidden Request.

application/json

404

Not Found Request

application/json

422

Unprocessable Entity — conflicting or ambiguous identifiers.

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

/pois/lookup

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"
    }
  ]
}

Send Customer Order Link

post

Triggers to send the order link to customer.

Body

orderIdstring · uuidRequired

Verifone allocated ID for the Order.

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

orderLinkstring · uriRequired

UI-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.

Responses

202

Sent Customer Order Link

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

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

Validate Customer Order Link Expiry

post

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.

Body

orderIdstring · uuidRequired

Verifone allocated ID for the Order.

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

Responses

200

The order link is valid and can be used.

No content

400

Bad Request

application/json

401

Unauthorised Request

application/json

403

Forbidden Request.

application/json

404

Not Found Request

application/json

410

The order link has expired and is no longer usable.

429

Too Many Requests

application/json

500

Internal Error

application/json

503

Service Not Available

application/json

504

Service Timeout

application/json

post

/orders/validateCustomerOrderLink

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

PreviousPOI NextMerchant Orders

Last updated 12 days ago

Was this helpful?