Verifone Hardware Orders API is one of 27 APIs that Verifone publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Hardware Orders. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
1 operation
across 1 path,
and defines 73 schemas.
It is described by OpenAPI 3.0.1, at version 3.43.0.
Requests are made against 5 base URLs: https://emea.gsc.verifone.cloud/oidc/3ds-service, https://us.gsc.verifone.cloud/oidc/3ds-service, https://nz.gsc.verifone.cloud/oidc/3ds-service, https://cst.test-gsc.vfims.com/oidc/3ds-service, https://uscst-gb.gsc.vficloud.net/oidc/3ds-service.
The identity and technical contract details declared by the specification.
AmountSimple
string
The value, which can be anything from: - An integer. For currencies that are not typically fractional, such as JPY. - A three-place decimal fraction. For curre…
SigningInformation
object
Information on the signing request.
4 properties
2 required
EmailAddress
string
A valid internationalized email address, as defined by RFC 5322, RFC 6530, and other RFCs. Due to RFC 5321, an email address can be up to 254 characters long e…
httpError500
object
Unexpected Server Error
4 required
HardwareOrderResponse
4 required
ContactTypeEnum
string
An indicator for the type of contact. |Value|Description| |----|-----------| |BUSINESS|Generic business contact information, e.g. info@example.com| |DISPUTEHAN…
OrderId
string
Verifone allocated ID for the Order.
ExternalOnboarding
object
External merchant onboarding details
3 properties
PackageBundleId
string
The Verifone allocated ID for the package bundle.
Phone
object
A simple Phone Number
5 properties
2 required
httpError504
object
Gateway Timeout Error
4 required
Notification
object
Object containing the sent date-time and template used for the notification.
3 properties
LastChangeTime
string
Time status detailed status last changed.
BaseProcessorParameters
object
Payment Processor Parameters related to Merchant onboarding.
2 properties
1 required
OrderReference
string
Client reference for the Order.
HardwarePoiType
object
The Point of Interaction. This may refer to a number of different entities, but is primarily considered to be the Terminal. This object contains the POI detail…
2 properties
httpError429
object
The resource exists the number of requests has exceeded the specified quota.
4 required
NotificationReminders
object
A container for all supported notification reminders.
3 properties
VmssSchemeStatus
string
Scheme Status
SiteReferenceId
string
An optional identifier for the Site which can be provided if different to the merchantId.
CancelReasonEnum
string
Reason for order cancellation.
CreatedUserId
string
The assigned User ID corresponding to the Order Created By.
NotificationReminder
object
Notification Reminder Sent Details
4 properties
ContactType
object
The details of a Contact.
5 properties
2 required
HardwareOrderData
object
7 properties
2 required
BaseAddress
object
An Address following the convention of http://microformats.org/wiki/hcard
10 properties
SiteName
string
The site name, if different to the merchant name.
AdjustedPriceType
object
2 properties
CancelAdditionalReason
string
Free-Form reason for order cancellation.
PaymentTypeEnum
string
A type indicator for the payment that is being processed. Value GIFT is deprecated.
AddressWithoutType
object
An Address following the convention of http://microformats.org/wiki/hcard
4 required
PaymentDetails
object
Details of how the order will be paid, and the further re-occuring billing for services.
1 property
1 required
HardwareMerchant
object
details of the merchant
12 properties
1 required
httpError503
object
Service Unavailable Error
4 required
BundleAndPrice
object
2 properties
1 required
TimeZone
string
A time zone, following the format defined in the IANA tz database (https://www.iana.org/time-zones). Valid examples are America/NewYork and Etc/UTC. Do not use…
BundleAndPriceAndData
object
3 properties
1 required
OrderStats
object
Order Statistics
2 properties
DayOfWeekEnum
string
An enumeration specifying the days of the week.
Name
object
An object representing the name or component names of a party, person or business. No elements are mandatory due to the different usages, but the business rule…
6 properties
2 required
CustomerOrderLink
object
Customer Order Link Sent Details
8 properties
SerialNumber
string
The serial number of the physical device
ServicePackages
object
5 properties
1 required
OrderCancellation
object
5 properties
1 required
CountryCode3Enum
string
The [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO3166-1alpha-3) country code. Note: The country code for Great Britain is GB and not UK as is used in…
ExtendedDetails
object
Detailed Status of the Order
5 properties
BundleAndSerialNumberAndQuantity
object
4 properties
1 required
httpError400
object
The request could not be understood by the server due to malformed syntax.
4 required
ErrorResp
object
A common Error object returned as part of the API layer. . This is modified to become the base class for all of the derived HTTP Error Responses.
1 property
1 required
httpError404
object
The server cannot find the requested resource.
4 required
PackageDetails
object
Select the base package, hardware and additional services for this order.
4 properties
1 required
EntityOpeningPeriod
object
The opening and closing hours.
2 properties
2 required
PostCode
string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
UserName
string
The username of the person who's UID is represented, e.g. "John/Jane Smith".
InternalAllocatedInformation
object
Internally allocated identifiers. This is for verifone use only and is subject to change.
15 properties
BaseAddressWithoutType
object
An Address following the convention of http://microformats.org/wiki/hcard
5 properties
httpError401
object
The request must be authenticated to access the resource.
4 required
SignersInformation
object
Information on the signers in the request.
5 properties
1 required
VmssSchemeMatches
number
Number of matches found against the VMSS service.
RequestedDateOfShipment
string
Requested date of shipment.
EntityOpeningHours
object
An dictionary map of the different opening hours for an Entity
2 properties
2 required
MCC
string
The Merchant Category Code (MCC). A 4 digit Code classifying the type of business being done by the card acceptor or Merchant (in accordance with ISO 18245).
MerchantName
string
The primary merchant name, e.g. "McDonalds".
PhoneTypeEnum
string
Phone type in PHONETYPECON. Mapped to PARTYPHONE.PHONETYPECONID or VENUEPHONE.PHONETYPECONID
httpError403
object
The request must be authorised to access the resource.
4 required
DetailedStatusEnum
string
An order will be in one of the following states.
ThreeDSecureMerchantIdentifiers
object
Override the Merchant ID (merchantId) with the default value configured in the payment provider contract (PPC), where applicable. In cases where the acquirer-i…
2 properties
2 required
VariableResponseType
object
Variable/Value Pairs.
2 properties
VmssApplication
object
5 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Verifone publishes across the network.
