Pricing Templates
Log in Sign up
Integrations / Verifone Global Service Connector (GSC) - Order Service / ...

POST /orders/merchant/additionalServices

Creates an order for add-on services (e.g. APM integration).A new PPC is created if no contract id is specified.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"
saveDraft Boolean No

An optional header indicating whether to save the order into a DRAFT status. If this value is not specified or set to false then the order will be SUBMITTED immediately.

Request body fields

Name Type Required Description
paymentDetails Object No

Details of how the order will be paid, and the further re-occuring billing for services.
paymentDetails.paymentType String Yes

Type of payment that can be made.

Default value: "CREDIT"
contract Object No

Used if merchant contract is to be processed
contract.legalStructure String No

Legal Structure

Valid values:

  • "PROPRIETOR_OWN_BEHALF"
  • "SHARED_LESS_25_PERC_EACH"
  • "PROPRIETOR_NOT_OWN_BEHALF"
contract.contacts[] Array No
contract.contacts[].contact Object Yes

The details of a Contact.
contract.contacts[].contact.passportId String No

Passport Identity Identifier.
contract.contacts[].contact.phoneNumbers[] Array No

The phone numbers to be used for the Contact. If you include this property there should be at least one phone number.
contract.contacts[].contact.phoneNumbers[].isPrimary Boolean No

Indicates that the phone is a the primary phone. Mapped to PARTY_PHONE_PRIMARY

Default value: false
contract.contacts[].contact.phoneNumbers[].callingCode String No

Country Calling Code. Mapped to PARTY_PHONE.CALLING_CODE or VENUE_PHONE.CALLING_CODE
contract.contacts[].contact.phoneNumbers[].phoneType String Yes

Phone type in PHONE_TYPE_CON. Mapped to PARTY_PHONE.PHONE_TYPE_CON_ID or VENUE_PHONE.PHONE_TYPE_CON_ID

Valid values:

  • "OTHER"
  • "HOME"
  • "MOBILE"
  • "FAX"
  • "WORK"

Default value: "HOME"
contract.contacts[].contact.phoneNumbers[].extension String No

The internal extension number where applicable or known.
contract.contacts[].contact.phoneNumbers[].value String Yes

The actual phone number less country code and/or extension.
contract.contacts[].contact.email String No

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.
contract.contacts[].contact.businessTitle String No

Business Title.
contract.contacts[].contact.nationality String No

Nationality
contract.contacts[].contact.nationalIdentifer String No

Contact's national identity identifier.
contract.contacts[].contact.contactType String Yes

An indicator for the type of contact

Valid values:

  • "OWNER"
  • "PERSONAL"
  • "BUSINESS"

Default value: "BUSINESS"
contract.contacts[].representativeType String No

Type of representative when this contact is legal or authorized rep

Valid values:

  • "NOT_APPLICABLE"
  • "GENERAL_COMMERCIAL_POWER"
  • "LIMITED_COMMERCIAL_POWER"
contract.contacts[].placeOfBirth String No

Place of Birth
contract.contacts[].isPoliticallyExposed Boolean No

Is this contact a politically exposed person

Default value: false
contract.contacts[].addressDetails Object Yes

An Address following the convention of http://microformats.org/wiki/hcard
contract.contacts[].addressDetails.addressLine3 String No

Address Line 3
contract.contacts[].addressDetails.receiverName String No

The receiver name for the address if different to the company/site name.
contract.contacts[].addressDetails.countrySubdivision String No

Identifies a sub-division of a country which may be state, region or county. This follows a similar format to the openbank api.
contract.contacts[].addressDetails.postCode String No

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
contract.contacts[].addressDetails.poBox String No

The PO BOX number.
contract.contacts[].addressDetails.country String No

The ISO 3166-1 alpha-3 country code.

Note: The country code for Great Britain is GB and not UK as is used in that country's top-level domain names.
.

Valid values:

  • "KAZ"
  • "LBY"
  • "BEL"
  • "GUM"
  • "BHR"
  • "BLZ"
  • "PAK"
  • "JAM"
  • "NFK"
  • "CYP"
  • "COL"
  • "SYR"
  • "MYT"
  • "HKG"
  • "BDI"
  • "FSM"
  • "CHN"
  • "HTI"
  • "TCD"
  • "RWA"
  • "DEU"
  • "LVA"
  • "TZA"
  • "ARG"
  • "GEO"
  • "HRV"
  • "GNQ"
  • "COK"
  • "CUW"
  • "SYC"
  • "GTM"
  • "USA"
  • "SGP"
  • "UKR"
  • "NRU"
  • "MAF"
  • "ABW"
  • "MNP"
  • "SAU"
  • "NIC"
  • "PNG"
  • "SVN"
  • "CHL"
  • "PAN"
  • "AZE"
  • "VUT"
  • "GNB"
  • "CAN"
  • "BRB"
  • "ARE"
  • "CYM"
  • "PHL"
  • "WSM"
  • "ERI"
  • "TON"
  • "BOL"
  • "JPN"
  • "TWN"
  • "HUN"
  • "KGZ"
  • "AGO"
  • "JEY"
  • "NIU"
  • "ROU"
  • "BRA"
  • "SEN"
  • "TGO"
  • "THA"
  • "DMA"
  • "GLP"
  • "LSO"
  • "NGA"
  • "UZB"
  • "FRO"
  • "GRL"
  • "GMB"
  • "YEM"
  • "ATG"
  • "BSB"
  • "LBN"
  • "NOR"
  • "SGC"
  • "POL"
  • "UMI"
  • "AIA"
  • "KHM"
  • "COG"
  • "FIN"
  • "SDN"
  • "CUB"
  • "ATF"
  • "PLW"
  • "MMR"
  • "RUS"
  • "ESH"
  • "LCA"
  • "VCT"
  • "IMN"
  • "DJI"
  • "LKA"
  • "CMR"
  • "BMU"
  • "PSE"
  • "MCO"
  • "GGY"
  • "NCL"
  • "FRA"
  • "TUN"
  • "PRT"
  • "BRN"
  • "MDA"
  • "MTQ"
  • "MUS"
  • "BLR"
  • "MNE"
  • "SWE"
  • "HND"
  • "REU"
  • "LAO"
  • "SMR"
  • "IDN"
  • "OMN"
  • "COD"
  • "KIR"
  • "SUR"
  • "STP"
  • "ETH"
  • "LTU"
  • "IOT"
  • "GIN"
  • "VIR"
  • "ISL"
  • "CPV"
  • "TKL"
  • "BES"
  • "LBR"
  • "NER"
  • "SJM"
  • "GUF"
  • "ZAF"
  • "UGA"
  • "CRI"
  • "JOR"
  • "LUX"
  • "BVT"
  • "CHE"
  • "MNG"
  • "AFG"
  • "HMD"
  • "MWI"
  • "CCK"
  • "NZL"
  • "TKM"
  • "VNM"
  • "TJK"
  • "MLT"
  • "GBR"
  • "MOZ"
  • "ALB"
  • "MHL"
  • "ECU"
  • "TTO"
  • "WLF"
  • "AUT"
  • "MSR"
  • "VAT"
  • "SLB"
  • "IRL"
  • "EST"
  • "CAF"
  • "ZZZ"
  • "IND"
  • "CIV"
  • "ATA"
  • "URY"
  • "ALA"
  • "ARM"
  • "TUR"
  • "BTN"
  • "AUS"
  • "GUY"
  • "BGD"
  • "BIH"
  • "PYF"
  • "QAT"
  • "MDV"
  • "MEX"
  • "SWZ"
  • "NAM"
  • "PRY"
  • "GRC"
  • "ITA"
  • "AND"
  • "KEN"
  • "KOR"
  • "ZWE"
  • "BFA"
  • "CXR"
  • "PRI"
  • "DNK"
  • "GAB"
  • "DOM"
  • "MKD"
  • "IRN"
  • "BLM"
  • "FLK"
  • "VEN"
  • "GIB"
  • "CZE"
  • "GRD"
  • "SPM"
  • "ASM"
  • "VGB"
  • "MDG"
  • "NPL"
  • "SXM"
  • "ZMB"
  • "NLD"
  • "SLE"
  • "SLV"
  • "GHA"
  • "KNA"
  • "MAR"
  • "BWA"
  • "DZA"
  • "BEN"
  • "BGR"
  • "SHN"
  • "TLS"
  • "EGY"
  • "TCA"
  • "MRT"
  • "ESP"
  • "ISR"
  • "KWT"
  • "LIE"
  • "FJI"
  • "PRK"
  • "PER"
  • "SSD"
  • "SRB"
  • "BHS"
  • "TUV"
  • "PCN"
  • "SOM"
  • "MAC"
  • "MLI"
  • "SVK"
  • "COM"
  • "IRQ"
  • "MYS"
contract.contacts[].addressDetails.addressLine1 String No

Address Line 1. Should include street and apartment number if required.
contract.contacts[].addressDetails.city String No

Name of a built-up area, with defined boundaries, and a local government. This could be city or town.
contract.contacts[].addressDetails.timeZone String No

A time zone, following the format defined in the IANA tz database (https://www.iana.org/time-zones). Valid examples are America/New_York and Etc/UTC. Do not use ambiguous, non-qualified values such as EST or GB. Before including this type in your interface, please consider whether it is actually appropriate to convey time zone information with your type. It is almost always the case that this should be transformed from UTC at the time of display to the user; this type might therefore be most associated with user-preference APIs.
contract.contacts[].addressDetails.addressLine2 String No

Address Line 2
contract.contacts[].isAuthorizedRepresentative Boolean No

Is this contact an authorized representative

Default value: false
contract.contacts[].isLegalRepresentative Boolean No

Is this contact a legal representative

Default value: false
contract.contacts[].isContractSignatureRequired Boolean No

Is this contact's signature required

Default value: false
contract.contacts[].isIDCheckRequired Boolean No

Is this contact's ID required to be checked

Default value: false
contract.contacts[].isBeneficiaryOwner Boolean No

Is a beneficiary owner

Default value: false
contract.contacts[].dateOfBirth String No

Date of Birth
contract.serviceStartDate String No

The requested date for this service to start.
contract.proprietorAct Boolean No

Is proprietor is acting on its own behalf (true) or is not acting on own behalf (false)
contract.brokerId String No

ID of the broker, if one is being used
notes String No

Notes for the Order
shippingAddress Object No

An Address following the convention of http://microformats.org/wiki/hcard
shippingAddress.vfiSiteId String No

Address/Site identifier known as within Verifone internal systems.
shippingAddress.contact Object No

The details of a Contact.
shippingAddress.contact.phoneNumbers[] Array No

The phone numbers to be used for the Contact. If you include this property there should be at least one phone number.
shippingAddress.contact.phoneNumbers[].isPrimary Boolean No

Indicates that the phone is a the primary phone. Mapped to PARTY_PHONE_PRIMARY

Default value: false
shippingAddress.contact.phoneNumbers[].callingCode String No

Country Calling Code. Mapped to PARTY_PHONE.CALLING_CODE or VENUE_PHONE.CALLING_CODE
shippingAddress.contact.phoneNumbers[].phoneType String Yes

Phone type in PHONE_TYPE_CON. Mapped to PARTY_PHONE.PHONE_TYPE_CON_ID or VENUE_PHONE.PHONE_TYPE_CON_ID

Valid values:

  • "OTHER"
  • "HOME"
  • "MOBILE"
  • "FAX"
  • "WORK"

Default value: "HOME"
shippingAddress.contact.phoneNumbers[].extension String No

The internal extension number where applicable or known.
shippingAddress.contact.phoneNumbers[].value String Yes

The actual phone number less country code and/or extension.
shippingAddress.contact.email String No

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.
shippingAddress.contact.businessTitle String No

Business Title.
shippingAddress.contact.contactType String Yes

An indicator for the type of contact

Valid values:

  • "OWNER"
  • "PERSONAL"
  • "BUSINESS"

Default value: "BUSINESS"
shippingAddress.addressLine1 String Yes

Address Line 1. Should include street and apartment number if required.
shippingAddress.city String Yes

Name of a built-up area, with defined boundaries, and a local government. This could be city or town.
shippingAddress.addressLine2 String No

Address Line 2
shippingAddress.addressLine3 String No

Address Line 3
shippingAddress.receiverName String No

The receiver name for the address if different to the company/site name.
shippingAddress.countrySubdivision String No

Identifies a sub-division of a country which may be state, region or county. This follows a similar format to the openbank api.
shippingAddress.postCode String Yes

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

Store Number or Client/Customer ID in Oracle
shippingAddress.poBox String No

The PO BOX number.
shippingAddress.country String Yes

The ISO 3166-1 alpha-3 country code.

Note: The country code for Great Britain is GB and not UK as is used in that country's top-level domain names.
.

Valid values:

  • "KAZ"
  • "LBY"
  • "BEL"
  • "GUM"
  • "BHR"
  • "BLZ"
  • "PAK"
  • "JAM"
  • "NFK"
  • "CYP"
  • "COL"
  • "SYR"
  • "MYT"
  • "HKG"
  • "BDI"
  • "FSM"
  • "CHN"
  • "HTI"
  • "TCD"
  • "RWA"
  • "DEU"
  • "LVA"
  • "TZA"
  • "ARG"
  • "GEO"
  • "HRV"
  • "GNQ"
  • "COK"
  • "CUW"
  • "SYC"
  • "GTM"
  • "USA"
  • "SGP"
  • "UKR"
  • "NRU"
  • "MAF"
  • "ABW"
  • "MNP"
  • "SAU"
  • "NIC"
  • "PNG"
  • "SVN"
  • "CHL"
  • "PAN"
  • "AZE"
  • "VUT"
  • "GNB"
  • "CAN"
  • "BRB"
  • "ARE"
  • "CYM"
  • "PHL"
  • "WSM"
  • "ERI"
  • "TON"
  • "BOL"
  • "JPN"
  • "TWN"
  • "HUN"
  • "KGZ"
  • "AGO"
  • "JEY"
  • "NIU"
  • "ROU"
  • "BRA"
  • "SEN"
  • "TGO"
  • "THA"
  • "DMA"
  • "GLP"
  • "LSO"
  • "NGA"
  • "UZB"
  • "FRO"
  • "GRL"
  • "GMB"
  • "YEM"
  • "ATG"
  • "BSB"
  • "LBN"
  • "NOR"
  • "SGC"
  • "POL"
  • "UMI"
  • "AIA"
  • "KHM"
  • "COG"
  • "FIN"
  • "SDN"
  • "CUB"
  • "ATF"
  • "PLW"
  • "MMR"
  • "RUS"
  • "ESH"
  • "LCA"
  • "VCT"
  • "IMN"
  • "DJI"
  • "LKA"
  • "CMR"
  • "BMU"
  • "PSE"
  • "MCO"
  • "GGY"
  • "NCL"
  • "FRA"
  • "TUN"
  • "PRT"
  • "BRN"
  • "MDA"
  • "MTQ"
  • "MUS"
  • "BLR"
  • "MNE"
  • "SWE"
  • "HND"
  • "REU"
  • "LAO"
  • "SMR"
  • "IDN"
  • "OMN"
  • "COD"
  • "KIR"
  • "SUR"
  • "STP"
  • "ETH"
  • "LTU"
  • "IOT"
  • "GIN"
  • "VIR"
  • "ISL"
  • "CPV"
  • "TKL"
  • "BES"
  • "LBR"
  • "NER"
  • "SJM"
  • "GUF"
  • "ZAF"
  • "UGA"
  • "CRI"
  • "JOR"
  • "LUX"
  • "BVT"
  • "CHE"
  • "MNG"
  • "AFG"
  • "HMD"
  • "MWI"
  • "CCK"
  • "NZL"
  • "TKM"
  • "VNM"
  • "TJK"
  • "MLT"
  • "GBR"
  • "MOZ"
  • "ALB"
  • "MHL"
  • "ECU"
  • "TTO"
  • "WLF"
  • "AUT"
  • "MSR"
  • "VAT"
  • "SLB"
  • "IRL"
  • "EST"
  • "CAF"
  • "ZZZ"
  • "IND"
  • "CIV"
  • "ATA"
  • "URY"
  • "ALA"
  • "ARM"
  • "TUR"
  • "BTN"
  • "AUS"
  • "GUY"
  • "BGD"
  • "BIH"
  • "PYF"
  • "QAT"
  • "MDV"
  • "MEX"
  • "SWZ"
  • "NAM"
  • "PRY"
  • "GRC"
  • "ITA"
  • "AND"
  • "KEN"
  • "KOR"
  • "ZWE"
  • "BFA"
  • "CXR"
  • "PRI"
  • "DNK"
  • "GAB"
  • "DOM"
  • "MKD"
  • "IRN"
  • "BLM"
  • "FLK"
  • "VEN"
  • "GIB"
  • "CZE"
  • "GRD"
  • "SPM"
  • "ASM"
  • "VGB"
  • "MDG"
  • "NPL"
  • "SXM"
  • "ZMB"
  • "NLD"
  • "SLE"
  • "SLV"
  • "GHA"
  • "KNA"
  • "MAR"
  • "BWA"
  • "DZA"
  • "BEN"
  • "BGR"
  • "SHN"
  • "TLS"
  • "EGY"
  • "TCA"
  • "MRT"
  • "ESP"
  • "ISR"
  • "KWT"
  • "LIE"
  • "FJI"
  • "PRK"
  • "PER"
  • "SSD"
  • "SRB"
  • "BHS"
  • "TUV"
  • "PCN"
  • "SOM"
  • "MAC"
  • "MLI"
  • "SVK"
  • "COM"
  • "IRQ"
  • "MYS"
shippingAddress.timeZone String No

A time zone, following the format defined in the IANA tz database (https://www.iana.org/time-zones). Valid examples are America/New_York and Etc/UTC. Do not use ambiguous, non-qualified values such as EST or GB. Before including this type in your interface, please consider whether it is actually appropriate to convey time zone information with your type. It is almost always the case that this should be transformed from UTC at the time of display to the user; this type might therefore be most associated with user-preference APIs.
orderReference String Yes

Client reference for the Order
requestedDate String No

The requested date for this order.
poRef String No

Purchase Order Reference
servicePackages[] Array Yes
servicePackages[].adjustedPrices[] Array No
servicePackages[].adjustedPrices[].price String No

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.
  • An eight-place decimal fraction. For currencies such as Bitcoin.
  • For the required number of decimal places for a currency code, see ISO 4217.
servicePackages[].adjustedPrices[].priceModel String No

Pricing Model

Valid values:

  • "MINIMUM_AMT_PER_TRX"
  • "PERC_PER_TRX"
  • "MONTHLY_FEE"
  • "AMT_PER_TRX"
  • "MONTHLY_FEE_PER_DEVICE"
  • "ONE_TIME"
servicePackages[].processorParameters Object No

Payment Processor Parameters related to Merchant onboarding
servicePackages[].processorParameters.tidList[] Array No

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)
servicePackages[].processorParameters.processor String Yes

A type indicator for the contract that is being processed.

Valid values:

  • "IKANO"
  • "GPP2"
  • "PAYPAL_ECOM"
  • "CREDIT_DU_NORD_VERS_NATIXIS"
  • "BNP_PARIBAS"
  • "HSBC"
  • "RTS"
  • "GLOBALPAYMENTS_US"
  • "CEDICAM"
  • "MAESTRO"
  • "SWISH"
  • "SIMULATOR"
  • "LCL"
  • "INTERCARD"
  • "GICC"
  • "TIETO_EVRY"
  • "BNPP_ATC"
  • "MOBILEPAY"
  • "DANKORT"
  • "FIRSTDATA"
  • "CIC"
  • "HEARTLAND_US"
  • "CBA"
  • "TSYS_US"
  • "CREDIT_MUTUEL"
  • "RESURS_BANK"
  • "VERIFONE_AU"
  • "ELAVON"
  • "ISRACARD"
  • "VANTIV_US"
  • "CREDITGUARD"
  • "LLOYDS_CARDNET"
  • "FDRC"
  • "ABS_ISO"
  • "BARCLAYS"
  • "CAISSE_D_EPARGNE"
  • "WESTPAC"
  • "FISERV_US"
  • "BNPP_VERS_ATOS"
  • "LA_BANQUE_POSTAL"
  • "CUSCAL_AU"
  • "ELAVON_US"
  • "BFCOI"
  • "LES_BANQUES_POPULAIRES"
  • "BANQUE_CHABRIERES"
  • "BANKAXEPT"
  • "OTHER"
  • "CREDIT_DU_NORD_VERS_ATOS"
  • "FISERV_AU"
  • "SVS_UK"
  • "ABS_PDM"
  • "WORLDPAY"
  • "CM_ARKEA"
  • "EFTPOS_NZ"
  • "GLOBALPAY"
  • "PELECARD"
  • "NETS"
  • "VIPPS"
  • "CREDIT_AGRICOLE"
  • "BRED"
  • "PAYPAL"
  • "SG"
  • "AMEX"
  • "ABS_WEB"
  • "SWEDBANK_PAY"
  • "CHASE_US"
  • "SVS_US"

Default value: "TSYS_US"
servicePackages[].additionalPackageData[] Array No

Input data required to configure the package. For example some packages require a merchant ID
servicePackages[].additionalPackageData[].variableName String No

Variable name (this would be provided by Verifone)
servicePackages[].additionalPackageData[].variableValue String No

Value of the variable
servicePackages[].contractUid String No

The Verifone assigned ID corresponding to the contract.
servicePackages[].packageBundleId String Yes

The Verifone allocated ID for the package bundle.
billingAddress Object No

An Address following the convention of http://microformats.org/wiki/hcard
billingAddress.vfiSiteId String No

Address/Site identifier known as within Verifone internal systems.
billingAddress.contact Object No

The details of a Contact.
billingAddress.contact.phoneNumbers[] Array No

The phone numbers to be used for the Contact. If you include this property there should be at least one phone number.
billingAddress.contact.phoneNumbers[].isPrimary Boolean No

Indicates that the phone is a the primary phone. Mapped to PARTY_PHONE_PRIMARY

Default value: false
billingAddress.contact.phoneNumbers[].callingCode String No

Country Calling Code. Mapped to PARTY_PHONE.CALLING_CODE or VENUE_PHONE.CALLING_CODE
billingAddress.contact.phoneNumbers[].phoneType String Yes

Phone type in PHONE_TYPE_CON. Mapped to PARTY_PHONE.PHONE_TYPE_CON_ID or VENUE_PHONE.PHONE_TYPE_CON_ID

Valid values:

  • "OTHER"
  • "HOME"
  • "MOBILE"
  • "FAX"
  • "WORK"

Default value: "HOME"
billingAddress.contact.phoneNumbers[].extension String No

The internal extension number where applicable or known.
billingAddress.contact.phoneNumbers[].value String Yes

The actual phone number less country code and/or extension.
billingAddress.contact.email String No

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.
billingAddress.contact.businessTitle String No

Business Title.
billingAddress.contact.contactType String Yes

An indicator for the type of contact

Valid values:

  • "OWNER"
  • "PERSONAL"
  • "BUSINESS"

Default value: "BUSINESS"
billingAddress.addressLine1 String Yes

Address Line 1. Should include street and apartment number if required.
billingAddress.city String Yes

Name of a built-up area, with defined boundaries, and a local government. This could be city or town.
billingAddress.addressLine2 String No

Address Line 2
billingAddress.addressLine3 String No

Address Line 3
billingAddress.receiverName String No

The receiver name for the address if different to the company/site name.
billingAddress.countrySubdivision String No

Identifies a sub-division of a country which may be state, region or county. This follows a similar format to the openbank api.
billingAddress.postCode String Yes

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

Store Number or Client/Customer ID in Oracle
billingAddress.poBox String No

The PO BOX number.
billingAddress.country String Yes

The ISO 3166-1 alpha-3 country code.

Note: The country code for Great Britain is GB and not UK as is used in that country's top-level domain names.
.

Valid values:

  • "KAZ"
  • "LBY"
  • "BEL"
  • "GUM"
  • "BHR"
  • "BLZ"
  • "PAK"
  • "JAM"
  • "NFK"
  • "CYP"
  • "COL"
  • "SYR"
  • "MYT"
  • "HKG"
  • "BDI"
  • "FSM"
  • "CHN"
  • "HTI"
  • "TCD"
  • "RWA"
  • "DEU"
  • "LVA"
  • "TZA"
  • "ARG"
  • "GEO"
  • "HRV"
  • "GNQ"
  • "COK"
  • "CUW"
  • "SYC"
  • "GTM"
  • "USA"
  • "SGP"
  • "UKR"
  • "NRU"
  • "MAF"
  • "ABW"
  • "MNP"
  • "SAU"
  • "NIC"
  • "PNG"
  • "SVN"
  • "CHL"
  • "PAN"
  • "AZE"
  • "VUT"
  • "GNB"
  • "CAN"
  • "BRB"
  • "ARE"
  • "CYM"
  • "PHL"
  • "WSM"
  • "ERI"
  • "TON"
  • "BOL"
  • "JPN"
  • "TWN"
  • "HUN"
  • "KGZ"
  • "AGO"
  • "JEY"
  • "NIU"
  • "ROU"
  • "BRA"
  • "SEN"
  • "TGO"
  • "THA"
  • "DMA"
  • "GLP"
  • "LSO"
  • "NGA"
  • "UZB"
  • "FRO"
  • "GRL"
  • "GMB"
  • "YEM"
  • "ATG"
  • "BSB"
  • "LBN"
  • "NOR"
  • "SGC"
  • "POL"
  • "UMI"
  • "AIA"
  • "KHM"
  • "COG"
  • "FIN"
  • "SDN"
  • "CUB"
  • "ATF"
  • "PLW"
  • "MMR"
  • "RUS"
  • "ESH"
  • "LCA"
  • "VCT"
  • "IMN"
  • "DJI"
  • "LKA"
  • "CMR"
  • "BMU"
  • "PSE"
  • "MCO"
  • "GGY"
  • "NCL"
  • "FRA"
  • "TUN"
  • "PRT"
  • "BRN"
  • "MDA"
  • "MTQ"
  • "MUS"
  • "BLR"
  • "MNE"
  • "SWE"
  • "HND"
  • "REU"
  • "LAO"
  • "SMR"
  • "IDN"
  • "OMN"
  • "COD"
  • "KIR"
  • "SUR"
  • "STP"
  • "ETH"
  • "LTU"
  • "IOT"
  • "GIN"
  • "VIR"
  • "ISL"
  • "CPV"
  • "TKL"
  • "BES"
  • "LBR"
  • "NER"
  • "SJM"
  • "GUF"
  • "ZAF"
  • "UGA"
  • "CRI"
  • "JOR"
  • "LUX"
  • "BVT"
  • "CHE"
  • "MNG"
  • "AFG"
  • "HMD"
  • "MWI"
  • "CCK"
  • "NZL"
  • "TKM"
  • "VNM"
  • "TJK"
  • "MLT"
  • "GBR"
  • "MOZ"
  • "ALB"
  • "MHL"
  • "ECU"
  • "TTO"
  • "WLF"
  • "AUT"
  • "MSR"
  • "VAT"
  • "SLB"
  • "IRL"
  • "EST"
  • "CAF"
  • "ZZZ"
  • "IND"
  • "CIV"
  • "ATA"
  • "URY"
  • "ALA"
  • "ARM"
  • "TUR"
  • "BTN"
  • "AUS"
  • "GUY"
  • "BGD"
  • "BIH"
  • "PYF"
  • "QAT"
  • "MDV"
  • "MEX"
  • "SWZ"
  • "NAM"
  • "PRY"
  • "GRC"
  • "ITA"
  • "AND"
  • "KEN"
  • "KOR"
  • "ZWE"
  • "BFA"
  • "CXR"
  • "PRI"
  • "DNK"
  • "GAB"
  • "DOM"
  • "MKD"
  • "IRN"
  • "BLM"
  • "FLK"
  • "VEN"
  • "GIB"
  • "CZE"
  • "GRD"
  • "SPM"
  • "ASM"
  • "VGB"
  • "MDG"
  • "NPL"
  • "SXM"
  • "ZMB"
  • "NLD"
  • "SLE"
  • "SLV"
  • "GHA"
  • "KNA"
  • "MAR"
  • "BWA"
  • "DZA"
  • "BEN"
  • "BGR"
  • "SHN"
  • "TLS"
  • "EGY"
  • "TCA"
  • "MRT"
  • "ESP"
  • "ISR"
  • "KWT"
  • "LIE"
  • "FJI"
  • "PRK"
  • "PER"
  • "SSD"
  • "SRB"
  • "BHS"
  • "TUV"
  • "PCN"
  • "SOM"
  • "MAC"
  • "MLI"
  • "SVK"
  • "COM"
  • "IRQ"
  • "MYS"
billingAddress.timeZone String No

A time zone, following the format defined in the IANA tz database (https://www.iana.org/time-zones). Valid examples are America/New_York and Etc/UTC. Do not use ambiguous, non-qualified values such as EST or GB. Before including this type in your interface, please consider whether it is actually appropriate to convey time zone information with your type. It is almost always the case that this should be transformed from UTC at the time of display to the user; this type might therefore be most associated with user-preference APIs.
customerEntityUid String Yes

Verifone allocated ID for the customer this order is for (packages and bundles are associated with this entity).
additionalOrderData[] Array No

Input data which maybe required for the country/business unit to to complete the order. For example some countries require a VAT ID, or different legal forms of business, this will be defined by Verifone if needed for your integration
additionalOrderData[].variableName String No

Variable name (this would be provided by Verifone)
additionalOrderData[].variableValue String No

Value of the variable

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2026 SimWorkflow
Terms of Service Privacy Policy