Internal

Verifone internal operations

Get the list of all Verifone Sites in Billing Engine

get

Using the UUID of the user or the merchantCompanyUid in the query (ROLE) Dependent.

Query parameters

customerEntityUidstring · uuidRequired

The Verifone allocated unique id for this site.

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

merchantCompanyEntityUidstring · uuidOptional

The Verifone allocated unique ID for this merchant company.

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

billingSitesOnlybooleanOptional

Only return the billing sites.

Default: true

billingSiteIdstringOptional

The billing site id to query.

Example: 13232331

locateCustomerbooleanOptional

A flag to indicate if when creating the user to verify them by locating the customer in the Verifone billing systems.

merchantCompanystring · min: 1 · max: 100Optional

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

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

addressLinestring · min: 1 · max: 40Optional

Address Line. Should include street and apartment number if required.

Example: 213 Miller Street

postCodestring · min: 1 · max: 16Optional

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Example: 2061

activeBankstring · min: 1 · max: 4Optional

Last 4 digits of active bank account

Example: 2061Pattern: ^[0-9]*

customerIdstringOptional

Customer ID in Oracle

Example: 28792600010001, BK00045

siteIdstringOptional

Site ID of existing unapproved user.

Example: 42679Pattern: ^[0-9]*

Responses

200

Search results matching criteria.

application/json

Account Sites Response.

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/accounts/sites

GET /accounts/sites?customerEntityUid=14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9 HTTP/1.1
Host: api.verifone.com
Accept: */*

{
  "sites": [
    {
      "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",
      "sitePurpose": "BILL",
      "groupNumber": "text",
      "activeBank": "2061",
      "customerId": "28792600010001, BK00045",
      "linkedSites": [
        {
          "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",
          "sitePurpose": "BILL",
          "groupNumber": "text",
          "activeBank": "2061",
          "customerId": "28792600010001, BK00045"
        }
      ]
    }
  ]
}

Get extended status

get

Get more details about the order status, worfklows, etc.

Path parameters

orderIdstring · uuidRequired

Verifone allocated ID for the Order.

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

Responses

200

search results matching criteria

application/json

statusstring · enumRequiredPossible values:

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}/status

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

{
  "status": "DRAFT",
  "workflow": {
    "workflowState": "text",
    "lastChangeDateTime": "2026-07-10T18:01:47.505Z",
    "tasks": [
      {
        "name": "text",
        "state": "text",
        "timestamp": "2026-07-10T18:01:47.505Z"
      }
    ]
  }
}

Update order status

patch

Update order status. This can only be done by internal Verifone systems.

Path parameters

orderIdstring · uuidRequired

Verifone allocated ID for the Order.

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

Body

Update status request.

newStatusstring · enumRequiredPossible values:

newStatusExtendedstring · enumOptional

An order will be in one of the following states.

Possible values:

Responses

200

Order status updated

No content

400

Bad Request

application/json

401

Unauthorised Request

application/json

403

Forbidden Request.

application/json

404

Not Found Request

application/json

429

Too Many Requests

application/json

500

Internal Error

application/json

503

Service Not Available

application/json

504

Service Timeout

application/json

patch/orders/{orderId}/status

PATCH /orders/{orderId}/status HTTP/1.1
Host: api.verifone.com
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "newStatus": "DRAFT",
  "newStatusExtended": "DRAFT"
}

No content

Internal Merchant Maintenance Order Request

post

Create an internal merchant maintenance order to track the workflow related to a merchant maintenance request such as updating a trading address. This should only be used by the order service consumer after a change has been done to entity service and additional workflow steps are required to orchestrate this data to other systems.

Body

orderReferencestring · min: 1Required

Client reference for the Order.

Example: ORD-1234

customerEntityUidstring · uuidRequired

Verifone allocated ID for the customer this order is for (packages and bundles are associated with this entity).

requestedDatestring · date-timeOptional

The requested date for this order.

deferredOrderProcessingDatestring · date-timeOptional

Defers order processing until the specified ISO 8601 UTC datetime (e.g. 2026-06-20T09:00:00Z). The workflow will not start before this point. If absent, processing begins immediately.

Example: 2026-06-20T09:00:00Z

poRefstringOptional

Purchase Order Reference

Example: 85219587

notesstringOptional

Notes for the Order

Example: Current in draft, caller got busy, callback anothertime.

eventTypestring · enumRequiredPossible values:

itemIdstringRequired

The ID of the record associated to the event.

orderIdstring · uuidRequired

Verifone allocated ID for the Order.

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

statusstring · enumRequiredPossible values:

createdUserUidstring · uuidOptional

The assigned User ID corresponding to the Order Created By.

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

createdBystring · min: 1Optional

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

createdDatestring · date-timeOptional

The created date for this order.

modifiedUserUidstring · uuidOptional

The assigned User_ID corresponding to the Order Modified By.

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

modifiedBystring · min: 1Optional

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

modifiedDatestring · date-timeOptional

The last modified date for this order.

orderTypestringOptionalDefault: MerchantMaintenanceOrder

entityUidstring · uuidRequired

The Verifone allocated unique id for this site.

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

contentobjectOptional

Responses

201

Create Merchant Maintenance Order Response

application/json

orderReferencestring · min: 1Required

Client reference for the Order.

Example: ORD-1234

customerEntityUidstring · uuidRequired

Verifone allocated ID for the customer this order is for (packages and bundles are associated with this entity).

requestedDatestring · date-timeOptional

The requested date for this order.

deferredOrderProcessingDatestring · date-timeOptional

Defers order processing until the specified ISO 8601 UTC datetime (e.g. 2026-06-20T09:00:00Z). The workflow will not start before this point. If absent, processing begins immediately.

Example: 2026-06-20T09:00:00Z

poRefstringOptional

Purchase Order Reference

Example: 85219587

notesstringOptional

Notes for the Order

Example: Current in draft, caller got busy, callback anothertime.

eventTypestring · enumRequiredPossible values:

itemIdstringRequired

The ID of the record associated to the event.

orderIdstring · uuidRequired

Verifone allocated ID for the Order.

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

statusstring · enumRequiredPossible values:

createdUserUidstring · uuidOptional

The assigned User ID corresponding to the Order Created By.

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

createdBystring · min: 1Optional

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

createdDatestring · date-timeOptional

The created date for this order.

modifiedUserUidstring · uuidOptional

The assigned User_ID corresponding to the Order Modified By.

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

modifiedBystring · min: 1Optional

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

modifiedDatestring · date-timeOptional

The last modified date for this order.

orderTypestringOptionalDefault: MerchantMaintenanceOrder

entityUidstring · uuidRequired

The Verifone allocated unique id for this site.

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

contentobjectOptional

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

POST /orders/merchantMaintenance HTTP/1.1
Host: api.verifone.com
Content-Type: application/json
Accept: */*
Content-Length: 1387

{
  "orderReference": "ORD-1234",
  "customerEntityUid": "123e4567-e89b-12d3-a456-426614174000",
  "requestedDate": "2026-07-10T18:01:47.505Z",
  "deferredOrderProcessingDate": "2026-06-20T09:00:00Z",
  "poRef": "85219587",
  "paymentDetails": {
    "paymentType": "CREDIT",
    "accountType": "CHEQUE",
    "accountCurrency": "AED",
    "institutionName": "HSBC Bank",
    "accountName": "Coffee Supreme LTD",
    "sortCode": "301105",
    "bsb": 22039,
    "routingTransitNumber": "247484410",
    "accountNumber": "23008275",
    "accountAddress": {
      "receiverName": "text",
      "addressLine1": "213 Miller Street",
      "addressLine2": "North Sydney",
      "addressLine3": "text",
      "poBox": "K1234",
      "city": "York",
      "countrySubdivision": "Georgia",
      "postCode": "2061",
      "country": "AUS",
      "timeZone": "text"
    },
    "ean": "23008275",
    "iban": "text",
    "bic": "CTBAAU2SXXX"
  },
  "notes": "Current in draft, caller got busy, callback anothertime.",
  "additionalOrderData": [
    {
      "variableName": "VAT_ID or BAX_ID",
      "variableValue": "1234566"
    }
  ],
  "eventType": "TradingAddressUpdated",
  "itemId": "text",
  "orderId": "32c480b5-4dfb-4c53-959f-49edf45a0931",
  "status": "DRAFT",
  "createdUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
  "createdBy": "text",
  "createdDate": "2026-07-10T18:01:47.505Z",
  "modifiedUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
  "modifiedBy": "text",
  "modifiedDate": "2026-07-10T18:01:47.505Z",
  "orderType": "MerchantMaintenanceOrder",
  "entityUid": "14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9",
  "merchant": {
    "merchantName": "text"
  },
  "content": {}
}

{
  "orderReference": "ORD-1234",
  "customerEntityUid": "123e4567-e89b-12d3-a456-426614174000",
  "requestedDate": "2026-07-10T18:01:47.505Z",
  "deferredOrderProcessingDate": "2026-06-20T09:00:00Z",
  "poRef": "85219587",
  "paymentDetails": {
    "paymentType": "CREDIT",
    "accountType": "CHEQUE",
    "accountCurrency": "AED",
    "institutionName": "HSBC Bank",
    "accountName": "Coffee Supreme LTD",
    "sortCode": "301105",
    "bsb": 22039,
    "routingTransitNumber": "247484410",
    "accountNumber": "23008275",
    "accountAddress": {
      "receiverName": "text",
      "addressLine1": "213 Miller Street",
      "addressLine2": "North Sydney",
      "addressLine3": "text",
      "poBox": "K1234",
      "city": "York",
      "countrySubdivision": "Georgia",
      "postCode": "2061",
      "country": "AUS",
      "timeZone": "text"
    },
    "ean": "23008275",
    "iban": "text",
    "bic": "CTBAAU2SXXX"
  },
  "notes": "Current in draft, caller got busy, callback anothertime.",
  "additionalOrderData": [
    {
      "variableName": "VAT_ID or BAX_ID",
      "variableValue": "1234566"
    }
  ],
  "eventType": "TradingAddressUpdated",
  "itemId": "text",
  "orderId": "32c480b5-4dfb-4c53-959f-49edf45a0931",
  "status": "DRAFT",
  "createdUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
  "createdBy": "text",
  "createdDate": "2026-07-10T18:01:47.505Z",
  "modifiedUserUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1",
  "modifiedBy": "text",
  "modifiedDate": "2026-07-10T18:01:47.505Z",
  "orderType": "MerchantMaintenanceOrder",
  "entityUid": "14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9",
  "merchant": {
    "merchantName": "text"
  },
  "content": {}
}

Trigger re-submission of draft upsell wait orders

post

Internal endpoint called by order-service-consumer after OBS or entity wallet creation completes, to asynchronously re-submit DRAFT upsell wait orders for the given merchant. Restricted to ROLE_SYSTEM_ONBOARDING_BACKEND and ROLE_VERIFONE_ADMIN. Must not be exposed via the public API gateway.

Body

Request to trigger async re-submission of DRAFT upsell wait orders belonging to a merchant, called after OBS or entity wallet creation completes.

customerEntityUidstring · uuidRequired

The customer entity UID of the merchant whose parent order has completed. Used to query draft ECNS and POI upsell orders.

merchantCompanyEntityUidstring · uuidOptional

The merchant company entity UID. Used to scope the ECNS draft upsell query and determine whether the parent order has been signed.

entityUidstring · uuidOptional

The entity UID of the signed parent order. Used to query draft POI upsell orders and look up the parent order signing status.

Responses

202

Async submission task dispatched successfully.

No content

400

Bad Request

application/json

401

Unauthorised Request

application/json

403

Forbidden 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/internal/trigger-draft-upsells

POST /orders/internal/trigger-draft-upsells HTTP/1.1
Host: api.verifone.com
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "customerEntityUid": "123e4567-e89b-12d3-a456-426614174000",
  "merchantCompanyEntityUid": "123e4567-e89b-12d3-a456-426614174000",
  "entityUid": "123e4567-e89b-12d3-a456-426614174000"
}

No content

PreviousReseller Event Data NextAccounts

Last updated 23 days ago

Was this helpful?