XPay Payment APIs

C#PHPNodeShell

Scroll down for code samples, example requests and responses.
Select a language for code samples from the tabs or the mobile navigation menu.

createOrder

POST /api/v1/orders/hpp

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
x-plugin-namestringoptional
x-plugin-name

createOrder

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/hpp");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("x-plugin-name", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

orderobjectrequired
- amountstringrequired
  Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)
  example: 3545
- currencystringrequired
  Transaction currency. ISO 4217 alphabetic code
  
  AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAL, XAU, XBA, XBB, XBC, XBD, XCD, XCP, XDR, XFO, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW, ZWL
  example: EUR
- customFieldstringoptional
  Additional transaction description
  example: weekend promotion
- customerIdstringoptional
  Immutable identifier of the payer as registered on the ecommerce platform.
  example: mcid97295873
- customerInfoobjectoptional
  This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
  - billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
  - cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
  - cardHolderNamestringoptionalexample: Mauro Morandi
  - homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
  - merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
  - mobilePhonestringoptionalexample: 3280987654
  - mobilePhoneCountryCodestringoptionalexample: 39
  - shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
- descriptionstringoptional
  Transaction description
  example: TV LG 3423
- installmentsarrayoptional
  - amountstringoptional
    Installment amount.
    example: 350
  - datestring (date)optional
    Installment time in ISO 8601 format.
  - typestringoptional
    AUTOMATIC, MANUAL
- orderIdstringrequired
  Merchant order id, unique in the merchant domain
  example: btid2384983
- termsAndConditionsIdsarrayoptional
- transactionSummaryarrayoptional
  - languagestringoptional
    Language in ISO 639-2.
    
    ACE, ACH, ADA, ADY, AFA, AFH, AIN, AKK, ALE, ALG, ALT, ANG, ANP, APA, ARC, ARN, ARP, ART, ARW, AST, ATH, AUS, AWA, BAD, BAI, BAL, BAN, BAS, BAT, BEJ, BEM, BER, BHO, BIH, BIK, BIN, BLA, BNT, BRA, BTK, BUA, BUG, BYN, CAD, CAI, CAR, CAU, CEB, CEL, CHB, CHG, CHK, CHM, CHN, CHO, CHP, CHR, CHY, CMC, CNR, COP, CPE, CPF, CPP, CRH, CRP, CSB, CUS, DAK, DAR, DAY, DEL, DEN, DGR, DIN, DOI, DRA, DSB, DUA, DUM, DYU, EFI, EGY, EKA, ELX, ENM, EWO, FAN, FAT, FIL, FIU, FON, FRM, FRO, FRR, FRS, FUR, GAA, GAY, GBA, GEM, GEZ, GIL, GMH, GOH, GON, GOR, GOT, GRB, GRC, GSW, GWI, HAI, HAW, HIL, HIM, HIT, HMN, HSB, HUP, IBA, IJO, ILO, INC, INE, INH, IRA, IRO, JBO, JPR, JRB, KAA, KAB, KAC, KAM, KAR, KAW, KBD, KHA, KHI, KHO, KMB, KOK, KOS, KPE, KRC, KRL, KRO, KRU, KUM, KUT, LAD, LAH, LAM, LEZ, LOL, LOZ, LUA, LUI, LUN, LUO, LUS, MAD, MAG, MAI, MAK, MAN, MAP, MAS, MDF, MDR, MEN, MGA, MIC, MIN, MIS, MKH, MNC, MNI, MNO, MOH, MOS, MUL, MUN, MUS, MWL, MWR, MYN, MYV, NAH, NAI, NAP, NDS, NEW, NIA, NIC, NIU, NOG, NON, NQO, NSO, NUB, NWC, NYM, NYN, NYO, NZI, OSA, OTA, OTO, PAA, PAG, PAL, PAM, PAP, PAU, PEO, PHI, PHN, PON, PRA, PRO, QAA, QTZ, RAJ, RAP, RAR, ROA, ROM, RUP, SAD, SAH, SAI, SAL, SAM, SAS, SAT, SCN, SCO, SEL, SEM, SGA, SGN, SHN, SID, SIO, SIT, SLA, SMA, SMI, SMJ, SMN, SMS, SNK, SOG, SON, SRN, SRR, SSA, SUK, SUS, SUX, SYC, SYR, TAI, TEM, TER, TET, TIG, TIV, TKL, TLH, TLI, TMH, TOG, TPI, TSI, TUM, TUP, TUT, TVL, TYV, UDM, UGA, UMB, UND, VAI, VOT, WAK, WAL, WAR, WAS, WEN, XAL, YAO, YAP, YPK, ZAP, ZBL, ZEN, ZGH, ZND, ZUN, ZXX, ZZA, AAR, ABK, AVE, AFR, AKA, AMH, ARG, ARA, ASM, AVA, AYM, AZE, BAK, BEL, BUL, BIS, BAM, BEN, BOD, TIB, BRE, BOS, CAT, CHE, CHA, COS, CRE, CES, CZE, CHU, CHV, CYM, WEL, DAN, DEU, GER, DIV, DZO, EWE, ELL, GRE, ENG, EPO, SPA, EST, EUS, BAQ, FAS, PER, FUL, FIN, FIJ, FAO, FRA, FRE, FRY, GLE, GLA, GLG, GRN, GUJ, GLV, HAU, HEB, HIN, HMO, HRV, HAT, HUN, HYE, ARM, HER, INA, IND, ILE, IBO, III, IPK, IDO, ISL, ICE, ITA, IKU, JPN, JAV, KAT, GEO, KON, KIK, KUA, KAZ, KAL, KHM, KAN, KOR, KAU, KAS, KUR, KOM, COR, KIR, LAT, LTZ, LUG, LIM, LIN, LAO, LIT, LUB, LAV, MLG, MAH, MRI, MAO, MKD, MAC, MAL, MON, MAR, MSA, MAY, MLT, MYA, BUR, NAU, NOB, NDE, NEP, NDO, NLD, DUT, NNO, NOR, NBL, NAV, NYA, OCI, OJI, ORM, ORI, OSS, PAN, PLI, POL, PUS, POR, QUE, ROH, RUN, RON, RUM, RUS, KIN, SAN, SRD, SND, SME, SAG, SIN, SLK, SLO, SLV, SMO, SNA, SOM, SQI, ALB, SRP, SSW, SOT, SUN, SWE, SWA, TAM, TEL, TGK, THA, TIR, TUK, TGL, TSN, TON, TUR, TSO, TAT, TWI, TAH, UIG, UKR, URD, UZB, VEN, VIE, VOL, WLN, WOL, XHO, YID, YOR, ZHA, ZHO, CHI, ZUL, USA, ARB, JAP, ZHE, SVN
    example: ENG
  - summaryListarrayoptional
    labelstringoptional
    label of the field
    example: Number of people
    valuestringoptional
    value
    example: 4
- planobjectoptional
  - totalAmountstringoptional
  - contractIdstringoptional
  - planTypestringoptional
    FIXED, VARIABLE, ACQUIRER_AGREEMENT
  - statusstringoptional
    ACTIVE, INACTIVE, COMPLETED
paymentSessionobjectrequired
- actionTypestringoptional
  PAY, VERIFY, PURCHASE, PREAUTH
  example: PAY
- amountstringrequired
  Amount of the first payment which may be less or equals to the order amount. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)
  example: 3545
- cancelUrlstringrequired
  Merchant URL where the cardholder is redirected once the hosted payment is abandoned
  example: https://{merchant_cancel_url}
- captureTypestringoptional
  Overwrites the default confirmation method of the terminal, for card payments only:
  
  IMPLICIT - automatic confirmation
  
  EXPLICIT - authorization only Default value depends on the terminal configuration.
  
  Terminal set to EXPLICIT: a. if the captureType is EXPLICIT the capture will be EXPLICIT b. if the captureType is not present or null the capture will be EXPLICIT c. if the captureType is IMPLICIT the capture will be IMPLICIT
  
  Terminal set to IMPLICIT: a. if the captureType is EXPLICIT the capture will be an error b. if the captureType is not present or null the capture will be IMPLICIT c. if the captureType is IMPLICIT the capture will be IMPLICIT
  
  DEFERRED, EXPLICIT, FILE, IMPLICIT
  example: EXPLICIT
- exemptionsstringoptional
  It indicates the possible of exemption options
  
  NO_PREFERENCE - the merchant can request a payment without any preference
  
  CHALLENGE_REQUESTED - the merchant can request a payment with challenge
  
  EXEMPTION_REQUESTED - the merchant can request a payment with using Sca Exemption
  
  NO_PREFERENCE, CHALLENGE_REQUESTED, EXEMPTION_REQUESTED
  example: NO_PREFERENCE
- languagestringrequired
  Language in ISO 639-2.
  
  ACE, ACH, ADA, ADY, AFA, AFH, AIN, AKK, ALE, ALG, ALT, ANG, ANP, APA, ARC, ARN, ARP, ART, ARW, AST, ATH, AUS, AWA, BAD, BAI, BAL, BAN, BAS, BAT, BEJ, BEM, BER, BHO, BIH, BIK, BIN, BLA, BNT, BRA, BTK, BUA, BUG, BYN, CAD, CAI, CAR, CAU, CEB, CEL, CHB, CHG, CHK, CHM, CHN, CHO, CHP, CHR, CHY, CMC, CNR, COP, CPE, CPF, CPP, CRH, CRP, CSB, CUS, DAK, DAR, DAY, DEL, DEN, DGR, DIN, DOI, DRA, DSB, DUA, DUM, DYU, EFI, EGY, EKA, ELX, ENM, EWO, FAN, FAT, FIL, FIU, FON, FRM, FRO, FRR, FRS, FUR, GAA, GAY, GBA, GEM, GEZ, GIL, GMH, GOH, GON, GOR, GOT, GRB, GRC, GSW, GWI, HAI, HAW, HIL, HIM, HIT, HMN, HSB, HUP, IBA, IJO, ILO, INC, INE, INH, IRA, IRO, JBO, JPR, JRB, KAA, KAB, KAC, KAM, KAR, KAW, KBD, KHA, KHI, KHO, KMB, KOK, KOS, KPE, KRC, KRL, KRO, KRU, KUM, KUT, LAD, LAH, LAM, LEZ, LOL, LOZ, LUA, LUI, LUN, LUO, LUS, MAD, MAG, MAI, MAK, MAN, MAP, MAS, MDF, MDR, MEN, MGA, MIC, MIN, MIS, MKH, MNC, MNI, MNO, MOH, MOS, MUL, MUN, MUS, MWL, MWR, MYN, MYV, NAH, NAI, NAP, NDS, NEW, NIA, NIC, NIU, NOG, NON, NQO, NSO, NUB, NWC, NYM, NYN, NYO, NZI, OSA, OTA, OTO, PAA, PAG, PAL, PAM, PAP, PAU, PEO, PHI, PHN, PON, PRA, PRO, QAA, QTZ, RAJ, RAP, RAR, ROA, ROM, RUP, SAD, SAH, SAI, SAL, SAM, SAS, SAT, SCN, SCO, SEL, SEM, SGA, SGN, SHN, SID, SIO, SIT, SLA, SMA, SMI, SMJ, SMN, SMS, SNK, SOG, SON, SRN, SRR, SSA, SUK, SUS, SUX, SYC, SYR, TAI, TEM, TER, TET, TIG, TIV, TKL, TLH, TLI, TMH, TOG, TPI, TSI, TUM, TUP, TUT, TVL, TYV, UDM, UGA, UMB, UND, VAI, VOT, WAK, WAL, WAR, WAS, WEN, XAL, YAO, YAP, YPK, ZAP, ZBL, ZEN, ZGH, ZND, ZUN, ZXX, ZZA, AAR, ABK, AVE, AFR, AKA, AMH, ARG, ARA, ASM, AVA, AYM, AZE, BAK, BEL, BUL, BIS, BAM, BEN, BOD, TIB, BRE, BOS, CAT, CHE, CHA, COS, CRE, CES, CZE, CHU, CHV, CYM, WEL, DAN, DEU, GER, DIV, DZO, EWE, ELL, GRE, ENG, EPO, SPA, EST, EUS, BAQ, FAS, PER, FUL, FIN, FIJ, FAO, FRA, FRE, FRY, GLE, GLA, GLG, GRN, GUJ, GLV, HAU, HEB, HIN, HMO, HRV, HAT, HUN, HYE, ARM, HER, INA, IND, ILE, IBO, III, IPK, IDO, ISL, ICE, ITA, IKU, JPN, JAV, KAT, GEO, KON, KIK, KUA, KAZ, KAL, KHM, KAN, KOR, KAU, KAS, KUR, KOM, COR, KIR, LAT, LTZ, LUG, LIM, LIN, LAO, LIT, LUB, LAV, MLG, MAH, MRI, MAO, MKD, MAC, MAL, MON, MAR, MSA, MAY, MLT, MYA, BUR, NAU, NOB, NDE, NEP, NDO, NLD, DUT, NNO, NOR, NBL, NAV, NYA, OCI, OJI, ORM, ORI, OSS, PAN, PLI, POL, PUS, POR, QUE, ROH, RUN, RON, RUM, RUS, KIN, SAN, SRD, SND, SME, SAG, SIN, SLK, SLO, SLV, SMO, SNA, SOM, SQI, ALB, SRP, SSW, SOT, SUN, SWE, SWA, TAM, TEL, TGK, THA, TIR, TUK, TGL, TSN, TON, TUR, TSO, TAT, TWI, TAH, UIG, UKR, URD, UZB, VEN, VIE, VOL, WLN, WOL, XHO, YID, YOR, ZHA, ZHO, CHI, ZUL, USA, ARB, JAP, ZHE, SVN
  example: ENG
- notificationUrlstringoptional
  Merchant URL where the gateway pushes notifications
  example: https://{merchant_notification_url}
- paymentServicestringoptional
  Return the card fields in case of CARDS or an url where the cardholder should be redirect to complete the payment in case of an APM
  example: GOOGLEPAY
- recurrenceobjectoptional
  - actionstringoptional
    NO_RECURRING, CARD_SUBSTITUTION, CONTRACT_CREATION, SUBSEQUENT_PAYMENT
    example: CONTRACT_CREATION
  - contractTypestringoptional
    It indicates the possible options for the subsequent payments:
    
    CIT - the contract can be used only for subsequent payments initiated by the customer.
    
    MIT_SCHEDULED - the contract can be used for scheduled merchant initiated transactions. The number of day between one payment and another shall be equal or higher than the value of contractFrequency.
    
    MIT_UNSCHEDULED - the contract can be used for unscheduled merchant initiated transactions. The contractFrequency has no effect in this case.
    
    CIT, MIT_SCHEDULED, MIT_UNSCHEDULED
    example: CIT
  - contractExpiryDatestring (date)optional
    Used with contractType MIT_SCHEDULED. ISO 8601 format. If the token was provided by VTS or MDES, it represents the expiry date of the token provided by the circuit
  - contractFrequencystringoptional
    Mandatory when contract type is MIT_SCHEDULED Used with contractType MIT_SCHEDULED. Number of days
    example: 120
  - contractIdstringoptionalexample: C2834987
- resultUrlstringrequired
  Merchant URL where the cardholder is redirected once the hosted payment completes
  example: https://{merchant_result_url}

Request body

{
    "paymentSession": {
        "notificationUrl": "https://{merchant_notification_url}",
        "recurrence": {
            "contractType": "CIT",
            "contractFrequency": "120",
            "contractExpiryDate": "2000-01-23T00:00:00.000Z",
            "contractId": "C2834987",
            "action": "CONTRACT_CREATION"
        },
        "actionType": "PAY",
        "amount": "3545",
        "cancelUrl": "https://{merchant_cancel_url}",
        "exemptions": "NO_PREFERENCE",
        "paymentService": "GOOGLEPAY",
        "captureType": "EXPLICIT",
        "resultUrl": "https://{merchant_result_url}",
        "language": "ENG"
    },
    "order": {
        "amount": "3545",
        "termsAndConditionsIds": [
            "16dd6ac6-0791-4c72-b362-85f77f1728a2",
            "16dd6ac6-0791-4c72-b362-85f77f1728a2"
        ],
        "installments": [
            {
                "date": "2000-01-23T00:00:00.000Z",
                "amount": "350"
            },
            {
                "date": "2000-01-23T00:00:00.000Z",
                "amount": "350"
            }
        ],
        "orderId": "btid2384983",
        "customerId": "mcid97295873",
        "customerInfo": {
            "mobilePhone": "3280987654",
            "cardHolderName": "Mauro Morandi",
            "homePhone": "391231234567",
            "mobilePhoneCountryCode": 39,
            "shippingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderAcctInfo": {
                "chAccDate": "2019-02-11T00:00:00.000+0000",
                "txnActivityYear": 0,
                "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                "provisionAttemptsDay": 0,
                "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                "destinationAddressUsageIndicator": "01",
                "chAccChangeIndicator": "01",
                "nbPurchaseAccount": 0,
                "destinationNameIndicator": "01",
                "chAccPwChangeIndicator": "01",
                "paymentAccIndicator": "0",
                "chAccAgeIndicator": "01",
                "suspiciousAccActivity": "01",
                "txnActivityDay": 0
            },
            "workPhone": "391231234567",
            "billingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderEmail": "mauro.morandi@nexi.it",
            "merchantRiskIndicator": {
                "deliveryTimeframe": "01",
                "preOrderDate": "2019-02-11T00:00:00.000+0000",
                "reorderItemsIndicator": "01",
                "shipIndicator": "01",
                "giftCardAmount": {
                    "currency": "EUR",
                    "value": "100"
                },
                "deliveryEmail": "john.doe@email.com",
                "giftCardCount": 0,
                "preOrderPurchaseIndicator": "01"
            }
        },
        "description": "TV LG 3423",
        "currency": "EUR",
        "transactionSummary": [
            {
                "summaryList": [
                    {
                        "label": "Number of people",
                        "value": "4"
                    },
                    {
                        "label": "Number of people",
                        "value": "4"
                    }
                ],
                "language": "ENG"
            },
            {
                "summaryList": [
                    {
                        "label": "Number of people",
                        "value": "4"
                    },
                    {
                        "label": "Number of people",
                        "value": "4"
                    }
                ],
                "language": "ENG"
            }
        ],
        "plan": {
            "totalAmount": "totalAmount",
            "contractId": "contractId"
        },
        "customField": "weekend promotion"
    }
}

Responses

200OKoptional
- hostedPagestringoptional
- securityTokenstringoptional
- warningsarrayoptional
  - codestringoptionalexample: TRA001
  - descriptionstringoptionalexample: 3DS warning
201Createdoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "securityToken": "securityToken",
    "warnings": [
        {
            "code": "TRA001",
            "description": "3DS warning"
        },
        {
            "code": "TRA001",
            "description": "3DS warning"
        }
    ],
    "hostedPage": "hostedPage"
}

getOrdersAPI

GET /api/v1/orders

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
amountTypestringoptional
amountType
customFieldstringoptional
customField
fromTimestringoptional
fromTime
maxAmountstringoptional
maxAmount
maxRecordsinteger (int32)optional
maxRecords
minAmountstringoptional
minAmount
orderIdstringoptional
orderId
orderStatestringoptional
orderState
toTimestringoptional
toTime

getOrdersAPI

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders?amountType=SOME_STRING_VALUE&customField=SOME_STRING_VALUE&fromTime=SOME_STRING_VALUE&maxAmount=SOME_STRING_VALUE&maxRecords=SOME_INTEGER_VALUE&minAmount=SOME_STRING_VALUE&orderId=SOME_STRING_VALUE&orderState=SOME_STRING_VALUE&toTime=SOME_STRING_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200OKoptional
- ordersarrayoptional
  - authorizedAmountstringoptional
  - capturedAmountstringoptional
  - lastOperationTimestringoptional
  - lastOperationTypestringoptional
    It indicates the purpose of the request:
    
    AUTHORIZATION - any authorization with explicit capture
    
    CAPTURE - a captured authorization or an implicit captured payment
    
    REFUND - refund of a captured amount
    
    CANCEL - the rollback of an capture, refund.
    
    NOSHOW
    
    INCREMENTAL
    
    DELAY_CHARGE
    
    CARD_VERIFICATION
    
    CARD_CHECK
    
    VOID - reversal of an authorization
    
    AUTHORIZATION, CAPTURE, REFUND, CANCEL, NOSHOW, INCREMENTAL, DELAY_CHARGE, CARD_VERIFICATION, CARD_CHECK, VOID
    example: CAPTURE
  - orderobjectoptional
    amountstringrequired
    Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)
    example: 3545
    currencystringrequired
    Transaction currency. ISO 4217 alphabetic code
    
    AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAL, XAU, XBA, XBB, XBC, XBD, XCD, XCP, XDR, XFO, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW, ZWL
    example: EUR
    customFieldstringoptional
    Additional transaction description
    example: weekend promotion
    customerIdstringoptional
    Immutable identifier of the payer as registered on the ecommerce platform.
    example: mcid97295873
    customerInfoobjectoptional
    This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
    billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
    cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
    cardHolderNamestringoptionalexample: Mauro Morandi
    homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
    merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
    mobilePhonestringoptionalexample: 3280987654
    mobilePhoneCountryCodestringoptionalexample: 39
    shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
    descriptionstringoptional
    Transaction description
    example: TV LG 3423
    installmentsarrayoptional
    amountstringoptional
    Installment amount.
    example: 350
    datestring (date)optional
    Installment time in ISO 8601 format.
    typestringoptional
    AUTOMATIC, MANUAL
    orderIdstringrequired
    Merchant order id, unique in the merchant domain
    example: btid2384983
    termsAndConditionsIdsarrayoptional
    transactionSummaryarrayoptional
    languagestringoptional
    Language in ISO 639-2.
    
    ACE, ACH, ADA, ADY, AFA, AFH, AIN, AKK, ALE, ALG, ALT, ANG, ANP, APA, ARC, ARN, ARP, ART, ARW, AST, ATH, AUS, AWA, BAD, BAI, BAL, BAN, BAS, BAT, BEJ, BEM, BER, BHO, BIH, BIK, BIN, BLA, BNT, BRA, BTK, BUA, BUG, BYN, CAD, CAI, CAR, CAU, CEB, CEL, CHB, CHG, CHK, CHM, CHN, CHO, CHP, CHR, CHY, CMC, CNR, COP, CPE, CPF, CPP, CRH, CRP, CSB, CUS, DAK, DAR, DAY, DEL, DEN, DGR, DIN, DOI, DRA, DSB, DUA, DUM, DYU, EFI, EGY, EKA, ELX, ENM, EWO, FAN, FAT, FIL, FIU, FON, FRM, FRO, FRR, FRS, FUR, GAA, GAY, GBA, GEM, GEZ, GIL, GMH, GOH, GON, GOR, GOT, GRB, GRC, GSW, GWI, HAI, HAW, HIL, HIM, HIT, HMN, HSB, HUP, IBA, IJO, ILO, INC, INE, INH, IRA, IRO, JBO, JPR, JRB, KAA, KAB, KAC, KAM, KAR, KAW, KBD, KHA, KHI, KHO, KMB, KOK, KOS, KPE, KRC, KRL, KRO, KRU, KUM, KUT, LAD, LAH, LAM, LEZ, LOL, LOZ, LUA, LUI, LUN, LUO, LUS, MAD, MAG, MAI, MAK, MAN, MAP, MAS, MDF, MDR, MEN, MGA, MIC, MIN, MIS, MKH, MNC, MNI, MNO, MOH, MOS, MUL, MUN, MUS, MWL, MWR, MYN, MYV, NAH, NAI, NAP, NDS, NEW, NIA, NIC, NIU, NOG, NON, NQO, NSO, NUB, NWC, NYM, NYN, NYO, NZI, OSA, OTA, OTO, PAA, PAG, PAL, PAM, PAP, PAU, PEO, PHI, PHN, PON, PRA, PRO, QAA, QTZ, RAJ, RAP, RAR, ROA, ROM, RUP, SAD, SAH, SAI, SAL, SAM, SAS, SAT, SCN, SCO, SEL, SEM, SGA, SGN, SHN, SID, SIO, SIT, SLA, SMA, SMI, SMJ, SMN, SMS, SNK, SOG, SON, SRN, SRR, SSA, SUK, SUS, SUX, SYC, SYR, TAI, TEM, TER, TET, TIG, TIV, TKL, TLH, TLI, TMH, TOG, TPI, TSI, TUM, TUP, TUT, TVL, TYV, UDM, UGA, UMB, UND, VAI, VOT, WAK, WAL, WAR, WAS, WEN, XAL, YAO, YAP, YPK, ZAP, ZBL, ZEN, ZGH, ZND, ZUN, ZXX, ZZA, AAR, ABK, AVE, AFR, AKA, AMH, ARG, ARA, ASM, AVA, AYM, AZE, BAK, BEL, BUL, BIS, BAM, BEN, BOD, TIB, BRE, BOS, CAT, CHE, CHA, COS, CRE, CES, CZE, CHU, CHV, CYM, WEL, DAN, DEU, GER, DIV, DZO, EWE, ELL, GRE, ENG, EPO, SPA, EST, EUS, BAQ, FAS, PER, FUL, FIN, FIJ, FAO, FRA, FRE, FRY, GLE, GLA, GLG, GRN, GUJ, GLV, HAU, HEB, HIN, HMO, HRV, HAT, HUN, HYE, ARM, HER, INA, IND, ILE, IBO, III, IPK, IDO, ISL, ICE, ITA, IKU, JPN, JAV, KAT, GEO, KON, KIK, KUA, KAZ, KAL, KHM, KAN, KOR, KAU, KAS, KUR, KOM, COR, KIR, LAT, LTZ, LUG, LIM, LIN, LAO, LIT, LUB, LAV, MLG, MAH, MRI, MAO, MKD, MAC, MAL, MON, MAR, MSA, MAY, MLT, MYA, BUR, NAU, NOB, NDE, NEP, NDO, NLD, DUT, NNO, NOR, NBL, NAV, NYA, OCI, OJI, ORM, ORI, OSS, PAN, PLI, POL, PUS, POR, QUE, ROH, RUN, RON, RUM, RUS, KIN, SAN, SRD, SND, SME, SAG, SIN, SLK, SLO, SLV, SMO, SNA, SOM, SQI, ALB, SRP, SSW, SOT, SUN, SWE, SWA, TAM, TEL, TGK, THA, TIR, TUK, TGL, TSN, TON, TUR, TSO, TAT, TWI, TAH, UIG, UKR, URD, UZB, VEN, VIE, VOL, WLN, WOL, XHO, YID, YOR, ZHA, ZHO, CHI, ZUL, USA, ARB, JAP, ZHE, SVN
    example: ENG
    summaryListarrayoptional
    labelstringoptional
    label of the field
    example: Number of people
    valuestringoptional
    value
    example: 4
    planobjectoptional
    totalAmountstringoptional
    contractIdstringoptional
    planTypestringoptional
    FIXED, VARIABLE, ACQUIRER_AGREEMENT
    statusstringoptional
    ACTIVE, INACTIVE, COMPLETED
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "orders": [
        {
            "lastOperationType": "CAPTURE",
            "capturedAmount": "capturedAmount",
            "authorizedAmount": "authorizedAmount",
            "lastOperationTime": "lastOperationTime",
            "order": {
                "amount": "3545",
                "termsAndConditionsIds": [
                    "16dd6ac6-0791-4c72-b362-85f77f1728a2",
                    "16dd6ac6-0791-4c72-b362-85f77f1728a2"
                ],
                "installments": [
                    {
                        "date": "2000-01-23T00:00:00.000Z",
                        "amount": "350"
                    },
                    {
                        "date": "2000-01-23T00:00:00.000Z",
                        "amount": "350"
                    }
                ],
                "orderId": "btid2384983",
                "customerId": "mcid97295873",
                "customerInfo": {
                    "mobilePhone": "3280987654",
                    "cardHolderName": "Mauro Morandi",
                    "homePhone": "391231234567",
                    "mobilePhoneCountryCode": 39,
                    "shippingAddress": {
                        "country": "ITA",
                        "province": "BO",
                        "city": "Bologna",
                        "street": "Piazza Maggiore, 1",
                        "additionalInfo": "Quinto Piano, Scala B",
                        "name": "Mario Rossi",
                        "postCode": "40124"
                    },
                    "cardHolderAcctInfo": {
                        "chAccDate": "2019-02-11T00:00:00.000+0000",
                        "txnActivityYear": 0,
                        "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                        "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                        "provisionAttemptsDay": 0,
                        "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                        "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                        "destinationAddressUsageIndicator": "01",
                        "chAccChangeIndicator": "01",
                        "nbPurchaseAccount": 0,
                        "destinationNameIndicator": "01",
                        "chAccPwChangeIndicator": "01",
                        "paymentAccIndicator": "0",
                        "chAccAgeIndicator": "01",
                        "suspiciousAccActivity": "01",
                        "txnActivityDay": 0
                    },
                    "workPhone": "391231234567",
                    "billingAddress": {
                        "country": "ITA",
                        "province": "BO",
                        "city": "Bologna",
                        "street": "Piazza Maggiore, 1",
                        "additionalInfo": "Quinto Piano, Scala B",
                        "name": "Mario Rossi",
                        "postCode": "40124"
                    },
                    "cardHolderEmail": "mauro.morandi@nexi.it",
                    "merchantRiskIndicator": {
                        "deliveryTimeframe": "01",
                        "preOrderDate": "2019-02-11T00:00:00.000+0000",
                        "reorderItemsIndicator": "01",
                        "shipIndicator": "01",
                        "giftCardAmount": {
                            "currency": "EUR",
                            "value": "100"
                        },
                        "deliveryEmail": "john.doe@email.com",
                        "giftCardCount": 0,
                        "preOrderPurchaseIndicator": "01"
                    }
                },
                "description": "TV LG 3423",
                "currency": "EUR",
                "transactionSummary": [
                    {
                        "summaryList": [
                            {
                                "label": "Number of people",
                                "value": "4"
                            },
                            {
                                "label": "Number of people",
                                "value": "4"
                            }
                        ],
                        "language": "ENG"
                    },
                    {
                        "summaryList": [
                            {
                                "label": "Number of people",
                                "value": "4"
                            },
                            {
                                "label": "Number of people",
                                "value": "4"
                            }
                        ],
                        "language": "ENG"
                    }
                ],
                "plan": {
                    "totalAmount": "totalAmount",
                    "contractId": "contractId"
                },
                "customField": "weekend promotion"
            }
        },
        {
            "lastOperationType": "CAPTURE",
            "capturedAmount": "capturedAmount",
            "authorizedAmount": "authorizedAmount",
            "lastOperationTime": "lastOperationTime",
            "order": {
                "amount": "3545",
                "termsAndConditionsIds": [
                    "16dd6ac6-0791-4c72-b362-85f77f1728a2",
                    "16dd6ac6-0791-4c72-b362-85f77f1728a2"
                ],
                "installments": [
                    {
                        "date": "2000-01-23T00:00:00.000Z",
                        "amount": "350"
                    },
                    {
                        "date": "2000-01-23T00:00:00.000Z",
                        "amount": "350"
                    }
                ],
                "orderId": "btid2384983",
                "customerId": "mcid97295873",
                "customerInfo": {
                    "mobilePhone": "3280987654",
                    "cardHolderName": "Mauro Morandi",
                    "homePhone": "391231234567",
                    "mobilePhoneCountryCode": 39,
                    "shippingAddress": {
                        "country": "ITA",
                        "province": "BO",
                        "city": "Bologna",
                        "street": "Piazza Maggiore, 1",
                        "additionalInfo": "Quinto Piano, Scala B",
                        "name": "Mario Rossi",
                        "postCode": "40124"
                    },
                    "cardHolderAcctInfo": {
                        "chAccDate": "2019-02-11T00:00:00.000+0000",
                        "txnActivityYear": 0,
                        "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                        "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                        "provisionAttemptsDay": 0,
                        "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                        "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                        "destinationAddressUsageIndicator": "01",
                        "chAccChangeIndicator": "01",
                        "nbPurchaseAccount": 0,
                        "destinationNameIndicator": "01",
                        "chAccPwChangeIndicator": "01",
                        "paymentAccIndicator": "0",
                        "chAccAgeIndicator": "01",
                        "suspiciousAccActivity": "01",
                        "txnActivityDay": 0
                    },
                    "workPhone": "391231234567",
                    "billingAddress": {
                        "country": "ITA",
                        "province": "BO",
                        "city": "Bologna",
                        "street": "Piazza Maggiore, 1",
                        "additionalInfo": "Quinto Piano, Scala B",
                        "name": "Mario Rossi",
                        "postCode": "40124"
                    },
                    "cardHolderEmail": "mauro.morandi@nexi.it",
                    "merchantRiskIndicator": {
                        "deliveryTimeframe": "01",
                        "preOrderDate": "2019-02-11T00:00:00.000+0000",
                        "reorderItemsIndicator": "01",
                        "shipIndicator": "01",
                        "giftCardAmount": {
                            "currency": "EUR",
                            "value": "100"
                        },
                        "deliveryEmail": "john.doe@email.com",
                        "giftCardCount": 0,
                        "preOrderPurchaseIndicator": "01"
                    }
                },
                "description": "TV LG 3423",
                "currency": "EUR",
                "transactionSummary": [
                    {
                        "summaryList": [
                            {
                                "label": "Number of people",
                                "value": "4"
                            },
                            {
                                "label": "Number of people",
                                "value": "4"
                            }
                        ],
                        "language": "ENG"
                    },
                    {
                        "summaryList": [
                            {
                                "label": "Number of people",
                                "value": "4"
                            },
                            {
                                "label": "Number of people",
                                "value": "4"
                            }
                        ],
                        "language": "ENG"
                    }
                ],
                "plan": {
                    "totalAmount": "totalAmount",
                    "contractId": "contractId"
                },
                "customField": "weekend promotion"
            }
        }
    ]
}

getOrderById

GET /api/v1/orders/{orderId}

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
orderIdstringrequired
orderId

getOrderById

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/{orderId}");
var request = new RestRequest(Method.GET);
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200OKoptional
- operationsarrayoptional
  - additionalDataobjectoptional
    Map of additional fields specific to the chosen payment method
  - cancelledOperationIdstringoptional
    Operation id to be undone
  - channelstringoptional
    It indicates the originating channel:
    
    ECOMMERCE - carholder initiated operation through an online channel.
    
    POS - carholder initiated operation through a physical POS.
    
    BACKOFFICE - merchant initiated operation. It includes post operations and MIT.
    
    ECOMMERCE, POS, BACKOFFICE
    example: ECOMMERCE
  - customerInfoobjectoptional
    This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
    billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
    cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
    cardHolderNamestringoptionalexample: Mauro Morandi
    homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
    merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
    mobilePhonestringoptionalexample: 3280987654
    mobilePhoneCountryCodestringoptionalexample: 39
    shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
  - omnichannelIdstringoptional
  - operationAmountstringoptional
    Operation amount in the payment currency
    example: 3545
  - operationCurrencystringoptional
    Payment currency
    example: EUR
  - operationIdstringoptionalexample: 3470744
  - operationResultstringoptional
    Transaction output:
    
    AUTHORIZED - Payment authorized
    
    EXECUTED - Payment confirmed, verification successfully executed
    
    DECLINED - Declined by the Issuer during the authorization phase
    
    DENIED_BY_RISK - Negative outcome of the transaction risk analysis
    
    DENIED
    
    THREEDS_VALIDATED - 3DS authentication OK or 3DS skipped (non-secure payment)
    
    THREEDS_FAILED - cancellation or authentication failure during 3DS
    
    PENDING - Payment ongoing. Follow up notifications are expected
    
    CANCELED - Canceled by the cardholder
    
    VOIDED - Online reversal of the full authorized amount
    
    REFUNDED - Full or partial amount refunded
    
    FAILED - Payment failed due to technical reasons
    
    AUTHORIZED, EXECUTED, DECLINED, DENIED_BY_RISK, DENIED, THREEDS_VALIDATED, THREEDS_FAILED, PENDING, CANCELED, VOIDED, REFUNDED, FAILED
    example: AUTHORIZED
  - operationTimestring (date-time)optional
    Operation time in ISO 8601 format
  - operationTypestringoptional
    It indicates the purpose of the request:
    
    AUTHORIZATION - any authorization with explicit capture
    
    CAPTURE - a captured authorization or an implicit captured payment
    
    REFUND - refund of a captured amount
    
    CANCEL - the rollback of an capture, refund.
    
    NOSHOW
    
    INCREMENTAL
    
    DELAY_CHARGE
    
    CARD_VERIFICATION
    
    CARD_CHECK
    
    VOID - reversal of an authorization
    
    AUTHORIZATION, CAPTURE, REFUND, CANCEL, NOSHOW, INCREMENTAL, DELAY_CHARGE, CARD_VERIFICATION, CARD_CHECK, VOID
    example: CAPTURE
  - orderIdstringoptional
    Merchant order id, unique in the merchant domain
    example: btid2384983
  - paymentCircuitstringoptional
    One of the payment circuit values returned by the GET payment_methods web service. The list may include (but not limited to) VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY.
    example: VISA
  - paymentEndToEndIdstringoptional
    It is defined by the circuit to uniquely identify the transaction. Required for circuid reconciliation purposes.
    example: e723hedsdew
  - paymentInstrumentInfostringoptional
    Payment instrument information
    example: ***6152
  - paymentLinkIdstringoptional
    PayByLink id used for correlating this operation with the original link.
    example: 234244353
  - paymentMethodstringoptional
    
    CARD - Any card circuit
    
    APM - Alternative payment method
    
    CARD, APM
    example: CARD
  - warningsarrayoptional
    codestringoptionalexample: TRA001
    descriptionstringoptionalexample: 3DS warning
- orderStatusobjectoptional
  - authorizedAmountstringoptional
  - capturedAmountstringoptional
  - lastOperationTimestringoptional
  - lastOperationTypestringoptional
    It indicates the purpose of the request:
    
    AUTHORIZATION - any authorization with explicit capture
    
    CAPTURE - a captured authorization or an implicit captured payment
    
    REFUND - refund of a captured amount
    
    CANCEL - the rollback of an capture, refund.
    
    NOSHOW
    
    INCREMENTAL
    
    DELAY_CHARGE
    
    CARD_VERIFICATION
    
    CARD_CHECK
    
    VOID - reversal of an authorization
    
    AUTHORIZATION, CAPTURE, REFUND, CANCEL, NOSHOW, INCREMENTAL, DELAY_CHARGE, CARD_VERIFICATION, CARD_CHECK, VOID
    example: CAPTURE
  - orderobjectoptional
    amountstringrequired
    Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)
    example: 3545
    currencystringrequired
    Transaction currency. ISO 4217 alphabetic code
    
    AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAL, XAU, XBA, XBB, XBC, XBD, XCD, XCP, XDR, XFO, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW, ZWL
    example: EUR
    customFieldstringoptional
    Additional transaction description
    example: weekend promotion
    customerIdstringoptional
    Immutable identifier of the payer as registered on the ecommerce platform.
    example: mcid97295873
    customerInfoobjectoptional
    This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
    billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
    cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
    cardHolderNamestringoptionalexample: Mauro Morandi
    homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
    merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
    mobilePhonestringoptionalexample: 3280987654
    mobilePhoneCountryCodestringoptionalexample: 39
    shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
    descriptionstringoptional
    Transaction description
    example: TV LG 3423
    installmentsarrayoptional
    amountstringoptional
    Installment amount.
    example: 350
    datestring (date)optional
    Installment time in ISO 8601 format.
    typestringoptional
    AUTOMATIC, MANUAL
    orderIdstringrequired
    Merchant order id, unique in the merchant domain
    example: btid2384983
    termsAndConditionsIdsarrayoptional
    transactionSummaryarrayoptional
    languagestringoptional
    Language in ISO 639-2.
    
    ACE, ACH, ADA, ADY, AFA, AFH, AIN, AKK, ALE, ALG, ALT, ANG, ANP, APA, ARC, ARN, ARP, ART, ARW, AST, ATH, AUS, AWA, BAD, BAI, BAL, BAN, BAS, BAT, BEJ, BEM, BER, BHO, BIH, BIK, BIN, BLA, BNT, BRA, BTK, BUA, BUG, BYN, CAD, CAI, CAR, CAU, CEB, CEL, CHB, CHG, CHK, CHM, CHN, CHO, CHP, CHR, CHY, CMC, CNR, COP, CPE, CPF, CPP, CRH, CRP, CSB, CUS, DAK, DAR, DAY, DEL, DEN, DGR, DIN, DOI, DRA, DSB, DUA, DUM, DYU, EFI, EGY, EKA, ELX, ENM, EWO, FAN, FAT, FIL, FIU, FON, FRM, FRO, FRR, FRS, FUR, GAA, GAY, GBA, GEM, GEZ, GIL, GMH, GOH, GON, GOR, GOT, GRB, GRC, GSW, GWI, HAI, HAW, HIL, HIM, HIT, HMN, HSB, HUP, IBA, IJO, ILO, INC, INE, INH, IRA, IRO, JBO, JPR, JRB, KAA, KAB, KAC, KAM, KAR, KAW, KBD, KHA, KHI, KHO, KMB, KOK, KOS, KPE, KRC, KRL, KRO, KRU, KUM, KUT, LAD, LAH, LAM, LEZ, LOL, LOZ, LUA, LUI, LUN, LUO, LUS, MAD, MAG, MAI, MAK, MAN, MAP, MAS, MDF, MDR, MEN, MGA, MIC, MIN, MIS, MKH, MNC, MNI, MNO, MOH, MOS, MUL, MUN, MUS, MWL, MWR, MYN, MYV, NAH, NAI, NAP, NDS, NEW, NIA, NIC, NIU, NOG, NON, NQO, NSO, NUB, NWC, NYM, NYN, NYO, NZI, OSA, OTA, OTO, PAA, PAG, PAL, PAM, PAP, PAU, PEO, PHI, PHN, PON, PRA, PRO, QAA, QTZ, RAJ, RAP, RAR, ROA, ROM, RUP, SAD, SAH, SAI, SAL, SAM, SAS, SAT, SCN, SCO, SEL, SEM, SGA, SGN, SHN, SID, SIO, SIT, SLA, SMA, SMI, SMJ, SMN, SMS, SNK, SOG, SON, SRN, SRR, SSA, SUK, SUS, SUX, SYC, SYR, TAI, TEM, TER, TET, TIG, TIV, TKL, TLH, TLI, TMH, TOG, TPI, TSI, TUM, TUP, TUT, TVL, TYV, UDM, UGA, UMB, UND, VAI, VOT, WAK, WAL, WAR, WAS, WEN, XAL, YAO, YAP, YPK, ZAP, ZBL, ZEN, ZGH, ZND, ZUN, ZXX, ZZA, AAR, ABK, AVE, AFR, AKA, AMH, ARG, ARA, ASM, AVA, AYM, AZE, BAK, BEL, BUL, BIS, BAM, BEN, BOD, TIB, BRE, BOS, CAT, CHE, CHA, COS, CRE, CES, CZE, CHU, CHV, CYM, WEL, DAN, DEU, GER, DIV, DZO, EWE, ELL, GRE, ENG, EPO, SPA, EST, EUS, BAQ, FAS, PER, FUL, FIN, FIJ, FAO, FRA, FRE, FRY, GLE, GLA, GLG, GRN, GUJ, GLV, HAU, HEB, HIN, HMO, HRV, HAT, HUN, HYE, ARM, HER, INA, IND, ILE, IBO, III, IPK, IDO, ISL, ICE, ITA, IKU, JPN, JAV, KAT, GEO, KON, KIK, KUA, KAZ, KAL, KHM, KAN, KOR, KAU, KAS, KUR, KOM, COR, KIR, LAT, LTZ, LUG, LIM, LIN, LAO, LIT, LUB, LAV, MLG, MAH, MRI, MAO, MKD, MAC, MAL, MON, MAR, MSA, MAY, MLT, MYA, BUR, NAU, NOB, NDE, NEP, NDO, NLD, DUT, NNO, NOR, NBL, NAV, NYA, OCI, OJI, ORM, ORI, OSS, PAN, PLI, POL, PUS, POR, QUE, ROH, RUN, RON, RUM, RUS, KIN, SAN, SRD, SND, SME, SAG, SIN, SLK, SLO, SLV, SMO, SNA, SOM, SQI, ALB, SRP, SSW, SOT, SUN, SWE, SWA, TAM, TEL, TGK, THA, TIR, TUK, TGL, TSN, TON, TUR, TSO, TAT, TWI, TAH, UIG, UKR, URD, UZB, VEN, VIE, VOL, WLN, WOL, XHO, YID, YOR, ZHA, ZHO, CHI, ZUL, USA, ARB, JAP, ZHE, SVN
    example: ENG
    summaryListarrayoptional
    labelstringoptional
    label of the field
    example: Number of people
    valuestringoptional
    value
    example: 4
    planobjectoptional
    totalAmountstringoptional
    contractIdstringoptional
    planTypestringoptional
    FIXED, VARIABLE, ACQUIRER_AGREEMENT
    statusstringoptional
    ACTIVE, INACTIVE, COMPLETED
- paymentLinkarrayoptional
  - amountstringoptional
  - expirationDatestringoptional
  - linkstringoptional
  - linkIdstringoptional
  - paidByOperationIdstringoptional
  - statusstringoptional
    ACTIVE, DELETED, EXPIRED, INACTIVE
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "operations": [
        {
            "paymentLinkId": "234244353",
            "orderId": "btid2384983",
            "warnings": [
                {
                    "code": "TRA001",
                    "description": "3DS warning"
                },
                {
                    "code": "TRA001",
                    "description": "3DS warning"
                }
            ],
            "channel": "ECOMMERCE",
            "customerInfo": {
                "mobilePhone": "3280987654",
                "cardHolderName": "Mauro Morandi",
                "homePhone": "391231234567",
                "mobilePhoneCountryCode": 39,
                "shippingAddress": {
                    "country": "ITA",
                    "province": "BO",
                    "city": "Bologna",
                    "street": "Piazza Maggiore, 1",
                    "additionalInfo": "Quinto Piano, Scala B",
                    "name": "Mario Rossi",
                    "postCode": "40124"
                },
                "cardHolderAcctInfo": {
                    "chAccDate": "2019-02-11T00:00:00.000+0000",
                    "txnActivityYear": 0,
                    "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                    "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                    "provisionAttemptsDay": 0,
                    "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                    "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                    "destinationAddressUsageIndicator": "01",
                    "chAccChangeIndicator": "01",
                    "nbPurchaseAccount": 0,
                    "destinationNameIndicator": "01",
                    "chAccPwChangeIndicator": "01",
                    "paymentAccIndicator": "0",
                    "chAccAgeIndicator": "01",
                    "suspiciousAccActivity": "01",
                    "txnActivityDay": 0
                },
                "workPhone": "391231234567",
                "billingAddress": {
                    "country": "ITA",
                    "province": "BO",
                    "city": "Bologna",
                    "street": "Piazza Maggiore, 1",
                    "additionalInfo": "Quinto Piano, Scala B",
                    "name": "Mario Rossi",
                    "postCode": "40124"
                },
                "cardHolderEmail": "mauro.morandi@nexi.it",
                "merchantRiskIndicator": {
                    "deliveryTimeframe": "01",
                    "preOrderDate": "2019-02-11T00:00:00.000+0000",
                    "reorderItemsIndicator": "01",
                    "shipIndicator": "01",
                    "giftCardAmount": {
                        "currency": "EUR",
                        "value": "100"
                    },
                    "deliveryEmail": "john.doe@email.com",
                    "giftCardCount": 0,
                    "preOrderPurchaseIndicator": "01"
                }
            },
            "operationTime": "2000-01-23T04:56:07.000Z",
            "paymentCircuit": "VISA",
            "omnichannelId": "omnichannelId",
            "operationAmount": "3545",
            "operationId": "3470744",
            "paymentEndToEndId": "e723hedsdew",
            "paymentMethod": "CARD",
            "operationType": "CAPTURE",
            "additionalData": {
                "authorizationCode": "647189",
                "cardCountry": "ITA",
                "threeDS": "FULL_SECURE",
                "schemaTID": "MCS01198U",
                "multiCurrencyConversion": {
                    "amount": "2662",
                    "currency": "JPY",
                    "exchangeRate": "0.007510523"
                }
            },
            "operationCurrency": "EUR",
            "paymentInstrumentInfo": "***6152",
            "cancelledOperationId": "",
            "operationResult": "AUTHORIZED"
        },
        {
            "paymentLinkId": "234244353",
            "orderId": "btid2384983",
            "warnings": [
                {
                    "code": "TRA001",
                    "description": "3DS warning"
                },
                {
                    "code": "TRA001",
                    "description": "3DS warning"
                }
            ],
            "channel": "ECOMMERCE",
            "customerInfo": {
                "mobilePhone": "3280987654",
                "cardHolderName": "Mauro Morandi",
                "homePhone": "391231234567",
                "mobilePhoneCountryCode": 39,
                "shippingAddress": {
                    "country": "ITA",
                    "province": "BO",
                    "city": "Bologna",
                    "street": "Piazza Maggiore, 1",
                    "additionalInfo": "Quinto Piano, Scala B",
                    "name": "Mario Rossi",
                    "postCode": "40124"
                },
                "cardHolderAcctInfo": {
                    "chAccDate": "2019-02-11T00:00:00.000+0000",
                    "txnActivityYear": 0,
                    "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                    "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                    "provisionAttemptsDay": 0,
                    "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                    "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                    "destinationAddressUsageIndicator": "01",
                    "chAccChangeIndicator": "01",
                    "nbPurchaseAccount": 0,
                    "destinationNameIndicator": "01",
                    "chAccPwChangeIndicator": "01",
                    "paymentAccIndicator": "0",
                    "chAccAgeIndicator": "01",
                    "suspiciousAccActivity": "01",
                    "txnActivityDay": 0
                },
                "workPhone": "391231234567",
                "billingAddress": {
                    "country": "ITA",
                    "province": "BO",
                    "city": "Bologna",
                    "street": "Piazza Maggiore, 1",
                    "additionalInfo": "Quinto Piano, Scala B",
                    "name": "Mario Rossi",
                    "postCode": "40124"
                },
                "cardHolderEmail": "mauro.morandi@nexi.it",
                "merchantRiskIndicator": {
                    "deliveryTimeframe": "01",
                    "preOrderDate": "2019-02-11T00:00:00.000+0000",
                    "reorderItemsIndicator": "01",
                    "shipIndicator": "01",
                    "giftCardAmount": {
                        "currency": "EUR",
                        "value": "100"
                    },
                    "deliveryEmail": "john.doe@email.com",
                    "giftCardCount": 0,
                    "preOrderPurchaseIndicator": "01"
                }
            },
            "operationTime": "2000-01-23T04:56:07.000Z",
            "paymentCircuit": "VISA",
            "omnichannelId": "omnichannelId",
            "operationAmount": "3545",
            "operationId": "3470744",
            "paymentEndToEndId": "e723hedsdew",
            "paymentMethod": "CARD",
            "operationType": "CAPTURE",
            "additionalData": {
                "authorizationCode": "647189",
                "cardCountry": "ITA",
                "threeDS": "FULL_SECURE",
                "schemaTID": "MCS01198U",
                "multiCurrencyConversion": {
                    "amount": "2662",
                    "currency": "JPY",
                    "exchangeRate": "0.007510523"
                }
            },
            "operationCurrency": "EUR",
            "paymentInstrumentInfo": "***6152",
            "cancelledOperationId": "",
            "operationResult": "AUTHORIZED"
        }
    ],
    "orderStatus": {
        "lastOperationType": "CAPTURE",
        "capturedAmount": "capturedAmount",
        "authorizedAmount": "authorizedAmount",
        "lastOperationTime": "lastOperationTime",
        "order": {
            "amount": "3545",
            "termsAndConditionsIds": [
                "16dd6ac6-0791-4c72-b362-85f77f1728a2",
                "16dd6ac6-0791-4c72-b362-85f77f1728a2"
            ],
            "installments": [
                {
                    "date": "2000-01-23T00:00:00.000Z",
                    "amount": "350"
                },
                {
                    "date": "2000-01-23T00:00:00.000Z",
                    "amount": "350"
                }
            ],
            "orderId": "btid2384983",
            "customerId": "mcid97295873",
            "customerInfo": {
                "mobilePhone": "3280987654",
                "cardHolderName": "Mauro Morandi",
                "homePhone": "391231234567",
                "mobilePhoneCountryCode": 39,
                "shippingAddress": {
                    "country": "ITA",
                    "province": "BO",
                    "city": "Bologna",
                    "street": "Piazza Maggiore, 1",
                    "additionalInfo": "Quinto Piano, Scala B",
                    "name": "Mario Rossi",
                    "postCode": "40124"
                },
                "cardHolderAcctInfo": {
                    "chAccDate": "2019-02-11T00:00:00.000+0000",
                    "txnActivityYear": 0,
                    "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                    "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                    "provisionAttemptsDay": 0,
                    "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                    "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                    "destinationAddressUsageIndicator": "01",
                    "chAccChangeIndicator": "01",
                    "nbPurchaseAccount": 0,
                    "destinationNameIndicator": "01",
                    "chAccPwChangeIndicator": "01",
                    "paymentAccIndicator": "0",
                    "chAccAgeIndicator": "01",
                    "suspiciousAccActivity": "01",
                    "txnActivityDay": 0
                },
                "workPhone": "391231234567",
                "billingAddress": {
                    "country": "ITA",
                    "province": "BO",
                    "city": "Bologna",
                    "street": "Piazza Maggiore, 1",
                    "additionalInfo": "Quinto Piano, Scala B",
                    "name": "Mario Rossi",
                    "postCode": "40124"
                },
                "cardHolderEmail": "mauro.morandi@nexi.it",
                "merchantRiskIndicator": {
                    "deliveryTimeframe": "01",
                    "preOrderDate": "2019-02-11T00:00:00.000+0000",
                    "reorderItemsIndicator": "01",
                    "shipIndicator": "01",
                    "giftCardAmount": {
                        "currency": "EUR",
                        "value": "100"
                    },
                    "deliveryEmail": "john.doe@email.com",
                    "giftCardCount": 0,
                    "preOrderPurchaseIndicator": "01"
                }
            },
            "description": "TV LG 3423",
            "currency": "EUR",
            "transactionSummary": [
                {
                    "summaryList": [
                        {
                            "label": "Number of people",
                            "value": "4"
                        },
                        {
                            "label": "Number of people",
                            "value": "4"
                        }
                    ],
                    "language": "ENG"
                },
                {
                    "summaryList": [
                        {
                            "label": "Number of people",
                            "value": "4"
                        },
                        {
                            "label": "Number of people",
                            "value": "4"
                        }
                    ],
                    "language": "ENG"
                }
            ],
            "plan": {
                "totalAmount": "totalAmount",
                "contractId": "contractId"
            },
            "customField": "weekend promotion"
        }
    },
    "paymentLink": [
        {
            "amount": "amount",
            "linkId": "linkId",
            "paidByOperationId": "paidByOperationId",
            "link": "link",
            "expirationDate": "expirationDate"
        },
        {
            "amount": "amount",
            "linkId": "linkId",
            "paidByOperationId": "paidByOperationId",
            "link": "link",
            "expirationDate": "expirationDate"
        }
    ]
}

getOperationById

GET /api/v1/operations/{operationId}

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
operationIdstringrequired
operationId

getOperationById

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/operations/{operationId}");
var request = new RestRequest(Method.GET);
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200OKoptional
- additionalDataobjectoptional
  Map of additional fields specific to the chosen payment method
- cancelledOperationIdstringoptional
  Operation id to be undone
- channelstringoptional
  It indicates the originating channel:
  
  ECOMMERCE - carholder initiated operation through an online channel.
  
  POS - carholder initiated operation through a physical POS.
  
  BACKOFFICE - merchant initiated operation. It includes post operations and MIT.
  
  ECOMMERCE, POS, BACKOFFICE
  example: ECOMMERCE
- customerInfoobjectoptional
  This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
  - billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
  - cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
  - cardHolderNamestringoptionalexample: Mauro Morandi
  - homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
  - merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
  - mobilePhonestringoptionalexample: 3280987654
  - mobilePhoneCountryCodestringoptionalexample: 39
  - shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
- omnichannelIdstringoptional
- operationAmountstringoptional
  Operation amount in the payment currency
  example: 3545
- operationCurrencystringoptional
  Payment currency
  example: EUR
- operationIdstringoptionalexample: 3470744
- operationResultstringoptional
  Transaction output:
  
  AUTHORIZED - Payment authorized
  
  EXECUTED - Payment confirmed, verification successfully executed
  
  DECLINED - Declined by the Issuer during the authorization phase
  
  DENIED_BY_RISK - Negative outcome of the transaction risk analysis
  
  DENIED
  
  THREEDS_VALIDATED - 3DS authentication OK or 3DS skipped (non-secure payment)
  
  THREEDS_FAILED - cancellation or authentication failure during 3DS
  
  PENDING - Payment ongoing. Follow up notifications are expected
  
  CANCELED - Canceled by the cardholder
  
  VOIDED - Online reversal of the full authorized amount
  
  REFUNDED - Full or partial amount refunded
  
  FAILED - Payment failed due to technical reasons
  
  AUTHORIZED, EXECUTED, DECLINED, DENIED_BY_RISK, DENIED, THREEDS_VALIDATED, THREEDS_FAILED, PENDING, CANCELED, VOIDED, REFUNDED, FAILED
  example: AUTHORIZED
- operationTimestring (date-time)optional
  Operation time in ISO 8601 format
- operationTypestringoptional
  It indicates the purpose of the request:
  
  AUTHORIZATION - any authorization with explicit capture
  
  CAPTURE - a captured authorization or an implicit captured payment
  
  REFUND - refund of a captured amount
  
  CANCEL - the rollback of an capture, refund.
  
  NOSHOW
  
  INCREMENTAL
  
  DELAY_CHARGE
  
  CARD_VERIFICATION
  
  CARD_CHECK
  
  VOID - reversal of an authorization
  
  AUTHORIZATION, CAPTURE, REFUND, CANCEL, NOSHOW, INCREMENTAL, DELAY_CHARGE, CARD_VERIFICATION, CARD_CHECK, VOID
  example: CAPTURE
- orderIdstringoptional
  Merchant order id, unique in the merchant domain
  example: btid2384983
- paymentCircuitstringoptional
  One of the payment circuit values returned by the GET payment_methods web service. The list may include (but not limited to) VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY.
  example: VISA
- paymentEndToEndIdstringoptional
  It is defined by the circuit to uniquely identify the transaction. Required for circuid reconciliation purposes.
  example: e723hedsdew
- paymentInstrumentInfostringoptional
  Payment instrument information
  example: ***6152
- paymentLinkIdstringoptional
  PayByLink id used for correlating this operation with the original link.
  example: 234244353
- paymentMethodstringoptional
  
  CARD - Any card circuit
  
  APM - Alternative payment method
  
  CARD, APM
  example: CARD
- warningsarrayoptional
  - codestringoptionalexample: TRA001
  - descriptionstringoptionalexample: 3DS warning
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "paymentLinkId": "234244353",
    "orderId": "btid2384983",
    "warnings": [
        {
            "code": "TRA001",
            "description": "3DS warning"
        },
        {
            "code": "TRA001",
            "description": "3DS warning"
        }
    ],
    "channel": "ECOMMERCE",
    "customerInfo": {
        "mobilePhone": "3280987654",
        "cardHolderName": "Mauro Morandi",
        "homePhone": "391231234567",
        "mobilePhoneCountryCode": 39,
        "shippingAddress": {
            "country": "ITA",
            "province": "BO",
            "city": "Bologna",
            "street": "Piazza Maggiore, 1",
            "additionalInfo": "Quinto Piano, Scala B",
            "name": "Mario Rossi",
            "postCode": "40124"
        },
        "cardHolderAcctInfo": {
            "chAccDate": "2019-02-11T00:00:00.000+0000",
            "txnActivityYear": 0,
            "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
            "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
            "provisionAttemptsDay": 0,
            "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
            "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
            "destinationAddressUsageIndicator": "01",
            "chAccChangeIndicator": "01",
            "nbPurchaseAccount": 0,
            "destinationNameIndicator": "01",
            "chAccPwChangeIndicator": "01",
            "paymentAccIndicator": "0",
            "chAccAgeIndicator": "01",
            "suspiciousAccActivity": "01",
            "txnActivityDay": 0
        },
        "workPhone": "391231234567",
        "billingAddress": {
            "country": "ITA",
            "province": "BO",
            "city": "Bologna",
            "street": "Piazza Maggiore, 1",
            "additionalInfo": "Quinto Piano, Scala B",
            "name": "Mario Rossi",
            "postCode": "40124"
        },
        "cardHolderEmail": "mauro.morandi@nexi.it",
        "merchantRiskIndicator": {
            "deliveryTimeframe": "01",
            "preOrderDate": "2019-02-11T00:00:00.000+0000",
            "reorderItemsIndicator": "01",
            "shipIndicator": "01",
            "giftCardAmount": {
                "currency": "EUR",
                "value": "100"
            },
            "deliveryEmail": "john.doe@email.com",
            "giftCardCount": 0,
            "preOrderPurchaseIndicator": "01"
        }
    },
    "operationTime": "2000-01-23T04:56:07.000Z",
    "paymentCircuit": "VISA",
    "omnichannelId": "omnichannelId",
    "operationAmount": "3545",
    "operationId": "3470744",
    "paymentEndToEndId": "e723hedsdew",
    "paymentMethod": "CARD",
    "operationType": "CAPTURE",
    "additionalData": {
        "authorizationCode": "647189",
        "cardCountry": "ITA",
        "threeDS": "FULL_SECURE",
        "schemaTID": "MCS01198U",
        "multiCurrencyConversion": {
            "amount": "2662",
            "currency": "JPY",
            "exchangeRate": "0.007510523"
        }
    },
    "operationCurrency": "EUR",
    "paymentInstrumentInfo": "***6152",
    "cancelledOperationId": "",
    "operationResult": "AUTHORIZED"
}

getOperationsAPI

GET /api/v1/operations

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
channelstringoptional
channel
channelDetailstringoptional
channel
customFieldstringoptional
customField
fromTimestringoptional
fromTime
maxRecordsinteger (int32)optional
maxRecords
operationTypestringoptional
operationType
toTimestringoptional
toTime
operationIdstringoptional
operationId
orderIdstringoptional
orderId
maxAmountstringoptional
maxAmount
minAmountstringoptional
minAmount
contractIdstringoptional
contractId
contractTypestringoptional
contractType
statusstringoptional
status
paymentMethodstringoptional
paymentMethod
installmentQtystringoptional
installmentQty
pageNumberinteger (int32)optional
pageNumber
paymentCircuitstringoptional
paymentCircuit
terminalIdstringoptional
terminalId
orderBystringoptional
order by selecting OperationsOrderingType
sortInstringoptional
sort in DESCending or ASCending order

getOperationsAPI

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/operations?channel=SOME_STRING_VALUE&channelDetail=SOME_STRING_VALUE&customField=SOME_STRING_VALUE&fromTime=SOME_STRING_VALUE&maxRecords=SOME_INTEGER_VALUE&operationType=CAPTURE&toTime=SOME_STRING_VALUE&operationId=SOME_STRING_VALUE&orderId=SOME_STRING_VALUE&maxAmount=SOME_STRING_VALUE&minAmount=SOME_STRING_VALUE&contractId=SOME_STRING_VALUE&contractType=SOME_STRING_VALUE&status=SOME_STRING_VALUE&paymentMethod=SOME_STRING_VALUE&installmentQty=SOME_STRING_VALUE&pageNumber=SOME_INTEGER_VALUE&paymentCircuit=SOME_STRING_VALUE&terminalId=SOME_STRING_VALUE&orderBy=SOME_STRING_VALUE&sortIn=SOME_STRING_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200OKoptional
- operationsarrayoptional
  - additionalDataobjectoptional
    Map of additional fields specific to the chosen payment method
  - cancelledOperationIdstringoptional
    Operation id to be undone
  - channelstringoptional
    It indicates the originating channel:
    
    ECOMMERCE - carholder initiated operation through an online channel.
    
    POS - carholder initiated operation through a physical POS.
    
    BACKOFFICE - merchant initiated operation. It includes post operations and MIT.
    
    ECOMMERCE, POS, BACKOFFICE
    example: ECOMMERCE
  - customerInfoobjectoptional
    This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
    billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
    cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
    cardHolderNamestringoptionalexample: Mauro Morandi
    homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
    merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
    mobilePhonestringoptionalexample: 3280987654
    mobilePhoneCountryCodestringoptionalexample: 39
    shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
  - omnichannelIdstringoptional
  - operationAmountstringoptional
    Operation amount in the payment currency
    example: 3545
  - operationCurrencystringoptional
    Payment currency
    example: EUR
  - operationIdstringoptionalexample: 3470744
  - operationResultstringoptional
    Transaction output:
    
    AUTHORIZED - Payment authorized
    
    EXECUTED - Payment confirmed, verification successfully executed
    
    DECLINED - Declined by the Issuer during the authorization phase
    
    DENIED_BY_RISK - Negative outcome of the transaction risk analysis
    
    DENIED
    
    THREEDS_VALIDATED - 3DS authentication OK or 3DS skipped (non-secure payment)
    
    THREEDS_FAILED - cancellation or authentication failure during 3DS
    
    PENDING - Payment ongoing. Follow up notifications are expected
    
    CANCELED - Canceled by the cardholder
    
    VOIDED - Online reversal of the full authorized amount
    
    REFUNDED - Full or partial amount refunded
    
    FAILED - Payment failed due to technical reasons
    
    AUTHORIZED, EXECUTED, DECLINED, DENIED_BY_RISK, DENIED, THREEDS_VALIDATED, THREEDS_FAILED, PENDING, CANCELED, VOIDED, REFUNDED, FAILED
    example: AUTHORIZED
  - operationTimestring (date-time)optional
    Operation time in ISO 8601 format
  - operationTypestringoptional
    It indicates the purpose of the request:
    
    AUTHORIZATION - any authorization with explicit capture
    
    CAPTURE - a captured authorization or an implicit captured payment
    
    REFUND - refund of a captured amount
    
    CANCEL - the rollback of an capture, refund.
    
    NOSHOW
    
    INCREMENTAL
    
    DELAY_CHARGE
    
    CARD_VERIFICATION
    
    CARD_CHECK
    
    VOID - reversal of an authorization
    
    AUTHORIZATION, CAPTURE, REFUND, CANCEL, NOSHOW, INCREMENTAL, DELAY_CHARGE, CARD_VERIFICATION, CARD_CHECK, VOID
    example: CAPTURE
  - orderIdstringoptional
    Merchant order id, unique in the merchant domain
    example: btid2384983
  - paymentCircuitstringoptional
    One of the payment circuit values returned by the GET payment_methods web service. The list may include (but not limited to) VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY.
    example: VISA
  - paymentEndToEndIdstringoptional
    It is defined by the circuit to uniquely identify the transaction. Required for circuid reconciliation purposes.
    example: e723hedsdew
  - paymentInstrumentInfostringoptional
    Payment instrument information
    example: ***6152
  - paymentLinkIdstringoptional
    PayByLink id used for correlating this operation with the original link.
    example: 234244353
  - paymentMethodstringoptional
    
    CARD - Any card circuit
    
    APM - Alternative payment method
    
    CARD, APM
    example: CARD
  - warningsarrayoptional
    codestringoptionalexample: TRA001
    descriptionstringoptionalexample: 3DS warning
- paginationobjectoptional
  - totalinteger (int64)optional
  - pageintegeroptional
  - pageSizeintegeroptional
  - pageCountintegeroptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "operations": [
        {
            "paymentLinkId": "234244353",
            "orderId": "btid2384983",
            "warnings": [
                {
                    "code": "TRA001",
                    "description": "3DS warning"
                },
                {
                    "code": "TRA001",
                    "description": "3DS warning"
                }
            ],
            "channel": "ECOMMERCE",
            "customerInfo": {
                "mobilePhone": "3280987654",
                "cardHolderName": "Mauro Morandi",
                "homePhone": "391231234567",
                "mobilePhoneCountryCode": 39,
                "shippingAddress": {
                    "country": "ITA",
                    "province": "BO",
                    "city": "Bologna",
                    "street": "Piazza Maggiore, 1",
                    "additionalInfo": "Quinto Piano, Scala B",
                    "name": "Mario Rossi",
                    "postCode": "40124"
                },
                "cardHolderAcctInfo": {
                    "chAccDate": "2019-02-11T00:00:00.000+0000",
                    "txnActivityYear": 0,
                    "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                    "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                    "provisionAttemptsDay": 0,
                    "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                    "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                    "destinationAddressUsageIndicator": "01",
                    "chAccChangeIndicator": "01",
                    "nbPurchaseAccount": 0,
                    "destinationNameIndicator": "01",
                    "chAccPwChangeIndicator": "01",
                    "paymentAccIndicator": "0",
                    "chAccAgeIndicator": "01",
                    "suspiciousAccActivity": "01",
                    "txnActivityDay": 0
                },
                "workPhone": "391231234567",
                "billingAddress": {
                    "country": "ITA",
                    "province": "BO",
                    "city": "Bologna",
                    "street": "Piazza Maggiore, 1",
                    "additionalInfo": "Quinto Piano, Scala B",
                    "name": "Mario Rossi",
                    "postCode": "40124"
                },
                "cardHolderEmail": "mauro.morandi@nexi.it",
                "merchantRiskIndicator": {
                    "deliveryTimeframe": "01",
                    "preOrderDate": "2019-02-11T00:00:00.000+0000",
                    "reorderItemsIndicator": "01",
                    "shipIndicator": "01",
                    "giftCardAmount": {
                        "currency": "EUR",
                        "value": "100"
                    },
                    "deliveryEmail": "john.doe@email.com",
                    "giftCardCount": 0,
                    "preOrderPurchaseIndicator": "01"
                }
            },
            "operationTime": "2000-01-23T04:56:07.000Z",
            "paymentCircuit": "VISA",
            "omnichannelId": "omnichannelId",
            "operationAmount": "3545",
            "operationId": "3470744",
            "paymentEndToEndId": "e723hedsdew",
            "paymentMethod": "CARD",
            "operationType": "CAPTURE",
            "additionalData": {
                "authorizationCode": "647189",
                "cardCountry": "ITA",
                "threeDS": "FULL_SECURE",
                "schemaTID": "MCS01198U",
                "multiCurrencyConversion": {
                    "amount": "2662",
                    "currency": "JPY",
                    "exchangeRate": "0.007510523"
                }
            },
            "operationCurrency": "EUR",
            "paymentInstrumentInfo": "***6152",
            "cancelledOperationId": "",
            "operationResult": "AUTHORIZED"
        },
        {
            "paymentLinkId": "234244353",
            "orderId": "btid2384983",
            "warnings": [
                {
                    "code": "TRA001",
                    "description": "3DS warning"
                },
                {
                    "code": "TRA001",
                    "description": "3DS warning"
                }
            ],
            "channel": "ECOMMERCE",
            "customerInfo": {
                "mobilePhone": "3280987654",
                "cardHolderName": "Mauro Morandi",
                "homePhone": "391231234567",
                "mobilePhoneCountryCode": 39,
                "shippingAddress": {
                    "country": "ITA",
                    "province": "BO",
                    "city": "Bologna",
                    "street": "Piazza Maggiore, 1",
                    "additionalInfo": "Quinto Piano, Scala B",
                    "name": "Mario Rossi",
                    "postCode": "40124"
                },
                "cardHolderAcctInfo": {
                    "chAccDate": "2019-02-11T00:00:00.000+0000",
                    "txnActivityYear": 0,
                    "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                    "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                    "provisionAttemptsDay": 0,
                    "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                    "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                    "destinationAddressUsageIndicator": "01",
                    "chAccChangeIndicator": "01",
                    "nbPurchaseAccount": 0,
                    "destinationNameIndicator": "01",
                    "chAccPwChangeIndicator": "01",
                    "paymentAccIndicator": "0",
                    "chAccAgeIndicator": "01",
                    "suspiciousAccActivity": "01",
                    "txnActivityDay": 0
                },
                "workPhone": "391231234567",
                "billingAddress": {
                    "country": "ITA",
                    "province": "BO",
                    "city": "Bologna",
                    "street": "Piazza Maggiore, 1",
                    "additionalInfo": "Quinto Piano, Scala B",
                    "name": "Mario Rossi",
                    "postCode": "40124"
                },
                "cardHolderEmail": "mauro.morandi@nexi.it",
                "merchantRiskIndicator": {
                    "deliveryTimeframe": "01",
                    "preOrderDate": "2019-02-11T00:00:00.000+0000",
                    "reorderItemsIndicator": "01",
                    "shipIndicator": "01",
                    "giftCardAmount": {
                        "currency": "EUR",
                        "value": "100"
                    },
                    "deliveryEmail": "john.doe@email.com",
                    "giftCardCount": 0,
                    "preOrderPurchaseIndicator": "01"
                }
            },
            "operationTime": "2000-01-23T04:56:07.000Z",
            "paymentCircuit": "VISA",
            "omnichannelId": "omnichannelId",
            "operationAmount": "3545",
            "operationId": "3470744",
            "paymentEndToEndId": "e723hedsdew",
            "paymentMethod": "CARD",
            "operationType": "CAPTURE",
            "additionalData": {
                "authorizationCode": "647189",
                "cardCountry": "ITA",
                "threeDS": "FULL_SECURE",
                "schemaTID": "MCS01198U",
                "multiCurrencyConversion": {
                    "amount": "2662",
                    "currency": "JPY",
                    "exchangeRate": "0.007510523"
                }
            },
            "operationCurrency": "EUR",
            "paymentInstrumentInfo": "***6152",
            "cancelledOperationId": "",
            "operationResult": "AUTHORIZED"
        }
    ],
    "pagination": {
        "total": 0,
        "pageCount": 5,
        "pageSize": 1,
        "page": 6
    }
}

Refund

POST /api/v1/operations/{operationId}/refunds

Refund or Reversal based on the clearing state, partial or full

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
Idempotency-Keystringoptional
Idempotency-Key
operationIdstringrequired
Operation id

Refund

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/operations/21345/refunds");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("Idempotency-Key", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

amountstringoptional
currencystringoptional
Transaction currency. ISO 4217 alphabetic code

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAL, XAU, XBA, XBB, XBC, XBD, XCD, XCP, XDR, XFO, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW, ZWL
example: EUR
descriptionstringoptional

Request body

{
    "amount": "string",
    "currency": "EUR",
    "description": "string"
}

Responses

200Post operation acceptedoptional
- operationIdstringoptionalexample: 3470744
- operationTimestring (date-time)optional
  Post operation time in ISO 8601 format
  example: 2022-09-01T01:20:00.001Z
201Createdoptional
400Request rejectedoptional
- timestampstringoptional
- errorsarrayoptional
  - codestringoptionalexample: GW0001
  - descriptionstringoptionalexample: Invalid merchant URL
401Unauthorizedoptional
403Forbiddenoptional
404Transaction not foundoptional
500Internal Server Erroroptional
- errorsarrayoptional
  - codestringoptionalexample: GW0001
  - descriptionstringoptionalexample: Invalid merchant URL

{
    "operationId": "3470744",
    "operationTime": "2022-09-01T01:20:00.001Z"
}

Capture

POST /api/v1/operations/{operationId}/captures

Payment confirmation, partial or full

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
Idempotency-Keystringoptional
Idempotency-Key
operationIdstringrequired
operationId

Capture

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/operations/{operationId}/captures");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("Idempotency-Key", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

amountstringoptional
currencystringoptional
Transaction currency. ISO 4217 alphabetic code

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAL, XAU, XBA, XBB, XBC, XBD, XCD, XCP, XDR, XFO, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW, ZWL
example: EUR
descriptionstringoptional

Request body

{
    "amount": "string",
    "currency": "EUR",
    "description": "string"
}

Responses

200OKoptional
- operationIdstringoptionalexample: 3470744
- operationTimestring (date-time)optional
  Post operation time in ISO 8601 format
  example: 2022-09-01T01:20:00.001Z
201Createdoptional
400Request rejectedoptional
- timestampstringoptional
- errorsarrayoptional
  - codestringoptionalexample: GW0001
  - descriptionstringoptionalexample: Invalid merchant URL
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional
500Internal Server Erroroptional
- errorsarrayoptional
  - codestringoptionalexample: GW0001
  - descriptionstringoptionalexample: Invalid merchant URL

{
    "operationId": "3470744",
    "operationTime": "2022-09-01T01:20:00.001Z"
}

Cancel

POST /api/v1/operations/{operationId}/cancels

Cancel a capture operation. Does not apply to any other operation types.

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
operationIdstringrequired
Operation id of a capture operation to be cancelled

Cancel

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/operations/3470744/cancels");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

descriptionstringoptional
Free text message available to describe the rationale of the cancel.
example: refund executed by mistake

Request body

{
    "description": "refund executed by mistake"
}

Responses

200Request acceptedoptional
- operationIdstringoptionalexample: 3470744
- operationTimestring (date-time)optional
  Post operation time in ISO 8601 format
  example: 2022-09-01T01:20:00.001Z
201Createdoptional
400Request rejectedoptional
- timestampstringoptional
- errorsarrayoptional
  - codestringoptionalexample: GW0001
  - descriptionstringoptionalexample: Invalid merchant URL
401Unauthorizedoptional
403Forbiddenoptional
404Order or operation not foundoptional
500Internal Server Erroroptional
- errorsarrayoptional
  - codestringoptionalexample: GW0001
  - descriptionstringoptionalexample: Invalid merchant URL

{
    "operationId": "3470744",
    "operationTime": "2022-09-01T01:20:00.001Z"
}

getPaymentMethods

GET /api/v1/payment_methods

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.

getPaymentMethods

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/payment_methods");
var request = new RestRequest(Method.GET);
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200OKoptional
- paymentMethodsarrayoptional
  - circuitstringoptional
  - imageLinkstringoptional
  - oneClickSupportedbooleanoptional
  - paymentMethodTypestringoptional
  - recurringSupportedbooleanoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "paymentMethods": [
        {
            "oneClickSupported": true,
            "imageLink": "imageLink",
            "circuit": "circuit",
            "recurringSupported": true,
            "paymentMethodType": "paymentMethodType"
        },
        {
            "oneClickSupported": true,
            "imageLink": "imageLink",
            "circuit": "circuit",
            "recurringSupported": true,
            "paymentMethodType": "paymentMethodType"
        }
    ]
}

moto

POST /api/v1/orders/moto

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
x-plugin-namestringoptional
x-plugin-name

moto

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/moto");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("x-plugin-name", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

captureTypestringoptional
Overwrites the default confirmation method of the terminal, for card payments only:

IMPLICIT - automatic confirmation

EXPLICIT - authorization only Default value depends on the terminal configuration.

Terminal set to EXPLICIT: a. if the captureType is EXPLICIT the capture will be EXPLICIT b. if the captureType is not present or null the capture will be EXPLICIT c. if the captureType is IMPLICIT the capture will be IMPLICIT

Terminal set to IMPLICIT: a. if the captureType is EXPLICIT the capture will be an error b. if the captureType is not present or null the capture will be IMPLICIT c. if the captureType is IMPLICIT the capture will be IMPLICIT

DEFERRED, EXPLICIT, FILE, IMPLICIT
example: EXPLICIT
cardobjectoptional
- cvvstringoptionalexample: 123
- expiryDatestringoptionalexample: 1225
- panstringrequiredexample: 1234567890123456
orderobjectoptional
- amountstringrequired
  Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)
  example: 3545
- currencystringrequired
  Transaction currency. ISO 4217 alphabetic code
  
  AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAL, XAU, XBA, XBB, XBC, XBD, XCD, XCP, XDR, XFO, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW, ZWL
  example: EUR
- customFieldstringoptional
  Additional transaction description
  example: weekend promotion
- customerIdstringoptional
  Immutable identifier of the payer as registered on the ecommerce platform.
  example: mcid97295873
- customerInfoobjectoptional
  This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
  - billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
  - cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
  - cardHolderNamestringoptionalexample: Mauro Morandi
  - homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
  - merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
  - mobilePhonestringoptionalexample: 3280987654
  - mobilePhoneCountryCodestringoptionalexample: 39
  - shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
- descriptionstringoptional
  Transaction description
  example: TV LG 3423
- installmentsarrayoptional
  - amountstringoptional
    Installment amount.
    example: 350
  - datestring (date)optional
    Installment time in ISO 8601 format.
  - typestringoptional
    AUTOMATIC, MANUAL
- orderIdstringrequired
  Merchant order id, unique in the merchant domain
  example: btid2384983
- termsAndConditionsIdsarrayoptional
- transactionSummaryarrayoptional
  - languagestringoptional
    Language in ISO 639-2.
    
    ACE, ACH, ADA, ADY, AFA, AFH, AIN, AKK, ALE, ALG, ALT, ANG, ANP, APA, ARC, ARN, ARP, ART, ARW, AST, ATH, AUS, AWA, BAD, BAI, BAL, BAN, BAS, BAT, BEJ, BEM, BER, BHO, BIH, BIK, BIN, BLA, BNT, BRA, BTK, BUA, BUG, BYN, CAD, CAI, CAR, CAU, CEB, CEL, CHB, CHG, CHK, CHM, CHN, CHO, CHP, CHR, CHY, CMC, CNR, COP, CPE, CPF, CPP, CRH, CRP, CSB, CUS, DAK, DAR, DAY, DEL, DEN, DGR, DIN, DOI, DRA, DSB, DUA, DUM, DYU, EFI, EGY, EKA, ELX, ENM, EWO, FAN, FAT, FIL, FIU, FON, FRM, FRO, FRR, FRS, FUR, GAA, GAY, GBA, GEM, GEZ, GIL, GMH, GOH, GON, GOR, GOT, GRB, GRC, GSW, GWI, HAI, HAW, HIL, HIM, HIT, HMN, HSB, HUP, IBA, IJO, ILO, INC, INE, INH, IRA, IRO, JBO, JPR, JRB, KAA, KAB, KAC, KAM, KAR, KAW, KBD, KHA, KHI, KHO, KMB, KOK, KOS, KPE, KRC, KRL, KRO, KRU, KUM, KUT, LAD, LAH, LAM, LEZ, LOL, LOZ, LUA, LUI, LUN, LUO, LUS, MAD, MAG, MAI, MAK, MAN, MAP, MAS, MDF, MDR, MEN, MGA, MIC, MIN, MIS, MKH, MNC, MNI, MNO, MOH, MOS, MUL, MUN, MUS, MWL, MWR, MYN, MYV, NAH, NAI, NAP, NDS, NEW, NIA, NIC, NIU, NOG, NON, NQO, NSO, NUB, NWC, NYM, NYN, NYO, NZI, OSA, OTA, OTO, PAA, PAG, PAL, PAM, PAP, PAU, PEO, PHI, PHN, PON, PRA, PRO, QAA, QTZ, RAJ, RAP, RAR, ROA, ROM, RUP, SAD, SAH, SAI, SAL, SAM, SAS, SAT, SCN, SCO, SEL, SEM, SGA, SGN, SHN, SID, SIO, SIT, SLA, SMA, SMI, SMJ, SMN, SMS, SNK, SOG, SON, SRN, SRR, SSA, SUK, SUS, SUX, SYC, SYR, TAI, TEM, TER, TET, TIG, TIV, TKL, TLH, TLI, TMH, TOG, TPI, TSI, TUM, TUP, TUT, TVL, TYV, UDM, UGA, UMB, UND, VAI, VOT, WAK, WAL, WAR, WAS, WEN, XAL, YAO, YAP, YPK, ZAP, ZBL, ZEN, ZGH, ZND, ZUN, ZXX, ZZA, AAR, ABK, AVE, AFR, AKA, AMH, ARG, ARA, ASM, AVA, AYM, AZE, BAK, BEL, BUL, BIS, BAM, BEN, BOD, TIB, BRE, BOS, CAT, CHE, CHA, COS, CRE, CES, CZE, CHU, CHV, CYM, WEL, DAN, DEU, GER, DIV, DZO, EWE, ELL, GRE, ENG, EPO, SPA, EST, EUS, BAQ, FAS, PER, FUL, FIN, FIJ, FAO, FRA, FRE, FRY, GLE, GLA, GLG, GRN, GUJ, GLV, HAU, HEB, HIN, HMO, HRV, HAT, HUN, HYE, ARM, HER, INA, IND, ILE, IBO, III, IPK, IDO, ISL, ICE, ITA, IKU, JPN, JAV, KAT, GEO, KON, KIK, KUA, KAZ, KAL, KHM, KAN, KOR, KAU, KAS, KUR, KOM, COR, KIR, LAT, LTZ, LUG, LIM, LIN, LAO, LIT, LUB, LAV, MLG, MAH, MRI, MAO, MKD, MAC, MAL, MON, MAR, MSA, MAY, MLT, MYA, BUR, NAU, NOB, NDE, NEP, NDO, NLD, DUT, NNO, NOR, NBL, NAV, NYA, OCI, OJI, ORM, ORI, OSS, PAN, PLI, POL, PUS, POR, QUE, ROH, RUN, RON, RUM, RUS, KIN, SAN, SRD, SND, SME, SAG, SIN, SLK, SLO, SLV, SMO, SNA, SOM, SQI, ALB, SRP, SSW, SOT, SUN, SWE, SWA, TAM, TEL, TGK, THA, TIR, TUK, TGL, TSN, TON, TUR, TSO, TAT, TWI, TAH, UIG, UKR, URD, UZB, VEN, VIE, VOL, WLN, WOL, XHO, YID, YOR, ZHA, ZHO, CHI, ZUL, USA, ARB, JAP, ZHE, SVN
    example: ENG
  - summaryListarrayoptional
    labelstringoptional
    label of the field
    example: Number of people
    valuestringoptional
    value
    example: 4
- planobjectoptional
  - totalAmountstringoptional
  - contractIdstringoptional
  - planTypestringoptional
    FIXED, VARIABLE, ACQUIRER_AGREEMENT
  - statusstringoptional
    ACTIVE, INACTIVE, COMPLETED

Request body

{
    "captureType": "EXPLICIT",
    "card": {
        "cvv": "123",
        "expiryDate": "1225",
        "pan": "1234567890123456"
    },
    "order": {
        "amount": "3545",
        "termsAndConditionsIds": [
            "16dd6ac6-0791-4c72-b362-85f77f1728a2",
            "16dd6ac6-0791-4c72-b362-85f77f1728a2"
        ],
        "installments": [
            {
                "date": "2000-01-23T00:00:00.000Z",
                "amount": "350"
            },
            {
                "date": "2000-01-23T00:00:00.000Z",
                "amount": "350"
            }
        ],
        "orderId": "btid2384983",
        "customerId": "mcid97295873",
        "customerInfo": {
            "mobilePhone": "3280987654",
            "cardHolderName": "Mauro Morandi",
            "homePhone": "391231234567",
            "mobilePhoneCountryCode": 39,
            "shippingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderAcctInfo": {
                "chAccDate": "2019-02-11T00:00:00.000+0000",
                "txnActivityYear": 0,
                "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                "provisionAttemptsDay": 0,
                "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                "destinationAddressUsageIndicator": "01",
                "chAccChangeIndicator": "01",
                "nbPurchaseAccount": 0,
                "destinationNameIndicator": "01",
                "chAccPwChangeIndicator": "01",
                "paymentAccIndicator": "0",
                "chAccAgeIndicator": "01",
                "suspiciousAccActivity": "01",
                "txnActivityDay": 0
            },
            "workPhone": "391231234567",
            "billingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderEmail": "mauro.morandi@nexi.it",
            "merchantRiskIndicator": {
                "deliveryTimeframe": "01",
                "preOrderDate": "2019-02-11T00:00:00.000+0000",
                "reorderItemsIndicator": "01",
                "shipIndicator": "01",
                "giftCardAmount": {
                    "currency": "EUR",
                    "value": "100"
                },
                "deliveryEmail": "john.doe@email.com",
                "giftCardCount": 0,
                "preOrderPurchaseIndicator": "01"
            }
        },
        "description": "TV LG 3423",
        "currency": "EUR",
        "transactionSummary": [
            {
                "summaryList": [
                    {
                        "label": "Number of people",
                        "value": "4"
                    },
                    {
                        "label": "Number of people",
                        "value": "4"
                    }
                ],
                "language": "ENG"
            },
            {
                "summaryList": [
                    {
                        "label": "Number of people",
                        "value": "4"
                    },
                    {
                        "label": "Number of people",
                        "value": "4"
                    }
                ],
                "language": "ENG"
            }
        ],
        "plan": {
            "totalAmount": "totalAmount",
            "contractId": "contractId"
        },
        "customField": "weekend promotion"
    }
}

Responses

200OKoptional
- operationobjectoptional
  - additionalDataobjectoptional
    Map of additional fields specific to the chosen payment method
  - cancelledOperationIdstringoptional
    Operation id to be undone
  - channelstringoptional
    It indicates the originating channel:
    
    ECOMMERCE - carholder initiated operation through an online channel.
    
    POS - carholder initiated operation through a physical POS.
    
    BACKOFFICE - merchant initiated operation. It includes post operations and MIT.
    
    ECOMMERCE, POS, BACKOFFICE
    example: ECOMMERCE
  - customerInfoobjectoptional
    This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
    billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
    cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
    cardHolderNamestringoptionalexample: Mauro Morandi
    homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
    merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
    mobilePhonestringoptionalexample: 3280987654
    mobilePhoneCountryCodestringoptionalexample: 39
    shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
  - omnichannelIdstringoptional
  - operationAmountstringoptional
    Operation amount in the payment currency
    example: 3545
  - operationCurrencystringoptional
    Payment currency
    example: EUR
  - operationIdstringoptionalexample: 3470744
  - operationResultstringoptional
    Transaction output:
    
    AUTHORIZED - Payment authorized
    
    EXECUTED - Payment confirmed, verification successfully executed
    
    DECLINED - Declined by the Issuer during the authorization phase
    
    DENIED_BY_RISK - Negative outcome of the transaction risk analysis
    
    DENIED
    
    THREEDS_VALIDATED - 3DS authentication OK or 3DS skipped (non-secure payment)
    
    THREEDS_FAILED - cancellation or authentication failure during 3DS
    
    PENDING - Payment ongoing. Follow up notifications are expected
    
    CANCELED - Canceled by the cardholder
    
    VOIDED - Online reversal of the full authorized amount
    
    REFUNDED - Full or partial amount refunded
    
    FAILED - Payment failed due to technical reasons
    
    AUTHORIZED, EXECUTED, DECLINED, DENIED_BY_RISK, DENIED, THREEDS_VALIDATED, THREEDS_FAILED, PENDING, CANCELED, VOIDED, REFUNDED, FAILED
    example: AUTHORIZED
  - operationTimestring (date-time)optional
    Operation time in ISO 8601 format
  - operationTypestringoptional
    It indicates the purpose of the request:
    
    AUTHORIZATION - any authorization with explicit capture
    
    CAPTURE - a captured authorization or an implicit captured payment
    
    REFUND - refund of a captured amount
    
    CANCEL - the rollback of an capture, refund.
    
    NOSHOW
    
    INCREMENTAL
    
    DELAY_CHARGE
    
    CARD_VERIFICATION
    
    CARD_CHECK
    
    VOID - reversal of an authorization
    
    AUTHORIZATION, CAPTURE, REFUND, CANCEL, NOSHOW, INCREMENTAL, DELAY_CHARGE, CARD_VERIFICATION, CARD_CHECK, VOID
    example: CAPTURE
  - orderIdstringoptional
    Merchant order id, unique in the merchant domain
    example: btid2384983
  - paymentCircuitstringoptional
    One of the payment circuit values returned by the GET payment_methods web service. The list may include (but not limited to) VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY.
    example: VISA
  - paymentEndToEndIdstringoptional
    It is defined by the circuit to uniquely identify the transaction. Required for circuid reconciliation purposes.
    example: e723hedsdew
  - paymentInstrumentInfostringoptional
    Payment instrument information
    example: ***6152
  - paymentLinkIdstringoptional
    PayByLink id used for correlating this operation with the original link.
    example: 234244353
  - paymentMethodstringoptional
    
    CARD - Any card circuit
    
    APM - Alternative payment method
    
    CARD, APM
    example: CARD
  - warningsarrayoptional
    codestringoptionalexample: TRA001
    descriptionstringoptionalexample: 3DS warning
- warningsarrayoptional
  - codestringoptionalexample: TRA001
  - descriptionstringoptionalexample: 3DS warning
201Createdoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "operation": {
        "paymentLinkId": "234244353",
        "orderId": "btid2384983",
        "warnings": [
            {
                "code": "TRA001",
                "description": "3DS warning"
            },
            {
                "code": "TRA001",
                "description": "3DS warning"
            }
        ],
        "channel": "ECOMMERCE",
        "customerInfo": {
            "mobilePhone": "3280987654",
            "cardHolderName": "Mauro Morandi",
            "homePhone": "391231234567",
            "mobilePhoneCountryCode": 39,
            "shippingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderAcctInfo": {
                "chAccDate": "2019-02-11T00:00:00.000+0000",
                "txnActivityYear": 0,
                "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                "provisionAttemptsDay": 0,
                "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                "destinationAddressUsageIndicator": "01",
                "chAccChangeIndicator": "01",
                "nbPurchaseAccount": 0,
                "destinationNameIndicator": "01",
                "chAccPwChangeIndicator": "01",
                "paymentAccIndicator": "0",
                "chAccAgeIndicator": "01",
                "suspiciousAccActivity": "01",
                "txnActivityDay": 0
            },
            "workPhone": "391231234567",
            "billingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderEmail": "mauro.morandi@nexi.it",
            "merchantRiskIndicator": {
                "deliveryTimeframe": "01",
                "preOrderDate": "2019-02-11T00:00:00.000+0000",
                "reorderItemsIndicator": "01",
                "shipIndicator": "01",
                "giftCardAmount": {
                    "currency": "EUR",
                    "value": "100"
                },
                "deliveryEmail": "john.doe@email.com",
                "giftCardCount": 0,
                "preOrderPurchaseIndicator": "01"
            }
        },
        "operationTime": "2000-01-23T04:56:07.000Z",
        "paymentCircuit": "VISA",
        "omnichannelId": "omnichannelId",
        "operationAmount": "3545",
        "operationId": "3470744",
        "paymentEndToEndId": "e723hedsdew",
        "paymentMethod": "CARD",
        "operationType": "CAPTURE",
        "additionalData": {
            "authorizationCode": "647189",
            "cardCountry": "ITA",
            "threeDS": "FULL_SECURE",
            "schemaTID": "MCS01198U",
            "multiCurrencyConversion": {
                "amount": "2662",
                "currency": "JPY",
                "exchangeRate": "0.007510523"
            }
        },
        "operationCurrency": "EUR",
        "paymentInstrumentInfo": "***6152",
        "cancelledOperationId": "",
        "operationResult": "AUTHORIZED"
    },
    "warnings": [
        {
            "code": "TRA001",
            "description": "3DS warning"
        }
    ]
}

cardVerification

POST /api/v1/orders/card_verification

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
x-plugin-namestringoptional
x-plugin-name

cardVerification

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/card_verification");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("x-plugin-name", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

cardobjectoptional
- cvvstringoptionalexample: 123
- expiryDatestringoptionalexample: 1225
- panstringrequiredexample: 1234567890123456
orderobjectoptional
- amountstringrequired
  Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)
  example: 3545
- currencystringrequired
  Transaction currency. ISO 4217 alphabetic code
  
  AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAL, XAU, XBA, XBB, XBC, XBD, XCD, XCP, XDR, XFO, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW, ZWL
  example: EUR
- customFieldstringoptional
  Additional transaction description
  example: weekend promotion
- customerIdstringoptional
  Immutable identifier of the payer as registered on the ecommerce platform.
  example: mcid97295873
- customerInfoobjectoptional
  This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
  - billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
  - cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
  - cardHolderNamestringoptionalexample: Mauro Morandi
  - homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
  - merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
  - mobilePhonestringoptionalexample: 3280987654
  - mobilePhoneCountryCodestringoptionalexample: 39
  - shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
- descriptionstringoptional
  Transaction description
  example: TV LG 3423
- installmentsarrayoptional
  - amountstringoptional
    Installment amount.
    example: 350
  - datestring (date)optional
    Installment time in ISO 8601 format.
  - typestringoptional
    AUTOMATIC, MANUAL
- orderIdstringrequired
  Merchant order id, unique in the merchant domain
  example: btid2384983
- termsAndConditionsIdsarrayoptional
- transactionSummaryarrayoptional
  - languagestringoptional
    Language in ISO 639-2.
    
    ACE, ACH, ADA, ADY, AFA, AFH, AIN, AKK, ALE, ALG, ALT, ANG, ANP, APA, ARC, ARN, ARP, ART, ARW, AST, ATH, AUS, AWA, BAD, BAI, BAL, BAN, BAS, BAT, BEJ, BEM, BER, BHO, BIH, BIK, BIN, BLA, BNT, BRA, BTK, BUA, BUG, BYN, CAD, CAI, CAR, CAU, CEB, CEL, CHB, CHG, CHK, CHM, CHN, CHO, CHP, CHR, CHY, CMC, CNR, COP, CPE, CPF, CPP, CRH, CRP, CSB, CUS, DAK, DAR, DAY, DEL, DEN, DGR, DIN, DOI, DRA, DSB, DUA, DUM, DYU, EFI, EGY, EKA, ELX, ENM, EWO, FAN, FAT, FIL, FIU, FON, FRM, FRO, FRR, FRS, FUR, GAA, GAY, GBA, GEM, GEZ, GIL, GMH, GOH, GON, GOR, GOT, GRB, GRC, GSW, GWI, HAI, HAW, HIL, HIM, HIT, HMN, HSB, HUP, IBA, IJO, ILO, INC, INE, INH, IRA, IRO, JBO, JPR, JRB, KAA, KAB, KAC, KAM, KAR, KAW, KBD, KHA, KHI, KHO, KMB, KOK, KOS, KPE, KRC, KRL, KRO, KRU, KUM, KUT, LAD, LAH, LAM, LEZ, LOL, LOZ, LUA, LUI, LUN, LUO, LUS, MAD, MAG, MAI, MAK, MAN, MAP, MAS, MDF, MDR, MEN, MGA, MIC, MIN, MIS, MKH, MNC, MNI, MNO, MOH, MOS, MUL, MUN, MUS, MWL, MWR, MYN, MYV, NAH, NAI, NAP, NDS, NEW, NIA, NIC, NIU, NOG, NON, NQO, NSO, NUB, NWC, NYM, NYN, NYO, NZI, OSA, OTA, OTO, PAA, PAG, PAL, PAM, PAP, PAU, PEO, PHI, PHN, PON, PRA, PRO, QAA, QTZ, RAJ, RAP, RAR, ROA, ROM, RUP, SAD, SAH, SAI, SAL, SAM, SAS, SAT, SCN, SCO, SEL, SEM, SGA, SGN, SHN, SID, SIO, SIT, SLA, SMA, SMI, SMJ, SMN, SMS, SNK, SOG, SON, SRN, SRR, SSA, SUK, SUS, SUX, SYC, SYR, TAI, TEM, TER, TET, TIG, TIV, TKL, TLH, TLI, TMH, TOG, TPI, TSI, TUM, TUP, TUT, TVL, TYV, UDM, UGA, UMB, UND, VAI, VOT, WAK, WAL, WAR, WAS, WEN, XAL, YAO, YAP, YPK, ZAP, ZBL, ZEN, ZGH, ZND, ZUN, ZXX, ZZA, AAR, ABK, AVE, AFR, AKA, AMH, ARG, ARA, ASM, AVA, AYM, AZE, BAK, BEL, BUL, BIS, BAM, BEN, BOD, TIB, BRE, BOS, CAT, CHE, CHA, COS, CRE, CES, CZE, CHU, CHV, CYM, WEL, DAN, DEU, GER, DIV, DZO, EWE, ELL, GRE, ENG, EPO, SPA, EST, EUS, BAQ, FAS, PER, FUL, FIN, FIJ, FAO, FRA, FRE, FRY, GLE, GLA, GLG, GRN, GUJ, GLV, HAU, HEB, HIN, HMO, HRV, HAT, HUN, HYE, ARM, HER, INA, IND, ILE, IBO, III, IPK, IDO, ISL, ICE, ITA, IKU, JPN, JAV, KAT, GEO, KON, KIK, KUA, KAZ, KAL, KHM, KAN, KOR, KAU, KAS, KUR, KOM, COR, KIR, LAT, LTZ, LUG, LIM, LIN, LAO, LIT, LUB, LAV, MLG, MAH, MRI, MAO, MKD, MAC, MAL, MON, MAR, MSA, MAY, MLT, MYA, BUR, NAU, NOB, NDE, NEP, NDO, NLD, DUT, NNO, NOR, NBL, NAV, NYA, OCI, OJI, ORM, ORI, OSS, PAN, PLI, POL, PUS, POR, QUE, ROH, RUN, RON, RUM, RUS, KIN, SAN, SRD, SND, SME, SAG, SIN, SLK, SLO, SLV, SMO, SNA, SOM, SQI, ALB, SRP, SSW, SOT, SUN, SWE, SWA, TAM, TEL, TGK, THA, TIR, TUK, TGL, TSN, TON, TUR, TSO, TAT, TWI, TAH, UIG, UKR, URD, UZB, VEN, VIE, VOL, WLN, WOL, XHO, YID, YOR, ZHA, ZHO, CHI, ZUL, USA, ARB, JAP, ZHE, SVN
    example: ENG
  - summaryListarrayoptional
    labelstringoptional
    label of the field
    example: Number of people
    valuestringoptional
    value
    example: 4
- planobjectoptional
  - totalAmountstringoptional
  - contractIdstringoptional
  - planTypestringoptional
    FIXED, VARIABLE, ACQUIRER_AGREEMENT
  - statusstringoptional
    ACTIVE, INACTIVE, COMPLETED

Request body

{
    "card": {
        "cvv": "123",
        "expiryDate": "1225",
        "pan": "1234567890123456"
    },
    "order": {
        "amount": "3545",
        "termsAndConditionsIds": [
            "16dd6ac6-0791-4c72-b362-85f77f1728a2",
            "16dd6ac6-0791-4c72-b362-85f77f1728a2"
        ],
        "installments": [
            {
                "date": "2000-01-23T00:00:00.000Z",
                "amount": "350"
            },
            {
                "date": "2000-01-23T00:00:00.000Z",
                "amount": "350"
            }
        ],
        "orderId": "btid2384983",
        "customerId": "mcid97295873",
        "customerInfo": {
            "mobilePhone": "3280987654",
            "cardHolderName": "Mauro Morandi",
            "homePhone": "391231234567",
            "mobilePhoneCountryCode": 39,
            "shippingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderAcctInfo": {
                "chAccDate": "2019-02-11T00:00:00.000+0000",
                "txnActivityYear": 0,
                "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                "provisionAttemptsDay": 0,
                "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                "destinationAddressUsageIndicator": "01",
                "chAccChangeIndicator": "01",
                "nbPurchaseAccount": 0,
                "destinationNameIndicator": "01",
                "chAccPwChangeIndicator": "01",
                "paymentAccIndicator": "0",
                "chAccAgeIndicator": "01",
                "suspiciousAccActivity": "01",
                "txnActivityDay": 0
            },
            "workPhone": "391231234567",
            "billingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderEmail": "mauro.morandi@nexi.it",
            "merchantRiskIndicator": {
                "deliveryTimeframe": "01",
                "preOrderDate": "2019-02-11T00:00:00.000+0000",
                "reorderItemsIndicator": "01",
                "shipIndicator": "01",
                "giftCardAmount": {
                    "currency": "EUR",
                    "value": "100"
                },
                "deliveryEmail": "john.doe@email.com",
                "giftCardCount": 0,
                "preOrderPurchaseIndicator": "01"
            }
        },
        "description": "TV LG 3423",
        "currency": "EUR",
        "transactionSummary": [
            {
                "summaryList": [
                    {
                        "label": "Number of people",
                        "value": "4"
                    },
                    {
                        "label": "Number of people",
                        "value": "4"
                    }
                ],
                "language": "ENG"
            },
            {
                "summaryList": [
                    {
                        "label": "Number of people",
                        "value": "4"
                    },
                    {
                        "label": "Number of people",
                        "value": "4"
                    }
                ],
                "language": "ENG"
            }
        ],
        "plan": {
            "totalAmount": "totalAmount",
            "contractId": "contractId"
        },
        "customField": "weekend promotion"
    }
}

Responses

200OKoptional
- operationobjectoptional
  - additionalDataobjectoptional
    Map of additional fields specific to the chosen payment method
  - cancelledOperationIdstringoptional
    Operation id to be undone
  - channelstringoptional
    It indicates the originating channel:
    
    ECOMMERCE - carholder initiated operation through an online channel.
    
    POS - carholder initiated operation through a physical POS.
    
    BACKOFFICE - merchant initiated operation. It includes post operations and MIT.
    
    ECOMMERCE, POS, BACKOFFICE
    example: ECOMMERCE
  - customerInfoobjectoptional
    This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
    billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
    cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
    cardHolderNamestringoptionalexample: Mauro Morandi
    homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
    merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
    mobilePhonestringoptionalexample: 3280987654
    mobilePhoneCountryCodestringoptionalexample: 39
    shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
  - omnichannelIdstringoptional
  - operationAmountstringoptional
    Operation amount in the payment currency
    example: 3545
  - operationCurrencystringoptional
    Payment currency
    example: EUR
  - operationIdstringoptionalexample: 3470744
  - operationResultstringoptional
    Transaction output:
    
    AUTHORIZED - Payment authorized
    
    EXECUTED - Payment confirmed, verification successfully executed
    
    DECLINED - Declined by the Issuer during the authorization phase
    
    DENIED_BY_RISK - Negative outcome of the transaction risk analysis
    
    DENIED
    
    THREEDS_VALIDATED - 3DS authentication OK or 3DS skipped (non-secure payment)
    
    THREEDS_FAILED - cancellation or authentication failure during 3DS
    
    PENDING - Payment ongoing. Follow up notifications are expected
    
    CANCELED - Canceled by the cardholder
    
    VOIDED - Online reversal of the full authorized amount
    
    REFUNDED - Full or partial amount refunded
    
    FAILED - Payment failed due to technical reasons
    
    AUTHORIZED, EXECUTED, DECLINED, DENIED_BY_RISK, DENIED, THREEDS_VALIDATED, THREEDS_FAILED, PENDING, CANCELED, VOIDED, REFUNDED, FAILED
    example: AUTHORIZED
  - operationTimestring (date-time)optional
    Operation time in ISO 8601 format
  - operationTypestringoptional
    It indicates the purpose of the request:
    
    AUTHORIZATION - any authorization with explicit capture
    
    CAPTURE - a captured authorization or an implicit captured payment
    
    REFUND - refund of a captured amount
    
    CANCEL - the rollback of an capture, refund.
    
    NOSHOW
    
    INCREMENTAL
    
    DELAY_CHARGE
    
    CARD_VERIFICATION
    
    CARD_CHECK
    
    VOID - reversal of an authorization
    
    AUTHORIZATION, CAPTURE, REFUND, CANCEL, NOSHOW, INCREMENTAL, DELAY_CHARGE, CARD_VERIFICATION, CARD_CHECK, VOID
    example: CAPTURE
  - orderIdstringoptional
    Merchant order id, unique in the merchant domain
    example: btid2384983
  - paymentCircuitstringoptional
    One of the payment circuit values returned by the GET payment_methods web service. The list may include (but not limited to) VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY.
    example: VISA
  - paymentEndToEndIdstringoptional
    It is defined by the circuit to uniquely identify the transaction. Required for circuid reconciliation purposes.
    example: e723hedsdew
  - paymentInstrumentInfostringoptional
    Payment instrument information
    example: ***6152
  - paymentLinkIdstringoptional
    PayByLink id used for correlating this operation with the original link.
    example: 234244353
  - paymentMethodstringoptional
    
    CARD - Any card circuit
    
    APM - Alternative payment method
    
    CARD, APM
    example: CARD
  - warningsarrayoptional
    codestringoptionalexample: TRA001
    descriptionstringoptionalexample: 3DS warning
- warningsarrayoptional
  - codestringoptionalexample: TRA001
  - descriptionstringoptionalexample: 3DS warning
201Createdoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "warnings": [
        {
            "code": "TRA001",
            "description": "3DS warning"
        },
        {
            "code": "TRA001",
            "description": "3DS warning"
        }
    ],
    "operation": {
        "paymentLinkId": "234244353",
        "orderId": "btid2384983",
        "warnings": [
            {
                "code": "TRA001",
                "description": "3DS warning"
            },
            {
                "code": "TRA001",
                "description": "3DS warning"
            }
        ],
        "channel": "ECOMMERCE",
        "customerInfo": {
            "mobilePhone": "3280987654",
            "cardHolderName": "Mauro Morandi",
            "homePhone": "391231234567",
            "mobilePhoneCountryCode": 39,
            "shippingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderAcctInfo": {
                "chAccDate": "2019-02-11T00:00:00.000+0000",
                "txnActivityYear": 0,
                "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                "provisionAttemptsDay": 0,
                "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                "destinationAddressUsageIndicator": "01",
                "chAccChangeIndicator": "01",
                "nbPurchaseAccount": 0,
                "destinationNameIndicator": "01",
                "chAccPwChangeIndicator": "01",
                "paymentAccIndicator": "0",
                "chAccAgeIndicator": "01",
                "suspiciousAccActivity": "01",
                "txnActivityDay": 0
            },
            "workPhone": "391231234567",
            "billingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderEmail": "mauro.morandi@nexi.it",
            "merchantRiskIndicator": {
                "deliveryTimeframe": "01",
                "preOrderDate": "2019-02-11T00:00:00.000+0000",
                "reorderItemsIndicator": "01",
                "shipIndicator": "01",
                "giftCardAmount": {
                    "currency": "EUR",
                    "value": "100"
                },
                "deliveryEmail": "john.doe@email.com",
                "giftCardCount": 0,
                "preOrderPurchaseIndicator": "01"
            }
        },
        "operationTime": "2000-01-23T04:56:07.000Z",
        "paymentCircuit": "VISA",
        "omnichannelId": "omnichannelId",
        "operationAmount": "3545",
        "operationId": "3470744",
        "paymentEndToEndId": "e723hedsdew",
        "paymentMethod": "CARD",
        "operationType": "CAPTURE",
        "additionalData": {
            "authorizationCode": "647189",
            "cardCountry": "ITA",
            "threeDS": "FULL_SECURE",
            "schemaTID": "MCS01198U",
            "multiCurrencyConversion": {
                "amount": "2662",
                "currency": "JPY",
                "exchangeRate": "0.007510523"
            }
        },
        "operationCurrency": "EUR",
        "paymentInstrumentInfo": "***6152",
        "cancelledOperationId": "",
        "operationResult": "AUTHORIZED"
    }
}

createMit

POST /api/v1/orders/mit

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
merchantIdstringoptional
merchantId
tenantIdstringoptional
tenantId
terminalIdstringoptional
terminalId
x-plugin-namestringoptional
x-plugin-name

createMit

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/mit");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("merchantId", "SOME_STRING_VALUE");
request.AddHeader("tenantId", "SOME_STRING_VALUE");
request.AddHeader("terminalId", "SOME_STRING_VALUE");
request.AddHeader("x-plugin-name", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

captureTypestringoptional
Overwrites the default confirmation method of the terminal, for card payments only:

IMPLICIT - automatic confirmation

EXPLICIT - authorization only Default value depends on the terminal configuration.

Terminal set to EXPLICIT: a. if the captureType is EXPLICIT the capture will be EXPLICIT b. if the captureType is not present or null the capture will be EXPLICIT c. if the captureType is IMPLICIT the capture will be IMPLICIT

Terminal set to IMPLICIT: a. if the captureType is EXPLICIT the capture will be an error b. if the captureType is not present or null the capture will be IMPLICIT c. if the captureType is IMPLICIT the capture will be IMPLICIT

DEFERRED, EXPLICIT, FILE, IMPLICIT
example: EXPLICIT
contractIdstringrequired
orderobjectrequired
- amountstringrequired
  Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)
  example: 3545
- currencystringrequired
  Transaction currency. ISO 4217 alphabetic code
  
  AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAL, XAU, XBA, XBB, XBC, XBD, XCD, XCP, XDR, XFO, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW, ZWL
  example: EUR
- customFieldstringoptional
  Additional transaction description
  example: weekend promotion
- customerIdstringoptional
  Immutable identifier of the payer as registered on the ecommerce platform.
  example: mcid97295873
- customerInfoobjectoptional
  This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
  - billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
  - cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
  - cardHolderNamestringoptionalexample: Mauro Morandi
  - homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
  - merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
  - mobilePhonestringoptionalexample: 3280987654
  - mobilePhoneCountryCodestringoptionalexample: 39
  - shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
- descriptionstringoptional
  Transaction description
  example: TV LG 3423
- installmentsarrayoptional
  - amountstringoptional
    Installment amount.
    example: 350
  - datestring (date)optional
    Installment time in ISO 8601 format.
  - typestringoptional
    AUTOMATIC, MANUAL
- orderIdstringrequired
  Merchant order id, unique in the merchant domain
  example: btid2384983
- termsAndConditionsIdsarrayoptional
- transactionSummaryarrayoptional
  - languagestringoptional
    Language in ISO 639-2.
    
    ACE, ACH, ADA, ADY, AFA, AFH, AIN, AKK, ALE, ALG, ALT, ANG, ANP, APA, ARC, ARN, ARP, ART, ARW, AST, ATH, AUS, AWA, BAD, BAI, BAL, BAN, BAS, BAT, BEJ, BEM, BER, BHO, BIH, BIK, BIN, BLA, BNT, BRA, BTK, BUA, BUG, BYN, CAD, CAI, CAR, CAU, CEB, CEL, CHB, CHG, CHK, CHM, CHN, CHO, CHP, CHR, CHY, CMC, CNR, COP, CPE, CPF, CPP, CRH, CRP, CSB, CUS, DAK, DAR, DAY, DEL, DEN, DGR, DIN, DOI, DRA, DSB, DUA, DUM, DYU, EFI, EGY, EKA, ELX, ENM, EWO, FAN, FAT, FIL, FIU, FON, FRM, FRO, FRR, FRS, FUR, GAA, GAY, GBA, GEM, GEZ, GIL, GMH, GOH, GON, GOR, GOT, GRB, GRC, GSW, GWI, HAI, HAW, HIL, HIM, HIT, HMN, HSB, HUP, IBA, IJO, ILO, INC, INE, INH, IRA, IRO, JBO, JPR, JRB, KAA, KAB, KAC, KAM, KAR, KAW, KBD, KHA, KHI, KHO, KMB, KOK, KOS, KPE, KRC, KRL, KRO, KRU, KUM, KUT, LAD, LAH, LAM, LEZ, LOL, LOZ, LUA, LUI, LUN, LUO, LUS, MAD, MAG, MAI, MAK, MAN, MAP, MAS, MDF, MDR, MEN, MGA, MIC, MIN, MIS, MKH, MNC, MNI, MNO, MOH, MOS, MUL, MUN, MUS, MWL, MWR, MYN, MYV, NAH, NAI, NAP, NDS, NEW, NIA, NIC, NIU, NOG, NON, NQO, NSO, NUB, NWC, NYM, NYN, NYO, NZI, OSA, OTA, OTO, PAA, PAG, PAL, PAM, PAP, PAU, PEO, PHI, PHN, PON, PRA, PRO, QAA, QTZ, RAJ, RAP, RAR, ROA, ROM, RUP, SAD, SAH, SAI, SAL, SAM, SAS, SAT, SCN, SCO, SEL, SEM, SGA, SGN, SHN, SID, SIO, SIT, SLA, SMA, SMI, SMJ, SMN, SMS, SNK, SOG, SON, SRN, SRR, SSA, SUK, SUS, SUX, SYC, SYR, TAI, TEM, TER, TET, TIG, TIV, TKL, TLH, TLI, TMH, TOG, TPI, TSI, TUM, TUP, TUT, TVL, TYV, UDM, UGA, UMB, UND, VAI, VOT, WAK, WAL, WAR, WAS, WEN, XAL, YAO, YAP, YPK, ZAP, ZBL, ZEN, ZGH, ZND, ZUN, ZXX, ZZA, AAR, ABK, AVE, AFR, AKA, AMH, ARG, ARA, ASM, AVA, AYM, AZE, BAK, BEL, BUL, BIS, BAM, BEN, BOD, TIB, BRE, BOS, CAT, CHE, CHA, COS, CRE, CES, CZE, CHU, CHV, CYM, WEL, DAN, DEU, GER, DIV, DZO, EWE, ELL, GRE, ENG, EPO, SPA, EST, EUS, BAQ, FAS, PER, FUL, FIN, FIJ, FAO, FRA, FRE, FRY, GLE, GLA, GLG, GRN, GUJ, GLV, HAU, HEB, HIN, HMO, HRV, HAT, HUN, HYE, ARM, HER, INA, IND, ILE, IBO, III, IPK, IDO, ISL, ICE, ITA, IKU, JPN, JAV, KAT, GEO, KON, KIK, KUA, KAZ, KAL, KHM, KAN, KOR, KAU, KAS, KUR, KOM, COR, KIR, LAT, LTZ, LUG, LIM, LIN, LAO, LIT, LUB, LAV, MLG, MAH, MRI, MAO, MKD, MAC, MAL, MON, MAR, MSA, MAY, MLT, MYA, BUR, NAU, NOB, NDE, NEP, NDO, NLD, DUT, NNO, NOR, NBL, NAV, NYA, OCI, OJI, ORM, ORI, OSS, PAN, PLI, POL, PUS, POR, QUE, ROH, RUN, RON, RUM, RUS, KIN, SAN, SRD, SND, SME, SAG, SIN, SLK, SLO, SLV, SMO, SNA, SOM, SQI, ALB, SRP, SSW, SOT, SUN, SWE, SWA, TAM, TEL, TGK, THA, TIR, TUK, TGL, TSN, TON, TUR, TSO, TAT, TWI, TAH, UIG, UKR, URD, UZB, VEN, VIE, VOL, WLN, WOL, XHO, YID, YOR, ZHA, ZHO, CHI, ZUL, USA, ARB, JAP, ZHE, SVN
    example: ENG
  - summaryListarrayoptional
    labelstringoptional
    label of the field
    example: Number of people
    valuestringoptional
    value
    example: 4
- planobjectoptional
  - totalAmountstringoptional
  - contractIdstringoptional
  - planTypestringoptional
    FIXED, VARIABLE, ACQUIRER_AGREEMENT
  - statusstringoptional
    ACTIVE, INACTIVE, COMPLETED

Request body

{
    "captureType": "EXPLICIT",
    "contractId": "contractId",
    "order": {
        "amount": "3545",
        "termsAndConditionsIds": [
            "16dd6ac6-0791-4c72-b362-85f77f1728a2",
            "16dd6ac6-0791-4c72-b362-85f77f1728a2"
        ],
        "installments": [
            {
                "date": "2000-01-23T00:00:00.000Z",
                "amount": "350"
            },
            {
                "date": "2000-01-23T00:00:00.000Z",
                "amount": "350"
            }
        ],
        "orderId": "btid2384983",
        "customerId": "mcid97295873",
        "customerInfo": {
            "mobilePhone": "3280987654",
            "cardHolderName": "Mauro Morandi",
            "homePhone": "391231234567",
            "mobilePhoneCountryCode": 39,
            "shippingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderAcctInfo": {
                "chAccDate": "2019-02-11T00:00:00.000+0000",
                "txnActivityYear": 0,
                "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                "provisionAttemptsDay": 0,
                "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                "destinationAddressUsageIndicator": "01",
                "chAccChangeIndicator": "01",
                "nbPurchaseAccount": 0,
                "destinationNameIndicator": "01",
                "chAccPwChangeIndicator": "01",
                "paymentAccIndicator": "0",
                "chAccAgeIndicator": "01",
                "suspiciousAccActivity": "01",
                "txnActivityDay": 0
            },
            "workPhone": "391231234567",
            "billingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderEmail": "mauro.morandi@nexi.it",
            "merchantRiskIndicator": {
                "deliveryTimeframe": "01",
                "preOrderDate": "2019-02-11T00:00:00.000+0000",
                "reorderItemsIndicator": "01",
                "shipIndicator": "01",
                "giftCardAmount": {
                    "currency": "EUR",
                    "value": "100"
                },
                "deliveryEmail": "john.doe@email.com",
                "giftCardCount": 0,
                "preOrderPurchaseIndicator": "01"
            }
        },
        "description": "TV LG 3423",
        "currency": "EUR",
        "transactionSummary": [
            {
                "summaryList": [
                    {
                        "label": "Number of people",
                        "value": "4"
                    },
                    {
                        "label": "Number of people",
                        "value": "4"
                    }
                ],
                "language": "ENG"
            },
            {
                "summaryList": [
                    {
                        "label": "Number of people",
                        "value": "4"
                    },
                    {
                        "label": "Number of people",
                        "value": "4"
                    }
                ],
                "language": "ENG"
            }
        ],
        "plan": {
            "totalAmount": "totalAmount",
            "contractId": "contractId"
        },
        "customField": "weekend promotion"
    }
}

Responses

200OKoptional
- operationobjectoptional
  - additionalDataobjectoptional
    Map of additional fields specific to the chosen payment method
  - cancelledOperationIdstringoptional
    Operation id to be undone
  - channelstringoptional
    It indicates the originating channel:
    
    ECOMMERCE - carholder initiated operation through an online channel.
    
    POS - carholder initiated operation through a physical POS.
    
    BACKOFFICE - merchant initiated operation. It includes post operations and MIT.
    
    ECOMMERCE, POS, BACKOFFICE
    example: ECOMMERCE
  - customerInfoobjectoptional
    This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
    billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
    cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
    cardHolderNamestringoptionalexample: Mauro Morandi
    homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
    merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
    mobilePhonestringoptionalexample: 3280987654
    mobilePhoneCountryCodestringoptionalexample: 39
    shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
  - omnichannelIdstringoptional
  - operationAmountstringoptional
    Operation amount in the payment currency
    example: 3545
  - operationCurrencystringoptional
    Payment currency
    example: EUR
  - operationIdstringoptionalexample: 3470744
  - operationResultstringoptional
    Transaction output:
    
    AUTHORIZED - Payment authorized
    
    EXECUTED - Payment confirmed, verification successfully executed
    
    DECLINED - Declined by the Issuer during the authorization phase
    
    DENIED_BY_RISK - Negative outcome of the transaction risk analysis
    
    DENIED
    
    THREEDS_VALIDATED - 3DS authentication OK or 3DS skipped (non-secure payment)
    
    THREEDS_FAILED - cancellation or authentication failure during 3DS
    
    PENDING - Payment ongoing. Follow up notifications are expected
    
    CANCELED - Canceled by the cardholder
    
    VOIDED - Online reversal of the full authorized amount
    
    REFUNDED - Full or partial amount refunded
    
    FAILED - Payment failed due to technical reasons
    
    AUTHORIZED, EXECUTED, DECLINED, DENIED_BY_RISK, DENIED, THREEDS_VALIDATED, THREEDS_FAILED, PENDING, CANCELED, VOIDED, REFUNDED, FAILED
    example: AUTHORIZED
  - operationTimestring (date-time)optional
    Operation time in ISO 8601 format
  - operationTypestringoptional
    It indicates the purpose of the request:
    
    AUTHORIZATION - any authorization with explicit capture
    
    CAPTURE - a captured authorization or an implicit captured payment
    
    REFUND - refund of a captured amount
    
    CANCEL - the rollback of an capture, refund.
    
    NOSHOW
    
    INCREMENTAL
    
    DELAY_CHARGE
    
    CARD_VERIFICATION
    
    CARD_CHECK
    
    VOID - reversal of an authorization
    
    AUTHORIZATION, CAPTURE, REFUND, CANCEL, NOSHOW, INCREMENTAL, DELAY_CHARGE, CARD_VERIFICATION, CARD_CHECK, VOID
    example: CAPTURE
  - orderIdstringoptional
    Merchant order id, unique in the merchant domain
    example: btid2384983
  - paymentCircuitstringoptional
    One of the payment circuit values returned by the GET payment_methods web service. The list may include (but not limited to) VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY.
    example: VISA
  - paymentEndToEndIdstringoptional
    It is defined by the circuit to uniquely identify the transaction. Required for circuid reconciliation purposes.
    example: e723hedsdew
  - paymentInstrumentInfostringoptional
    Payment instrument information
    example: ***6152
  - paymentLinkIdstringoptional
    PayByLink id used for correlating this operation with the original link.
    example: 234244353
  - paymentMethodstringoptional
    
    CARD - Any card circuit
    
    APM - Alternative payment method
    
    CARD, APM
    example: CARD
  - warningsarrayoptional
    codestringoptionalexample: TRA001
    descriptionstringoptionalexample: 3DS warning
- warningsarrayoptional
  - codestringoptionalexample: TRA001
  - descriptionstringoptionalexample: 3DS warning
201Createdoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "warnings": [
        {
            "code": "TRA001",
            "description": "3DS warning"
        },
        {
            "code": "TRA001",
            "description": "3DS warning"
        }
    ],
    "operation": {
        "paymentLinkId": "234244353",
        "orderId": "btid2384983",
        "warnings": [
            {
                "code": "TRA001",
                "description": "3DS warning"
            },
            {
                "code": "TRA001",
                "description": "3DS warning"
            }
        ],
        "channel": "ECOMMERCE",
        "customerInfo": {
            "mobilePhone": "3280987654",
            "cardHolderName": "Mauro Morandi",
            "homePhone": "391231234567",
            "mobilePhoneCountryCode": 39,
            "shippingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderAcctInfo": {
                "chAccDate": "2019-02-11T00:00:00.000+0000",
                "txnActivityYear": 0,
                "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                "provisionAttemptsDay": 0,
                "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                "destinationAddressUsageIndicator": "01",
                "chAccChangeIndicator": "01",
                "nbPurchaseAccount": 0,
                "destinationNameIndicator": "01",
                "chAccPwChangeIndicator": "01",
                "paymentAccIndicator": "0",
                "chAccAgeIndicator": "01",
                "suspiciousAccActivity": "01",
                "txnActivityDay": 0
            },
            "workPhone": "391231234567",
            "billingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderEmail": "mauro.morandi@nexi.it",
            "merchantRiskIndicator": {
                "deliveryTimeframe": "01",
                "preOrderDate": "2019-02-11T00:00:00.000+0000",
                "reorderItemsIndicator": "01",
                "shipIndicator": "01",
                "giftCardAmount": {
                    "currency": "EUR",
                    "value": "100"
                },
                "deliveryEmail": "john.doe@email.com",
                "giftCardCount": 0,
                "preOrderPurchaseIndicator": "01"
            }
        },
        "operationTime": "2000-01-23T04:56:07.000Z",
        "paymentCircuit": "VISA",
        "omnichannelId": "omnichannelId",
        "operationAmount": "3545",
        "operationId": "3470744",
        "paymentEndToEndId": "e723hedsdew",
        "paymentMethod": "CARD",
        "operationType": "CAPTURE",
        "additionalData": {
            "authorizationCode": "647189",
            "cardCountry": "ITA",
            "threeDS": "FULL_SECURE",
            "schemaTID": "MCS01198U",
            "multiCurrencyConversion": {
                "amount": "2662",
                "currency": "JPY",
                "exchangeRate": "0.007510523"
            }
        },
        "operationCurrency": "EUR",
        "paymentInstrumentInfo": "***6152",
        "cancelledOperationId": "",
        "operationResult": "AUTHORIZED"
    }
}

payByLink

POST /api/v1/orders/paybylink

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
x-plugin-namestringoptional
x-plugin-name
x-userstringoptional
x-user
x-versionstringoptional
x-version

payByLink

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/paybylink");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("x-plugin-name", "SOME_STRING_VALUE");
request.AddHeader("x-user", "SOME_STRING_VALUE");
request.AddHeader("x-version", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

expirationDatestringoptional
orderobjectoptional
- amountstringrequired
  Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)
  example: 3545
- currencystringrequired
  Transaction currency. ISO 4217 alphabetic code
  
  AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAL, XAU, XBA, XBB, XBC, XBD, XCD, XCP, XDR, XFO, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW, ZWL
  example: EUR
- customFieldstringoptional
  Additional transaction description
  example: weekend promotion
- customerIdstringoptional
  Immutable identifier of the payer as registered on the ecommerce platform.
  example: mcid97295873
- customerInfoobjectoptional
  This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
  - billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
  - cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
  - cardHolderNamestringoptionalexample: Mauro Morandi
  - homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
  - merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
  - mobilePhonestringoptionalexample: 3280987654
  - mobilePhoneCountryCodestringoptionalexample: 39
  - shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
- descriptionstringoptional
  Transaction description
  example: TV LG 3423
- installmentsarrayoptional
  - amountstringoptional
    Installment amount.
    example: 350
  - datestring (date)optional
    Installment time in ISO 8601 format.
  - typestringoptional
    AUTOMATIC, MANUAL
- orderIdstringrequired
  Merchant order id, unique in the merchant domain
  example: btid2384983
- termsAndConditionsIdsarrayoptional
- transactionSummaryarrayoptional
  - languagestringoptional
    Language in ISO 639-2.
    
    ACE, ACH, ADA, ADY, AFA, AFH, AIN, AKK, ALE, ALG, ALT, ANG, ANP, APA, ARC, ARN, ARP, ART, ARW, AST, ATH, AUS, AWA, BAD, BAI, BAL, BAN, BAS, BAT, BEJ, BEM, BER, BHO, BIH, BIK, BIN, BLA, BNT, BRA, BTK, BUA, BUG, BYN, CAD, CAI, CAR, CAU, CEB, CEL, CHB, CHG, CHK, CHM, CHN, CHO, CHP, CHR, CHY, CMC, CNR, COP, CPE, CPF, CPP, CRH, CRP, CSB, CUS, DAK, DAR, DAY, DEL, DEN, DGR, DIN, DOI, DRA, DSB, DUA, DUM, DYU, EFI, EGY, EKA, ELX, ENM, EWO, FAN, FAT, FIL, FIU, FON, FRM, FRO, FRR, FRS, FUR, GAA, GAY, GBA, GEM, GEZ, GIL, GMH, GOH, GON, GOR, GOT, GRB, GRC, GSW, GWI, HAI, HAW, HIL, HIM, HIT, HMN, HSB, HUP, IBA, IJO, ILO, INC, INE, INH, IRA, IRO, JBO, JPR, JRB, KAA, KAB, KAC, KAM, KAR, KAW, KBD, KHA, KHI, KHO, KMB, KOK, KOS, KPE, KRC, KRL, KRO, KRU, KUM, KUT, LAD, LAH, LAM, LEZ, LOL, LOZ, LUA, LUI, LUN, LUO, LUS, MAD, MAG, MAI, MAK, MAN, MAP, MAS, MDF, MDR, MEN, MGA, MIC, MIN, MIS, MKH, MNC, MNI, MNO, MOH, MOS, MUL, MUN, MUS, MWL, MWR, MYN, MYV, NAH, NAI, NAP, NDS, NEW, NIA, NIC, NIU, NOG, NON, NQO, NSO, NUB, NWC, NYM, NYN, NYO, NZI, OSA, OTA, OTO, PAA, PAG, PAL, PAM, PAP, PAU, PEO, PHI, PHN, PON, PRA, PRO, QAA, QTZ, RAJ, RAP, RAR, ROA, ROM, RUP, SAD, SAH, SAI, SAL, SAM, SAS, SAT, SCN, SCO, SEL, SEM, SGA, SGN, SHN, SID, SIO, SIT, SLA, SMA, SMI, SMJ, SMN, SMS, SNK, SOG, SON, SRN, SRR, SSA, SUK, SUS, SUX, SYC, SYR, TAI, TEM, TER, TET, TIG, TIV, TKL, TLH, TLI, TMH, TOG, TPI, TSI, TUM, TUP, TUT, TVL, TYV, UDM, UGA, UMB, UND, VAI, VOT, WAK, WAL, WAR, WAS, WEN, XAL, YAO, YAP, YPK, ZAP, ZBL, ZEN, ZGH, ZND, ZUN, ZXX, ZZA, AAR, ABK, AVE, AFR, AKA, AMH, ARG, ARA, ASM, AVA, AYM, AZE, BAK, BEL, BUL, BIS, BAM, BEN, BOD, TIB, BRE, BOS, CAT, CHE, CHA, COS, CRE, CES, CZE, CHU, CHV, CYM, WEL, DAN, DEU, GER, DIV, DZO, EWE, ELL, GRE, ENG, EPO, SPA, EST, EUS, BAQ, FAS, PER, FUL, FIN, FIJ, FAO, FRA, FRE, FRY, GLE, GLA, GLG, GRN, GUJ, GLV, HAU, HEB, HIN, HMO, HRV, HAT, HUN, HYE, ARM, HER, INA, IND, ILE, IBO, III, IPK, IDO, ISL, ICE, ITA, IKU, JPN, JAV, KAT, GEO, KON, KIK, KUA, KAZ, KAL, KHM, KAN, KOR, KAU, KAS, KUR, KOM, COR, KIR, LAT, LTZ, LUG, LIM, LIN, LAO, LIT, LUB, LAV, MLG, MAH, MRI, MAO, MKD, MAC, MAL, MON, MAR, MSA, MAY, MLT, MYA, BUR, NAU, NOB, NDE, NEP, NDO, NLD, DUT, NNO, NOR, NBL, NAV, NYA, OCI, OJI, ORM, ORI, OSS, PAN, PLI, POL, PUS, POR, QUE, ROH, RUN, RON, RUM, RUS, KIN, SAN, SRD, SND, SME, SAG, SIN, SLK, SLO, SLV, SMO, SNA, SOM, SQI, ALB, SRP, SSW, SOT, SUN, SWE, SWA, TAM, TEL, TGK, THA, TIR, TUK, TGL, TSN, TON, TUR, TSO, TAT, TWI, TAH, UIG, UKR, URD, UZB, VEN, VIE, VOL, WLN, WOL, XHO, YID, YOR, ZHA, ZHO, CHI, ZUL, USA, ARB, JAP, ZHE, SVN
    example: ENG
  - summaryListarrayoptional
    labelstringoptional
    label of the field
    example: Number of people
    valuestringoptional
    value
    example: 4
- planobjectoptional
  - totalAmountstringoptional
  - contractIdstringoptional
  - planTypestringoptional
    FIXED, VARIABLE, ACQUIRER_AGREEMENT
  - statusstringoptional
    ACTIVE, INACTIVE, COMPLETED
paymentSessionobjectoptional
- actionTypestringoptional
  PAY, VERIFY, PURCHASE, PREAUTH
  example: PAY
- amountstringrequired
  Amount of the first payment which may be less or equals to the order amount. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)
  example: 3545
- cancelUrlstringrequired
  Merchant URL where the cardholder is redirected once the hosted payment is abandoned
  example: https://{merchant_cancel_url}
- captureTypestringoptional
  Overwrites the default confirmation method of the terminal, for card payments only:
  
  IMPLICIT - automatic confirmation
  
  EXPLICIT - authorization only Default value depends on the terminal configuration.
  
  Terminal set to EXPLICIT: a. if the captureType is EXPLICIT the capture will be EXPLICIT b. if the captureType is not present or null the capture will be EXPLICIT c. if the captureType is IMPLICIT the capture will be IMPLICIT
  
  Terminal set to IMPLICIT: a. if the captureType is EXPLICIT the capture will be an error b. if the captureType is not present or null the capture will be IMPLICIT c. if the captureType is IMPLICIT the capture will be IMPLICIT
  
  DEFERRED, EXPLICIT, FILE, IMPLICIT
  example: EXPLICIT
- exemptionsstringoptional
  It indicates the possible of exemption options
  
  NO_PREFERENCE - the merchant can request a payment without any preference
  
  CHALLENGE_REQUESTED - the merchant can request a payment with challenge
  
  EXEMPTION_REQUESTED - the merchant can request a payment with using Sca Exemption
  
  NO_PREFERENCE, CHALLENGE_REQUESTED, EXEMPTION_REQUESTED
  example: NO_PREFERENCE
- languagestringrequired
  Language in ISO 639-2.
  
  ACE, ACH, ADA, ADY, AFA, AFH, AIN, AKK, ALE, ALG, ALT, ANG, ANP, APA, ARC, ARN, ARP, ART, ARW, AST, ATH, AUS, AWA, BAD, BAI, BAL, BAN, BAS, BAT, BEJ, BEM, BER, BHO, BIH, BIK, BIN, BLA, BNT, BRA, BTK, BUA, BUG, BYN, CAD, CAI, CAR, CAU, CEB, CEL, CHB, CHG, CHK, CHM, CHN, CHO, CHP, CHR, CHY, CMC, CNR, COP, CPE, CPF, CPP, CRH, CRP, CSB, CUS, DAK, DAR, DAY, DEL, DEN, DGR, DIN, DOI, DRA, DSB, DUA, DUM, DYU, EFI, EGY, EKA, ELX, ENM, EWO, FAN, FAT, FIL, FIU, FON, FRM, FRO, FRR, FRS, FUR, GAA, GAY, GBA, GEM, GEZ, GIL, GMH, GOH, GON, GOR, GOT, GRB, GRC, GSW, GWI, HAI, HAW, HIL, HIM, HIT, HMN, HSB, HUP, IBA, IJO, ILO, INC, INE, INH, IRA, IRO, JBO, JPR, JRB, KAA, KAB, KAC, KAM, KAR, KAW, KBD, KHA, KHI, KHO, KMB, KOK, KOS, KPE, KRC, KRL, KRO, KRU, KUM, KUT, LAD, LAH, LAM, LEZ, LOL, LOZ, LUA, LUI, LUN, LUO, LUS, MAD, MAG, MAI, MAK, MAN, MAP, MAS, MDF, MDR, MEN, MGA, MIC, MIN, MIS, MKH, MNC, MNI, MNO, MOH, MOS, MUL, MUN, MUS, MWL, MWR, MYN, MYV, NAH, NAI, NAP, NDS, NEW, NIA, NIC, NIU, NOG, NON, NQO, NSO, NUB, NWC, NYM, NYN, NYO, NZI, OSA, OTA, OTO, PAA, PAG, PAL, PAM, PAP, PAU, PEO, PHI, PHN, PON, PRA, PRO, QAA, QTZ, RAJ, RAP, RAR, ROA, ROM, RUP, SAD, SAH, SAI, SAL, SAM, SAS, SAT, SCN, SCO, SEL, SEM, SGA, SGN, SHN, SID, SIO, SIT, SLA, SMA, SMI, SMJ, SMN, SMS, SNK, SOG, SON, SRN, SRR, SSA, SUK, SUS, SUX, SYC, SYR, TAI, TEM, TER, TET, TIG, TIV, TKL, TLH, TLI, TMH, TOG, TPI, TSI, TUM, TUP, TUT, TVL, TYV, UDM, UGA, UMB, UND, VAI, VOT, WAK, WAL, WAR, WAS, WEN, XAL, YAO, YAP, YPK, ZAP, ZBL, ZEN, ZGH, ZND, ZUN, ZXX, ZZA, AAR, ABK, AVE, AFR, AKA, AMH, ARG, ARA, ASM, AVA, AYM, AZE, BAK, BEL, BUL, BIS, BAM, BEN, BOD, TIB, BRE, BOS, CAT, CHE, CHA, COS, CRE, CES, CZE, CHU, CHV, CYM, WEL, DAN, DEU, GER, DIV, DZO, EWE, ELL, GRE, ENG, EPO, SPA, EST, EUS, BAQ, FAS, PER, FUL, FIN, FIJ, FAO, FRA, FRE, FRY, GLE, GLA, GLG, GRN, GUJ, GLV, HAU, HEB, HIN, HMO, HRV, HAT, HUN, HYE, ARM, HER, INA, IND, ILE, IBO, III, IPK, IDO, ISL, ICE, ITA, IKU, JPN, JAV, KAT, GEO, KON, KIK, KUA, KAZ, KAL, KHM, KAN, KOR, KAU, KAS, KUR, KOM, COR, KIR, LAT, LTZ, LUG, LIM, LIN, LAO, LIT, LUB, LAV, MLG, MAH, MRI, MAO, MKD, MAC, MAL, MON, MAR, MSA, MAY, MLT, MYA, BUR, NAU, NOB, NDE, NEP, NDO, NLD, DUT, NNO, NOR, NBL, NAV, NYA, OCI, OJI, ORM, ORI, OSS, PAN, PLI, POL, PUS, POR, QUE, ROH, RUN, RON, RUM, RUS, KIN, SAN, SRD, SND, SME, SAG, SIN, SLK, SLO, SLV, SMO, SNA, SOM, SQI, ALB, SRP, SSW, SOT, SUN, SWE, SWA, TAM, TEL, TGK, THA, TIR, TUK, TGL, TSN, TON, TUR, TSO, TAT, TWI, TAH, UIG, UKR, URD, UZB, VEN, VIE, VOL, WLN, WOL, XHO, YID, YOR, ZHA, ZHO, CHI, ZUL, USA, ARB, JAP, ZHE, SVN
  example: ENG
- notificationUrlstringoptional
  Merchant URL where the gateway pushes notifications
  example: https://{merchant_notification_url}
- paymentServicestringoptional
  Return the card fields in case of CARDS or an url where the cardholder should be redirect to complete the payment in case of an APM
  example: GOOGLEPAY
- recurrenceobjectoptional
  - actionstringoptional
    NO_RECURRING, CARD_SUBSTITUTION, CONTRACT_CREATION, SUBSEQUENT_PAYMENT
    example: CONTRACT_CREATION
  - contractTypestringoptional
    It indicates the possible options for the subsequent payments:
    
    CIT - the contract can be used only for subsequent payments initiated by the customer.
    
    MIT_SCHEDULED - the contract can be used for scheduled merchant initiated transactions. The number of day between one payment and another shall be equal or higher than the value of contractFrequency.
    
    MIT_UNSCHEDULED - the contract can be used for unscheduled merchant initiated transactions. The contractFrequency has no effect in this case.
    
    CIT, MIT_SCHEDULED, MIT_UNSCHEDULED
    example: CIT
  - contractExpiryDatestring (date)optional
    Used with contractType MIT_SCHEDULED. ISO 8601 format. If the token was provided by VTS or MDES, it represents the expiry date of the token provided by the circuit
  - contractFrequencystringoptional
    Mandatory when contract type is MIT_SCHEDULED Used with contractType MIT_SCHEDULED. Number of days
    example: 120
  - contractIdstringoptionalexample: C2834987
- resultUrlstringrequired
  Merchant URL where the cardholder is redirected once the hosted payment completes
  example: https://{merchant_result_url}

Request body

{
    "paymentSession": {
        "notificationUrl": "https://{merchant_notification_url}",
        "recurrence": {
            "contractType": "CIT",
            "contractFrequency": "120",
            "contractExpiryDate": "2000-01-23T00:00:00.000Z",
            "contractId": "C2834987",
            "action": "CONTRACT_CREATION"
        },
        "actionType": "PAY",
        "amount": "3545",
        "cancelUrl": "https://{merchant_cancel_url}",
        "exemptions": "NO_PREFERENCE",
        "paymentService": "GOOGLEPAY",
        "captureType": "EXPLICIT",
        "resultUrl": "https://{merchant_result_url}",
        "language": "ENG"
    },
    "expirationDate": "expirationDate",
    "order": {
        "amount": "3545",
        "termsAndConditionsIds": [
            "16dd6ac6-0791-4c72-b362-85f77f1728a2",
            "16dd6ac6-0791-4c72-b362-85f77f1728a2"
        ],
        "installments": [
            {
                "date": "2000-01-23T00:00:00.000Z",
                "amount": "350"
            },
            {
                "date": "2000-01-23T00:00:00.000Z",
                "amount": "350"
            }
        ],
        "orderId": "btid2384983",
        "customerId": "mcid97295873",
        "customerInfo": {
            "mobilePhone": "3280987654",
            "cardHolderName": "Mauro Morandi",
            "homePhone": "391231234567",
            "mobilePhoneCountryCode": 39,
            "shippingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderAcctInfo": {
                "chAccDate": "2019-02-11T00:00:00.000+0000",
                "txnActivityYear": 0,
                "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                "provisionAttemptsDay": 0,
                "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                "destinationAddressUsageIndicator": "01",
                "chAccChangeIndicator": "01",
                "nbPurchaseAccount": 0,
                "destinationNameIndicator": "01",
                "chAccPwChangeIndicator": "01",
                "paymentAccIndicator": "0",
                "chAccAgeIndicator": "01",
                "suspiciousAccActivity": "01",
                "txnActivityDay": 0
            },
            "workPhone": "391231234567",
            "billingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderEmail": "mauro.morandi@nexi.it",
            "merchantRiskIndicator": {
                "deliveryTimeframe": "01",
                "preOrderDate": "2019-02-11T00:00:00.000+0000",
                "reorderItemsIndicator": "01",
                "shipIndicator": "01",
                "giftCardAmount": {
                    "currency": "EUR",
                    "value": "100"
                },
                "deliveryEmail": "john.doe@email.com",
                "giftCardCount": 0,
                "preOrderPurchaseIndicator": "01"
            }
        },
        "description": "TV LG 3423",
        "currency": "EUR",
        "transactionSummary": [
            {
                "summaryList": [
                    {
                        "label": "Number of people",
                        "value": "4"
                    },
                    {
                        "label": "Number of people",
                        "value": "4"
                    }
                ],
                "language": "ENG"
            },
            {
                "summaryList": [
                    {
                        "label": "Number of people",
                        "value": "4"
                    },
                    {
                        "label": "Number of people",
                        "value": "4"
                    }
                ],
                "language": "ENG"
            }
        ],
        "plan": {
            "totalAmount": "totalAmount",
            "contractId": "contractId"
        },
        "customField": "weekend promotion"
    }
}

Responses

200OKoptional
- paymentLinkobjectoptional
  - amountstringoptional
  - expirationDatestringoptional
  - linkstringoptional
  - linkIdstringoptional
  - paidByOperationIdstringoptional
  - statusstringoptional
    ACTIVE, DELETED, EXPIRED, INACTIVE
- securityTokenstringoptional
- warningsarrayoptional
  - codestringoptionalexample: TRA001
  - descriptionstringoptionalexample: 3DS warning
201Createdoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "securityToken": "securityToken",
    "warnings": [
        {
            "code": "TRA001",
            "description": "3DS warning"
        },
        {
            "code": "TRA001",
            "description": "3DS warning"
        }
    ],
    "paymentLink": {
        "amount": "amount",
        "linkId": "linkId",
        "paidByOperationId": "paidByOperationId",
        "link": "link",
        "expirationDate": "expirationDate"
    }
}

payByLinkReport

GET /api/v1/orders/paybylink

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
fromTimestringoptional
fromTime
maxRecordsinteger (int32)optional
maxRecords
statusstringoptional
status
toTimestringoptional
toTime
userstringoptional
user

payByLinkReport

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/paybylink?fromTime=SOME_STRING_VALUE&maxRecords=SOME_INTEGER_VALUE&status=SOME_STRING_VALUE&toTime=SOME_STRING_VALUE&user=SOME_STRING_VALUE");
var request = new RestRequest(Method.GET);
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200OKoptional
- paymentLinksarrayoptional
  - creationDatestringoptional
  - currencystringoptional
  - lastUpdatedDatestringoptional
  - sharingModestringoptional
  - userstringoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "paymentLinks": [
        {
            "lastUpdatedDate": "lastUpdatedDate",
            "sharingMode": "sharingMode",
            "currency": "currency",
            "creationDate": "creationDate",
            "user": "user"
        },
        {
            "lastUpdatedDate": "lastUpdatedDate",
            "sharingMode": "sharingMode",
            "currency": "currency",
            "creationDate": "creationDate",
            "user": "user"
        }
    ]
}

cancelPaymentLink

POST /api/v1/paybylink/{linkId}/cancels

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
linkIdstringrequired
linkId

cancelPaymentLink

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/paybylink/{linkId}/cancels");
var request = new RestRequest(Method.POST);
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200OKoptional
201Createdoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

Finds recurring contracts by customer ID

GET /api/v1/contracts/customers/{customerId}

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
customerIdstringrequired
Customer ID

Finds recurring contracts by customer ID

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/contracts/customers/36451278");
var request = new RestRequest(Method.GET);
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200Payment successfuloptional
- contractsarrayoptional
  - contractExpiryDatestringoptional
  - contractFrequencystringoptional
  - contractIdstringoptional
  - contractTypestringoptional
    It indicates the possible options for the subsequent payments:
    
    CIT - the contract can be used only for subsequent payments initiated by the customer.
    
    MIT_SCHEDULED - the contract can be used for scheduled merchant initiated transactions. The number of day between one payment and another shall be equal or higher than the value of contractFrequency.
    
    MIT_UNSCHEDULED - the contract can be used for unscheduled merchant initiated transactions. The contractFrequency has no effect in this case.
    
    CIT, MIT_SCHEDULED, MIT_UNSCHEDULED
    example: CIT
  - paymentCircuitstringoptional
    ALIPAY, AMAZON_PAY, AMEX, APPLE_PAY, BANCOMAT_PAY, BANCONTACT, DINERS, GOOGLE_PAY, MC, MYBANK, PAYPAL, PIS, VISA
  - paymentInstrumentInfostringoptional
  - paymentMethodstringoptional
    
    CARD - Any card circuit
    
    APM - Alternative payment method
    
    CARD, APM
    example: CARD
- customerIdstringoptional
401Unauthorizedoptional
403Forbiddenoptional
404Customer not foundoptional
500Internal Server Erroroptional
- errorsarrayoptional
  - codestringoptionalexample: GW0001
  - descriptionstringoptionalexample: Invalid merchant URL

{
    "customerId": "customerId",
    "contracts": [
        {
            "contractType": "CIT",
            "contractFrequency": "contractFrequency",
            "contractExpiryDate": "contractExpiryDate",
            "contractId": "contractId",
            "paymentMethod": "CARD",
            "paymentInstrumentInfo": "paymentInstrumentInfo"
        },
        {
            "contractType": "CIT",
            "contractFrequency": "contractFrequency",
            "contractExpiryDate": "contractExpiryDate",
            "contractId": "contractId",
            "paymentMethod": "CARD",
            "paymentInstrumentInfo": "paymentInstrumentInfo"
        }
    ]
}

Disables a contract

POST /api/v1/contracts/{contractId}/deactivation

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
contractIdstringrequired
Recurring contract id

Disables a contract

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/contracts/C2834987/deactivation");
var request = new RestRequest(Method.POST);
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200Deactivation successfuloptional
201Createdoptional
400Invalid request dataoptional
- timestampstringoptional
- errorsarrayoptional
  - codestringoptionalexample: GW0001
  - descriptionstringoptionalexample: Invalid merchant URL
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional
500Internal Server Erroroptional
- errorsarrayoptional
  - codestringoptionalexample: GW0001
  - descriptionstringoptionalexample: Invalid merchant URL

{
    "timestamp": "string",
    "errors": [
        {
            "code": "GW0001",
            "description": "Invalid merchant URL"
        }
    ]
}

initiate

POST /api/v1/orders/3steps/init

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.

initiate

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/3steps/init");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

actionTypestringoptional
PAY, VERIFY, PURCHASE, PREAUTH
example: PAY
cardobjectoptional
- cvvstringoptionalexample: 123
- expiryDatestringoptionalexample: 1225
- panstringrequiredexample: 1234567890123456
exemptionsstringoptional
It indicates the possible of exemption options

NO_PREFERENCE - the merchant can request a payment without any preference

CHALLENGE_REQUESTED - the merchant can request a payment with challenge

EXEMPTION_REQUESTED - the merchant can request a payment with using Sca Exemption

NO_PREFERENCE, CHALLENGE_REQUESTED, EXEMPTION_REQUESTED
example: NO_PREFERENCE
orderobjectoptional
- amountstringrequired
  Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)
  example: 3545
- currencystringrequired
  Transaction currency. ISO 4217 alphabetic code
  
  AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAL, XAU, XBA, XBB, XBC, XBD, XCD, XCP, XDR, XFO, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW, ZWL
  example: EUR
- customFieldstringoptional
  Additional transaction description
  example: weekend promotion
- customerIdstringoptional
  Immutable identifier of the payer as registered on the ecommerce platform.
  example: mcid97295873
- customerInfoobjectoptional
  This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
  - billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
  - cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
  - cardHolderNamestringoptionalexample: Mauro Morandi
  - homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
  - merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
  - mobilePhonestringoptionalexample: 3280987654
  - mobilePhoneCountryCodestringoptionalexample: 39
  - shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
- descriptionstringoptional
  Transaction description
  example: TV LG 3423
- installmentsarrayoptional
  - amountstringoptional
    Installment amount.
    example: 350
  - datestring (date)optional
    Installment time in ISO 8601 format.
  - typestringoptional
    AUTOMATIC, MANUAL
- orderIdstringrequired
  Merchant order id, unique in the merchant domain
  example: btid2384983
- termsAndConditionsIdsarrayoptional
- transactionSummaryarrayoptional
  - languagestringoptional
    Language in ISO 639-2.
    
    ACE, ACH, ADA, ADY, AFA, AFH, AIN, AKK, ALE, ALG, ALT, ANG, ANP, APA, ARC, ARN, ARP, ART, ARW, AST, ATH, AUS, AWA, BAD, BAI, BAL, BAN, BAS, BAT, BEJ, BEM, BER, BHO, BIH, BIK, BIN, BLA, BNT, BRA, BTK, BUA, BUG, BYN, CAD, CAI, CAR, CAU, CEB, CEL, CHB, CHG, CHK, CHM, CHN, CHO, CHP, CHR, CHY, CMC, CNR, COP, CPE, CPF, CPP, CRH, CRP, CSB, CUS, DAK, DAR, DAY, DEL, DEN, DGR, DIN, DOI, DRA, DSB, DUA, DUM, DYU, EFI, EGY, EKA, ELX, ENM, EWO, FAN, FAT, FIL, FIU, FON, FRM, FRO, FRR, FRS, FUR, GAA, GAY, GBA, GEM, GEZ, GIL, GMH, GOH, GON, GOR, GOT, GRB, GRC, GSW, GWI, HAI, HAW, HIL, HIM, HIT, HMN, HSB, HUP, IBA, IJO, ILO, INC, INE, INH, IRA, IRO, JBO, JPR, JRB, KAA, KAB, KAC, KAM, KAR, KAW, KBD, KHA, KHI, KHO, KMB, KOK, KOS, KPE, KRC, KRL, KRO, KRU, KUM, KUT, LAD, LAH, LAM, LEZ, LOL, LOZ, LUA, LUI, LUN, LUO, LUS, MAD, MAG, MAI, MAK, MAN, MAP, MAS, MDF, MDR, MEN, MGA, MIC, MIN, MIS, MKH, MNC, MNI, MNO, MOH, MOS, MUL, MUN, MUS, MWL, MWR, MYN, MYV, NAH, NAI, NAP, NDS, NEW, NIA, NIC, NIU, NOG, NON, NQO, NSO, NUB, NWC, NYM, NYN, NYO, NZI, OSA, OTA, OTO, PAA, PAG, PAL, PAM, PAP, PAU, PEO, PHI, PHN, PON, PRA, PRO, QAA, QTZ, RAJ, RAP, RAR, ROA, ROM, RUP, SAD, SAH, SAI, SAL, SAM, SAS, SAT, SCN, SCO, SEL, SEM, SGA, SGN, SHN, SID, SIO, SIT, SLA, SMA, SMI, SMJ, SMN, SMS, SNK, SOG, SON, SRN, SRR, SSA, SUK, SUS, SUX, SYC, SYR, TAI, TEM, TER, TET, TIG, TIV, TKL, TLH, TLI, TMH, TOG, TPI, TSI, TUM, TUP, TUT, TVL, TYV, UDM, UGA, UMB, UND, VAI, VOT, WAK, WAL, WAR, WAS, WEN, XAL, YAO, YAP, YPK, ZAP, ZBL, ZEN, ZGH, ZND, ZUN, ZXX, ZZA, AAR, ABK, AVE, AFR, AKA, AMH, ARG, ARA, ASM, AVA, AYM, AZE, BAK, BEL, BUL, BIS, BAM, BEN, BOD, TIB, BRE, BOS, CAT, CHE, CHA, COS, CRE, CES, CZE, CHU, CHV, CYM, WEL, DAN, DEU, GER, DIV, DZO, EWE, ELL, GRE, ENG, EPO, SPA, EST, EUS, BAQ, FAS, PER, FUL, FIN, FIJ, FAO, FRA, FRE, FRY, GLE, GLA, GLG, GRN, GUJ, GLV, HAU, HEB, HIN, HMO, HRV, HAT, HUN, HYE, ARM, HER, INA, IND, ILE, IBO, III, IPK, IDO, ISL, ICE, ITA, IKU, JPN, JAV, KAT, GEO, KON, KIK, KUA, KAZ, KAL, KHM, KAN, KOR, KAU, KAS, KUR, KOM, COR, KIR, LAT, LTZ, LUG, LIM, LIN, LAO, LIT, LUB, LAV, MLG, MAH, MRI, MAO, MKD, MAC, MAL, MON, MAR, MSA, MAY, MLT, MYA, BUR, NAU, NOB, NDE, NEP, NDO, NLD, DUT, NNO, NOR, NBL, NAV, NYA, OCI, OJI, ORM, ORI, OSS, PAN, PLI, POL, PUS, POR, QUE, ROH, RUN, RON, RUM, RUS, KIN, SAN, SRD, SND, SME, SAG, SIN, SLK, SLO, SLV, SMO, SNA, SOM, SQI, ALB, SRP, SSW, SOT, SUN, SWE, SWA, TAM, TEL, TGK, THA, TIR, TUK, TGL, TSN, TON, TUR, TSO, TAT, TWI, TAH, UIG, UKR, URD, UZB, VEN, VIE, VOL, WLN, WOL, XHO, YID, YOR, ZHA, ZHO, CHI, ZUL, USA, ARB, JAP, ZHE, SVN
    example: ENG
  - summaryListarrayoptional
    labelstringoptional
    label of the field
    example: Number of people
    valuestringoptional
    value
    example: 4
- planobjectoptional
  - totalAmountstringoptional
  - contractIdstringoptional
  - planTypestringoptional
    FIXED, VARIABLE, ACQUIRER_AGREEMENT
  - statusstringoptional
    ACTIVE, INACTIVE, COMPLETED
recurrenceobjectoptional
- actionstringoptional
  NO_RECURRING, CARD_SUBSTITUTION, CONTRACT_CREATION, SUBSEQUENT_PAYMENT
  example: CONTRACT_CREATION
- contractTypestringoptional
  It indicates the possible options for the subsequent payments:
  
  CIT - the contract can be used only for subsequent payments initiated by the customer.
  
  MIT_SCHEDULED - the contract can be used for scheduled merchant initiated transactions. The number of day between one payment and another shall be equal or higher than the value of contractFrequency.
  
  MIT_UNSCHEDULED - the contract can be used for unscheduled merchant initiated transactions. The contractFrequency has no effect in this case.
  
  CIT, MIT_SCHEDULED, MIT_UNSCHEDULED
  example: CIT
- contractExpiryDatestring (date)optional
  Used with contractType MIT_SCHEDULED. ISO 8601 format. If the token was provided by VTS or MDES, it represents the expiry date of the token provided by the circuit
- contractFrequencystringoptional
  Mandatory when contract type is MIT_SCHEDULED Used with contractType MIT_SCHEDULED. Number of days
  example: 120
- contractIdstringoptionalexample: C2834987

Request body

{
    "recurrence": {
        "contractType": "CIT",
        "contractFrequency": "120",
        "contractExpiryDate": "2000-01-23T00:00:00.000Z",
        "contractId": "C2834987",
        "action": "CONTRACT_CREATION"
    },
    "actionType": "PAY",
    "exemptions": "NO_PREFERENCE",
    "card": {
        "cvv": "123",
        "expiryDate": "1225",
        "pan": "1234567890123456"
    },
    "order": {
        "amount": "3545",
        "termsAndConditionsIds": [
            "16dd6ac6-0791-4c72-b362-85f77f1728a2",
            "16dd6ac6-0791-4c72-b362-85f77f1728a2"
        ],
        "installments": [
            {
                "date": "2000-01-23T00:00:00.000Z",
                "amount": "350"
            },
            {
                "date": "2000-01-23T00:00:00.000Z",
                "amount": "350"
            }
        ],
        "orderId": "btid2384983",
        "customerId": "mcid97295873",
        "customerInfo": {
            "mobilePhone": "3280987654",
            "cardHolderName": "Mauro Morandi",
            "homePhone": "391231234567",
            "mobilePhoneCountryCode": 39,
            "shippingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderAcctInfo": {
                "chAccDate": "2019-02-11T00:00:00.000+0000",
                "txnActivityYear": 0,
                "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                "provisionAttemptsDay": 0,
                "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                "destinationAddressUsageIndicator": "01",
                "chAccChangeIndicator": "01",
                "nbPurchaseAccount": 0,
                "destinationNameIndicator": "01",
                "chAccPwChangeIndicator": "01",
                "paymentAccIndicator": "0",
                "chAccAgeIndicator": "01",
                "suspiciousAccActivity": "01",
                "txnActivityDay": 0
            },
            "workPhone": "391231234567",
            "billingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderEmail": "mauro.morandi@nexi.it",
            "merchantRiskIndicator": {
                "deliveryTimeframe": "01",
                "preOrderDate": "2019-02-11T00:00:00.000+0000",
                "reorderItemsIndicator": "01",
                "shipIndicator": "01",
                "giftCardAmount": {
                    "currency": "EUR",
                    "value": "100"
                },
                "deliveryEmail": "john.doe@email.com",
                "giftCardCount": 0,
                "preOrderPurchaseIndicator": "01"
            }
        },
        "description": "TV LG 3423",
        "currency": "EUR",
        "transactionSummary": [
            {
                "summaryList": [
                    {
                        "label": "Number of people",
                        "value": "4"
                    },
                    {
                        "label": "Number of people",
                        "value": "4"
                    }
                ],
                "language": "ENG"
            },
            {
                "summaryList": [
                    {
                        "label": "Number of people",
                        "value": "4"
                    },
                    {
                        "label": "Number of people",
                        "value": "4"
                    }
                ],
                "language": "ENG"
            }
        ],
        "plan": {
            "totalAmount": "totalAmount",
            "contractId": "contractId"
        },
        "customField": "weekend promotion"
    }
}

Responses

200OKoptional
- operationobjectoptional
  - additionalDataobjectoptional
    Map of additional fields specific to the chosen payment method
  - cancelledOperationIdstringoptional
    Operation id to be undone
  - channelstringoptional
    It indicates the originating channel:
    
    ECOMMERCE - carholder initiated operation through an online channel.
    
    POS - carholder initiated operation through a physical POS.
    
    BACKOFFICE - merchant initiated operation. It includes post operations and MIT.
    
    ECOMMERCE, POS, BACKOFFICE
    example: ECOMMERCE
  - customerInfoobjectoptional
    This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
    billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
    cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
    cardHolderNamestringoptionalexample: Mauro Morandi
    homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
    merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
    mobilePhonestringoptionalexample: 3280987654
    mobilePhoneCountryCodestringoptionalexample: 39
    shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
  - omnichannelIdstringoptional
  - operationAmountstringoptional
    Operation amount in the payment currency
    example: 3545
  - operationCurrencystringoptional
    Payment currency
    example: EUR
  - operationIdstringoptionalexample: 3470744
  - operationResultstringoptional
    Transaction output:
    
    AUTHORIZED - Payment authorized
    
    EXECUTED - Payment confirmed, verification successfully executed
    
    DECLINED - Declined by the Issuer during the authorization phase
    
    DENIED_BY_RISK - Negative outcome of the transaction risk analysis
    
    DENIED
    
    THREEDS_VALIDATED - 3DS authentication OK or 3DS skipped (non-secure payment)
    
    THREEDS_FAILED - cancellation or authentication failure during 3DS
    
    PENDING - Payment ongoing. Follow up notifications are expected
    
    CANCELED - Canceled by the cardholder
    
    VOIDED - Online reversal of the full authorized amount
    
    REFUNDED - Full or partial amount refunded
    
    FAILED - Payment failed due to technical reasons
    
    AUTHORIZED, EXECUTED, DECLINED, DENIED_BY_RISK, DENIED, THREEDS_VALIDATED, THREEDS_FAILED, PENDING, CANCELED, VOIDED, REFUNDED, FAILED
    example: AUTHORIZED
  - operationTimestring (date-time)optional
    Operation time in ISO 8601 format
  - operationTypestringoptional
    It indicates the purpose of the request:
    
    AUTHORIZATION - any authorization with explicit capture
    
    CAPTURE - a captured authorization or an implicit captured payment
    
    REFUND - refund of a captured amount
    
    CANCEL - the rollback of an capture, refund.
    
    NOSHOW
    
    INCREMENTAL
    
    DELAY_CHARGE
    
    CARD_VERIFICATION
    
    CARD_CHECK
    
    VOID - reversal of an authorization
    
    AUTHORIZATION, CAPTURE, REFUND, CANCEL, NOSHOW, INCREMENTAL, DELAY_CHARGE, CARD_VERIFICATION, CARD_CHECK, VOID
    example: CAPTURE
  - orderIdstringoptional
    Merchant order id, unique in the merchant domain
    example: btid2384983
  - paymentCircuitstringoptional
    One of the payment circuit values returned by the GET payment_methods web service. The list may include (but not limited to) VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY.
    example: VISA
  - paymentEndToEndIdstringoptional
    It is defined by the circuit to uniquely identify the transaction. Required for circuid reconciliation purposes.
    example: e723hedsdew
  - paymentInstrumentInfostringoptional
    Payment instrument information
    example: ***6152
  - paymentLinkIdstringoptional
    PayByLink id used for correlating this operation with the original link.
    example: 234244353
  - paymentMethodstringoptional
    
    CARD - Any card circuit
    
    APM - Alternative payment method
    
    CARD, APM
    example: CARD
  - warningsarrayoptional
    codestringoptionalexample: TRA001
    descriptionstringoptionalexample: 3DS warning
- threeDSAuthRequeststringoptional
- threeDSAuthUrlstringoptional
- threeDSEnrollmentStatusstringoptional
201Createdoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "threeDSAuthUrl": "threeDSAuthUrl",
    "threeDSAuthRequest": "threeDSAuthRequest",
    "threeDSEnrollmentStatus": "threeDSEnrollmentStatus",
    "operation": {
        "paymentLinkId": "234244353",
        "orderId": "btid2384983",
        "warnings": [
            {
                "code": "TRA001",
                "description": "3DS warning"
            },
            {
                "code": "TRA001",
                "description": "3DS warning"
            }
        ],
        "channel": "ECOMMERCE",
        "customerInfo": {
            "mobilePhone": "3280987654",
            "cardHolderName": "Mauro Morandi",
            "homePhone": "391231234567",
            "mobilePhoneCountryCode": 39,
            "shippingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderAcctInfo": {
                "chAccDate": "2019-02-11T00:00:00.000+0000",
                "txnActivityYear": 0,
                "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                "provisionAttemptsDay": 0,
                "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                "destinationAddressUsageIndicator": "01",
                "chAccChangeIndicator": "01",
                "nbPurchaseAccount": 0,
                "destinationNameIndicator": "01",
                "chAccPwChangeIndicator": "01",
                "paymentAccIndicator": "0",
                "chAccAgeIndicator": "01",
                "suspiciousAccActivity": "01",
                "txnActivityDay": 0
            },
            "workPhone": "391231234567",
            "billingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderEmail": "mauro.morandi@nexi.it",
            "merchantRiskIndicator": {
                "deliveryTimeframe": "01",
                "preOrderDate": "2019-02-11T00:00:00.000+0000",
                "reorderItemsIndicator": "01",
                "shipIndicator": "01",
                "giftCardAmount": {
                    "currency": "EUR",
                    "value": "100"
                },
                "deliveryEmail": "john.doe@email.com",
                "giftCardCount": 0,
                "preOrderPurchaseIndicator": "01"
            }
        },
        "operationTime": "2000-01-23T04:56:07.000Z",
        "paymentCircuit": "VISA",
        "omnichannelId": "omnichannelId",
        "operationAmount": "3545",
        "operationId": "3470744",
        "paymentEndToEndId": "e723hedsdew",
        "paymentMethod": "CARD",
        "operationType": "CAPTURE",
        "additionalData": {
            "authorizationCode": "647189",
            "cardCountry": "ITA",
            "threeDS": "FULL_SECURE",
            "schemaTID": "MCS01198U",
            "multiCurrencyConversion": {
                "amount": "2662",
                "currency": "JPY",
                "exchangeRate": "0.007510523"
            }
        },
        "operationCurrency": "EUR",
        "paymentInstrumentInfo": "***6152",
        "cancelledOperationId": "",
        "operationResult": "AUTHORIZED"
    }
}

validate

POST /api/v1/orders/3steps/validation

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.

validate

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/3steps/validation");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

operationIdstringoptional
threeDSAuthResponsestringoptional

Request body

{
    "threeDSAuthResponse": "threeDSAuthResponse",
    "operationId": "operationId"
}

Responses

200OKoptional
- operationobjectoptional
  - additionalDataobjectoptional
    Map of additional fields specific to the chosen payment method
  - cancelledOperationIdstringoptional
    Operation id to be undone
  - channelstringoptional
    It indicates the originating channel:
    
    ECOMMERCE - carholder initiated operation through an online channel.
    
    POS - carholder initiated operation through a physical POS.
    
    BACKOFFICE - merchant initiated operation. It includes post operations and MIT.
    
    ECOMMERCE, POS, BACKOFFICE
    example: ECOMMERCE
  - customerInfoobjectoptional
    This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
    billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
    cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
    cardHolderNamestringoptionalexample: Mauro Morandi
    homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
    merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
    mobilePhonestringoptionalexample: 3280987654
    mobilePhoneCountryCodestringoptionalexample: 39
    shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
  - omnichannelIdstringoptional
  - operationAmountstringoptional
    Operation amount in the payment currency
    example: 3545
  - operationCurrencystringoptional
    Payment currency
    example: EUR
  - operationIdstringoptionalexample: 3470744
  - operationResultstringoptional
    Transaction output:
    
    AUTHORIZED - Payment authorized
    
    EXECUTED - Payment confirmed, verification successfully executed
    
    DECLINED - Declined by the Issuer during the authorization phase
    
    DENIED_BY_RISK - Negative outcome of the transaction risk analysis
    
    DENIED
    
    THREEDS_VALIDATED - 3DS authentication OK or 3DS skipped (non-secure payment)
    
    THREEDS_FAILED - cancellation or authentication failure during 3DS
    
    PENDING - Payment ongoing. Follow up notifications are expected
    
    CANCELED - Canceled by the cardholder
    
    VOIDED - Online reversal of the full authorized amount
    
    REFUNDED - Full or partial amount refunded
    
    FAILED - Payment failed due to technical reasons
    
    AUTHORIZED, EXECUTED, DECLINED, DENIED_BY_RISK, DENIED, THREEDS_VALIDATED, THREEDS_FAILED, PENDING, CANCELED, VOIDED, REFUNDED, FAILED
    example: AUTHORIZED
  - operationTimestring (date-time)optional
    Operation time in ISO 8601 format
  - operationTypestringoptional
    It indicates the purpose of the request:
    
    AUTHORIZATION - any authorization with explicit capture
    
    CAPTURE - a captured authorization or an implicit captured payment
    
    REFUND - refund of a captured amount
    
    CANCEL - the rollback of an capture, refund.
    
    NOSHOW
    
    INCREMENTAL
    
    DELAY_CHARGE
    
    CARD_VERIFICATION
    
    CARD_CHECK
    
    VOID - reversal of an authorization
    
    AUTHORIZATION, CAPTURE, REFUND, CANCEL, NOSHOW, INCREMENTAL, DELAY_CHARGE, CARD_VERIFICATION, CARD_CHECK, VOID
    example: CAPTURE
  - orderIdstringoptional
    Merchant order id, unique in the merchant domain
    example: btid2384983
  - paymentCircuitstringoptional
    One of the payment circuit values returned by the GET payment_methods web service. The list may include (but not limited to) VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY.
    example: VISA
  - paymentEndToEndIdstringoptional
    It is defined by the circuit to uniquely identify the transaction. Required for circuid reconciliation purposes.
    example: e723hedsdew
  - paymentInstrumentInfostringoptional
    Payment instrument information
    example: ***6152
  - paymentLinkIdstringoptional
    PayByLink id used for correlating this operation with the original link.
    example: 234244353
  - paymentMethodstringoptional
    
    CARD - Any card circuit
    
    APM - Alternative payment method
    
    CARD, APM
    example: CARD
  - warningsarrayoptional
    codestringoptionalexample: TRA001
    descriptionstringoptionalexample: 3DS warning
- threeDSAuthResultobjectoptional
  - authenticationValuestringoptional
  - cavvAlgorithmstringoptional
  - ecistringoptional
  - merchantAcquirerBinstringoptional
  - xidstringoptional
  - statusstringoptional
  - vendorcodestringoptional
  - versionstringoptional
201Createdoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "threeDSAuthResult": {
        "merchantAcquirerBin": "merchantAcquirerBin",
        "xid": "xid",
        "cavvAlgorithm": "cavvAlgorithm",
        "eci": "eci",
        "vendorcode": "vendorcode",
        "authenticationValue": "authenticationValue",
        "version": "version",
        "status": "status"
    },
    "operation": {
        "paymentLinkId": "234244353",
        "orderId": "btid2384983",
        "warnings": [
            {
                "code": "TRA001",
                "description": "3DS warning"
            },
            {
                "code": "TRA001",
                "description": "3DS warning"
            }
        ],
        "channel": "ECOMMERCE",
        "customerInfo": {
            "mobilePhone": "3280987654",
            "cardHolderName": "Mauro Morandi",
            "homePhone": "391231234567",
            "mobilePhoneCountryCode": 39,
            "shippingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderAcctInfo": {
                "chAccDate": "2019-02-11T00:00:00.000+0000",
                "txnActivityYear": 0,
                "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                "provisionAttemptsDay": 0,
                "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                "destinationAddressUsageIndicator": "01",
                "chAccChangeIndicator": "01",
                "nbPurchaseAccount": 0,
                "destinationNameIndicator": "01",
                "chAccPwChangeIndicator": "01",
                "paymentAccIndicator": "0",
                "chAccAgeIndicator": "01",
                "suspiciousAccActivity": "01",
                "txnActivityDay": 0
            },
            "workPhone": "391231234567",
            "billingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderEmail": "mauro.morandi@nexi.it",
            "merchantRiskIndicator": {
                "deliveryTimeframe": "01",
                "preOrderDate": "2019-02-11T00:00:00.000+0000",
                "reorderItemsIndicator": "01",
                "shipIndicator": "01",
                "giftCardAmount": {
                    "currency": "EUR",
                    "value": "100"
                },
                "deliveryEmail": "john.doe@email.com",
                "giftCardCount": 0,
                "preOrderPurchaseIndicator": "01"
            }
        },
        "operationTime": "2000-01-23T04:56:07.000Z",
        "paymentCircuit": "VISA",
        "omnichannelId": "omnichannelId",
        "operationAmount": "3545",
        "operationId": "3470744",
        "paymentEndToEndId": "e723hedsdew",
        "paymentMethod": "CARD",
        "operationType": "CAPTURE",
        "additionalData": {
            "authorizationCode": "647189",
            "cardCountry": "ITA",
            "threeDS": "FULL_SECURE",
            "schemaTID": "MCS01198U",
            "multiCurrencyConversion": {
                "amount": "2662",
                "currency": "JPY",
                "exchangeRate": "0.007510523"
            }
        },
        "operationCurrency": "EUR",
        "paymentInstrumentInfo": "***6152",
        "cancelledOperationId": "",
        "operationResult": "AUTHORIZED"
    }
}

pay

POST /api/v1/orders/3steps/payment

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.

pay

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/3steps/payment");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

actionTypestringoptional
PAY, VERIFY, PURCHASE, PREAUTH
example: PAY
captureTypestringoptional
Overwrites the default confirmation method of the terminal, for card payments only:

IMPLICIT - automatic confirmation

EXPLICIT - authorization only Default value depends on the terminal configuration.

Terminal set to EXPLICIT: a. if the captureType is EXPLICIT the capture will be EXPLICIT b. if the captureType is not present or null the capture will be EXPLICIT c. if the captureType is IMPLICIT the capture will be IMPLICIT

Terminal set to IMPLICIT: a. if the captureType is EXPLICIT the capture will be an error b. if the captureType is not present or null the capture will be IMPLICIT c. if the captureType is IMPLICIT the capture will be IMPLICIT

DEFERRED, EXPLICIT, FILE, IMPLICIT
example: EXPLICIT
cardobjectoptional
- cvvstringoptionalexample: 123
- expiryDatestringoptionalexample: 1225
- panstringrequiredexample: 1234567890123456
exemptionsstringoptional
It indicates the possible of exemption options

NO_PREFERENCE - the merchant can request a payment without any preference

CHALLENGE_REQUESTED - the merchant can request a payment with challenge

EXEMPTION_REQUESTED - the merchant can request a payment with using Sca Exemption

NO_PREFERENCE, CHALLENGE_REQUESTED, EXEMPTION_REQUESTED
example: NO_PREFERENCE
operationIdstringoptional
orderobjectoptional
- amountstringrequired
  Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)
  example: 3545
- currencystringrequired
  Transaction currency. ISO 4217 alphabetic code
  
  AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAL, XAU, XBA, XBB, XBC, XBD, XCD, XCP, XDR, XFO, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW, ZWL
  example: EUR
- customFieldstringoptional
  Additional transaction description
  example: weekend promotion
- customerIdstringoptional
  Immutable identifier of the payer as registered on the ecommerce platform.
  example: mcid97295873
- customerInfoobjectoptional
  This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
  - billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
  - cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
  - cardHolderNamestringoptionalexample: Mauro Morandi
  - homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
  - merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
  - mobilePhonestringoptionalexample: 3280987654
  - mobilePhoneCountryCodestringoptionalexample: 39
  - shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
  - workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
- descriptionstringoptional
  Transaction description
  example: TV LG 3423
- installmentsarrayoptional
  - amountstringoptional
    Installment amount.
    example: 350
  - datestring (date)optional
    Installment time in ISO 8601 format.
  - typestringoptional
    AUTOMATIC, MANUAL
- orderIdstringrequired
  Merchant order id, unique in the merchant domain
  example: btid2384983
- termsAndConditionsIdsarrayoptional
- transactionSummaryarrayoptional
  - languagestringoptional
    Language in ISO 639-2.
    
    ACE, ACH, ADA, ADY, AFA, AFH, AIN, AKK, ALE, ALG, ALT, ANG, ANP, APA, ARC, ARN, ARP, ART, ARW, AST, ATH, AUS, AWA, BAD, BAI, BAL, BAN, BAS, BAT, BEJ, BEM, BER, BHO, BIH, BIK, BIN, BLA, BNT, BRA, BTK, BUA, BUG, BYN, CAD, CAI, CAR, CAU, CEB, CEL, CHB, CHG, CHK, CHM, CHN, CHO, CHP, CHR, CHY, CMC, CNR, COP, CPE, CPF, CPP, CRH, CRP, CSB, CUS, DAK, DAR, DAY, DEL, DEN, DGR, DIN, DOI, DRA, DSB, DUA, DUM, DYU, EFI, EGY, EKA, ELX, ENM, EWO, FAN, FAT, FIL, FIU, FON, FRM, FRO, FRR, FRS, FUR, GAA, GAY, GBA, GEM, GEZ, GIL, GMH, GOH, GON, GOR, GOT, GRB, GRC, GSW, GWI, HAI, HAW, HIL, HIM, HIT, HMN, HSB, HUP, IBA, IJO, ILO, INC, INE, INH, IRA, IRO, JBO, JPR, JRB, KAA, KAB, KAC, KAM, KAR, KAW, KBD, KHA, KHI, KHO, KMB, KOK, KOS, KPE, KRC, KRL, KRO, KRU, KUM, KUT, LAD, LAH, LAM, LEZ, LOL, LOZ, LUA, LUI, LUN, LUO, LUS, MAD, MAG, MAI, MAK, MAN, MAP, MAS, MDF, MDR, MEN, MGA, MIC, MIN, MIS, MKH, MNC, MNI, MNO, MOH, MOS, MUL, MUN, MUS, MWL, MWR, MYN, MYV, NAH, NAI, NAP, NDS, NEW, NIA, NIC, NIU, NOG, NON, NQO, NSO, NUB, NWC, NYM, NYN, NYO, NZI, OSA, OTA, OTO, PAA, PAG, PAL, PAM, PAP, PAU, PEO, PHI, PHN, PON, PRA, PRO, QAA, QTZ, RAJ, RAP, RAR, ROA, ROM, RUP, SAD, SAH, SAI, SAL, SAM, SAS, SAT, SCN, SCO, SEL, SEM, SGA, SGN, SHN, SID, SIO, SIT, SLA, SMA, SMI, SMJ, SMN, SMS, SNK, SOG, SON, SRN, SRR, SSA, SUK, SUS, SUX, SYC, SYR, TAI, TEM, TER, TET, TIG, TIV, TKL, TLH, TLI, TMH, TOG, TPI, TSI, TUM, TUP, TUT, TVL, TYV, UDM, UGA, UMB, UND, VAI, VOT, WAK, WAL, WAR, WAS, WEN, XAL, YAO, YAP, YPK, ZAP, ZBL, ZEN, ZGH, ZND, ZUN, ZXX, ZZA, AAR, ABK, AVE, AFR, AKA, AMH, ARG, ARA, ASM, AVA, AYM, AZE, BAK, BEL, BUL, BIS, BAM, BEN, BOD, TIB, BRE, BOS, CAT, CHE, CHA, COS, CRE, CES, CZE, CHU, CHV, CYM, WEL, DAN, DEU, GER, DIV, DZO, EWE, ELL, GRE, ENG, EPO, SPA, EST, EUS, BAQ, FAS, PER, FUL, FIN, FIJ, FAO, FRA, FRE, FRY, GLE, GLA, GLG, GRN, GUJ, GLV, HAU, HEB, HIN, HMO, HRV, HAT, HUN, HYE, ARM, HER, INA, IND, ILE, IBO, III, IPK, IDO, ISL, ICE, ITA, IKU, JPN, JAV, KAT, GEO, KON, KIK, KUA, KAZ, KAL, KHM, KAN, KOR, KAU, KAS, KUR, KOM, COR, KIR, LAT, LTZ, LUG, LIM, LIN, LAO, LIT, LUB, LAV, MLG, MAH, MRI, MAO, MKD, MAC, MAL, MON, MAR, MSA, MAY, MLT, MYA, BUR, NAU, NOB, NDE, NEP, NDO, NLD, DUT, NNO, NOR, NBL, NAV, NYA, OCI, OJI, ORM, ORI, OSS, PAN, PLI, POL, PUS, POR, QUE, ROH, RUN, RON, RUM, RUS, KIN, SAN, SRD, SND, SME, SAG, SIN, SLK, SLO, SLV, SMO, SNA, SOM, SQI, ALB, SRP, SSW, SOT, SUN, SWE, SWA, TAM, TEL, TGK, THA, TIR, TUK, TGL, TSN, TON, TUR, TSO, TAT, TWI, TAH, UIG, UKR, URD, UZB, VEN, VIE, VOL, WLN, WOL, XHO, YID, YOR, ZHA, ZHO, CHI, ZUL, USA, ARB, JAP, ZHE, SVN
    example: ENG
  - summaryListarrayoptional
    labelstringoptional
    label of the field
    example: Number of people
    valuestringoptional
    value
    example: 4
- planobjectoptional
  - totalAmountstringoptional
  - contractIdstringoptional
  - planTypestringoptional
    FIXED, VARIABLE, ACQUIRER_AGREEMENT
  - statusstringoptional
    ACTIVE, INACTIVE, COMPLETED
recurrenceobjectoptional
- actionstringoptional
  NO_RECURRING, CARD_SUBSTITUTION, CONTRACT_CREATION, SUBSEQUENT_PAYMENT
  example: CONTRACT_CREATION
- contractTypestringoptional
  It indicates the possible options for the subsequent payments:
  
  CIT - the contract can be used only for subsequent payments initiated by the customer.
  
  MIT_SCHEDULED - the contract can be used for scheduled merchant initiated transactions. The number of day between one payment and another shall be equal or higher than the value of contractFrequency.
  
  MIT_UNSCHEDULED - the contract can be used for unscheduled merchant initiated transactions. The contractFrequency has no effect in this case.
  
  CIT, MIT_SCHEDULED, MIT_UNSCHEDULED
  example: CIT
- contractExpiryDatestring (date)optional
  Used with contractType MIT_SCHEDULED. ISO 8601 format. If the token was provided by VTS or MDES, it represents the expiry date of the token provided by the circuit
- contractFrequencystringoptional
  Mandatory when contract type is MIT_SCHEDULED Used with contractType MIT_SCHEDULED. Number of days
  example: 120
- contractIdstringoptionalexample: C2834987
threeDSAuthDataobjectoptional
- authenticationValuestringoptional
- ecistringoptional
- threeDSAuthResponsestringoptional
- xidstringoptional

Request body

{
    "recurrence": {
        "contractType": "CIT",
        "contractFrequency": "120",
        "contractExpiryDate": "2000-01-23T00:00:00.000Z",
        "contractId": "C2834987",
        "action": "CONTRACT_CREATION"
    },
    "actionType": "PAY",
    "exemptions": "NO_PREFERENCE",
    "captureType": "EXPLICIT",
    "operationId": "operationId",
    "threeDSAuthData": {
        "xid": "xid",
        "threeDSAuthResponse": "threeDSAuthResponse",
        "eci": "eci",
        "authenticationValue": "authenticationValue"
    },
    "card": {
        "cvv": "123",
        "expiryDate": "1225",
        "pan": "1234567890123456"
    },
    "order": {
        "amount": "3545",
        "termsAndConditionsIds": [
            "16dd6ac6-0791-4c72-b362-85f77f1728a2",
            "16dd6ac6-0791-4c72-b362-85f77f1728a2"
        ],
        "installments": [
            {
                "date": "2000-01-23T00:00:00.000Z",
                "amount": "350"
            },
            {
                "date": "2000-01-23T00:00:00.000Z",
                "amount": "350"
            }
        ],
        "orderId": "btid2384983",
        "customerId": "mcid97295873",
        "customerInfo": {
            "mobilePhone": "3280987654",
            "cardHolderName": "Mauro Morandi",
            "homePhone": "391231234567",
            "mobilePhoneCountryCode": 39,
            "shippingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderAcctInfo": {
                "chAccDate": "2019-02-11T00:00:00.000+0000",
                "txnActivityYear": 0,
                "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                "provisionAttemptsDay": 0,
                "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                "destinationAddressUsageIndicator": "01",
                "chAccChangeIndicator": "01",
                "nbPurchaseAccount": 0,
                "destinationNameIndicator": "01",
                "chAccPwChangeIndicator": "01",
                "paymentAccIndicator": "0",
                "chAccAgeIndicator": "01",
                "suspiciousAccActivity": "01",
                "txnActivityDay": 0
            },
            "workPhone": "391231234567",
            "billingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderEmail": "mauro.morandi@nexi.it",
            "merchantRiskIndicator": {
                "deliveryTimeframe": "01",
                "preOrderDate": "2019-02-11T00:00:00.000+0000",
                "reorderItemsIndicator": "01",
                "shipIndicator": "01",
                "giftCardAmount": {
                    "currency": "EUR",
                    "value": "100"
                },
                "deliveryEmail": "john.doe@email.com",
                "giftCardCount": 0,
                "preOrderPurchaseIndicator": "01"
            }
        },
        "description": "TV LG 3423",
        "currency": "EUR",
        "transactionSummary": [
            {
                "summaryList": [
                    {
                        "label": "Number of people",
                        "value": "4"
                    },
                    {
                        "label": "Number of people",
                        "value": "4"
                    }
                ],
                "language": "ENG"
            },
            {
                "summaryList": [
                    {
                        "label": "Number of people",
                        "value": "4"
                    },
                    {
                        "label": "Number of people",
                        "value": "4"
                    }
                ],
                "language": "ENG"
            }
        ],
        "plan": {
            "totalAmount": "totalAmount",
            "contractId": "contractId"
        },
        "customField": "weekend promotion"
    }
}

Responses

200OKoptional
- operationobjectoptional
  - additionalDataobjectoptional
    Map of additional fields specific to the chosen payment method
  - cancelledOperationIdstringoptional
    Operation id to be undone
  - channelstringoptional
    It indicates the originating channel:
    
    ECOMMERCE - carholder initiated operation through an online channel.
    
    POS - carholder initiated operation through a physical POS.
    
    BACKOFFICE - merchant initiated operation. It includes post operations and MIT.
    
    ECOMMERCE, POS, BACKOFFICE
    example: ECOMMERCE
  - customerInfoobjectoptional
    This object contains information about the customer. It is strongly recommended to provide as much information as possible in order to facilitate the risk assessment, fraud prevention and the payment processing. It also helps to improve the customer experience by reducing the number of fields to be filled in by the customer and raise the chances to avoid Strong Customer Authentication (SCA) when the transaction is subject to the PSD2 regulation.
    billingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    cardHolderAcctInfoobjectoptional
    chAccAgeIndicatorstringoptional
    Length of time that the cardholder has had the account with the 3DS Requestor. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: ?
    
    example: 01
    chAccChangeDatestringoptional
    Date that the cardholder's account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    chAccChangeIndicatorstringoptional
    Length of time since the cardholder's account information was last changed on merchant e-comm platform, including Billing or Shipping address, new payment account, or new user(s) added. Values accepted:
    
    01 = Changed during this transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 day EMVCO: chAccChangeInd
    
    example: 01
    chAccDatestringoptional
    Date when the cardholder opened the account with the merchant's e-commerce platform. ISO 8601 format EMVCO: chAccDate
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeDatestringoptional
    Date when the cardholder last changed the password on merchant's e-commerce platform. ISO 8601 format EMVCO: chAccPwChange
    example: 2019-02-11T00:00:00.000+0000
    chAccPwChangeIndicatorstringoptional
    Indicates when the cardholder last changed the password or asked for a password reset on merchant's e-commerce platform.
    
    01 = No change
    
    02 = Changed during this transaction
    
    03 = Less than 30 days
    
    04 = 30−60 days
    
    05 = More than 60 days
    
    example: 01
    destinationAddressUsageDatestringoptional
    Date when the shipping address used for this transaction was first used on merchant's e-commerce platform. ISO 8601 format EMVCO: shipAddressUsage
    example: 2019-02-11T00:00:00.000+0000
    destinationAddressUsageIndicatorstringoptional
    Indicates when the shipping address used for this transaction was first used on the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: shipAddressUsageInd
    
    example: 01
    destinationNameIndicatorstringoptional
    Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Values accepted:
    
    01 = Account Name identical to shipping Name
    
    02 = Account Name different than shipping Name EMVCO: shipNameIndicator
    
    example: 01
    nbPurchaseAccountinteger (int32)optional
    Number of purchases with this cardholder account during the previous six months. EMVCO: nbPurchaseAccount
    example: 0
    paymentAccAgeDatestringoptional
    Date when the payment method has been added to the cardholder's account on the merchant's e-commerce platform. ISO 8601 format EMVCO: paymentAccAge
    example: 2019-02-11T00:00:00.000+0000
    paymentAccIndicatorstringoptional
    Indicates the length of time that the payment account was enrolled in the cardholder's account with the merchant's e-commerce platform. Values accepted:
    
    01 = This transaction
    
    02 = Less than 30 days
    
    03 = 30−60 days
    
    04 = More than 60 days EMVCO: paymentAccInd
    
    example: 0
    provisionAttemptsDayinteger (int32)optional
    Number of Add Card attempts in the last 24 hours. EMVCO: provisionAttemptsDay
    example: 0
    suspiciousAccActivitystringoptional
    Indicates whether the merchant has experienced suspicious activity (including previous fraud) on the cardholder account. Values accepted:
    
    01 = No suspicious activity has been observed
    
    02 = Suspicious activity has been observed
    
    example: 01
    txnActivityDayinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous 24 hours. EMVCO: txnActivityDay
    example: 0
    txnActivityYearinteger (int32)optional
    Number of transactions (successful and abandoned) for this cardholder account on merchant's e-commerce platform across all payment accounts in the previous year. EMVCO: txnActivityYear
    example: 0
    cardHolderEmailstring (email)optionalexample: mauro.morandi@nexi.it
    cardHolderNamestringoptionalexample: Mauro Morandi
    homePhonestringoptional
    The home phone number provided by the Cardholder.
    example: 391231234567
    merchantRiskIndicatorobjectoptional
    deliveryEmailstringoptional
    For Electronic delivery, the email address to which the merchandise was delivered.
    example: john.doe@email.com
    deliveryTimeframestringoptional
    Indicates the merchandise delivery timeframe. Values accepted:
    
    01 = Electronic Delivery
    
    02 = Same day shipping
    
    03 = Overnight shipping
    
    04 = Two-day or more shipping
    
    example: 01
    giftCardAmountobjectoptional
    currencystringoptional
    For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217. EMVCO: giftCardCurr
    example: EUR
    valuestringoptional
    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
    example: 100
    giftCardCountinteger (int32)optional
    For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
    example: 0
    preOrderDatestringoptional
    For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format
    example: 2019-02-11T00:00:00.000+0000
    preOrderPurchaseIndicatorstringoptional
    Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
    example: 01
    reorderItemsIndicatorstringoptional
    Indicates whether the cardholder is reordering previously purchased merchandise.
    example: 01
    shipIndicatorstringoptional
    Indicates shipping method chosen for the transaction.
    example: 01
    mobilePhonestringoptionalexample: 3280987654
    mobilePhoneCountryCodestringoptionalexample: 39
    shippingAddressobjectoptional
    additionalInfostringoptionalexample: Quinto Piano, Scala B
    citystringoptionalexample: Bologna
    countrystringoptional
    ISO 3166-1 alpha-3
    example: ITA
    namestringoptionalexample: Mario Rossi
    postCodestringoptionalexample: 40124
    provincestringoptionalexample: BO
    streetstringoptionalexample: Piazza Maggiore, 1
    workPhonestringoptional
    The work phone number provided by the Cardholder.
    example: 391231234567
  - omnichannelIdstringoptional
  - operationAmountstringoptional
    Operation amount in the payment currency
    example: 3545
  - operationCurrencystringoptional
    Payment currency
    example: EUR
  - operationIdstringoptionalexample: 3470744
  - operationResultstringoptional
    Transaction output:
    
    AUTHORIZED - Payment authorized
    
    EXECUTED - Payment confirmed, verification successfully executed
    
    DECLINED - Declined by the Issuer during the authorization phase
    
    DENIED_BY_RISK - Negative outcome of the transaction risk analysis
    
    DENIED
    
    THREEDS_VALIDATED - 3DS authentication OK or 3DS skipped (non-secure payment)
    
    THREEDS_FAILED - cancellation or authentication failure during 3DS
    
    PENDING - Payment ongoing. Follow up notifications are expected
    
    CANCELED - Canceled by the cardholder
    
    VOIDED - Online reversal of the full authorized amount
    
    REFUNDED - Full or partial amount refunded
    
    FAILED - Payment failed due to technical reasons
    
    AUTHORIZED, EXECUTED, DECLINED, DENIED_BY_RISK, DENIED, THREEDS_VALIDATED, THREEDS_FAILED, PENDING, CANCELED, VOIDED, REFUNDED, FAILED
    example: AUTHORIZED
  - operationTimestring (date-time)optional
    Operation time in ISO 8601 format
  - operationTypestringoptional
    It indicates the purpose of the request:
    
    AUTHORIZATION - any authorization with explicit capture
    
    CAPTURE - a captured authorization or an implicit captured payment
    
    REFUND - refund of a captured amount
    
    CANCEL - the rollback of an capture, refund.
    
    NOSHOW
    
    INCREMENTAL
    
    DELAY_CHARGE
    
    CARD_VERIFICATION
    
    CARD_CHECK
    
    VOID - reversal of an authorization
    
    AUTHORIZATION, CAPTURE, REFUND, CANCEL, NOSHOW, INCREMENTAL, DELAY_CHARGE, CARD_VERIFICATION, CARD_CHECK, VOID
    example: CAPTURE
  - orderIdstringoptional
    Merchant order id, unique in the merchant domain
    example: btid2384983
  - paymentCircuitstringoptional
    One of the payment circuit values returned by the GET payment_methods web service. The list may include (but not limited to) VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY.
    example: VISA
  - paymentEndToEndIdstringoptional
    It is defined by the circuit to uniquely identify the transaction. Required for circuid reconciliation purposes.
    example: e723hedsdew
  - paymentInstrumentInfostringoptional
    Payment instrument information
    example: ***6152
  - paymentLinkIdstringoptional
    PayByLink id used for correlating this operation with the original link.
    example: 234244353
  - paymentMethodstringoptional
    
    CARD - Any card circuit
    
    APM - Alternative payment method
    
    CARD, APM
    example: CARD
  - warningsarrayoptional
    codestringoptionalexample: TRA001
    descriptionstringoptionalexample: 3DS warning
201Createdoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "operation": {
        "paymentLinkId": "234244353",
        "orderId": "btid2384983",
        "warnings": [
            {
                "code": "TRA001",
                "description": "3DS warning"
            },
            {
                "code": "TRA001",
                "description": "3DS warning"
            }
        ],
        "channel": "ECOMMERCE",
        "customerInfo": {
            "mobilePhone": "3280987654",
            "cardHolderName": "Mauro Morandi",
            "homePhone": "391231234567",
            "mobilePhoneCountryCode": 39,
            "shippingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderAcctInfo": {
                "chAccDate": "2019-02-11T00:00:00.000+0000",
                "txnActivityYear": 0,
                "chAccPwChangeDate": "2019-02-11T00:00:00.000+0000",
                "paymentAccAgeDate": "2019-02-11T00:00:00.000+0000",
                "provisionAttemptsDay": 0,
                "destinationAddressUsageDate": "2019-02-11T00:00:00.000+0000",
                "chAccChangeDate": "2019-02-11T00:00:00.000+0000",
                "destinationAddressUsageIndicator": "01",
                "chAccChangeIndicator": "01",
                "nbPurchaseAccount": 0,
                "destinationNameIndicator": "01",
                "chAccPwChangeIndicator": "01",
                "paymentAccIndicator": "0",
                "chAccAgeIndicator": "01",
                "suspiciousAccActivity": "01",
                "txnActivityDay": 0
            },
            "workPhone": "391231234567",
            "billingAddress": {
                "country": "ITA",
                "province": "BO",
                "city": "Bologna",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "name": "Mario Rossi",
                "postCode": "40124"
            },
            "cardHolderEmail": "mauro.morandi@nexi.it",
            "merchantRiskIndicator": {
                "deliveryTimeframe": "01",
                "preOrderDate": "2019-02-11T00:00:00.000+0000",
                "reorderItemsIndicator": "01",
                "shipIndicator": "01",
                "giftCardAmount": {
                    "currency": "EUR",
                    "value": "100"
                },
                "deliveryEmail": "john.doe@email.com",
                "giftCardCount": 0,
                "preOrderPurchaseIndicator": "01"
            }
        },
        "operationTime": "2000-01-23T04:56:07.000Z",
        "paymentCircuit": "VISA",
        "omnichannelId": "omnichannelId",
        "operationAmount": "3545",
        "operationId": "3470744",
        "paymentEndToEndId": "e723hedsdew",
        "paymentMethod": "CARD",
        "operationType": "CAPTURE",
        "additionalData": {
            "authorizationCode": "647189",
            "cardCountry": "ITA",
            "threeDS": "FULL_SECURE",
            "schemaTID": "MCS01198U",
            "multiCurrencyConversion": {
                "amount": "2662",
                "currency": "JPY",
                "exchangeRate": "0.007510523"
            }
        },
        "operationCurrency": "EUR",
        "paymentInstrumentInfo": "***6152",
        "cancelledOperationId": "",
        "operationResult": "AUTHORIZED"
    }
}

getActions

GET /api/v1/operations/{operationId}/actions

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
operationIdstringrequired
operationId

getActions

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/operations/{operationId}/actions");
var request = new RestRequest(Method.GET);
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200OKoptional
- actionsarrayoptional
  - actionstringoptional
  - currencystringoptional
  - defaultAmountstringoptional
  - maxAmountstringoptional
  - minAmountstringoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "actions": [
        {
            "minAmount": "minAmount",
            "defaultAmount": "defaultAmount",
            "action": "action",
            "currency": "currency",
            "maxAmount": "maxAmount"
        },
        {
            "minAmount": "minAmount",
            "defaultAmount": "defaultAmount",
            "action": "action",
            "currency": "currency",
            "maxAmount": "maxAmount"
        }
    ]
}

payByLinkByLinkId

GET /api/v1/orders/paybylink/{linkId}

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
x-plugin-namestringoptional
x-plugin-name
linkIdstringrequired
linkId

payByLinkByLinkId

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/paybylink/{linkId}");
var request = new RestRequest(Method.GET);
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("x-plugin-name", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200OKoptional
- paymentLinkobjectoptional
  - amountstringoptional
  - expirationDatestringoptional
  - linkstringoptional
  - linkIdstringoptional
  - paidByOperationIdstringoptional
  - statusstringoptional
    ACTIVE, DELETED, EXPIRED, INACTIVE
- securityTokenstringoptional
- warningsarrayoptional
  - codestringoptionalexample: TRA001
  - descriptionstringoptionalexample: 3DS warning
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "securityToken": "securityToken",
    "warnings": [
        {
            "code": "TRA001",
            "description": "3DS warning"
        },
        {
            "code": "TRA001",
            "description": "3DS warning"
        }
    ],
    "paymentLink": {
        "amount": "amount",
        "linkId": "linkId",
        "paidByOperationId": "paidByOperationId",
        "link": "link",
        "expirationDate": "expirationDate"
    }
}

payByLinkRenewal

POST /api/v1/orders/paybylink/{linkId}/renewals

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
linkIdstringrequired
linkId

payByLinkRenewal

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/paybylink/{linkId}/renewals");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

expirationDatestringoptional

Request body

{
    "expirationDate": "expirationDate"
}

Responses

200OKoptional
- paymentLinkobjectoptional
  - amountstringoptional
  - expirationDatestringoptional
  - linkstringoptional
  - linkIdstringoptional
  - paidByOperationIdstringoptional
  - statusstringoptional
    ACTIVE, DELETED, EXPIRED, INACTIVE
- securityTokenstringoptional
- warningsarrayoptional
  - codestringoptionalexample: TRA001
  - descriptionstringoptionalexample: 3DS warning
201Createdoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "securityToken": "securityToken",
    "warnings": [
        {
            "code": "TRA001",
            "description": "3DS warning"
        },
        {
            "code": "TRA001",
            "description": "3DS warning"
        }
    ],
    "paymentLink": {
        "amount": "amount",
        "linkId": "linkId",
        "paidByOperationId": "paidByOperationId",
        "link": "link",
        "expirationDate": "expirationDate"
    }
}

Retrieve contract details by contract id

GET /api/v1/contract/{contractId}

Parameters

X-API-KEYstringrequired
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
contractIdstringrequired
Recurring contract id

Retrieve contract details by contract id

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/contract/C2834987");
var request = new RestRequest(Method.GET);
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200Contract detailsoptional
- encryptedResponsestringoptional
400Invalid request dataoptional
- timestampstringoptional
- errorsarrayoptional
  - codestringoptionalexample: GW0001
  - descriptionstringoptionalexample: Invalid merchant URL
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional
500Internal Server Erroroptional
- errorsarrayoptional
  - codestringoptionalexample: GW0001
  - descriptionstringoptionalexample: Invalid merchant URL

{
    "encryptedResponse": "encryptedResponse"
}

mitByOrderId

POST /api/v1/orders/{orderId}/mit

Parameters

X-API-KEYstringrequired
Authorizationstringrequired
Authorization
Correlation-Idstring (uuid)required
Mandatory field as format of an UUID v4. The purpose of the field is trace the request among different systems to make easier debug or following a trace.
lastRetrystringoptional
lastRetry
merchantIdstringoptional
merchantId
orderIdstringrequired
orderId
tenantIdstringoptional
tenantId
terminalIdstringoptional
terminalId

mitByOrderId

C#
PHP
Node
Shell

var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/{orderId}/mit");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Authorization", "SOME_STRING_VALUE");
request.AddHeader("Correlation-Id", "SOME_STRING_VALUE");
request.AddHeader("lastRetry", "SOME_STRING_VALUE");
request.AddHeader("merchantId", "SOME_STRING_VALUE");
request.AddHeader("tenantId", "SOME_STRING_VALUE");
request.AddHeader("terminalId", "SOME_STRING_VALUE");
request.AddHeader("X-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

amountstringoptional
contractIdstringoptional
currencystringoptional
Transaction currency. ISO 4217 alphabetic code

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAL, XAU, XBA, XBB, XBC, XBD, XCD, XCP, XDR, XFO, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW, ZWL
example: EUR
installmentCountstringoptional
installmentIdstring (uuid)optional

Request body

{
    "amount": "amount",
    "installmentId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "installmentCount": "installmentCount",
    "contractId": "contractId",
    "currency": "EUR"
}

Responses

200OKoptional
- operationIdstringoptional
201Createdoptional
401Unauthorizedoptional
403Forbiddenoptional
404Not Foundoptional

200

{
    "operationId": "operationId"
}