Verifone POI 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 POI 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 93 schemas.
It is described by OpenAPI 3.2.0, at version 2.62.1-SNAPSHOT.
Requests are made against a single base URL, https://api.verifone.com.
The identity and technical contract details declared by the specification.
CutoverTime
string
The cutover time HH:MM. Usually this will be a local time where a timezone has to be used to be used to derive the UTC time. EG: processor.cutoverTimeZone
DetailedStatusEnum
string
An order will be in one of the following states.
PaymentDetails
object
Details of how the order will be paid, and the further re-occuring billing for services.
1 property
1 required
CustomerOrderLink
object
Customer Order Link Sent Details
8 properties
BaseProcessorParameters
object
Payment Processor Parameters related to Merchant onboarding.
2 properties
1 required
CurrencyCodeEnum
string
Three-letter ISO 4217 alphabetical currency code. e.g. USD. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO4217). Deprecated: BYR (replaced by B…
PoiOrder
object
2 required
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…
MerchantContract
object
Used if merchant contract is to be processed
10 properties
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…
OrderStats
object
Order Statistics
2 properties
LastChangeTime
string
Time status detailed status last changed.
ReplacementAgreement
object
Replacement agreement details for devices covered under this contract.
2 properties
1 required
MerchantName
string
The primary merchant name, e.g. "McDonalds".
AltVfiPoiId
string
An alternative Verifone assigned identifier used for the POI within Verifone systems for transaction processing. This is also referred to as the Terminal ID (T…
ExtendedDetails
object
Detailed Status of the Order
5 properties
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…
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
PhoneTypeEnum
string
Phone type in PHONETYPECON. Mapped to PARTYPHONE.PHONETYPECONID or VENUEPHONE.PHONETYPECONID
httpError500
object
Unexpected Server Error
4 required
VmssSchemeStatus
string
Scheme Status
ExternalOnboarding
object
External merchant onboarding details
3 properties
InternalAllocatedInformation
object
Internally allocated identifiers. This is for verifone use only and is subject to change.
15 properties
NotificationReminder
object
Notification Reminder Sent Details
4 properties
OrderId
string
Verifone allocated ID for the Order.
ServicePackages
object
5 properties
1 required
httpError503
object
Service Unavailable Error
4 required
PoiLaneInformation
object
Lane in which the POI is to be configured.
3 properties
ContractContactType
object
9 properties
2 required
httpError403
object
The request must be authorised to access the resource.
4 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…
SignersInformation
object
Information on the signers in the request.
5 properties
1 required
SepaAccount
A SEPA Account structure extending the base account
httpError404
object
The server cannot find the requested resource.
4 required
httpError504
object
Gateway Timeout Error
4 required
MerchantDocument
object
Merchant Document Info.
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
AddressWithoutType
object
An Address following the convention of http://microformats.org/wiki/hcard
4 required
DomesticAccount
A Domestic Bank Account structure extending the base account.
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.
BundleAndPriceAndData
object
3 properties
1 required
ContactType
object
The details of a Contact.
5 properties
2 required
BaseOrderData
object
7 properties
2 required
OrderReference
string
Client reference for the Order.
PoiTypeEnum
string
The Point of Interaction Type. An indicator to indicate the type of Point of Interaction. NOTE: The value MULTIMERCHANTCHILD aligns to MULTMERCHANT in common/E…
httpError400
object
The request could not be understood by the server due to malformed syntax.
4 required
Account
object
Unambiguous identification of an account to which credit and debit entries are made. These entries are based on the Open Banking standards used in various coun…
4 properties
CreatedUserId
string
The assigned User ID corresponding to the Order Created By.
DocumentStatusEnum
string
Current status of the document. Rejected documents must be re-uploaded.
ReplacedDevice
object
A device being replaced under a replacement agreement.
2 properties
2 required
PackageBundleId
string
The Verifone allocated ID for the package bundle.
VariableResponseType
object
Variable/Value Pairs.
2 properties
PoiOrderResponse
3 required
OrderCancellation
object
5 properties
1 required
BICIdentifier
string
International Bank Identifier Code Format. The Bank Identifier Code or SWIFT Code ,this can also be referred to as the CHIPS, NCC, VSC or IFSC depending on you…
VmssApplication
object
5 properties
MerchantCompanyEntityUid
string
The Verifone allocated unique ID for this merchant company.
BundleAndPrice
object
2 properties
1 required
RequestedDateOfShipment
string
Requested date of shipment.
PackageDetails
object
Select the base package, hardware and additional services for this order.
4 properties
1 required
httpError401
object
The request must be authenticated to access the resource.
4 required
RequiredDocument
object
Merchant Required Document Details
7 properties
4 required
IBANIdentifier
string
International Bank Account Number (ISO 13616-1:2007). The use of an IBAN is mandated for all SEPA transactions. There are 66 countries that support this format…
PoiUid
string
The Verifone allocated unique id for this terminal/POI. This is allocated by Verifone when an order is initially received.
BasePoiType
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…
19 properties
2 required
AdjustedPriceType
object
2 properties
NotificationReminders
object
A container for all supported notification reminders.
3 properties
SigningInformation
object
Information on the signing request.
4 properties
2 required
UserName
string
The username of the person who's UID is represented, e.g. "John/Jane Smith".
PaymentTypeEnum
string
A type indicator for the payment that is being processed. Value GIFT is deprecated.
VmssSchemeMatches
number
Number of matches found against the VMSS service.
CancelReasonEnum
string
Reason for order cancellation.
ContentTypeEnum
string
Supported content type for documents.
BaseAddressWithoutType
object
An Address following the convention of http://microformats.org/wiki/hcard
5 properties
httpError429
object
The resource exists the number of requests has exceeded the specified quota.
4 required
MerchantNameWrapper
object
Simple Wrapper object for Merchant Name.Used by UI.
1 property
BaseAddress
object
An Address following the convention of http://microformats.org/wiki/hcard
10 properties
EntityUid
string
The Verifone allocated unique id for this site.
IpAddressv4v6
string
A valid IPV4 or V6 address.
ContactTypeEnum
string
An indicator for the type of contact. |Value|Description| |----|-----------| |BUSINESS|Generic business contact information, e.g. info@example.com| |DISPUTEHAN…
ContactAddressType
object
A Contact and their address details.
11 properties
2 required
Phone
object
A simple Phone Number
5 properties
2 required
DomesticSettlementAccount
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
PoiNetworkConfig
object
Network settings of the POI
9 properties
CancelAdditionalReason
string
Free-Form reason for order cancellation.
SerialNumber
string
The serial number of the physical device
Notification
object
Object containing the sent date-time and template used for the notification.
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Verifone publishes across the network.
