PARAM QUERY

		NAME	DESCRIPTION	FORMAT
No param query

PARAM BODY

request

		NAME	DESCRIPTION	FORMAT
reservation Object agencyId String Min. length: 1 Max. length: 255 amount String cancelationDetails Object cancellationCondition Array dataTypeValue The value of the selected data type. String value The value for the penalty amount or percentage of refund. String dataType Type of date within which it is possible to cancel the reservation. Possible values: - DATE - HOUR_FROM_CHECKIN - DAY_FROM_CHECKIN String checkInDate String checkInTime String Max. length: 5 checkOutDate String checkOutTime String Max. length: 5 collectionType Accounting typology: - INSTANT - DELAYED - INSTALLMENT: delayed Delayed and installment Collection String creationDate String currency Transaction currency. ISO 4217 alphabetic code String Example: EUR customField String Max. length: 255 customerId Customer identifier computed by the merchant to match the registered customer on the ecommerce platform. Use only letters, digits, underscore (_), or hyphen (-). String Max. length: 27 Example: mcid97295873 customerInfo Object containing the customer detail. Sending the content of this object increases the security level of the transaction, thus increasing the probability that two-factor authentication will not be requested in the payment. Object billingAddress Object containing the detail of the customer's address. Object additionalInfo Additional info of address, for example floor. Recommended maximum length: 50 characters. String Example: Quinto Piano, Scala B city City. Recommended maximum length: 40 characters. String Example: Bologna country State in ISO 3166-1 alpha-3 code. Recommended maximum length: 3 characters. String Example: ITA name Name and surname. Recommended maximum length: 50 characters. String Example: Mario Rossi postCode Postal code. Recommended maximum length: 16 characters. String Example: 40124 province Code of province. Recommended maximum length: 3 characters. String Example: BO street Full address. Recommended maximum length: 50 characters. String Example: Piazza Maggiore, 1 cardHolderAcctInfo Object containing information about the buyer's account. Object chAccAgeIndicator Account age indicator on the merchant site: 01 = No account 02 = Created during this transaction 03 = Created in the last 30 days 04 = Created between 30 and 60 days ago 05 = Created before 60 days ago String Example: 01 chAccChangeDate Date of the last variation of the account on the merchant's website, including Billing or Shipping address, new payment account, or new user(s) added. String Example: 2019-02-11T00:00:00.000+0000 chAccChangeIndicator Elapsed time since the last change to the buyer's account information on the merchant site, including Billing or Shipping address, new payment account, or new user(s) added. 01 = Created during this transaction 02 = Created in the last 30 days 03 = Created between 30 and 60 days ago 04 = Created before 60 days ago String Example: 01 chAccDate Date of activation of the account on the merchant's website. String Example: 2019-02-11T00:00:00.000+0000 chAccPwChangeDate Date of last account password change (including password reset). String Example: 2019-02-11T00:00:00.000+0000 chAccPwChangeIndicator Time elapsed since the buyer's account performed a password change or account recovery: 01 = No account 02 = Created during this transaction 03 = In the last 30 days 04 = Between 30 and 60 days ago 05 = Before 60 days ago String Example: 01 destinationAddressUsageDate Date of last use of this delivery address. String Example: 2019-02-11T00:00:00.000+0000 destinationAddressUsageIndicator Indicates when the shipping address used for this transaction was used for the first time: 01 = Created during this transaction 02 = Created in the last 30 days 03 = Created between 30 and 60 days ago 04 = Created before 60 days ago String Example: 01 destinationNameIndicator Indicates if the name associated with the account matches the name listed for shipping: 01 = Account name identical to the shipping address name. 02 = Different account name from the shipping address name String Example: 01 nbPurchaseAccount Number of purchases of this account in the last 6 months. Integer Example: 0 paymentAccAgeDate Payment account activation date. String Example: 2019-02-11T00:00:00.000+0000 paymentAccIndicator Indicates when the buyer has entered the Payment account on the merchant's site: 01 = No account 02 = created during this transaction 03 = Created in the last 30 days 04 = Created between 30 and 60 days ago 05 = Created before 60 days ago String Example: 0 provisionAttemptsDay Number of attempts to add a new card in the last 24 hours. Integer Example: 0 suspiciousAccActivity Indicates whether the merchant has detected suspicious activity (including previous fraud) on the buyer's account: 01 = No suspicious activity verified. 02 = Suspicious activity detected String Example: 01 txnActivityDay Number of transactions (successful and abandoned) for this account in the previous 24 hours. Integer Example: 0 txnActivityYear Number of transactions (successful and abandoned) for this account in the previous year. Integer Example: 0 cardHolderEmail Email of the cardholder. Recommended maximum length: 255 characters. String Example: mauro.morandi@nexi.it cardHolderName Name and surname of the cardholder. Recommended maximum length: 255 characters. String Example: Mauro Morandi homePhone Home phone number provided by the Cardholder. Recommended maximum length: 18 characters. String Example: 391231234567 merchantRiskIndicator Object containing information relating to the purchase made. Object deliveryEmail In case of purchase of virtual/digital products: email address to which the product is sent. String Example: john.doe@email.com deliveryTimeframe Indicator on the delivery period of the goods: 01 = Immediate Delivery (virtual/digital products). 02 = Same day delivery. 03 = Night delivery. 04 = Delivery in two or more days String Example: 01 giftCardAmount Object containing the total amount and currency of the prepaid or gift card(s) purchased. Object currency For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr String Example: EUR value For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in major units (for example, USD 123.45 is 123). EMVCO: giftCardAmount String Max. length: 18 Example: 100 giftCardCount Total number of individual prepaid or gift cards/codes purchased. Integer Example: 0 preOrderDate For a pre-ordered purchase, the expected date that the merchandise will be available. String Example: 2019-02-11T00:00:00.000+0000 preOrderPurchaseIndicator Indicates whether buyer is placing an order for merchandise with a future availability: 01 = Goods available. 02 = Future availability. String Example: 01 reorderItemsIndicator Indicates whether the cardholder is reordering previously purchased merchandise: 01 = First order. 02 = Goods already purchased previously. String Example: 01 shipIndicator Indicator on the type of delivery: 01 = Shipping to the billing address. 02 = Shipping to another address verified by the merchant. 03 = Delivery to a different address than the billing. 04 = Shipment or collection to the store (the address of the store must be indicated in the "destinationAddress" object). 05 = Virtual/digital goods, including online services, electronic gift certificates, recovery codes. 06 = Travel and event tickets (not sent). 07 = Other: for example games, digital services not sent, electronic media subscriptions String Example: 01 mobilePhone Mobile phone. Recommended maximum length: 15 characters. String Example: 3280987654 mobilePhoneCountryCode Prefix of the mobile phone. Recommended maximum length: 4 characters. String Example: +39 recontactConsent In certain scenarios, it is possible to collect the payer's consent to be recontacted by the merchant. This field indicates whether the payer has given such consent. Boolean shippingAddress Object containing the detail of the customer's address. Object additionalInfo Additional info of address, for example floor. Recommended maximum length: 50 characters. String Example: Quinto Piano, Scala B city City. Recommended maximum length: 40 characters. String Example: Bologna country State in ISO 3166-1 alpha-3 code. Recommended maximum length: 3 characters. String Example: ITA name Name and surname. Recommended maximum length: 50 characters. String Example: Mario Rossi postCode Postal code. Recommended maximum length: 16 characters. String Example: 40124 province Code of province. Recommended maximum length: 3 characters. String Example: BO street Full address. Recommended maximum length: 50 characters. String Example: Piazza Maggiore, 1 tin Tax Identification Number is collected in certain scenarios, such as donations, to comply with tax regulations. It is an identifier used in many countries for tax purposes. String Max. length: 32 Example: 12345678901 workPhone Work phone number provided by the Cardholder. Recommended maximum length: 18 characters. String Example: 391231234567 customerName String Max. length: 255 customerNumber String Max. length: 4 customerSurname String Max. length: 255 customerTaxCode String Max. length: 21 deposit String description String Max. length: 255 installments Array amount Installment amount. String Example: 350 date Installment time. String type String instalmentPlanId String Max. length: 36 linkExpirationDate String reservationId String Max. length: 27 reservationPeriod String Max. length: 4 reservationType Possible values: - PREPAID_REFUNDABLE: reservation is paid in advace for the service that will be provided and it can be refundable. - PREPAID_NOT_REFUNDABLE: reservation is paid in advace for the service that will be provided and it can not be refundable. - GUARANTEED_NOSHOW: reservation, through a card verification without charge to the customer. If the customer does not show up at the property, it is possible to charge the cost of the first night of stay. - GUARANTEED_PENALTY: reservation, through a card verification without charge to the customer. An automatic charge of the predetermined penalty is made in case a guest does not show up at the property. - BUNDLE: booking of a package containing several services provided by the same structure, for example stay + excursion + restaurant + tourist bus. String status String structureId String Min. length: 1 Max. length: 36 termsAndConditionsIds Array timeLabel String transactionSummary Array language Language in ISO 639-2 three-letter code. String Min. length: 3 Max. length: 3 Default: ITA Example: ENG summaryList Array containing the summary list. Array label Label of the fields. String Max. length: 50 Example: Number of people value Value. String Max. length: 50 Example: 4