Skip to content
XPay

    XPay Payment APIs

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

    Create Order for Hosted Payment

    POST /orders/hpp

    Hosted Payment Initialization. Server-to-Server API for starting the order lifecycle

    Parameters

    • X-API-KEYstringrequired
    • Correlation-Idstring (uuid)required

    Create Order for Hosted Payment

    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-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

    Request body

    • orderobjectoptional
      • orderIdstringoptional

        Merchant order id, unique in the merchant domain

      • amountstringoptional

        Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)

      • currencystringoptional

        Transaction currency. ISO 4217 alphabetic code

      • customerIdstringoptional

        Customer label for this transaction

      • descriptionstringoptional

        Transaction description

      • customFieldstringoptional

        Additional transaction description

      • customerInfoobjectoptional
        • cardHolderNamestringoptional
        • cardHolderEmailstringoptional
        • billingAddressobjectoptional
          • namestringoptional
          • streetstringoptional
          • additionalInfostringoptional
          • citystringoptional
          • postCodestringoptional
          • provincestringoptional
          • countrystringoptional

            ISO 3166-1 alpha-3

        • shippingAddressobjectoptional
          • namestringoptional
          • streetstringoptional
          • additionalInfostringoptional
          • citystringoptional
          • postCodestringoptional
          • provincestringoptional
          • countrystringoptional

            ISO 3166-1 alpha-3

        • mobilePhoneCountryCodestringoptional
        • mobilePhonestringoptional
        • homePhonestringoptional

          The home phone number provided by the Cardholder.

        • workPhonestringoptional

          The work phone number provided by the Cardholder.

        • cardHolderAcctInfoobjectoptional
          • chAccDatestringoptional

            Date that the cardholder opened the account with the 3DS Requestor. ISO 8601 format

          • chAccAgeIndicatorstringoptional

            Length of time that the cardholder has had the account with the 3DS Requestor.

          • 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

          • chAccChangeIndicatorstringoptional

            Length of time since the cardholder's account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.

          • chAccPwChangeDatestringoptional

            Date that cardholder's account with the 3DS Requestor had a password change or account reset. ISO 8601 format

          • chAccPwChangeIndicatorstringoptional

            Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset.

          • nbPurchaseAccountnumberoptional

            Number of purchases with this cardholder account during the previous six months.

          • destinationAddressUsageDatestringoptional

            Date when the shipping address used for this transaction was first used with the 3DS Requestor. ISO 8601 format

          • destinationAddressUsageIndicatorstringoptional

            Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.

          • destinationNameIndicatorstringoptional

            Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.

          • txnActivityDaynumberoptional

            Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

          • txnActivityYearnumberoptional

            Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

          • provisionAttemptsDaynumberoptional

            Number of Add Card attempts in the last 24 hours.

          • suspiciousAccActivitystringoptional

            Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.

          • paymentAccAgeDatestringoptional

            Date that the payment account was enrolled in the cardholder's account with the 3DS Requestor. ISO 8601 format

          • paymentAccIndicatorstringoptional

            Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor.

        • merchantRiskIndicatorobjectoptional
          • deliveryEmailstringoptional

            For Electronic delivery, the email address to which the merchandise was delivered.

          • deliveryTimeframestringoptional

            Indicates the merchandise delivery timeframe.

          • giftCardAmountobjectoptional
            • valuenumberoptional

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

            • currencystringoptional

              For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

          • giftCardCountnumberoptional

            For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

          • preOrderDatestringoptional

            For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format

          • preOrderPurchaseIndicatorstringoptional

            Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.

          • reorderItemsIndicatorstringoptional

            Indicates whether the cardholder is reordering previously purchased merchandise.

          • shipIndicatorstringoptional

            Indicates shipping method chosen for the transaction.

      • transactionSummaryarrayoptional
        • languagestringoptional

          Language to be used on the transaction summary details, ISO 639-2.

        • summaryListarrayoptional
          • labelstringoptional

            label of the field

          • valuestringoptional

            value

      • installmentsarrayoptional
        • datestringoptional

          Installment time in ISO 8601 format.

        • amountstringoptional

          Installment amount.

      • termsAndConditionsIdsarrayoptional
    • paymentSessionobjectoptional
      • actionTypestringoptional

        PAY, VERIFY, PREAUTH

      • amountstringoptional

        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)

      • recurrenceobjectoptional
        • actionstringoptional

          NO_RECURRING, SUBSEQUENT_PAYMENT, CONTRACT_CREATION, CARD_SUBSTITUTION

        • contractIdstringoptional
        • contractTypestringoptional

          MIT_UNSCHEDULED, MIT_SCHEDULED, CIT

        • contractExpiryDatestringoptional

          Used with contractType MIT_SCHEDULED. ISO 8601 format

        • contractFrequencystringoptional

          Used with contractType MIT_SCHEDULED. Number of days

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

        IMPLICIT, EXPLICIT

      • exemptionsstringoptional

        NO_PREFERENCE, CHALLENGE_REQUESTED

      • languagestringoptional

        Language to be used on the hosted payment page. ISO 639-2

      • resultUrlstringoptional

        Merchant URL where the cardholder is redirected once the hosted payment completes

      • cancelUrlstringoptional

        Merchant URL where the cardholder is redirected once the hosted payment is abandoned

      • notificationUrlstringoptional

        Merchant URL where the gateway pushes notifications

    Request body

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

    Responses

    • 200Payment initialization successfuloptional
      • hostedPagestringoptional

        URL of the hosted payment page. Redirect the payment flow to this URL.

      • securityTokenstringoptional

        Token which may be used for validating the notifications related to this payment

    • 400Invalid request dataoptional
      • errorsarrayoptional
        • codestringoptional
        • descriptionstringoptional
    • 401Unauthorizedoptional
    • 500Internal Server Erroroptional
      • errorsarrayoptional
        • codestringoptional
        • descriptionstringoptional
    {
    "hostedPage": "https://{gateway_hosted_page}",
    "securityToken": "2f0ea5059b41414ca3744fe672327d85"
}

    Find Orders

    GET /orders

    Find orders in reversed chronological order

    Parameters

    • X-API-KEYstringrequired
    • Correlation-Idstring (uuid)required
    • fromTimestringoptional
    • toTimestringoptional
    • maxRecordsnumberoptional
    • customFieldstringoptional

    Find Orders

    var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders?fromTime=SOME_STRING_VALUE&toTime=SOME_STRING_VALUE&maxRecords=SOME_NUMBER_VALUE&customField=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

    • 200Request successfully processedoptional
      • ordersarrayoptional
        • orderobjectoptional
          • orderIdstringoptional

            Merchant order id, unique in the merchant domain

          • amountstringoptional

            Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)

          • currencystringoptional

            Transaction currency. ISO 4217 alphabetic code

          • customerIdstringoptional

            Customer label for this transaction

          • descriptionstringoptional

            Transaction description

          • customFieldstringoptional

            Additional transaction description

          • customerInfoobjectoptional
            • cardHolderNamestringoptional
            • cardHolderEmailstringoptional
            • billingAddressobjectoptional
              • namestringoptional
              • streetstringoptional
              • additionalInfostringoptional
              • citystringoptional
              • postCodestringoptional
              • provincestringoptional
              • countrystringoptional

                ISO 3166-1 alpha-3

            • shippingAddressobjectoptional
              • namestringoptional
              • streetstringoptional
              • additionalInfostringoptional
              • citystringoptional
              • postCodestringoptional
              • provincestringoptional
              • countrystringoptional

                ISO 3166-1 alpha-3

            • mobilePhoneCountryCodestringoptional
            • mobilePhonestringoptional
            • homePhonestringoptional

              The home phone number provided by the Cardholder.

            • workPhonestringoptional

              The work phone number provided by the Cardholder.

            • cardHolderAcctInfoobjectoptional
              • chAccDatestringoptional

                Date that the cardholder opened the account with the 3DS Requestor. ISO 8601 format

              • chAccAgeIndicatorstringoptional

                Length of time that the cardholder has had the account with the 3DS Requestor.

              • 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

              • chAccChangeIndicatorstringoptional

                Length of time since the cardholder's account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.

              • chAccPwChangeDatestringoptional

                Date that cardholder's account with the 3DS Requestor had a password change or account reset. ISO 8601 format

              • chAccPwChangeIndicatorstringoptional

                Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset.

              • nbPurchaseAccountnumberoptional

                Number of purchases with this cardholder account during the previous six months.

              • destinationAddressUsageDatestringoptional

                Date when the shipping address used for this transaction was first used with the 3DS Requestor. ISO 8601 format

              • destinationAddressUsageIndicatorstringoptional

                Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.

              • destinationNameIndicatorstringoptional

                Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.

              • txnActivityDaynumberoptional

                Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

              • txnActivityYearnumberoptional

                Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

              • provisionAttemptsDaynumberoptional

                Number of Add Card attempts in the last 24 hours.

              • suspiciousAccActivitystringoptional

                Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.

              • paymentAccAgeDatestringoptional

                Date that the payment account was enrolled in the cardholder's account with the 3DS Requestor. ISO 8601 format

              • paymentAccIndicatorstringoptional

                Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor.

            • merchantRiskIndicatorobjectoptional
              • deliveryEmailstringoptional

                For Electronic delivery, the email address to which the merchandise was delivered.

              • deliveryTimeframestringoptional

                Indicates the merchandise delivery timeframe.

              • giftCardAmountobjectoptional
                • valuenumberoptional

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

                • currencystringoptional

                  For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

              • giftCardCountnumberoptional

                For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

              • preOrderDatestringoptional

                For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format

              • preOrderPurchaseIndicatorstringoptional

                Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.

              • reorderItemsIndicatorstringoptional

                Indicates whether the cardholder is reordering previously purchased merchandise.

              • shipIndicatorstringoptional

                Indicates shipping method chosen for the transaction.

          • transactionSummaryarrayoptional
            • languagestringoptional

              Language to be used on the transaction summary details, ISO 639-2.

            • summaryListarrayoptional
              • labelstringoptional

                label of the field

              • valuestringoptional

                value

          • installmentsarrayoptional
            • datestringoptional

              Installment time in ISO 8601 format.

            • amountstringoptional

              Installment amount.

          • termsAndConditionsIdsarrayoptional
        • authorizedAmountstringoptional
        • capturedAmountstringoptional
        • lastOperationTypestringoptional

          It indicates the purpose of the request:

          • AUTHORIZATION - any authorization with explicit capture
          • CAPTURE - a captured authorization or an implicit captured payment
          • VOID - reversal of an authorization
          • REFUND - refund of a captured amount
          • CANCEL - the rollback of an capture, refund.

          AUTHORIZATION, CAPTURE, VOID, REFUND, CANCEL

        • lastOperationTimestringoptional

          Operation time in ISO 8601 format

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

    Find Order by ID

    GET /orders/{orderId}

    Retrieve all the operations for the given order

    Parameters

    • X-API-KEYstringrequired
    • Correlation-Idstring (uuid)required
    • orderIdstringrequired

      Merchant order id

    Find Order by ID

    var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/orders/btid2384983");
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

    • 200Order foundoptional
      • orderStatusobjectoptional
        • orderobjectoptional
          • orderIdstringoptional

            Merchant order id, unique in the merchant domain

          • amountstringoptional

            Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)

          • currencystringoptional

            Transaction currency. ISO 4217 alphabetic code

          • customerIdstringoptional

            Customer label for this transaction

          • descriptionstringoptional

            Transaction description

          • customFieldstringoptional

            Additional transaction description

          • customerInfoobjectoptional
            • cardHolderNamestringoptional
            • cardHolderEmailstringoptional
            • billingAddressobjectoptional
              • namestringoptional
              • streetstringoptional
              • additionalInfostringoptional
              • citystringoptional
              • postCodestringoptional
              • provincestringoptional
              • countrystringoptional

                ISO 3166-1 alpha-3

            • shippingAddressobjectoptional
              • namestringoptional
              • streetstringoptional
              • additionalInfostringoptional
              • citystringoptional
              • postCodestringoptional
              • provincestringoptional
              • countrystringoptional

                ISO 3166-1 alpha-3

            • mobilePhoneCountryCodestringoptional
            • mobilePhonestringoptional
            • homePhonestringoptional

              The home phone number provided by the Cardholder.

            • workPhonestringoptional

              The work phone number provided by the Cardholder.

            • cardHolderAcctInfoobjectoptional
              • chAccDatestringoptional

                Date that the cardholder opened the account with the 3DS Requestor. ISO 8601 format

              • chAccAgeIndicatorstringoptional

                Length of time that the cardholder has had the account with the 3DS Requestor.

              • 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

              • chAccChangeIndicatorstringoptional

                Length of time since the cardholder's account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.

              • chAccPwChangeDatestringoptional

                Date that cardholder's account with the 3DS Requestor had a password change or account reset. ISO 8601 format

              • chAccPwChangeIndicatorstringoptional

                Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset.

              • nbPurchaseAccountnumberoptional

                Number of purchases with this cardholder account during the previous six months.

              • destinationAddressUsageDatestringoptional

                Date when the shipping address used for this transaction was first used with the 3DS Requestor. ISO 8601 format

              • destinationAddressUsageIndicatorstringoptional

                Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.

              • destinationNameIndicatorstringoptional

                Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.

              • txnActivityDaynumberoptional

                Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

              • txnActivityYearnumberoptional

                Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

              • provisionAttemptsDaynumberoptional

                Number of Add Card attempts in the last 24 hours.

              • suspiciousAccActivitystringoptional

                Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.

              • paymentAccAgeDatestringoptional

                Date that the payment account was enrolled in the cardholder's account with the 3DS Requestor. ISO 8601 format

              • paymentAccIndicatorstringoptional

                Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor.

            • merchantRiskIndicatorobjectoptional
              • deliveryEmailstringoptional

                For Electronic delivery, the email address to which the merchandise was delivered.

              • deliveryTimeframestringoptional

                Indicates the merchandise delivery timeframe.

              • giftCardAmountobjectoptional
                • valuenumberoptional

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

                • currencystringoptional

                  For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

              • giftCardCountnumberoptional

                For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

              • preOrderDatestringoptional

                For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format

              • preOrderPurchaseIndicatorstringoptional

                Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.

              • reorderItemsIndicatorstringoptional

                Indicates whether the cardholder is reordering previously purchased merchandise.

              • shipIndicatorstringoptional

                Indicates shipping method chosen for the transaction.

          • transactionSummaryarrayoptional
            • languagestringoptional

              Language to be used on the transaction summary details, ISO 639-2.

            • summaryListarrayoptional
              • labelstringoptional

                label of the field

              • valuestringoptional

                value

          • installmentsarrayoptional
            • datestringoptional

              Installment time in ISO 8601 format.

            • amountstringoptional

              Installment amount.

          • termsAndConditionsIdsarrayoptional
        • authorizedAmountstringoptional
        • capturedAmountstringoptional
        • lastOperationTypestringoptional

          It indicates the purpose of the request:

          • AUTHORIZATION - any authorization with explicit capture
          • CAPTURE - a captured authorization or an implicit captured payment
          • VOID - reversal of an authorization
          • REFUND - refund of a captured amount
          • CANCEL - the rollback of an capture, refund.

          AUTHORIZATION, CAPTURE, VOID, REFUND, CANCEL

        • lastOperationTimestringoptional

          Operation time in ISO 8601 format

      • operationsarrayoptional
        • orderIdstringoptional

          Merchant order id, unique in the merchant domain

        • operationIdstringoptional
        • 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

        • operationTypestringoptional

          It indicates the purpose of the request:

          • AUTHORIZATION - any authorization with explicit capture
          • CAPTURE - a captured authorization or an implicit captured payment
          • VOID - reversal of an authorization
          • REFUND - refund of a captured amount
          • CANCEL - the rollback of an capture, refund.

          AUTHORIZATION, CAPTURE, VOID, REFUND, CANCEL

        • 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
          • 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, THREEDS_VALIDATED, THREEDS_FAILED, PENDING, CANCELED, VOIDED, REFUNDED, FAILED

        • operationTimestringoptional

          Operation time in ISO 8601 format

        • paymentMethodstringoptional
          • CARD - Any card circuit
          • APM - Alternative payment method

          CARD, APM

        • paymentCircuitstringoptional

          one of the payment circuit values returned by the GET payment_methods web service VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY etc.

        • paymentInstrumentInfostringoptional

          Payment instrument information

        • paymentEndToEndIdstringoptional

          It is defined by the circuit to uniquely identify the transaction. Required for circuid reconciliation purposes.

        • cancelledOperationIdstringoptional

          Operation id to be undone

        • operationAmountstringoptional

          Operation amount in the payment currency

        • operationCurrencystringoptional

          Payment currency

        • customerInfoobjectoptional
          • cardHolderNamestringoptional
          • cardHolderEmailstringoptional
          • billingAddressobjectoptional
            • namestringoptional
            • streetstringoptional
            • additionalInfostringoptional
            • citystringoptional
            • postCodestringoptional
            • provincestringoptional
            • countrystringoptional

              ISO 3166-1 alpha-3

          • shippingAddressobjectoptional
            • namestringoptional
            • streetstringoptional
            • additionalInfostringoptional
            • citystringoptional
            • postCodestringoptional
            • provincestringoptional
            • countrystringoptional

              ISO 3166-1 alpha-3

          • mobilePhoneCountryCodestringoptional
          • mobilePhonestringoptional
          • homePhonestringoptional

            The home phone number provided by the Cardholder.

          • workPhonestringoptional

            The work phone number provided by the Cardholder.

          • cardHolderAcctInfoobjectoptional
            • chAccDatestringoptional

              Date that the cardholder opened the account with the 3DS Requestor. ISO 8601 format

            • chAccAgeIndicatorstringoptional

              Length of time that the cardholder has had the account with the 3DS Requestor.

            • 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

            • chAccChangeIndicatorstringoptional

              Length of time since the cardholder's account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.

            • chAccPwChangeDatestringoptional

              Date that cardholder's account with the 3DS Requestor had a password change or account reset. ISO 8601 format

            • chAccPwChangeIndicatorstringoptional

              Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset.

            • nbPurchaseAccountnumberoptional

              Number of purchases with this cardholder account during the previous six months.

            • destinationAddressUsageDatestringoptional

              Date when the shipping address used for this transaction was first used with the 3DS Requestor. ISO 8601 format

            • destinationAddressUsageIndicatorstringoptional

              Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.

            • destinationNameIndicatorstringoptional

              Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.

            • txnActivityDaynumberoptional

              Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

            • txnActivityYearnumberoptional

              Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

            • provisionAttemptsDaynumberoptional

              Number of Add Card attempts in the last 24 hours.

            • suspiciousAccActivitystringoptional

              Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.

            • paymentAccAgeDatestringoptional

              Date that the payment account was enrolled in the cardholder's account with the 3DS Requestor. ISO 8601 format

            • paymentAccIndicatorstringoptional

              Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor.

          • merchantRiskIndicatorobjectoptional
            • deliveryEmailstringoptional

              For Electronic delivery, the email address to which the merchandise was delivered.

            • deliveryTimeframestringoptional

              Indicates the merchandise delivery timeframe.

            • giftCardAmountobjectoptional
              • valuenumberoptional

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

              • currencystringoptional

                For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

            • giftCardCountnumberoptional

              For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

            • preOrderDatestringoptional

              For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format

            • preOrderPurchaseIndicatorstringoptional

              Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.

            • reorderItemsIndicatorstringoptional

              Indicates whether the cardholder is reordering previously purchased merchandise.

            • shipIndicatorstringoptional

              Indicates shipping method chosen for the transaction.

        • warningsarrayoptional
          • codestringoptional
          • descriptionstringoptional
        • paymentLinkIdstringoptional

          PayByLink id used for correlating this operation with the original link.

        • additionalDataobjectoptional

          Map of additional fields specific to the chosen payment method

      • paymentLinksarrayoptional
        • linkIdstringoptional

          Unique identifier for this link.

        • amountstringoptional

          Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)

        • expirationDatestringoptional

          Expiration date in ISO 8601 format.

        • linkstringoptional

          Link to be shared with the customer for doing the payment.

        • paidByOperationIdstringoptional

          Operation Id identifying the successful payment related to this link.

    • 401Unauthorizedoptional
    • 404Order not foundoptional
    • 500Internal Server Erroroptional
      • errorsarrayoptional
        • codestringoptional
        • descriptionstringoptional
    {
    "orderStatus": {
        "order": {
            "orderId": "btid2384983",
            "amount": "3545",
            "currency": "EUR",
            "customerId": "mcid97295873",
            "description": "TV LG 3423",
            "customField": "weekend promotion",
            "customerInfo": {
                "cardHolderName": "Mauro Morandi",
                "cardHolderEmail": "mauro.morandi@nexi.it",
                "billingAddress": {
                    "name": "Mario Rossi",
                    "street": "Piazza Maggiore, 1",
                    "additionalInfo": "Quinto Piano, Scala B",
                    "city": "Bologna",
                    "postCode": "40124",
                    "province": "BO",
                    "country": "ITA"
                },
                "shippingAddress": {
                    "name": "Mario Rossi",
                    "street": "Piazza Maggiore, 1",
                    "additionalInfo": "Quinto Piano, Scala B",
                    "city": "Bologna",
                    "postCode": "40124",
                    "province": "BO",
                    "country": "ITA"
                },
                "mobilePhoneCountryCode": "39",
                "mobilePhone": "3280987654",
                "homePhone": 391231234567,
                "workPhone": 391231234567,
                "cardHolderAcctInfo": {
                    "chAccDate": "2019-02-11T00:00:00.000Z",
                    "chAccAgeIndicator": "01",
                    "chAccChangeDate": "2019-02-11T00:00:00.000Z",
                    "chAccChangeIndicator": "01",
                    "chAccPwChangeDate": "2019-02-11T00:00:00.000Z",
                    "chAccPwChangeIndicator": "01",
                    "nbPurchaseAccount": 0,
                    "destinationAddressUsageDate": "2019-02-11T00:00:00.000Z",
                    "destinationAddressUsageIndicator": "01",
                    "destinationNameIndicator": "01",
                    "txnActivityDay": 0,
                    "txnActivityYear": 0,
                    "provisionAttemptsDay": 0,
                    "suspiciousAccActivity": "01",
                    "paymentAccAgeDate": "2019-02-11T00:00:00.000Z",
                    "paymentAccIndicator": "0"
                },
                "merchantRiskIndicator": {
                    "deliveryEmail": "john.doe@email.com",
                    "deliveryTimeframe": "01",
                    "giftCardAmount": null,
                    "giftCardCount": 0,
                    "preOrderDate": "2019-02-11T00:00:00.000Z",
                    "preOrderPurchaseIndicator": "01",
                    "reorderItemsIndicator": "01",
                    "shipIndicator": "01"
                }
            },
            "transactionSummary": [
                {
                    "language": "eng",
                    "summaryList": [
                        {
                            "label": "Number of people",
                            "value": "4"
                        }
                    ]
                }
            ],
            "installments": [
                {
                    "date": "2022-09-01T00:00:00.000Z",
                    "amount": "350"
                }
            ],
            "termsAndConditionsIds": [
                "16dd6ac6-0791-4c72-b362-85f77f1728a2"
            ]
        },
        "authorizedAmount": "3545",
        "capturedAmount": "3545",
        "lastOperationType": "CAPTURE",
        "lastOperationTime": "2022-08-01T16:32:22.038Z"
    },
    "operations": [
        {
            "orderId": "btid2384983",
            "operationId": "3470744",
            "channel": "ECOMMERCE",
            "operationType": "CAPTURE",
            "operationResult": "AUTHORIZED",
            "operationTime": "2022-09-01T01:20:00.001Z",
            "paymentMethod": "CARD",
            "paymentCircuit": "VISA",
            "paymentInstrumentInfo": "***6152",
            "paymentEndToEndId": "e723hedsdew",
            "cancelledOperationId": "",
            "operationAmount": "3545",
            "operationCurrency": "EUR",
            "customerInfo": {
                "cardHolderName": "Mauro Morandi",
                "cardHolderEmail": "mauro.morandi@nexi.it",
                "billingAddress": {
                    "name": "Mario Rossi",
                    "street": "Piazza Maggiore, 1",
                    "additionalInfo": "Quinto Piano, Scala B",
                    "city": "Bologna",
                    "postCode": "40124",
                    "province": "BO",
                    "country": "ITA"
                },
                "shippingAddress": {
                    "name": "Mario Rossi",
                    "street": "Piazza Maggiore, 1",
                    "additionalInfo": "Quinto Piano, Scala B",
                    "city": "Bologna",
                    "postCode": "40124",
                    "province": "BO",
                    "country": "ITA"
                },
                "mobilePhoneCountryCode": "39",
                "mobilePhone": "3280987654",
                "homePhone": 391231234567,
                "workPhone": 391231234567,
                "cardHolderAcctInfo": {
                    "chAccDate": "2019-02-11T00:00:00.000Z",
                    "chAccAgeIndicator": "01",
                    "chAccChangeDate": "2019-02-11T00:00:00.000Z",
                    "chAccChangeIndicator": "01",
                    "chAccPwChangeDate": "2019-02-11T00:00:00.000Z",
                    "chAccPwChangeIndicator": "01",
                    "nbPurchaseAccount": 0,
                    "destinationAddressUsageDate": "2019-02-11T00:00:00.000Z",
                    "destinationAddressUsageIndicator": "01",
                    "destinationNameIndicator": "01",
                    "txnActivityDay": 0,
                    "txnActivityYear": 0,
                    "provisionAttemptsDay": 0,
                    "suspiciousAccActivity": "01",
                    "paymentAccAgeDate": "2019-02-11T00:00:00.000Z",
                    "paymentAccIndicator": "0"
                },
                "merchantRiskIndicator": {
                    "deliveryEmail": "john.doe@email.com",
                    "deliveryTimeframe": "01",
                    "giftCardAmount": null,
                    "giftCardCount": 0,
                    "preOrderDate": "2019-02-11T00:00:00.000Z",
                    "preOrderPurchaseIndicator": "01",
                    "reorderItemsIndicator": "01",
                    "shipIndicator": "01"
                }
            },
            "warnings": [
                {
                    "code": "TRA001",
                    "description": "3DS warning"
                }
            ],
            "paymentLinkId": "234244353",
            "additionalData": {
                "authorizationCode": "647189",
                "cardCountry": "ITA",
                "threeDS": "FULL_SECURE",
                "schemaTID": "MCS01198U",
                "multiCurrencyConversion": {
                    "amount": "2662",
                    "currency": "JPY",
                    "exchangeRate": "0.007510523"
                }
            }
        }
    ],
    "paymentLinks": [
        {
            "linkId": "92864835",
            "amount": "3545",
            "expirationDate": "2022-09-01T00:00:00.000Z",
            "link": "https://{gateway_hosted_page}",
            "paidByOperationId": "3470744"
        }
    ]
}

    Find Operation by ID

    GET /operations/{operationId}

    Parameters

    • X-API-KEYstringrequired
    • Correlation-Idstring (uuid)required
    • operationIdstringrequired

      Operation id

    Find Operation by ID

    var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/operations/21345");
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

    • 200Operation foundoptional
      • orderIdstringoptional

        Merchant order id, unique in the merchant domain

      • operationIdstringoptional
      • 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

      • operationTypestringoptional

        It indicates the purpose of the request:

        • AUTHORIZATION - any authorization with explicit capture
        • CAPTURE - a captured authorization or an implicit captured payment
        • VOID - reversal of an authorization
        • REFUND - refund of a captured amount
        • CANCEL - the rollback of an capture, refund.

        AUTHORIZATION, CAPTURE, VOID, REFUND, CANCEL

      • 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
        • 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, THREEDS_VALIDATED, THREEDS_FAILED, PENDING, CANCELED, VOIDED, REFUNDED, FAILED

      • operationTimestringoptional

        Operation time in ISO 8601 format

      • paymentMethodstringoptional
        • CARD - Any card circuit
        • APM - Alternative payment method

        CARD, APM

      • paymentCircuitstringoptional

        one of the payment circuit values returned by the GET payment_methods web service VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY etc.

      • paymentInstrumentInfostringoptional

        Payment instrument information

      • paymentEndToEndIdstringoptional

        It is defined by the circuit to uniquely identify the transaction. Required for circuid reconciliation purposes.

      • cancelledOperationIdstringoptional

        Operation id to be undone

      • operationAmountstringoptional

        Operation amount in the payment currency

      • operationCurrencystringoptional

        Payment currency

      • customerInfoobjectoptional
        • cardHolderNamestringoptional
        • cardHolderEmailstringoptional
        • billingAddressobjectoptional
          • namestringoptional
          • streetstringoptional
          • additionalInfostringoptional
          • citystringoptional
          • postCodestringoptional
          • provincestringoptional
          • countrystringoptional

            ISO 3166-1 alpha-3

        • shippingAddressobjectoptional
          • namestringoptional
          • streetstringoptional
          • additionalInfostringoptional
          • citystringoptional
          • postCodestringoptional
          • provincestringoptional
          • countrystringoptional

            ISO 3166-1 alpha-3

        • mobilePhoneCountryCodestringoptional
        • mobilePhonestringoptional
        • homePhonestringoptional

          The home phone number provided by the Cardholder.

        • workPhonestringoptional

          The work phone number provided by the Cardholder.

        • cardHolderAcctInfoobjectoptional
          • chAccDatestringoptional

            Date that the cardholder opened the account with the 3DS Requestor. ISO 8601 format

          • chAccAgeIndicatorstringoptional

            Length of time that the cardholder has had the account with the 3DS Requestor.

          • 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

          • chAccChangeIndicatorstringoptional

            Length of time since the cardholder's account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.

          • chAccPwChangeDatestringoptional

            Date that cardholder's account with the 3DS Requestor had a password change or account reset. ISO 8601 format

          • chAccPwChangeIndicatorstringoptional

            Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset.

          • nbPurchaseAccountnumberoptional

            Number of purchases with this cardholder account during the previous six months.

          • destinationAddressUsageDatestringoptional

            Date when the shipping address used for this transaction was first used with the 3DS Requestor. ISO 8601 format

          • destinationAddressUsageIndicatorstringoptional

            Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.

          • destinationNameIndicatorstringoptional

            Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.

          • txnActivityDaynumberoptional

            Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

          • txnActivityYearnumberoptional

            Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

          • provisionAttemptsDaynumberoptional

            Number of Add Card attempts in the last 24 hours.

          • suspiciousAccActivitystringoptional

            Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.

          • paymentAccAgeDatestringoptional

            Date that the payment account was enrolled in the cardholder's account with the 3DS Requestor. ISO 8601 format

          • paymentAccIndicatorstringoptional

            Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor.

        • merchantRiskIndicatorobjectoptional
          • deliveryEmailstringoptional

            For Electronic delivery, the email address to which the merchandise was delivered.

          • deliveryTimeframestringoptional

            Indicates the merchandise delivery timeframe.

          • giftCardAmountobjectoptional
            • valuenumberoptional

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

            • currencystringoptional

              For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

          • giftCardCountnumberoptional

            For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

          • preOrderDatestringoptional

            For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format

          • preOrderPurchaseIndicatorstringoptional

            Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.

          • reorderItemsIndicatorstringoptional

            Indicates whether the cardholder is reordering previously purchased merchandise.

          • shipIndicatorstringoptional

            Indicates shipping method chosen for the transaction.

      • warningsarrayoptional
        • codestringoptional
        • descriptionstringoptional
      • paymentLinkIdstringoptional

        PayByLink id used for correlating this operation with the original link.

      • additionalDataobjectoptional

        Map of additional fields specific to the chosen payment method

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

    Find Operations

    GET /operations

    Find operations created in the given time interval

    Parameters

    • X-API-KEYstringrequired
    • Correlation-Idstring (uuid)required
    • fromTimestringoptional
    • toTimestringoptional
    • maxRecordsnumberoptional
    • channelstringoptional
    • operationTypestringoptional
    • customFieldstringoptional

    Find Operations

    var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/operations?fromTime=SOME_STRING_VALUE&toTime=SOME_STRING_VALUE&maxRecords=SOME_NUMBER_VALUE&channel=ECOMMERCE&operationType=CAPTURE&customField=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

    • 200Request successfully processedoptional
      • operationsarrayoptional
        • orderIdstringoptional

          Merchant order id, unique in the merchant domain

        • operationIdstringoptional
        • 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

        • operationTypestringoptional

          It indicates the purpose of the request:

          • AUTHORIZATION - any authorization with explicit capture
          • CAPTURE - a captured authorization or an implicit captured payment
          • VOID - reversal of an authorization
          • REFUND - refund of a captured amount
          • CANCEL - the rollback of an capture, refund.

          AUTHORIZATION, CAPTURE, VOID, REFUND, CANCEL

        • 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
          • 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, THREEDS_VALIDATED, THREEDS_FAILED, PENDING, CANCELED, VOIDED, REFUNDED, FAILED

        • operationTimestringoptional

          Operation time in ISO 8601 format

        • paymentMethodstringoptional
          • CARD - Any card circuit
          • APM - Alternative payment method

          CARD, APM

        • paymentCircuitstringoptional

          one of the payment circuit values returned by the GET payment_methods web service VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY etc.

        • paymentInstrumentInfostringoptional

          Payment instrument information

        • paymentEndToEndIdstringoptional

          It is defined by the circuit to uniquely identify the transaction. Required for circuid reconciliation purposes.

        • cancelledOperationIdstringoptional

          Operation id to be undone

        • operationAmountstringoptional

          Operation amount in the payment currency

        • operationCurrencystringoptional

          Payment currency

        • customerInfoobjectoptional
          • cardHolderNamestringoptional
          • cardHolderEmailstringoptional
          • billingAddressobjectoptional
            • namestringoptional
            • streetstringoptional
            • additionalInfostringoptional
            • citystringoptional
            • postCodestringoptional
            • provincestringoptional
            • countrystringoptional

              ISO 3166-1 alpha-3

          • shippingAddressobjectoptional
            • namestringoptional
            • streetstringoptional
            • additionalInfostringoptional
            • citystringoptional
            • postCodestringoptional
            • provincestringoptional
            • countrystringoptional

              ISO 3166-1 alpha-3

          • mobilePhoneCountryCodestringoptional
          • mobilePhonestringoptional
          • homePhonestringoptional

            The home phone number provided by the Cardholder.

          • workPhonestringoptional

            The work phone number provided by the Cardholder.

          • cardHolderAcctInfoobjectoptional
            • chAccDatestringoptional

              Date that the cardholder opened the account with the 3DS Requestor. ISO 8601 format

            • chAccAgeIndicatorstringoptional

              Length of time that the cardholder has had the account with the 3DS Requestor.

            • 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

            • chAccChangeIndicatorstringoptional

              Length of time since the cardholder's account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.

            • chAccPwChangeDatestringoptional

              Date that cardholder's account with the 3DS Requestor had a password change or account reset. ISO 8601 format

            • chAccPwChangeIndicatorstringoptional

              Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset.

            • nbPurchaseAccountnumberoptional

              Number of purchases with this cardholder account during the previous six months.

            • destinationAddressUsageDatestringoptional

              Date when the shipping address used for this transaction was first used with the 3DS Requestor. ISO 8601 format

            • destinationAddressUsageIndicatorstringoptional

              Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.

            • destinationNameIndicatorstringoptional

              Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.

            • txnActivityDaynumberoptional

              Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

            • txnActivityYearnumberoptional

              Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

            • provisionAttemptsDaynumberoptional

              Number of Add Card attempts in the last 24 hours.

            • suspiciousAccActivitystringoptional

              Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.

            • paymentAccAgeDatestringoptional

              Date that the payment account was enrolled in the cardholder's account with the 3DS Requestor. ISO 8601 format

            • paymentAccIndicatorstringoptional

              Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor.

          • merchantRiskIndicatorobjectoptional
            • deliveryEmailstringoptional

              For Electronic delivery, the email address to which the merchandise was delivered.

            • deliveryTimeframestringoptional

              Indicates the merchandise delivery timeframe.

            • giftCardAmountobjectoptional
              • valuenumberoptional

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

              • currencystringoptional

                For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

            • giftCardCountnumberoptional

              For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

            • preOrderDatestringoptional

              For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format

            • preOrderPurchaseIndicatorstringoptional

              Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.

            • reorderItemsIndicatorstringoptional

              Indicates whether the cardholder is reordering previously purchased merchandise.

            • shipIndicatorstringoptional

              Indicates shipping method chosen for the transaction.

        • warningsarrayoptional
          • codestringoptional
          • descriptionstringoptional
        • paymentLinkIdstringoptional

          PayByLink id used for correlating this operation with the original link.

        • additionalDataobjectoptional

          Map of additional fields specific to the chosen payment method

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

    Refund

    POST /operations/{operationId}/refunds

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

    Parameters

    • X-API-KEYstringrequired
    • Idempotency-Keystring (uuid)required
    • Correlation-Idstring (uuid)required
    • operationIdstringrequired

      Operation id

    Refund

    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("Idempotency-Key", "SOME_STRING_VALUE");
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

      Responses

      • 200Post operation acceptedoptional
        • 400Request rejectedoptional
          • errorsarrayoptional
            • codestringoptional
            • descriptionstringoptional
        • 401Unauthorizedoptional
        • 404Transaction not foundoptional
        • 500Internal Server Erroroptional
          • errorsarrayoptional
            • codestringoptional
            • descriptionstringoptional
        {
    "errors": [
        {
            "code": "GW0001",
            "description": "Invalid merchant URL"
        }
    ]
}

        Capture

        POST /operations/{operationId}/captures

        Payment confirmation, partial or full

        Parameters

        • X-API-KEYstringrequired
        • Idempotency-Keystring (uuid)required
        • Correlation-Idstring (uuid)required
        • operationIdstringrequired

          Operation id

        Capture

        var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/operations/21345/captures");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Idempotency-Key", "SOME_STRING_VALUE");
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

          Responses

          • 200Post operation acceptedoptional
            • 400Request rejectedoptional
              • errorsarrayoptional
                • codestringoptional
                • descriptionstringoptional
            • 401Unauthorizedoptional
            • 404Transaction not foundoptional
            • 500Internal Server Erroroptional
              • errorsarrayoptional
                • codestringoptional
                • descriptionstringoptional
            {
    "errors": [
        {
            "code": "GW0001",
            "description": "Invalid merchant URL"
        }
    ]
}

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

            POST /operations/{operationId}/cancels

            Parameters

            • X-API-KEYstringrequired
            • Correlation-Idstring (uuid)required
            • operationIdstringrequired

              Operation id of a capture operation to be cancelled

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

            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.

            Request body

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

            Responses

            • 200Request acceptedoptional
              • 400Request rejectedoptional
                • errorsarrayoptional
                  • codestringoptional
                  • descriptionstringoptional
              • 401Unauthorizedoptional
              • 404Order or operation not foundoptional
              • 500Internal Server Erroroptional
                • errorsarrayoptional
                  • codestringoptional
                  • descriptionstringoptional
              {
    "errors": [
        {
            "code": "GW0001",
            "description": "Invalid merchant URL"
        }
    ]
}

              List of payment methods supported by this merchant together with associated attributes

              GET /payment_methods

              Parameters

              • X-API-KEYstringrequired
              • Correlation-Idstring (uuid)required

              List of payment methods supported by this merchant together with associated attributes

              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

              • 200Request processed successfullyoptional
                • paymentMethodsarrayoptional
                  • circuitstringoptional

                    one of VISA, MASTERCARD, PAYPAL, BANCONTACT, MYBANK etc.

                  • methodTypestringoptional
                    • CARD - Card circuit * APM - Alternative payment method

                    CARD, APM

                  • imageLinkstringoptional

                    Location for the logo of this payment method in SVG format

                  • recurringSupportedbooleanoptional
                  • oneClickSupportedbooleanoptional
              • 401Unauthorizedoptional
              • 500Internal Server Erroroptional
                • errorsarrayoptional
                  • codestringoptional
                  • descriptionstringoptional
              {
    "paymentMethods": [
        {
            "circuit": "VISA",
            "methodType": "CARD",
            "imageLink": "https://ngwecomm.nexi.it/monetaweb/static/images/mybank.svg",
            "recurringSupported": true,
            "oneClickSupported": true
        }
    ]
}

              MOTO Payment

              POST /orders/moto

              Parameters

              • X-API-KEYstringrequired
              • Correlation-Idstring (uuid)required

              MOTO Payment

              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-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

              Request body

              • orderobjectoptional
                • orderIdstringoptional

                  Merchant order id, unique in the merchant domain

                • amountstringoptional

                  Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)

                • currencystringoptional

                  Transaction currency. ISO 4217 alphabetic code

                • customerIdstringoptional

                  Customer label for this transaction

                • descriptionstringoptional

                  Transaction description

                • customFieldstringoptional

                  Additional transaction description

                • customerInfoobjectoptional
                  • cardHolderNamestringoptional
                  • cardHolderEmailstringoptional
                  • billingAddressobjectoptional
                    • namestringoptional
                    • streetstringoptional
                    • additionalInfostringoptional
                    • citystringoptional
                    • postCodestringoptional
                    • provincestringoptional
                    • countrystringoptional

                      ISO 3166-1 alpha-3

                  • shippingAddressobjectoptional
                    • namestringoptional
                    • streetstringoptional
                    • additionalInfostringoptional
                    • citystringoptional
                    • postCodestringoptional
                    • provincestringoptional
                    • countrystringoptional

                      ISO 3166-1 alpha-3

                  • mobilePhoneCountryCodestringoptional
                  • mobilePhonestringoptional
                  • homePhonestringoptional

                    The home phone number provided by the Cardholder.

                  • workPhonestringoptional

                    The work phone number provided by the Cardholder.

                  • cardHolderAcctInfoobjectoptional
                    • chAccDatestringoptional

                      Date that the cardholder opened the account with the 3DS Requestor. ISO 8601 format

                    • chAccAgeIndicatorstringoptional

                      Length of time that the cardholder has had the account with the 3DS Requestor.

                    • 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

                    • chAccChangeIndicatorstringoptional

                      Length of time since the cardholder's account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.

                    • chAccPwChangeDatestringoptional

                      Date that cardholder's account with the 3DS Requestor had a password change or account reset. ISO 8601 format

                    • chAccPwChangeIndicatorstringoptional

                      Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset.

                    • nbPurchaseAccountnumberoptional

                      Number of purchases with this cardholder account during the previous six months.

                    • destinationAddressUsageDatestringoptional

                      Date when the shipping address used for this transaction was first used with the 3DS Requestor. ISO 8601 format

                    • destinationAddressUsageIndicatorstringoptional

                      Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.

                    • destinationNameIndicatorstringoptional

                      Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.

                    • txnActivityDaynumberoptional

                      Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

                    • txnActivityYearnumberoptional

                      Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

                    • provisionAttemptsDaynumberoptional

                      Number of Add Card attempts in the last 24 hours.

                    • suspiciousAccActivitystringoptional

                      Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.

                    • paymentAccAgeDatestringoptional

                      Date that the payment account was enrolled in the cardholder's account with the 3DS Requestor. ISO 8601 format

                    • paymentAccIndicatorstringoptional

                      Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor.

                  • merchantRiskIndicatorobjectoptional
                    • deliveryEmailstringoptional

                      For Electronic delivery, the email address to which the merchandise was delivered.

                    • deliveryTimeframestringoptional

                      Indicates the merchandise delivery timeframe.

                    • giftCardAmountobjectoptional
                      • valuenumberoptional

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

                      • currencystringoptional

                        For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

                    • giftCardCountnumberoptional

                      For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

                    • preOrderDatestringoptional

                      For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format

                    • preOrderPurchaseIndicatorstringoptional

                      Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.

                    • reorderItemsIndicatorstringoptional

                      Indicates whether the cardholder is reordering previously purchased merchandise.

                    • shipIndicatorstringoptional

                      Indicates shipping method chosen for the transaction.

                • transactionSummaryarrayoptional
                  • languagestringoptional

                    Language to be used on the transaction summary details, ISO 639-2.

                  • summaryListarrayoptional
                    • labelstringoptional

                      label of the field

                    • valuestringoptional

                      value

                • installmentsarrayoptional
                  • datestringoptional

                    Installment time in ISO 8601 format.

                  • amountstringoptional

                    Installment amount.

                • termsAndConditionsIdsarrayoptional
              • cardobjectoptional
                • panstringoptional

                  Card PAN

                • expiryDatestringoptional

                  Card expiry date in format mmyy

                • cvvstringoptional

                  Card Validation Value, when available

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

                IMPLICIT, EXPLICIT

              Request body

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

              Responses

              • 200Payment successfuloptional
                • operationobjectoptional
                  • orderIdstringoptional

                    Merchant order id, unique in the merchant domain

                  • operationIdstringoptional
                  • 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

                  • operationTypestringoptional

                    It indicates the purpose of the request:

                    • AUTHORIZATION - any authorization with explicit capture
                    • CAPTURE - a captured authorization or an implicit captured payment
                    • VOID - reversal of an authorization
                    • REFUND - refund of a captured amount
                    • CANCEL - the rollback of an capture, refund.

                    AUTHORIZATION, CAPTURE, VOID, REFUND, CANCEL

                  • 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
                    • 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, THREEDS_VALIDATED, THREEDS_FAILED, PENDING, CANCELED, VOIDED, REFUNDED, FAILED

                  • operationTimestringoptional

                    Operation time in ISO 8601 format

                  • paymentMethodstringoptional
                    • CARD - Any card circuit
                    • APM - Alternative payment method

                    CARD, APM

                  • paymentCircuitstringoptional

                    one of the payment circuit values returned by the GET payment_methods web service VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY etc.

                  • paymentInstrumentInfostringoptional

                    Payment instrument information

                  • paymentEndToEndIdstringoptional

                    It is defined by the circuit to uniquely identify the transaction. Required for circuid reconciliation purposes.

                  • cancelledOperationIdstringoptional

                    Operation id to be undone

                  • operationAmountstringoptional

                    Operation amount in the payment currency

                  • operationCurrencystringoptional

                    Payment currency

                  • customerInfoobjectoptional
                    • cardHolderNamestringoptional
                    • cardHolderEmailstringoptional
                    • billingAddressobjectoptional
                      • namestringoptional
                      • streetstringoptional
                      • additionalInfostringoptional
                      • citystringoptional
                      • postCodestringoptional
                      • provincestringoptional
                      • countrystringoptional

                        ISO 3166-1 alpha-3

                    • shippingAddressobjectoptional
                      • namestringoptional
                      • streetstringoptional
                      • additionalInfostringoptional
                      • citystringoptional
                      • postCodestringoptional
                      • provincestringoptional
                      • countrystringoptional

                        ISO 3166-1 alpha-3

                    • mobilePhoneCountryCodestringoptional
                    • mobilePhonestringoptional
                    • homePhonestringoptional

                      The home phone number provided by the Cardholder.

                    • workPhonestringoptional

                      The work phone number provided by the Cardholder.

                    • cardHolderAcctInfoobjectoptional
                      • chAccDatestringoptional

                        Date that the cardholder opened the account with the 3DS Requestor. ISO 8601 format

                      • chAccAgeIndicatorstringoptional

                        Length of time that the cardholder has had the account with the 3DS Requestor.

                      • 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

                      • chAccChangeIndicatorstringoptional

                        Length of time since the cardholder's account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.

                      • chAccPwChangeDatestringoptional

                        Date that cardholder's account with the 3DS Requestor had a password change or account reset. ISO 8601 format

                      • chAccPwChangeIndicatorstringoptional

                        Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset.

                      • nbPurchaseAccountnumberoptional

                        Number of purchases with this cardholder account during the previous six months.

                      • destinationAddressUsageDatestringoptional

                        Date when the shipping address used for this transaction was first used with the 3DS Requestor. ISO 8601 format

                      • destinationAddressUsageIndicatorstringoptional

                        Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.

                      • destinationNameIndicatorstringoptional

                        Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.

                      • txnActivityDaynumberoptional

                        Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

                      • txnActivityYearnumberoptional

                        Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

                      • provisionAttemptsDaynumberoptional

                        Number of Add Card attempts in the last 24 hours.

                      • suspiciousAccActivitystringoptional

                        Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.

                      • paymentAccAgeDatestringoptional

                        Date that the payment account was enrolled in the cardholder's account with the 3DS Requestor. ISO 8601 format

                      • paymentAccIndicatorstringoptional

                        Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor.

                    • merchantRiskIndicatorobjectoptional
                      • deliveryEmailstringoptional

                        For Electronic delivery, the email address to which the merchandise was delivered.

                      • deliveryTimeframestringoptional

                        Indicates the merchandise delivery timeframe.

                      • giftCardAmountobjectoptional
                        • valuenumberoptional

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

                        • currencystringoptional

                          For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

                      • giftCardCountnumberoptional

                        For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

                      • preOrderDatestringoptional

                        For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format

                      • preOrderPurchaseIndicatorstringoptional

                        Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.

                      • reorderItemsIndicatorstringoptional

                        Indicates whether the cardholder is reordering previously purchased merchandise.

                      • shipIndicatorstringoptional

                        Indicates shipping method chosen for the transaction.

                  • warningsarrayoptional
                    • codestringoptional
                    • descriptionstringoptional
                  • paymentLinkIdstringoptional

                    PayByLink id used for correlating this operation with the original link.

                  • additionalDataobjectoptional

                    Map of additional fields specific to the chosen payment method

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

              Merchant Initiated Transaction

              POST /orders/mit

              Parameters

              • X-API-KEYstringrequired
              • Correlation-Idstring (uuid)required

              Merchant Initiated Transaction

              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("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

              • orderobjectoptional
                • orderIdstringoptional

                  Merchant order id, unique in the merchant domain

                • amountstringoptional

                  Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)

                • currencystringoptional

                  Transaction currency. ISO 4217 alphabetic code

                • customerIdstringoptional

                  Customer label for this transaction

                • descriptionstringoptional

                  Transaction description

                • customFieldstringoptional

                  Additional transaction description

                • customerInfoobjectoptional
                  • cardHolderNamestringoptional
                  • cardHolderEmailstringoptional
                  • billingAddressobjectoptional
                    • namestringoptional
                    • streetstringoptional
                    • additionalInfostringoptional
                    • citystringoptional
                    • postCodestringoptional
                    • provincestringoptional
                    • countrystringoptional

                      ISO 3166-1 alpha-3

                  • shippingAddressobjectoptional
                    • namestringoptional
                    • streetstringoptional
                    • additionalInfostringoptional
                    • citystringoptional
                    • postCodestringoptional
                    • provincestringoptional
                    • countrystringoptional

                      ISO 3166-1 alpha-3

                  • mobilePhoneCountryCodestringoptional
                  • mobilePhonestringoptional
                  • homePhonestringoptional

                    The home phone number provided by the Cardholder.

                  • workPhonestringoptional

                    The work phone number provided by the Cardholder.

                  • cardHolderAcctInfoobjectoptional
                    • chAccDatestringoptional

                      Date that the cardholder opened the account with the 3DS Requestor. ISO 8601 format

                    • chAccAgeIndicatorstringoptional

                      Length of time that the cardholder has had the account with the 3DS Requestor.

                    • 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

                    • chAccChangeIndicatorstringoptional

                      Length of time since the cardholder's account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.

                    • chAccPwChangeDatestringoptional

                      Date that cardholder's account with the 3DS Requestor had a password change or account reset. ISO 8601 format

                    • chAccPwChangeIndicatorstringoptional

                      Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset.

                    • nbPurchaseAccountnumberoptional

                      Number of purchases with this cardholder account during the previous six months.

                    • destinationAddressUsageDatestringoptional

                      Date when the shipping address used for this transaction was first used with the 3DS Requestor. ISO 8601 format

                    • destinationAddressUsageIndicatorstringoptional

                      Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.

                    • destinationNameIndicatorstringoptional

                      Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.

                    • txnActivityDaynumberoptional

                      Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

                    • txnActivityYearnumberoptional

                      Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

                    • provisionAttemptsDaynumberoptional

                      Number of Add Card attempts in the last 24 hours.

                    • suspiciousAccActivitystringoptional

                      Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.

                    • paymentAccAgeDatestringoptional

                      Date that the payment account was enrolled in the cardholder's account with the 3DS Requestor. ISO 8601 format

                    • paymentAccIndicatorstringoptional

                      Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor.

                  • merchantRiskIndicatorobjectoptional
                    • deliveryEmailstringoptional

                      For Electronic delivery, the email address to which the merchandise was delivered.

                    • deliveryTimeframestringoptional

                      Indicates the merchandise delivery timeframe.

                    • giftCardAmountobjectoptional
                      • valuenumberoptional

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

                      • currencystringoptional

                        For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

                    • giftCardCountnumberoptional

                      For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

                    • preOrderDatestringoptional

                      For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format

                    • preOrderPurchaseIndicatorstringoptional

                      Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.

                    • reorderItemsIndicatorstringoptional

                      Indicates whether the cardholder is reordering previously purchased merchandise.

                    • shipIndicatorstringoptional

                      Indicates shipping method chosen for the transaction.

                • transactionSummaryarrayoptional
                  • languagestringoptional

                    Language to be used on the transaction summary details, ISO 639-2.

                  • summaryListarrayoptional
                    • labelstringoptional

                      label of the field

                    • valuestringoptional

                      value

                • installmentsarrayoptional
                  • datestringoptional

                    Installment time in ISO 8601 format.

                  • amountstringoptional

                    Installment amount.

                • termsAndConditionsIdsarrayoptional
              • contractIdstringoptional
              • 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.

                IMPLICIT, EXPLICIT

              Request body

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

              Responses

              • 200Payment successfuloptional
                • operationobjectoptional
                  • orderIdstringoptional

                    Merchant order id, unique in the merchant domain

                  • operationIdstringoptional
                  • 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

                  • operationTypestringoptional

                    It indicates the purpose of the request:

                    • AUTHORIZATION - any authorization with explicit capture
                    • CAPTURE - a captured authorization or an implicit captured payment
                    • VOID - reversal of an authorization
                    • REFUND - refund of a captured amount
                    • CANCEL - the rollback of an capture, refund.

                    AUTHORIZATION, CAPTURE, VOID, REFUND, CANCEL

                  • 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
                    • 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, THREEDS_VALIDATED, THREEDS_FAILED, PENDING, CANCELED, VOIDED, REFUNDED, FAILED

                  • operationTimestringoptional

                    Operation time in ISO 8601 format

                  • paymentMethodstringoptional
                    • CARD - Any card circuit
                    • APM - Alternative payment method

                    CARD, APM

                  • paymentCircuitstringoptional

                    one of the payment circuit values returned by the GET payment_methods web service VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY etc.

                  • paymentInstrumentInfostringoptional

                    Payment instrument information

                  • paymentEndToEndIdstringoptional

                    It is defined by the circuit to uniquely identify the transaction. Required for circuid reconciliation purposes.

                  • cancelledOperationIdstringoptional

                    Operation id to be undone

                  • operationAmountstringoptional

                    Operation amount in the payment currency

                  • operationCurrencystringoptional

                    Payment currency

                  • customerInfoobjectoptional
                    • cardHolderNamestringoptional
                    • cardHolderEmailstringoptional
                    • billingAddressobjectoptional
                      • namestringoptional
                      • streetstringoptional
                      • additionalInfostringoptional
                      • citystringoptional
                      • postCodestringoptional
                      • provincestringoptional
                      • countrystringoptional

                        ISO 3166-1 alpha-3

                    • shippingAddressobjectoptional
                      • namestringoptional
                      • streetstringoptional
                      • additionalInfostringoptional
                      • citystringoptional
                      • postCodestringoptional
                      • provincestringoptional
                      • countrystringoptional

                        ISO 3166-1 alpha-3

                    • mobilePhoneCountryCodestringoptional
                    • mobilePhonestringoptional
                    • homePhonestringoptional

                      The home phone number provided by the Cardholder.

                    • workPhonestringoptional

                      The work phone number provided by the Cardholder.

                    • cardHolderAcctInfoobjectoptional
                      • chAccDatestringoptional

                        Date that the cardholder opened the account with the 3DS Requestor. ISO 8601 format

                      • chAccAgeIndicatorstringoptional

                        Length of time that the cardholder has had the account with the 3DS Requestor.

                      • 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

                      • chAccChangeIndicatorstringoptional

                        Length of time since the cardholder's account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.

                      • chAccPwChangeDatestringoptional

                        Date that cardholder's account with the 3DS Requestor had a password change or account reset. ISO 8601 format

                      • chAccPwChangeIndicatorstringoptional

                        Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset.

                      • nbPurchaseAccountnumberoptional

                        Number of purchases with this cardholder account during the previous six months.

                      • destinationAddressUsageDatestringoptional

                        Date when the shipping address used for this transaction was first used with the 3DS Requestor. ISO 8601 format

                      • destinationAddressUsageIndicatorstringoptional

                        Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.

                      • destinationNameIndicatorstringoptional

                        Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.

                      • txnActivityDaynumberoptional

                        Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

                      • txnActivityYearnumberoptional

                        Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

                      • provisionAttemptsDaynumberoptional

                        Number of Add Card attempts in the last 24 hours.

                      • suspiciousAccActivitystringoptional

                        Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.

                      • paymentAccAgeDatestringoptional

                        Date that the payment account was enrolled in the cardholder's account with the 3DS Requestor. ISO 8601 format

                      • paymentAccIndicatorstringoptional

                        Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor.

                    • merchantRiskIndicatorobjectoptional
                      • deliveryEmailstringoptional

                        For Electronic delivery, the email address to which the merchandise was delivered.

                      • deliveryTimeframestringoptional

                        Indicates the merchandise delivery timeframe.

                      • giftCardAmountobjectoptional
                        • valuenumberoptional

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

                        • currencystringoptional

                          For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

                      • giftCardCountnumberoptional

                        For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

                      • preOrderDatestringoptional

                        For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format

                      • preOrderPurchaseIndicatorstringoptional

                        Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.

                      • reorderItemsIndicatorstringoptional

                        Indicates whether the cardholder is reordering previously purchased merchandise.

                      • shipIndicatorstringoptional

                        Indicates shipping method chosen for the transaction.

                  • warningsarrayoptional
                    • codestringoptional
                    • descriptionstringoptional
                  • paymentLinkIdstringoptional

                    PayByLink id used for correlating this operation with the original link.

                  • additionalDataobjectoptional

                    Map of additional fields specific to the chosen payment method

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

              Generates a link to be shared with the cardholder for triggering the payment for the specified order

              POST /orders/paybylink

              Parameters

              • X-API-KEYstringrequired
              • Correlation-Idstring (uuid)required

              Generates a link to be shared with the cardholder for triggering the payment for the specified order

              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-API-KEY", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

              Request body

              • orderobjectoptional
                • orderIdstringoptional

                  Merchant order id, unique in the merchant domain

                • amountstringoptional

                  Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)

                • currencystringoptional

                  Transaction currency. ISO 4217 alphabetic code

                • customerIdstringoptional

                  Customer label for this transaction

                • descriptionstringoptional

                  Transaction description

                • customFieldstringoptional

                  Additional transaction description

                • customerInfoobjectoptional
                  • cardHolderNamestringoptional
                  • cardHolderEmailstringoptional
                  • billingAddressobjectoptional
                    • namestringoptional
                    • streetstringoptional
                    • additionalInfostringoptional
                    • citystringoptional
                    • postCodestringoptional
                    • provincestringoptional
                    • countrystringoptional

                      ISO 3166-1 alpha-3

                  • shippingAddressobjectoptional
                    • namestringoptional
                    • streetstringoptional
                    • additionalInfostringoptional
                    • citystringoptional
                    • postCodestringoptional
                    • provincestringoptional
                    • countrystringoptional

                      ISO 3166-1 alpha-3

                  • mobilePhoneCountryCodestringoptional
                  • mobilePhonestringoptional
                  • homePhonestringoptional

                    The home phone number provided by the Cardholder.

                  • workPhonestringoptional

                    The work phone number provided by the Cardholder.

                  • cardHolderAcctInfoobjectoptional
                    • chAccDatestringoptional

                      Date that the cardholder opened the account with the 3DS Requestor. ISO 8601 format

                    • chAccAgeIndicatorstringoptional

                      Length of time that the cardholder has had the account with the 3DS Requestor.

                    • 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

                    • chAccChangeIndicatorstringoptional

                      Length of time since the cardholder's account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.

                    • chAccPwChangeDatestringoptional

                      Date that cardholder's account with the 3DS Requestor had a password change or account reset. ISO 8601 format

                    • chAccPwChangeIndicatorstringoptional

                      Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset.

                    • nbPurchaseAccountnumberoptional

                      Number of purchases with this cardholder account during the previous six months.

                    • destinationAddressUsageDatestringoptional

                      Date when the shipping address used for this transaction was first used with the 3DS Requestor. ISO 8601 format

                    • destinationAddressUsageIndicatorstringoptional

                      Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.

                    • destinationNameIndicatorstringoptional

                      Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.

                    • txnActivityDaynumberoptional

                      Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

                    • txnActivityYearnumberoptional

                      Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

                    • provisionAttemptsDaynumberoptional

                      Number of Add Card attempts in the last 24 hours.

                    • suspiciousAccActivitystringoptional

                      Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.

                    • paymentAccAgeDatestringoptional

                      Date that the payment account was enrolled in the cardholder's account with the 3DS Requestor. ISO 8601 format

                    • paymentAccIndicatorstringoptional

                      Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor.

                  • merchantRiskIndicatorobjectoptional
                    • deliveryEmailstringoptional

                      For Electronic delivery, the email address to which the merchandise was delivered.

                    • deliveryTimeframestringoptional

                      Indicates the merchandise delivery timeframe.

                    • giftCardAmountobjectoptional
                      • valuenumberoptional

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

                      • currencystringoptional

                        For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

                    • giftCardCountnumberoptional

                      For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

                    • preOrderDatestringoptional

                      For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format

                    • preOrderPurchaseIndicatorstringoptional

                      Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.

                    • reorderItemsIndicatorstringoptional

                      Indicates whether the cardholder is reordering previously purchased merchandise.

                    • shipIndicatorstringoptional

                      Indicates shipping method chosen for the transaction.

                • transactionSummaryarrayoptional
                  • languagestringoptional

                    Language to be used on the transaction summary details, ISO 639-2.

                  • summaryListarrayoptional
                    • labelstringoptional

                      label of the field

                    • valuestringoptional

                      value

                • installmentsarrayoptional
                  • datestringoptional

                    Installment time in ISO 8601 format.

                  • amountstringoptional

                    Installment amount.

                • termsAndConditionsIdsarrayoptional
              • paymentSessionobjectoptional
                • actionTypestringoptional

                  PAY, VERIFY, PREAUTH

                • amountstringoptional

                  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)

                • recurrenceobjectoptional
                  • actionstringoptional

                    NO_RECURRING, SUBSEQUENT_PAYMENT, CONTRACT_CREATION, CARD_SUBSTITUTION

                  • contractIdstringoptional
                  • contractTypestringoptional

                    MIT_UNSCHEDULED, MIT_SCHEDULED, CIT

                  • contractExpiryDatestringoptional

                    Used with contractType MIT_SCHEDULED. ISO 8601 format

                  • contractFrequencystringoptional

                    Used with contractType MIT_SCHEDULED. Number of days

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

                  IMPLICIT, EXPLICIT

                • exemptionsstringoptional

                  NO_PREFERENCE, CHALLENGE_REQUESTED

                • languagestringoptional

                  Language to be used on the hosted payment page. ISO 639-2

                • resultUrlstringoptional

                  Merchant URL where the cardholder is redirected once the hosted payment completes

                • cancelUrlstringoptional

                  Merchant URL where the cardholder is redirected once the hosted payment is abandoned

                • notificationUrlstringoptional

                  Merchant URL where the gateway pushes notifications

              • expirationDatestringoptional

                Expiration date in ISO 8601 format. Maximum 90 days after the link creation

              Request body

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

              Responses

              • 200Link generatedoptional
                • paymentLinkobjectoptional
                  • linkIdstringoptional

                    Unique identifier for this link.

                  • amountstringoptional

                    Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)

                  • expirationDatestringoptional

                    Expiration date in ISO 8601 format.

                  • linkstringoptional

                    Link to be shared with the customer for doing the payment.

                  • paidByOperationIdstringoptional

                    Operation Id identifying the successful payment related to this link.

                • securityTokenstringoptional

                  Token which may be used for validating the notifications related to this payment

              • 400Invalid request dataoptional
                • errorsarrayoptional
                  • codestringoptional
                  • descriptionstringoptional
              • 401Unauthorizedoptional
              • 500Internal Server Erroroptional
                • errorsarrayoptional
                  • codestringoptional
                  • descriptionstringoptional
              {
    "paymentLink": {
        "linkId": "92864835",
        "amount": "3545",
        "expirationDate": "2022-09-01T00:00:00.000Z",
        "link": "https://{gateway_hosted_page}",
        "paidByOperationId": "3470744"
    },
    "securityToken": "2f0ea5059b41414ca3744fe672327d85"
}

              Cancel a non-paid link.

              POST /paybylink/{linkId}/cancels

              Parameters

              • X-API-KEYstringrequired
              • Correlation-Idstring (uuid)required
              • linkIdstringrequired

                Payment link ID to be cancelled.

              Cancel a non-paid link.

              var client = new RestClient("https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/paybylink/btid2384983/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

              • 200Link cancelled.optional
              • 400Request rejectedoptional
                • errorsarrayoptional
                  • codestringoptional
                  • descriptionstringoptional
              • 401Unauthorizedoptional
              • 404Link not foundoptional
              • 500Internal Server Erroroptional
                • errorsarrayoptional
                  • codestringoptional
                  • descriptionstringoptional
              {
    "errors": [
        {
            "code": "GW0001",
            "description": "Invalid merchant URL"
        }
    ]
}

              Finds recurring contracts by customer ID

              GET /contracts/customers/{customerId}

              Parameters

              • X-API-KEYstringrequired
              • Correlation-Idstring (uuid)required
              • customerIdstringrequired

              Finds recurring contracts by customer ID

              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
                • customerIdstringoptional

                  Customer ID

                • contractsarrayoptional
                  • contractIdstringoptional
                  • contractTypestringoptional

                    MIT_UNSCHEDULED, MIT_SCHEDULED, CIT

                  • contractExpiryDatestringoptional
                  • contractFrequencystringoptional
                  • paymentMethodstringoptional
                    • CARD - Any card circuit
                    • APM - Alternative payment method

                    CARD, APM

                  • paymentCircuitstringoptional

                    one of the payment circuit values returned by the GET payment_methods web service VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY etc.

                  • paymentInstrumentInfostringoptional
              • 401Unauthorizedoptional
              • 404Customer not foundoptional
              • 500Internal Server Erroroptional
                • errorsarrayoptional
                  • codestringoptional
                  • descriptionstringoptional
              {
    "customerId": "36451278",
    "contracts": [
        {
            "contractId": "C2834987",
            "contractType": "MIT_UNSCHEDULED",
            "contractExpiryDate": "2023-03-16T00:00:00.000Z",
            "contractFrequency": "120",
            "paymentMethod": "CARD",
            "paymentCircuit": "VISA",
            "paymentInstrumentInfo": "***6152"
        }
    ]
}

              Disables a contract

              POST /contracts/{contractId}/deactivation

              Parameters

              • X-API-KEYstringrequired
              • Correlation-Idstring (uuid)required
              • contractIdstringrequired

                Recurring contract id

              Disables a contract

              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
              • 400Invalid request dataoptional
                • errorsarrayoptional
                  • codestringoptional
                  • descriptionstringoptional
              • 401Unauthorizedoptional
              • 500Internal Server Erroroptional
                • errorsarrayoptional
                  • codestringoptional
                  • descriptionstringoptional
              {
    "errors": [
        {
            "code": "GW0001",
            "description": "Invalid merchant URL"
        }
    ]
}

              Verify 3DS enrollment. Begin 3-steps flow.

              POST /orders/3steps/init

              Parameters

              • X-API-KEYstringrequired
              • Correlation-Idstring (uuid)required

              Verify 3DS enrollment. Begin 3-steps flow.

              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

              • orderobjectoptional
                • orderIdstringoptional

                  Merchant order id, unique in the merchant domain

                • amountstringoptional

                  Transaction amount in smallest currency unit. 50 EUR is represented as 5000 (2 decimals) 50 JPY is represented as 50 (0 decimals)

                • currencystringoptional

                  Transaction currency. ISO 4217 alphabetic code

                • customerIdstringoptional

                  Customer label for this transaction

                • descriptionstringoptional

                  Transaction description

                • customFieldstringoptional

                  Additional transaction description

                • customerInfoobjectoptional
                  • cardHolderNamestringoptional
                  • cardHolderEmailstringoptional
                  • billingAddressobjectoptional
                    • namestringoptional
                    • streetstringoptional
                    • additionalInfostringoptional
                    • citystringoptional
                    • postCodestringoptional
                    • provincestringoptional
                    • countrystringoptional

                      ISO 3166-1 alpha-3

                  • shippingAddressobjectoptional
                    • namestringoptional
                    • streetstringoptional
                    • additionalInfostringoptional
                    • citystringoptional
                    • postCodestringoptional
                    • provincestringoptional
                    • countrystringoptional

                      ISO 3166-1 alpha-3

                  • mobilePhoneCountryCodestringoptional
                  • mobilePhonestringoptional
                  • homePhonestringoptional

                    The home phone number provided by the Cardholder.

                  • workPhonestringoptional

                    The work phone number provided by the Cardholder.

                  • cardHolderAcctInfoobjectoptional
                    • chAccDatestringoptional

                      Date that the cardholder opened the account with the 3DS Requestor. ISO 8601 format

                    • chAccAgeIndicatorstringoptional

                      Length of time that the cardholder has had the account with the 3DS Requestor.

                    • 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

                    • chAccChangeIndicatorstringoptional

                      Length of time since the cardholder's account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.

                    • chAccPwChangeDatestringoptional

                      Date that cardholder's account with the 3DS Requestor had a password change or account reset. ISO 8601 format

                    • chAccPwChangeIndicatorstringoptional

                      Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset.

                    • nbPurchaseAccountnumberoptional

                      Number of purchases with this cardholder account during the previous six months.

                    • destinationAddressUsageDatestringoptional

                      Date when the shipping address used for this transaction was first used with the 3DS Requestor. ISO 8601 format

                    • destinationAddressUsageIndicatorstringoptional

                      Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.

                    • destinationNameIndicatorstringoptional

                      Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.

                    • txnActivityDaynumberoptional

                      Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

                    • txnActivityYearnumberoptional

                      Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

                    • provisionAttemptsDaynumberoptional

                      Number of Add Card attempts in the last 24 hours.

                    • suspiciousAccActivitystringoptional

                      Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.

                    • paymentAccAgeDatestringoptional

                      Date that the payment account was enrolled in the cardholder's account with the 3DS Requestor. ISO 8601 format

                    • paymentAccIndicatorstringoptional

                      Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor.

                  • merchantRiskIndicatorobjectoptional
                    • deliveryEmailstringoptional

                      For Electronic delivery, the email address to which the merchandise was delivered.

                    • deliveryTimeframestringoptional

                      Indicates the merchandise delivery timeframe.

                    • giftCardAmountobjectoptional
                      • valuenumberoptional

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

                      • currencystringoptional

                        For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

                    • giftCardCountnumberoptional

                      For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

                    • preOrderDatestringoptional

                      For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format

                    • preOrderPurchaseIndicatorstringoptional

                      Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.

                    • reorderItemsIndicatorstringoptional

                      Indicates whether the cardholder is reordering previously purchased merchandise.

                    • shipIndicatorstringoptional

                      Indicates shipping method chosen for the transaction.

                • transactionSummaryarrayoptional
                  • languagestringoptional

                    Language to be used on the transaction summary details, ISO 639-2.

                  • summaryListarrayoptional
                    • labelstringoptional

                      label of the field

                    • valuestringoptional

                      value

                • installmentsarrayoptional
                  • datestringoptional

                    Installment time in ISO 8601 format.

                  • amountstringoptional

                    Installment amount.

                • termsAndConditionsIdsarrayoptional
              • cardobjectoptional
                • panstringoptional

                  Card PAN

                • expiryDatestringoptional

                  Card expiry date in format mmyy

                • cvvstringoptional

                  Card Validation Value, when available

              • recurrenceobjectoptional
                • actionstringoptional

                  NO_RECURRING, SUBSEQUENT_PAYMENT, CONTRACT_CREATION, CARD_SUBSTITUTION

                • contractIdstringoptional
                • contractTypestringoptional

                  MIT_UNSCHEDULED, MIT_SCHEDULED, CIT

                • contractExpiryDatestringoptional

                  Used with contractType MIT_SCHEDULED. ISO 8601 format

                • contractFrequencystringoptional

                  Used with contractType MIT_SCHEDULED. Number of days

              • exemptionsstringoptional

                NO_PREFERENCE, CHALLENGE_REQUESTED

              Request body

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

              Responses

              • 200Initialization doneoptional
                • operationobjectoptional
                  • orderIdstringoptional

                    Merchant order id, unique in the merchant domain

                  • operationIdstringoptional
                  • 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

                  • operationTypestringoptional

                    It indicates the purpose of the request:

                    • AUTHORIZATION - any authorization with explicit capture
                    • CAPTURE - a captured authorization or an implicit captured payment
                    • VOID - reversal of an authorization
                    • REFUND - refund of a captured amount
                    • CANCEL - the rollback of an capture, refund.

                    AUTHORIZATION, CAPTURE, VOID, REFUND, CANCEL

                  • 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
                    • 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, THREEDS_VALIDATED, THREEDS_FAILED, PENDING, CANCELED, VOIDED, REFUNDED, FAILED

                  • operationTimestringoptional

                    Operation time in ISO 8601 format

                  • paymentMethodstringoptional
                    • CARD - Any card circuit
                    • APM - Alternative payment method

                    CARD, APM

                  • paymentCircuitstringoptional

                    one of the payment circuit values returned by the GET payment_methods web service VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY etc.

                  • paymentInstrumentInfostringoptional

                    Payment instrument information

                  • paymentEndToEndIdstringoptional

                    It is defined by the circuit to uniquely identify the transaction. Required for circuid reconciliation purposes.

                  • cancelledOperationIdstringoptional

                    Operation id to be undone

                  • operationAmountstringoptional

                    Operation amount in the payment currency

                  • operationCurrencystringoptional

                    Payment currency

                  • customerInfoobjectoptional
                    • cardHolderNamestringoptional
                    • cardHolderEmailstringoptional
                    • billingAddressobjectoptional
                      • namestringoptional
                      • streetstringoptional
                      • additionalInfostringoptional
                      • citystringoptional
                      • postCodestringoptional
                      • provincestringoptional
                      • countrystringoptional

                        ISO 3166-1 alpha-3

                    • shippingAddressobjectoptional
                      • namestringoptional
                      • streetstringoptional
                      • additionalInfostringoptional
                      • citystringoptional
                      • postCodestringoptional
                      • provincestringoptional
                      • countrystringoptional

                        ISO 3166-1 alpha-3

                    • mobilePhoneCountryCodestringoptional
                    • mobilePhonestringoptional
                    • homePhonestringoptional

                      The home phone number provided by the Cardholder.

                    • workPhonestringoptional

                      The work phone number provided by the Cardholder.

                    • cardHolderAcctInfoobjectoptional
                      • chAccDatestringoptional

                        Date that the cardholder opened the account with the 3DS Requestor. ISO 8601 format

                      • chAccAgeIndicatorstringoptional

                        Length of time that the cardholder has had the account with the 3DS Requestor.

                      • 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

                      • chAccChangeIndicatorstringoptional

                        Length of time since the cardholder's account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.

                      • chAccPwChangeDatestringoptional

                        Date that cardholder's account with the 3DS Requestor had a password change or account reset. ISO 8601 format

                      • chAccPwChangeIndicatorstringoptional

                        Indicates the length of time since the cardholder's account with the 3DS Requestor had a password change or account reset.

                      • nbPurchaseAccountnumberoptional

                        Number of purchases with this cardholder account during the previous six months.

                      • destinationAddressUsageDatestringoptional

                        Date when the shipping address used for this transaction was first used with the 3DS Requestor. ISO 8601 format

                      • destinationAddressUsageIndicatorstringoptional

                        Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.

                      • destinationNameIndicatorstringoptional

                        Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.

                      • txnActivityDaynumberoptional

                        Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

                      • txnActivityYearnumberoptional

                        Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

                      • provisionAttemptsDaynumberoptional

                        Number of Add Card attempts in the last 24 hours.

                      • suspiciousAccActivitystringoptional

                        Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.

                      • paymentAccAgeDatestringoptional

                        Date that the payment account was enrolled in the cardholder's account with the 3DS Requestor. ISO 8601 format

                      • paymentAccIndicatorstringoptional

                        Indicates the length of time that the payment account was enrolled in the cardholder's account with the 3DS Requestor.

                    • merchantRiskIndicatorobjectoptional
                      • deliveryEmailstringoptional

                        For Electronic delivery, the email address to which the merchandise was delivered.

                      • deliveryTimeframestringoptional

                        Indicates the merchandise delivery timeframe.

                      • giftCardAmountobjectoptional
                        • valuenumberoptional

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

                        • currencystringoptional

                          For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

                      • giftCardCountnumberoptional

                        For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.

                      • preOrderDatestringoptional

                        For a pre-ordered purchase, the expected date that the merchandise will be available. ISO 8601 format

                      • preOrderPurchaseIndicatorstringoptional

                        Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.

                      • reorderItemsIndicatorstringoptional

                        Indicates whether the cardholder is reordering previously purchased merchandise.

                      • shipIndicatorstringoptional

                        Indicates shipping method chosen for the transaction.

                  • warningsarrayoptional
                    • codestringoptional
                    • descriptionstringoptional
                  • paymentLinkIdstringoptional

                    PayByLink id used for correlating this operation with the original link.

                  • additionalDataobjectoptional

                    Map of additional fields specific to the chosen payment method

                • threeDSEnrollmentStatusstringoptional

                  3Ds Server output of 3DS enrollment check for the given card.

                • threeDSAuthRequeststringoptional

                  Information to be passed in the 3DS authentication phase. Needed for 3DS1. This value must be passed in the form for triggerring the authentication step described in '#/components/schemas/ChallengeRequest'.

                • threeDSAuthUrlstringoptional

                  URL for posting the next step from the cardholder browser. The form application/x-www-form-urlencoded must include the fields described in '#/components/schemas/ChallengeRequest' The cardholder will be redirected to the 3DS authentication flow.

              • 400Invalid request dataoptional
                • errorsarrayoptional
                  • codestringoptional
                  • descriptionstringoptional
              • 401Unauthorizedoptional
              • 500Internal Server Erroroptional
                • errorsarrayoptional
                  • codestringoptional
                  • descriptionstringoptional
              {
    "operation": {
        "orderId": "btid2384983",
        "operationId": "3470744",
        "channel": "ECOMMERCE",
        "operationType": "CAPTURE",
        "operationResult": "AUTHORIZED",
        "operationTime": "2022-09-01T01:20:00.001Z",
        "paymentMethod": "CARD",
        "paymentCircuit": "VISA",
        "paymentInstrumentInfo": "***6152",
        "paymentEndToEndId": "e723hedsdew",
        "cancelledOperationId": "",
        "operationAmount": "3545",
        "operationCurrency": "EUR",
        "customerInfo": {
            "cardHolderName": "Mauro Morandi",
            "cardHolderEmail": "mauro.morandi@nexi.it",
            "billingAddress": {
                "name": "Mario Rossi",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "city": "Bologna",
                "postCode": "40124",
                "province": "BO",
                "country": "ITA"
            },
            "shippingAddress": {
                "name": "Mario Rossi",
                "street": "Piazza Maggiore, 1",
                "additionalInfo": "Quinto Piano, Scala B",
                "city": "Bologna",
                "postCode": "40124",
                "province": "BO",
                "country": "ITA"
            },
            "mobilePhoneCountryCode": "39",
            "mobilePhone": "3280987654",
            "homePhone": 391231234567,
            "workPhone": 391231234567,
            "cardHolderAcctInfo": {
                "chAccDate": "2019-02-11T00:00:00.000Z",
                "chAccAgeIndicator": "01",
                "chAccChangeDate": "2019-02-11T00:00:00.000Z",
                "chAccChangeIndicator": "01",
                "chAccPwChangeDate": "2019-02-11T00:00:00.000Z",
                "chAccPwChangeIndicator": "01",
                "nbPurchaseAccount": 0,
                "destinationAddressUsageDate": "2019-02-11T00:00:00.000Z",
                "destinationAddressUsageIndicator": "01",
                "destinationNameIndicator": "01",
                "txnActivityDay": 0,
                "txnActivityYear": 0,
                "provisionAttemptsDay": 0,
                "suspiciousAccActivity": "01",
                "paymentAccAgeDate": "2019-02-11T00:00:00.000Z",
                "paymentAccIndicator": "0"
            },
            "merchantRiskIndicator": {
                "deliveryEmail": "john.doe@email.com",
                "deliveryTimeframe": "01",
                "giftCardAmount": null,
                "giftCardCount": 0,
                "preOrderDate": "2019-02-11T00:00:00.000Z",
                "preOrderPurchaseIndicator": "01",
                "reorderItemsIndicator": "01",
                "shipIndicator": "01"
            }
        },
        "warnings": [
            {
                "code": "TRA001",
                "description": "3DS warning"
            }
        ],
        "paymentLinkId": "234244353",
        "additionalData": {
            "authorizationCode": "647189",
            "cardCountry": "ITA",
            "threeDS": "FULL_SECURE",
            "schemaTID": "MCS01198U",
            "multiCurrencyConversion": {
                "amount": "2662",
                "currency": "JPY",
                "exchangeRate": "0.007510523"
            }
        }
    },
    "threeDSEnrollmentStatus": "ENROLLED",
    "threeDSAuthRequest": "s51s35g1se3rg16r1gs35d1g53d1g813531818",
    "threeDSAuthUrl": "http://www.example.com/payment/nextStep"
}

              Validation for 3DS output

              POST /orders/3steps/validation

              Parameters