Verifone POI Orders API
The POI Orders API from Verifone — 1 operation(s) for poi orders.
The POI Orders API from Verifone — 1 operation(s) for poi orders.
openapi: 3.0.1
info:
title: 3D Secure 3DS Authentication POI Orders API
version: 3.43.0
description: Operations for listing and retrieving 3DS authentication records. Use these endpoints to query historical authentication results filtered by amount, currency, card, status, and more.
servers:
- url: https://emea.gsc.verifone.cloud/oidc/3ds-service
description: EMEA Production
- url: https://us.gsc.verifone.cloud/oidc/3ds-service
description: Americas Production
- url: https://nz.gsc.verifone.cloud/oidc/3ds-service
description: New Zealand Production
- url: https://cst.test-gsc.vfims.com/oidc/3ds-service
description: Global Sandbox
- url: https://uscst-gb.gsc.vficloud.net/oidc/3ds-service
description: Americas Sandbox
security:
- BearerAuth: []
- BasicAuth: []
tags:
- name: POI Orders
paths:
/orders/pois:
post:
tags:
- POI Orders
summary: Create POI Order
description: Adds new Point Of Interactions (terminals) to an existing merchant/store and optionally order hardware and services.
operationId: addPoiOrder
parameters:
- $ref: '#/components/parameters/saveDraftHeaderParam'
- $ref: '#/components/parameters/validateAcquirerHeaderParam'
- $ref: '#/components/parameters/SimplifiedFlowHeaderParam'
requestBody:
description: Terminals to add
content:
application/json:
schema:
$ref: '#/components/schemas/PoiOrder'
responses:
'200':
description: Create POI Order Response.
content:
application/json:
schema:
$ref: '#/components/schemas/PoiOrderResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
components:
schemas:
DomesticAccount:
title: Domestic Bank Account
description: A Domestic Bank Account structure extending the base account.
allOf:
- $ref: '#/components/schemas/Account'
- properties:
accountName:
description: Name of the account as known by the financial institution operating the account.
type: string
sortCode:
description: The UK Sorting Code identifier the sort code is xx xx xx.
type: string
pattern: ^[0-9]{6,6}$
bsb:
description: An Australian/New Zealand term for the Bank State Branch indicator. It is a 6 digit value constructed with the first 2 digits identifying the bank.
type: string
pattern: ^[0-9]{6,6}$
routingTransitNumber:
type: string
description: Routing transit number for the bank account. A routing transit number is a nine-digit number used to identify a bank or financial institution when clearing funds or processing checks. Established by the American Bankers Association (ABA).
pattern: ^[0-9]{9,9}$
accountNumberType:
description: "The type of the `accountNumber` which asserts the format of the number:\n - `BANKGIRIT`: Up to 9 characters (example: 123-4567 or 1234-5678)\n - `PLUSGIROT`: Up to 24 characters; starts with \"SE50\"\n - `DEFAULT`: Format-less value"
type: string
enum:
- BANKGIROT
- PLUSGIROT
- DEFAULT
default: DEFAULT
accountNumber:
description: The number of the account.
type: string
AmountSimple:
title: Amount Simple Type
type: string
description: '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 currencies that are subdivided into thousandths, such as `TND`.
*The required number of decimal places for a currency code is according to [ISO 4217](https://wikipedia.org/wiki/ISO_4217). However the following table documents exception to ISO 4217 that is also allowed:*
|Code|Currency|Decimals|Fixed minor units|
|--------|-----------|---------|-----------|
|ISK|Iceland Krona|2|.00|
'
maxLength: 32
pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$
SigningInformation:
description: Information on the signing request.
type: object
properties:
provider:
type: string
description: Signing Provider used
enum:
- SIGNICAT
- ADOBE
- DOKOBIT
providerRef:
type: string
description: Signing Provider reference to the signing request
signedFileUrl:
type: string
description: URL to the signed file
signingRequests:
type: array
items:
$ref: '#/components/schemas/SignersInformation'
required:
- provider
- providerRef
EmailAddress:
title: Email Address
maxLength: 254
minLength: 3
type: string
format: email
pattern: ^[a-zA-Z0-9!#$%&'*+=?^_`{|}~.-]+@[a-zA-Z0-9-]+[.].+$
description: 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 even though up to 64 characters are allowed before and 255 characters are allowed after the @ sign. This pattern verifies only that the string contains an unquoted @ sign. See https://tools.ietf.org/html/rfc5322#section-3.4.1.
httpError500:
title: HTTP 500 Error
type: object
description: Unexpected Server Error
allOf:
- $ref: '#/components/schemas/ErrorResp'
- properties:
code:
type: string
enum:
- '500'
default: '500'
title:
type: string
enum:
- Internal Server Error
default: Internal Server Error
message:
type: string
default: The server encountered an unexpected condition which prevented it from fulfilling the request.
timestamp:
description: "The time that the error occurred. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone."
type: string
format: date-time
type:
type: string
enum:
- API_ERROR
default: API_ERROR
param:
description: The parameter the error relates to if the error is parameter-specific. You can use this to display a message near the correct form field, for example.
type: string
required:
- code
- title
- message
- type
additionalProperties: false
ContactTypeEnum:
title: Contact Type
description: 'An indicator for the type of contact.
|Value|Description|
|----|-----------|
|BUSINESS|Generic business contact information, e.g. info@example.com|
|DISPUTE_HANDLING|Generic contact information specific to dispute handling, e.g. disputes@example.com|
|OWNER|Individual contact information of the owner of the Entity, e.g. ben.jerry@example.com|
|PERSONAL|Personal contact information of the person representing the Entity, e.g. bjerr83@example-personal-email-domain.com|'
type: string
enum:
- BUSINESS
- DISPUTE_HANDLING
- OWNER
- PERSONAL
default: BUSINESS
OrderId:
description: Verifone allocated ID for the Order.
type: string
format: uuid
ExternalOnboarding:
description: External merchant onboarding details
type: object
discriminator:
propertyName: provider
mapping:
BANKAXEPT: '#/components/schemas/BankAxeptExternalOnboarding'
properties:
provider:
title: External Onboarding Provider
description: The third-party provider used for merchant onboarding.
type: string
enum:
- BANKAXEPT
default: BANKAXEPT
agreementId:
type: string
format: uuid
description: 'Agreement or onboarding order identifier returned by the third-party provider when onboarding is initiated.
'
agreementStatus:
type: string
description: 'Latest onboarding or agreement status received from the third-party provider.
'
PackageBundleId:
description: The Verifone allocated ID for the package bundle.
type: string
pattern: ^[A-Za-z0-9_-]*$
maxLength: 100
PoiLaneInformation:
description: Lane in which the POI is to be configured.
type: object
properties:
customerLaneId:
type: string
minLength: 1
maxLength: 255
customerLaneDesignator:
type: string
minLength: 1
maxLength: 255
laneNotes:
type: string
maxLength: 200
Phone:
title: Phone number
description: A simple Phone Number
type: object
additionalProperties: false
properties:
callingCode:
description: Country Calling Code. Mapped to PARTY_PHONE.CALLING_CODE or VENUE_PHONE.CALLING_CODE
type: string
value:
description: The actual phone number less country code and/or extension.
type: string
minLength: 5
extension:
description: The internal extension number where applicable or known.
type: string
isPrimary:
description: Indicates that the phone is a the primary phone. Mapped to PARTY_PHONE_PRIMARY
type: boolean
default: false
phoneType:
$ref: '#/components/schemas/PhoneTypeEnum'
required:
- value
- phoneType
httpError504:
title: HTTP 504 Error
type: object
description: Gateway Timeout Error
allOf:
- $ref: '#/components/schemas/ErrorResp'
- properties:
code:
type: string
enum:
- '504'
default: '504'
title:
type: string
enum:
- Gateway Timeout
default: Gateway Timeout
message:
type: string
default: The server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.
timestamp:
description: "The time that the error occurred. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone."
type: string
format: date-time
type:
type: string
enum:
- API_ERROR
default: API_ERROR
param:
description: The parameter the error relates to if the error is parameter-specific. You can use this to display a message near the correct form field, for example.
type: string
required:
- code
- title
- message
- type
additionalProperties: false
MerchantContract:
type: object
properties:
brokerId:
type: string
maxLength: 100
description: ID of the broker, if one is being used
legalStructure:
type: string
description: Legal Structure
enum:
- PROPRIETOR_OWN_BEHALF
- PROPRIETOR_NOT_OWN_BEHALF
- SHARED_LESS_25_PERC_EACH
contacts:
type: array
maxItems: 50
items:
$ref: '#/components/schemas/ContactAddressType'
settlementAccount:
$ref: '#/components/schemas/SettlementAccount'
domesticSettlementAccount:
$ref: '#/components/schemas/DomesticSettlementAccount'
serviceStartDate:
type: string
description: The requested date for this service to start.
format: date-time
terminalRentalStartDate:
type: string
format: date-time
description: 'The date until which terminal rental is exempt for this contract (also labelled "Rent Exemption Until" / DE: "Mietfreiheit bis zum"). If not set, consumers should fall back to serviceStartDate.
'
proprietorAct:
type: boolean
description: Is proprietor is acting on its own behalf (true) or is not acting on own behalf (false)
documents:
type: array
items:
$ref: '#/components/schemas/MerchantDocument'
replacementAgreement:
$ref: '#/components/schemas/ReplacementAgreement'
description: Used if merchant contract is to be processed
IBANIdentifier:
title: IBAN
description: "International Bank Account Number (ISO 13616-1:2007).\n The use of an IBAN is mandated for all SEPA transactions.\nThere are 66 countries that support this format. The length will vary by country. Norway has the shortest format, 15 characters, currently Malta is the longest with 31 characters.\n"
type: string
pattern: ^[a-zA-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$
Notification:
description: Object containing the sent date-time and template used for the notification.
type: object
properties:
sentDateTime:
description: Date and Time when the notification was sent.
type: string
format: date-time
template:
description: Template name used for the notification.
type: string
responseReferenceId:
description: An ID from Messaging Service's response.
type: string
AltVfiPoiId:
description: 'An alternative Verifone assigned identifier used for the POI within Verifone systems for transaction processing. This
is also referred to as the Terminal ID (TID). This value maps to DE41 in ISO8583 specification. This identifier may
also be used per contract if required.
<strong>This value is not guaranteed to be globally unique. The unique value is the internally assigned uuid - poiUid
which is returned on the response.</strong>'
type: string
maxLength: 12
LastChangeTime:
description: Time status detailed status last changed.
type: string
format: date-time
OrderReference:
description: Client reference for the Order.
type: string
minLength: 1
BaseProcessorParameters:
description: Payment Processor Parameters related to Merchant onboarding.
type: object
properties:
processor:
title: Payment Provider ContractType Processor Acquirer Type
description: A type indicator for the contract that is being processed.
type: string
enum:
- ABS_ISO
- ABS_PDM
- ABS_WEB
- AMEX
- BANKAXEPT
- BANQUE_CHABRIERES
- BARCLAYS
- BFCOI
- BNPP_ATC
- BNP_PARIBAS
- BNPP_VERS_ATOS
- BRED
- CAISSE_D_EPARGNE
- CBA
- CEDICAM
- CIC
- CM_ARKEA
- CREDIT_AGRICOLE
- CREDIT_DU_NORD_VERS_ATOS
- CREDIT_DU_NORD_VERS_NATIXIS
- CREDIT_MUTUEL
- CREDITGUARD
- DANKORT
- EFTPOS_NZ
- ELAVON
- FDRC
- FIRSTDATA
- GICC
- GIVEX
- GLOBALPAY
- GPP2
- HSBC
- IKANO
- INTERCARD
- ISRACARD
- LA_BANQUE_POSTAL
- LCL
- LES_BANQUES_POPULAIRES
- LLOYDS_CARDNET
- MAESTRO
- MOBILEPAY
- NETS
- OTHER
- PAYPAL
- PAYPAL_ECOM
- PELECARD
- RESURS_BANK
- RTS
- SG
- SIMULATOR
- SWEDBANK_PAY
- SWISH
- TIETO_EVRY
- VERIFONE_AU
- VIPPS
- WESTPAC
- WORLDPAY
- WPAY_AU
- FISERV_AU
- CUSCAL_AU
- CHASE_US
- ELAVON_US
- FISERV_US
- TSYS_US
- GLOBALPAYMENTS_US
- VANTIV_US
- HEARTLAND_US
- TELECHECK_US
- SC_AMEX
- SC_EVRY
- SC_LUOTTOKUNTA
- SC_NETS_DK
- SC_NETS_NO
- SC_SWEDBANK_SE
- SVS_US
- SVS_UK
- VALUELINK_US
- VALUELINK_CA
- VALUTEC_US
- UNIFY_GIVEX
default: TSYS_US
tidList:
description: A pool of terminal IDs issued by the Acquiring Institution. This pool is intended to be used for the POIs that's capable of initiating multiple payment requests in parallel (e.g. Checkout Page and Virtual Terminal)
type: array
uniqueItems: true
items:
type: string
discriminator:
propertyName: processor
mapping:
GIVEX: '#/components/schemas/ProcessorParametersGivex'
GLOBALPAYMENTS_US: '#/components/schemas/ProcessorParametersUSGPEAST'
TSYS_US: '#/components/schemas/ProcessorParametersUSTSYS'
CHASE_US: '#/components/schemas/ProcessorParametersUSCHASE'
ELAVON_US: '#/components/schemas/ProcessorParametersUSELAVON'
FISERV_US: '#/components/schemas/ProcessorParametersUSFIRSTDATA'
VANTIV_US: '#/components/schemas/ProcessorParametersUSVANTIV'
HEARTLAND_US: '#/components/schemas/ProcessorParametersUSHeartland'
TELECHECK_US: '#/components/schemas/ProcessorParametersUSTelecheck'
FISERV_AU: '#/components/schemas/ProcessorParametersFiservAU'
CUSCAL_AU: '#/components/schemas/ProcessorParametersCuscalAU'
WPAY_AU: '#/components/schemas/ProcessorParametersWpayAU'
SVS_UK: '#/components/schemas/ProcessorParametersSVS'
SVS_US: '#/components/schemas/ProcessorParametersSVS'
VALUELINK_US: '#/components/schemas/ProcessorParametersValuelink'
VALUELINK_CA: '#/components/schemas/ProcessorParametersValuelink'
VALUTEC_US: '#/components/schemas/ProcessorParametersValutecUS'
VERIFONE_AU: '#/components/schemas/ProcessorParametersVerifoneAU'
SC_AMEX: '#/components/schemas/ProcessorParametersSC'
SC_EVRY: '#/components/schemas/ProcessorParametersSC'
SC_LUOTTOKUNTA: '#/components/schemas/ProcessorParametersSC'
SC_NETS_DK: '#/components/schemas/ProcessorParametersSC'
SC_NETS_NO: '#/components/schemas/ProcessorParametersSC'
SC_SWEDBANK_SE: '#/components/schemas/ProcessorParametersSC'
OTHER: '#/components/schemas/ProcessorParametersOTHER'
UNIFY_GIVEX: '#/components/schemas/ProcessorParametersUnifyGivex'
required:
- processor
httpError429:
title: HTTP 429 Error
type: object
description: The resource exists the number of requests has exceeded the specified quota.
allOf:
- $ref: '#/components/schemas/ErrorResp'
- properties:
code:
type: string
enum:
- '429'
default: '429'
title:
type: string
enum:
- Too Many Requests
default: Too Many Requests
message:
type: string
default: The number of requests from this client is restricted to a specified quota.
timestamp:
description: "The time that the error occurred. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone."
type: string
format: date-time
type:
type: string
enum:
- RATE_LIMIT_ERROR
default: RATE_LIMIT_ERROR
param:
description: The parameter the error relates to if the error is parameter-specific. You can use this to display a message near the correct form field, for example.
type: string
required:
- code
- title
- message
- type
additionalProperties: false
NotificationReminders:
description: A container for all supported notification reminders.
type: object
properties:
econtract:
$ref: '#/components/schemas/NotificationReminder'
draft:
$ref: '#/components/schemas/NotificationReminder'
docRequired:
$ref: '#/components/schemas/NotificationReminder'
additionalProperties: false
VmssSchemeStatus:
description: Scheme Status
type: string
enum:
- 'NA '
- PENDING
- ERROR
- COMPLETE
ContactName:
allOf:
- $ref: '#/components/schemas/Name'
BusinessTitle:
type: string
maxLength: 100
CancelReasonEnum:
description: Reason for order cancellation.
type: string
enum:
- ADMIN_REASON
- RELATED_PO_CHANGES
- WRONG_PRODUCT
- ORDER_LATE
- OTHER
OrderStatusEnum:
type: string
enum:
- DRAFT
- SUBMITTED
- INPROGRESS
- COMPLETED
- CANCELLED
- ONHOLD
ReplacementAgreement:
title: ReplacementAgreement
type: object
description: Replacement agreement details for devices covered under this contract.
required:
- devices
properties:
contractNumber:
type: string
maxLength: 255
description: Contract number for the replacement agreement.
devices:
type: array
description: List of devices being replaced.
minItems: 1
maxItems: 100
items:
$ref: '#/components/schemas/ReplacedDevice'
CreatedUserId:
description: The assigned User ID corresponding to the Order Created By.
type: string
format: uuid
NotificationReminder:
description: Notification Reminder Sent Details
type: object
properties:
lastNotificationSentDateTime:
description: Date and Time of the last notification sent. Defaulted to `createdDateTime` on first saved order.
type: string
format: date-time
notificationCount:
description: Number of notifications sent. -1 = Unsubscribed, or 1, 2, 3 as per the notification sent.
type: integer
templateName:
description: NotificationTemplate Name used, e.g. `T650P_WELCOME`
type: string
notifications:
description: List of notifications, each with the date-time sent and the template used.
type: array
items:
$ref: '#/components/schemas/Notification'
MerchantDocument:
type: object
description: Merchant Document Info.
allOf:
- $ref: '#/components/schemas/RequiredDocument'
- properties:
uploadedDate:
type: string
description: The uploaded date for this document.
format: date-time
modifiedDate:
type: string
description: The modified date for this document on status change.
format: date-time
ReplacedDevice:
title: ReplacedDevice
type: object
description: A device being replaced under a replacement agreement.
required:
- serialNumber
- deviceModel
properties:
serialNumber:
type: string
minLength: 1
maxLength: 12
description: Serial number of the replaced device.
deviceModel:
type: string
minLength: 1
maxLength: 100
description: Model name of the replaced device.
PoiOrderResponse:
allOf:
- $ref: '#/components/schemas/PoiOrder'
- properties:
orderId:
$ref: '#/components/schemas/OrderId'
status:
$ref: '#/components/schemas/OrderStatusEnum'
createdUserUid:
$ref: '#/components/schemas/CreatedUserId'
createdBy:
$ref: '#/components/schemas/UserName'
createdDate:
type: string
description: The created date for this order.
format: date-time
modifiedUserUid:
description: The assigned User_ID corresponding to the Order Modified By.
type: string
format: uuid
modifiedBy:
$ref: '#/components/schemas/UserName'
modifiedDate:
type: string
description: The last modified date for this order.
format: date-time
orderType:
type: string
default: POIOrder
entityUid:
$ref: '#/components/schemas/EntityUid'
merchantCompanyEntityUid:
$ref: '#/components/schemas/MerchantCompanyEntityUid'
merchant:
$ref: '#/components/schemas/MerchantNameWrapper'
internal:
$ref: '#/components/schemas/InternalAllocatedInformation'
required:
- orderId
- status
- orderType
ContactType:
description: The details of a Contact.
type: object
properties:
contactType:
$ref: '#/components/schemas/ContactTypeEnum'
name:
$ref: '#/components/schemas/ContactName'
phoneNumbers:
description: The phone numbers to be used for the Contact. If you include this property there should be at least one phone number.
items:
$ref: '#/components/schemas/Phone'
minItems: 1
uniqueItems: true
type: array
email:
$ref: '#/components/schemas/EmailAddress'
businessTitle:
$ref: '#/components/schemas/BusinessTitle'
required:
- contactType
- name
BaseAddress:
description: An Address following the convention of http://microformats.org/wiki/hcard
type: object
properties:
receiverName:
type: string
minLength: 1
description: The receiver name for the address if different to the company/site name.
addressLine1:
minLength: 1
maxLength: 40
type: string
description: Address Line 1. Should include street and apartment number if required.
addressLine2:
maxLength: 40
type: string
description: Address Line 2
addressLine3:
maxLength: 40
type: string
description: Address Line 3
poBox:
type: string
description: The PO BOX number.
city:
minLength: 1
maxLength: 28
type: string
description: Name of a built-up area, with defined boundaries, and a local government. This could be city or town.
countrySubdivision:
maxLength: 35
minLength: 1
type: string
description: Identifies a sub-division of a country which may be state, region or county. This follows a similar format to the openbank api.
postCode:
$ref: '#/components/schemas/PostCode'
country:
$ref: '#/components/schemas/CountryCode3Enum'
timeZone:
$ref: '#/components/schemas/TimeZone'
AdjustedPriceType:
type: object
properties:
priceModel:
type: string
description: Pricing Model
enum:
- MONTHLY_FEE
- MONTHLY_FEE_PER_DEVICE
- MINIMUM_AMT_PER_TRX
- AMT_PER_TRX
- PERC_PER_TRX
- ONE_TIME
- YEARLY_FEE
- QUARTERLY_FEE
price:
$ref: '#/components/schemas/AmountSimple'
MerchantNameWrapper:
description: Simple Wrapper object for Merchant Name.Used by UI.
type: object
properties:
merchantName:
$ref: '#/components/schemas/MerchantName'
IpAddressv4v6:
description: A valid IPV4 or V6 address.
type: string
anyOf:
- format: ipv4
description: 'Example : 232.100.1.1'
- format: ipv6
description: 'Example : 2405:204:638b:9daa:f3c8:a903:3227:c712'
AddressWithoutType:
description: An Address following the convention of http://microformats.org/wiki/hcard
type: object
required:
- addressLine1
- city
- postCode
- country
allOf:
- $ref: '#/components/schemas/BaseAddressWithoutType'
PaymentTypeEnum:
title: Payment Type
description: A type indicator for the payment that is being processed. Value `GIFT` is deprecated.
type: string
enum:
- AFFIRM
- AFTERPAY
- ALIPAY
- AMEX
- BAIDU_PAY
- BANK
- BANKAXEPT
- BARTERCARD
- BBBY_COB
- BBBY_PLCC
- BLIK
- BP_FUELCARD
- CALLIO_GASTRO
- CARD
- CARDLINK
- CARNET
- CASH
- CB
- CHEQUE
- CLAVE
- CRYPTO
- DANKORT
- DEBIT
- DINERS
- DISCOVER
- EASYCD
- EBT
- EBT_WIC_OFFLINE
- ECARD
- ECARDZ
- EDENRED
- ELECTRON
- EZIPAY
- FARMERS_FINANCE
- FARMLAND
- FARMLANDS
- FINNISH_DIRECT_BANKING
- FLEETCOR
- FLEETONE
- FLEXECASH
- FORBRUGSFORENINGEN
- FPF_GIFT
- GARMIN_PAY
- GIFT
- GIFT_CARD
- GIROCARD
- IKANO
- ISRACARD
- ISRAEL_PRIVATE_LABEL
- JCB
- JD_PAY
- KLARNA
- KLARNA_ECOM
- KLARAN_QR
- KLARNA_QR
- LANDSBANKINN
- MASTERCARD
- MAESTRO
- MOBILEPAY
- MOBILEPAY_ECOM
- OP_ONLINE_PAYMENT
- PAYPAL
- PAYPAL_ECOM
- PAYPAL_ECOM_MANAGED
- PAYPAL_QR
- PIX
- PLCC
- Q_CARD
- RESURS_BANK
- RURALCO
- SAMSUNG_PAY
- SODEXO_GASTRO
- SUPERCARD
- SWISH
- SWISH_ECOM
- TEN_PAY
- TRANXACTOR
- TRUE_REWARDS
- TT_CARD
- UP_SLOVENSKA
- UPI
- VENMO
- VENMO_ECOM
- VENMO_QR
- VIPPS
- VIPPS_ECOM
- VISA
- VOYAGER
- VPAY
- WECHAT
- WESTFIELD_GIFTCARD
- WESTPAC_DEBIT
- WEX
- ZELLE
- ZIP
- OTHER
CancelAdditionalReason:
description: Free-Form reason for order cancellation.
type: string
CutoverTime:
type: string
description: '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'
pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$
PoiNetworkConfig:
description: Network settings of the POI
type: object
properties:
ipAddress:
$ref: '#/components/schemas/IpAddressv4v6'
ipGateway:
$ref: '#/components/schemas/IpAddressv4v6'
subnetMask:
$ref: '#/components/schemas/IpAddressv4v6'
networkPrefix:
$ref: '#/components/schemas/IpAddressv4v6'
dns1:
$ref: '#/components/schemas/IpAddressv4v6'
dns2:
$ref: '#/components/schemas/IpAddressv4v6'
wifiSSID:
type: string
minLength: 2
maxLength: 32
wifiPassword:
type: string
wpaEncryptionMethod:
type: string
minLength: 2
maxLength: 10
PaymentDetails:
description: Details of how the order will be paid, and the further re-occuring billing for services.
type: object
properties:
paymentType:
type: string
description: Type of payment that can be made.
default: CREDIT
discriminator:
propertyName: paymentType
mapping:
ACCOUNT: '#/components/schemas/PaymentDetailsAccount'
CREDIT: '#/components/schemas/PaymentDetailsCredit'
NET: '#/components/schemas/PaymentDetailsNET'
EINVOICE: '#/components/schemas/PaymentDetailsEInvoice'
required:
- paymentType
MerchantCompanyEntityUid:
description
# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/openapi/verifone-poi-orders-api-openapi.yml