PUT /orders/merchant/{orderId}

Verifone allocated ID for the Order

Default value: "application/json"

An optional header indicating whether to validate the acquirer.

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

Type of payment that can be made.

Default value: "CREDIT"

Used if merchant contract is to be processed

Legal Structure

Valid values:

• "PROPRIETOR_OWN_BEHALF"
• "SHARED_LESS_25_PERC_EACH"
• "PROPRIETOR_NOT_OWN_BEHALF"

The details of a Contact.

Passport Identity Identifier.

The phone numbers to be used for the Contact. If you include this property there should be at least one phone number.

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

Default value: false

Country Calling Code. Mapped to PARTY_PHONE.CALLING_CODE or VENUE_PHONE.CALLING_CODE

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"

The internal extension number where applicable or known.

The actual phone number less country code and/or extension.

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.

Business Title.

Nationality

Contact's national identity identifier.

An indicator for the type of contact

Valid values:

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

Default value: "BUSINESS"

Type of representative when this contact is legal or authorized rep

Valid values:

• "NOT_APPLICABLE"
• "GENERAL_COMMERCIAL_POWER"
• "LIMITED_COMMERCIAL_POWER"

Place of Birth

Is this contact a politically exposed person

Default value: false

An Address following the convention of http://microformats.org/wiki/hcard

Address Line 3

The receiver name for the address if different to the company/site name.

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

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

The PO BOX number.

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"

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

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

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.

Address Line 2

Is this contact an authorized representative

Default value: false

Is this contact a legal representative

Default value: false

Is this contact's signature required

Default value: false

Is this contact's ID required to be checked

Default value: false

Is a beneficiary owner

Default value: false

Date of Birth

The requested date for this service to start.

Is proprietor is acting on its own behalf (true) or is not acting on own behalf (false)

ID of the broker, if one is being used

Notes for the Order

Client reference for the Order

The requested date for this order.

Purchase Order Reference

details of the merchant

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).

An Address following the convention of http://microformats.org/wiki/hcard

Address/Site identifier known as within Verifone internal systems.

The details of a Contact.

The phone numbers to be used for the Contact. If you include this property there should be at least one phone number.

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

Default value: false

Country Calling Code. Mapped to PARTY_PHONE.CALLING_CODE or VENUE_PHONE.CALLING_CODE

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"

The internal extension number where applicable or known.

The actual phone number less country code and/or extension.

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.

Business Title.

An indicator for the type of contact

Valid values:

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

Default value: "BUSINESS"

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

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

Address Line 2

Address Line 3

The receiver name for the address if different to the company/site name.

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

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

Store Number or Client/Customer ID in Oracle

The PO BOX number.

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"

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.

A Verifone assigned merchantId used to identify the Merchant Entity within Verifone systems for transaction processing. This is traditionally passed in ISO8583 DE42. This will also be used for Payment Processing Contracts unless a different merchant id is specified as part of the contract.

Do not specify this property unless the Entity is considered to be a Merchant Entity i.e. an Entity that holds a contract to process payments.

This value is not guaranteed as globally unique within Verifone. That value is the entityUid (uuid) property that will be assigned on creation of the Entity and returned on the response..

An Address following the convention of http://microformats.org/wiki/hcard

Address/Site identifier known as within Verifone internal systems.

The details of a Contact.

The phone numbers to be used for the Contact. If you include this property there should be at least one phone number.

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

Default value: false

Country Calling Code. Mapped to PARTY_PHONE.CALLING_CODE or VENUE_PHONE.CALLING_CODE

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"

The internal extension number where applicable or known.

The actual phone number less country code and/or extension.

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.

Business Title.

An indicator for the type of contact

Valid values:

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

Default value: "BUSINESS"

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

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

Address Line 2

Address Line 3

The receiver name for the address if different to the company/site name.

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

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

Store Number or Client/Customer ID in Oracle

The PO BOX number.

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"

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.

The Industry type applicable to a Merchant.

Valid values:

• "MOTO"
• "QUICK_SERVICE_RESTAURANT"
• "RECREATION"
• "EDUCATIONAL"
• "AIRLINE"
• "VEHICLE_RENTAL"
• "DIRECT"
• "PETROLEUM"
• "LODGING"
• "RESTAURANT"
• "GOVERNMENT"
• "RETAIL"
• "TRANSPORT"
• "MEDICAL"

If specified this will add the merchant company or site under a specific entity within Verifone systems.

Deprecated - Please use paymentAppParameters

Receipt Options

Placeholder for greeting text on the receipt.

Show e-mail option for customer receipts.

Defines the receipt print options. - Possible values are:
Never Print - NEVER
Prompt for print - PROMPT
Always Print - ALWAYS
Always Print when Signature is Captured - ALWAYS_WITH_SIGNATURE

Valid values:

• "ALWAYS_WITH_SIGNATURE"
• "ALWAYS"
• "PROMPT"
• "NEVER"

Determines if the device displays the Terms and Conditions text when a customer elects to receive an email receipt.

Receipt placeholder for footer text.

Defines the receipt print options. - Possible values are:
Never Print - NEVER
Prompt for print - PROMPT
Always Print - ALWAYS
Always Print when Signature is Captured - ALWAYS_WITH_SIGNATURE

Valid values:

• "ALWAYS_WITH_SIGNATURE"
• "ALWAYS"
• "PROMPT"
• "NEVER"

Tip Options

Defines the maximum percentage of the transaction amount that can be added as a tip. If this is exceeded, a warning is prompted.

Pre-Defines up to 3 tip percentage options for customers to choose from, after entering the purchase amount for a transaction, e.g. 10, 15, 20 = 10%, 15%, 20%, respectively. Note that the TipEnabled parameter must be enabled, and that only whole numbers are accepted as percentage values, e.g. 10% (not 10.5%).

Enable tipping. When enabled the device presents a tip selection screen during a transaction, showing pre-configured tip amounts and an option for a custom amount.

Transaction Options

Enable mail and telephone order (MOTO) payments.

Enable mail and telephone order (MOTO) payments.

Enable standalone Cashout for this merchant.

If enabled, separate options for telephone and mail order will be presented to the user.

Enable Purchase for this merchant.

Enable tip for moto payments for this merchant.

Enable Refund for this merchant.

Predefined Cashout amounts that user can select from. Comma separated amount e.g. 10.00,20.00,40.00. This is in the currency supported by the terminal. All currency format represents a decimal number. Maximum 3 values will be allowed.

Enable Purchase with Cashout for this merchant.

Enable Balance Enquiry for this merchant.

Enable mail and telephone order (MOTO) payments.

Enable PreAuth for this merchant.

Limits

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.

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.

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.

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.

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.

An Address following the convention of http://microformats.org/wiki/hcard

Address/Site identifier known as within Verifone internal systems.

The details of a Contact.

The phone numbers to be used for the Contact. If you include this property there should be at least one phone number.

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

Default value: false

Country Calling Code. Mapped to PARTY_PHONE.CALLING_CODE or VENUE_PHONE.CALLING_CODE

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"

The internal extension number where applicable or known.

The actual phone number less country code and/or extension.

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.

Business Title.

An indicator for the type of contact

Valid values:

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

Default value: "BUSINESS"

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

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

Address Line 2

Address Line 3

The receiver name for the address if different to the company/site name.

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

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

Store Number or Client/Customer ID in Oracle

The PO BOX number.

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"

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.

The identifier assigned to this Merchant Entity.

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

Valid merchant logo url

Payment Parameters - these can be specified per merchant and/or overridden at the poi level. If no values are specified then default template values will be applied.

Enable moto PreAuth for this merchant.

Display the option to disable merchant preferred app selection in the 'Prompt For Card' screen

Settlement runs on a schedule.

0 - Disabled: Pre-Auth/Completion transactions are not subject to surcharge

1 - Pre-Auth: Surcharge is applied to Pre-Auth (initial) transaction

2 - Completion: Surcharge is applied to Completion transaction

Enable contactless surcharging.

Allow EBT (Electronic benefit transfer) payment type.

Determines if the device displays the Terms and Conditions text when a customer elects to receive an email receipt.

Enable prompting for a cashout amount as part of a purchase transaction.

Maximum amount for a single transaction to be put into SAF. This overrides card scheme settings.

Enable void transaction for magnetic stripe and chip cards for this product

Enable tip for moto payments for this merchant.

Manual Refund Enabled.

Enable Refund transactions as such for this merchant.

Enable Manual Card Entry for Purchase.

Maximum cashout amount allowed, in the currency supported by the terminal. The value should be in a decimal format, e.g. $40 = 40.00 - where the currency symbol depends on the region.

Maximum refund amount allowed by the manager, in the currency supported by the terminal. The value should be in a decimal format, e.g. $40 = 40.00

Maximum limit allowed by terminal when communications fail

Defines the maximum percentage of the transaction amount that can be added as a tip. If this is exceeded, a warning is prompted.

Maximum refund amount allowed per settlement period, in the currency supported by the terminal. This value should be in a decimal format, e.g. $40 = 40.00

Payment Parameters - Regional specific options

Maximum refund amount allowed by the cashier, in the currency supported by the terminal. The value should be in a decimal format, e.g. $40 = 40.00

Settlement runs at this time everyday.

Defines the merchant receipt print options.

0-Never Print

1-Prompt for print

2-Always Print

3-Always Print when Signature is Captured

Enable mail and telephone order (MOTO) payments.

Enable moto refunds for this merchant.

Select if card holder is present (Always/Prompt/Never)

Valid values:

• "Always"
• "Never"
• "Prompt"

Enables surcharging for Purchase (+ Cash + Tip) transactions. Surchargeable amount - this is the amount in the transaction where a surcharge can be applied to. Purchase only - surchargeable amount is the purchase amount. Purchase + Cash - surchargeable amount is the purchase amount only. Purchase + Cash + Tip - surchargeable amount is the purchase amount only. Purchase

• Tip - surchargeable amount is the purchase amount only.

Enables surcharging for Cashout only transactions.

Enable Cashout only transactions for this merchant.

Determines whether to present separate options for mail and telephone orders (MOTO).

Pre-Defines up to 4 tip percentage options for customers to choose from, after entering the purchase amount for a transaction, e.g. 10, 15, 20, 25% = 10%, 15%, 20%, 25% respectively. Note that the TipEnabled parameter must be enabled, and that only whole numbers are accepted as percentage values, e.g. 10% (not 10.5%). Note also some terminal solutions only support 3 pre-defined limits.

Enable Purchase transactions for this merchant.

Represents the maximum purchase amount allowed in the currency supported by the terminal. The value should be in a decimal format, e.g. $40 = 40.00. Maximal amount supported by the payment application is 9,999,999,999.99.

Predefined cashout amounts presented at the cashout selection in the local currency. Maximum of 4 comma separated amounts e.g. 10.00,20.00,40.00.

Enable purchase with tip transaction for this product

Enable Pre-Auth transactions for this merchant.

Voice Referral floor limit authorisation code

Defines the customer receipt print options.

0-Never Print

1-Prompt for print

2-Always Print

Whether SAF (offline approval when device cannot go online or reach host/gateway), 1-Enabled, 0-Not enabled

Allow the total to be paid with multiple payments.

Enable Manual Card Entry for PreAuth.

Surcharging options for different card products

When enabled (true), surcharging of transactions that utilize international payment methods follows the surcharge parameter settings and rules as defined for domestic payment methods; and the international configuration variants are ignored. When disabled (false), unique International configuration parameters will control surcharging of transactions that utilize international payment methods.

Default value: "1"

Amount is in default Terminal currency, represented as a decimal number. When the transaction amount is above this maximum, no surcharge will be applied.

Default value: "0"

Amount is in default Terminal currency, represented as a decimal number. When the transaction amount is below this minimum, no surcharge will be applied.

Default value: "0"

Specifies the value of the surcharge depending on the surcharge type. Can be a fixed value (eg 2.5 = $2.50) or a percentage (eg 1.2 = 1.2%).

Applicable only when Surcharge Type is Percentage. Amount is in default Terminal currency, represented as a decimal number. Specifies the maximum surcharge amount; if the calculated surcharge is above this value, the Surcharge Max Adjustment amount will be applied instead.

Default value: "0"

Surcharge Type (Domestic)

0 - Not configured

1 - Fixed Amount

2 - Percentage

Applicable only when Surcharge Type is Percentage. Amount is in default Terminal currency, represented as a decimal number. Specifies the minimum surcharge amount; if the calculated surcharge is below this value, the Surcharge Min Adjustment amount will be applied instead.

Default value: "0"

Link to the card product which this surcharge applies to. Contact Verifone for card products applicable to your estate.

Maximum limit allowed for voice referral

Show e-mail option for customer receipts.

Receipt placeholder for footer text.

Maximum limit for contact less payments

Enables surcharging for mail and telephone order (MOTO) transactions.

Maximum amount of all pending SAF transactions that are allowed. Once this limit is reached, the terminal cannot approve anymore transaction as SAF

Placeholder for greeting text on the receipt.

Indicates if the force offline operation is enabled for the merchant

Enable Balance Enquiry transactions for this merchant.

Requested date of shipment.

Settlement details needed for onboarding in certain situations . e.g. For Payware solutions

Settlement time in HH:MM format

The Verifone allocated unique id for this site. This is allocated by Verifone when an order is initially received. Please use value returned in OrderResponse.

The details of a Contact.

The phone numbers to be used for the Contact. If you include this property there should be at least one phone number.

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

Default value: false

Country Calling Code. Mapped to PARTY_PHONE.CALLING_CODE or VENUE_PHONE.CALLING_CODE

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"

The internal extension number where applicable or known.

The actual phone number less country code and/or extension.

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.

Business Title.

An indicator for the type of contact

Valid values:

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

Default value: "BUSINESS"

Select the base package, hardware and additional services for this order.

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.

Pricing Model

Valid values:

• "MINIMUM_AMT_PER_TRX"
• "PERC_PER_TRX"
• "MONTHLY_FEE"
• "AMT_PER_TRX"
• "MONTHLY_FEE_PER_DEVICE"
• "ONE_TIME"

Input data required to configure the package. For example some packages require a merchant ID

Variable name (this would be provided by Verifone)

Value of the variable

The Verifone allocated ID for the package bundle.

Verifone ID for the Portfolio Selected. If this is not provided then a default portfolio will be used.

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.

Pricing Model

Valid values:

• "MINIMUM_AMT_PER_TRX"
• "PERC_PER_TRX"
• "MONTHLY_FEE"
• "AMT_PER_TRX"
• "MONTHLY_FEE_PER_DEVICE"
• "ONE_TIME"

Payment Processor Parameters related to Merchant onboarding

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)

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"

Input data required to configure the package. For example some packages require a merchant ID

Variable name (this would be provided by Verifone)

Value of the variable

The Verifone allocated ID for the package bundle.

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.

The Verifone allocated ID for the package bundle.

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

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

Variable name (this would be provided by Verifone)

Value of the variable