Skip to content

    PaymentService

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

    Authorize a payment.

    POST /{paymentId}/Authorize

    Authorize a payment allows the merchant to reserve money from the customers account that is equivalent to the total amount of the transaction. It is used when the nature of the product does not allow it to be used by the customer right away aka physical goods that need to be shipped, hotel reservations etc. Merchants cannot pull money from the customers account if their product isn't right away available to them, hence the need for authorizing a payment and ensuring that the money is reserved to settle the bill.

    Parameters

    • Authorizationstringrequired

      Authorization header using the Bearer scheme.

    • paymentIdstringrequired

      A unique ID identifying each payment initiated towards Unified System at any point.Generated once a payment has been initiated and returned in response.

    Authorize a payment.

    var client = new RestClient("https://sandbox.unifiedapi.nets.eu/api/v1/payments//%7BpaymentId%7D/Authorize");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/json");
    request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
    request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

    Request body

    • amountinteger (int32)optional

      Reserved amount (pre-authenticated payments only).

    • descriptionstringoptional

      Description of the operation.

    Request body

    {
        "amount": 0,
        "description": "string"
    }

    Responses

    • 200Successoptional
      • authorizationIdstringoptional
      • paymentIdstringoptional

        A unique ID identifying each payment initiated towards Unified System at any point.Generated once a payment has been initiated and returned in response.

    • 400Bad Requestoptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    • 422Client Erroroptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    • 500Server Erroroptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    {
        "authorizationId": "string",
        "paymentId": "string"
    }

    Cancel a payment.

    POST /{paymentId}/Cancel

    Canceling a payment allows the merchant to annul a payment before money is pulled from the bank account of the customer. This can be due to multiple factors ( eg. customer cancelled the order, double order, order is fraudulent etc) and we would like to ensure merchants have the ability to control the flow of money before it evens occurs.
    Cancellation of a payment can only be done if there has been prior authorization. Cancelations can only occur in situations where the money hasn't yet hit the bank account of the merchant. If the money was already pulled from the customers bank account, then the merchant would need to initiate a refund, NOT a cancelation.

    Parameters

    • Authorizationstringrequired

      Authorization header using the Bearer scheme.

    • paymentIdstringrequired

      A unique ID identifying each payment initiated towards Unified System at any point.Generated once a payment has been initiated and returned in response.

    Cancel a payment.

    var client = new RestClient("https://sandbox.unifiedapi.nets.eu/api/v1/payments//%7BpaymentId%7D/Cancel");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/json");
    request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
    request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

    Request body

    • descriptionstringoptional

      Description of the operation.

    Request body

    {
        "description": "string"
    }

    Responses

    • 200Successoptional
      • paymentIdstringoptional

        A unique ID identifying each payment initiated towards Unified System at any point.Generated once a payment has been initiated and returned in response.

    • 400Bad Requestoptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    • 422Client Erroroptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    • 500Server Erroroptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    {
        "paymentId": "string"
    }

    Capture a payment.

    POST /{paymentId}/Capture

    Capturing a payment is a subsequent phase after authorizing, This means that the merchant is able to pull the amount of money that was reserved in the authorization call and deposit it to their account.

    Parameters

    • Authorizationstringrequired

      Authorization header using the Bearer scheme.

    • paymentIdstringrequired

      A unique ID identifying each payment initiated towards Unified System at any point.Generated once a payment has been initiated and returned in response.

    Capture a payment.

    var client = new RestClient("https://sandbox.unifiedapi.nets.eu/api/v1/payments//%7BpaymentId%7D/Capture");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/json");
    request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
    request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

    Request body

    • amountinteger (int32)optional

      Transaction amount described as the lowest monetary unit for the given currency without punctuation marks and excluding any fees.

    • descriptionstringoptional

      Description of the operation.

    • basketarrayoptional

      Items in the order (required for invoice payments).

      • itemNumberstringoptional

        A form of "barcode" that is unique for that product. It is the common SKU concept.

      • titlestringoptional

        Indicates the name of the item.

      • quantityinteger (int32)optional

        Quantity of item ordered.

      • unitPriceinteger (int32)optional

        Price for single item.

      • vatPercentagenumber (double)optional

        VAT applied to item purchased. It is a nullable value: if VAT is present it means that UnitPrice is VAT included. If value is null or equal to 0 VAT is not included into UnitPrice.

      • discountPercentagenumber (double)optional

        Numeric description of the discount that is applied on the product.

      • includesHandlingbooleanoptional

        Specifies whether the handling is provided in the item data. If set to "true", it means that handling is included for this product.

      • includesShippingbooleanoptional

        Specifies whether the shipping is provided in the item data. If set to "true" it means that shipping is included with this product.

      • unitCodestringoptional

        Assigned to each item. The unit code should start from 0 and it will get incremented based on the number of items.

    Request body

    {
        "amount": 0,
        "description": "string",
        "basket": [
            {
                "itemNumber": "string",
                "title": "string",
                "quantity": 0,
                "unitPrice": 0,
                "vatPercentage": 0,
                "discountPercentage": 0,
                "includesHandling": true,
                "includesShipping": true,
                "unitCode": "string"
            }
        ]
    }

    Responses

    • 200Successoptional
      • paymentIdstringoptional

        A unique ID identifying each payment initiated towards Unified System at any point.Generated once a payment has been initiated and returned in response.

    • 400Bad Requestoptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    • 422Client Erroroptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    • 500Server Erroroptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    {
        "paymentId": "string"
    }

    Create a payment.

    POST /

    Before the merchant can actually pull or reserve money from the customer's account, they need to create a payment. With the create a payment call the merchant can contact Unified API in order to create a payment. With this call a PaymentId (unique identifier to a transaction) is created and a PayPageUrl is created that is sent from Unified API to the merchant. The PayPageUrl is used to collect the card details from the customer so that the payment can be later on processed.

    Parameters

    • Authorizationstringrequired

      Authorization header using the Bearer scheme.

    Create a payment.

    var client = new RestClient("https://sandbox.unifiedapi.nets.eu/api/v1/payments//");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/json");
    request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
    request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

    Request body

    • oneOfoptional

      Depending on a certain value, only one of the request bodies below is relevant.

      • CreateMerchantHostedEcomPaymentRequestoptional
        • scaExemptionstringoptional

          Delegated, LowValue, Force3ds

        • redirectUrlsobjectoptional
          • returnUrlstringoptional

            Gets or sets redirect URL for successful operation.

        • typestringoptional

          MerchantHostedEcom

        • orderNumberstringoptional

          Identifier defined by the merchant. As best practice is recommended to generate a unique order number for each payment but the same order number can be used several times if desired. Digits and letters are allowed except special characters.

        • orderDescriptionstringoptional

          Merchant order description.

        • reconciliationReferencestringoptional

          Merchant reference.

        • amountinteger (int32)optional

          Transaction amount described as the lowest monetary unit for the given currency without punctuation marks and excluding any fees.

        • currencyCodestringoptional

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

        • paymentMethodDetailsundefinedoptional

          Additional payment information.

          • oneOfoptional

            Depending on a certain value, only one of the request bodies below is relevant.

            • PaymentWithTokenoptional
              • tokenstringoptional
              • tokenSecretstringoptional
              • isRecurringbooleanoptional
              • recurringTypestringoptional

                Subscription, CardOnFile

              • typestringoptional

                PaymentWithToken

            • InitialPaymentMethodTokenizationDetailsoptional
              • expiryDatestring (date)optional
              • intervalDaysinteger (int32)optional
              • typestringoptional

                InitialPaymentMethodTokenizationDetails

            • MerchantInitiatedPaymentWithTokenoptional
              • tokenstringoptional
              • tokenSecretstringoptional
              • merchantInitiatedTransactionTypestringoptional

                UnscheduledCardOnFile, DelayedCharge, NoShow

              • typestringoptional

                MerchantInitiatedPaymentWithToken

            • SepaDirectDepositTypeAoptional
              • ibanstringoptional
              • customerEmailstringoptional
              • typestringoptional

                SepaDirectDepositTypeA

            • SepaDirectDepositTypeCoptional
              • ibanstringoptional
              • customerEmailstringoptional
              • mandateUrlstringoptional
              • typestringoptional

                SepaDirectDepositTypeC

        • processingstringoptional

          None, Verify, Authorize, Sale

        • customerundefinedoptional

          Individual or company customer.

          • oneOfoptional

            Depending on a certain value, only one of the request bodies below is relevant.

            • CompanyCustomeroptional
              • registrationNumberstringoptional
              • companyNamestringoptional
              • contactFirstNamestringoptional
              • contactLastNamestringoptional
              • typestringoptional

                Company

              • customerNumberstringoptional

                Gets or sets optional customer identifier.

              • addressobjectoptional
                • address1stringoptional
                • address2stringoptional
                • citystringoptional
                • postalCodestringoptional
                • countryCodestringoptional

                  AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW

              • emailstringoptional

                Gets or sets individual customer or company contact email.

              • phonestringoptional

                Gets or sets individual customer or company contact phone number.

            • IndividualCustomeroptional
              • firstNamestringoptional

                Gets or sets individual customer or company contact first name.

              • lastNamestringoptional

                Gets or sets individual customer or company contact last name.

              • typestringoptional

                Individual

              • customerNumberstringoptional

                Gets or sets optional customer identifier.

              • addressobjectoptional
                • address1stringoptional
                • address2stringoptional
                • citystringoptional
                • postalCodestringoptional
                • countryCodestringoptional

                  AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW

              • emailstringoptional

                Gets or sets individual customer or company contact email.

              • phonestringoptional

                Gets or sets individual customer or company contact phone number.

        • basketarrayoptional

          Items in the order (required for invoice payments).

          • itemNumberstringoptional

            A form of "barcode" that is unique for that product. It is the common SKU concept.

          • titlestringoptional

            Indicates the name of the item.

          • quantityinteger (int32)optional

            Quantity of item ordered.

          • unitPriceinteger (int32)optional

            Price for single item.

          • vatPercentagenumber (double)optional

            VAT applied to item purchased. It is a nullable value: if VAT is present it means that UnitPrice is VAT included. If value is null or equal to 0 VAT is not included into UnitPrice.

          • discountPercentagenumber (double)optional

            Numeric description of the discount that is applied on the product.

          • includesHandlingbooleanoptional

            Specifies whether the handling is provided in the item data. If set to "true", it means that handling is included for this product.

          • includesShippingbooleanoptional

            Specifies whether the shipping is provided in the item data. If set to "true" it means that shipping is included with this product.

          • unitCodestringoptional

            Assigned to each item. The unit code should start from 0 and it will get incremented based on the number of items.

        • payPageConfigurationobjectoptional
          • paymentMethodActionInfoListarrayoptional

            Gets or sets list of payment method actions.

            • paymentMethodstringoptional

              AmericanExpress, DinersClubInternational, JCB, Maestro, MasterCard, Visa, PproSepaDirectDebit, Sofortbanking, PayPal

            • namestringoptional
            • feeinteger (int32)optional
            • cardTypestringoptional

              All, Debit, Credit

            • cardOriginstringoptional

              International, Domestic, EU, NonEU

            • cardProductTypestringoptional

              All, Private, Corporate

            • bininteger (int32)optional
            • actionstringoptional

              Allow, Reject

          • languagestringoptional

            EN, DK, NL, ET, FI, FR, DE, IT, LV, LT, NO, PL, PT, RU, ES, SE

          • pageTypestringoptional

            Multipage, Singlepage, Custom

          • templateNamestringoptional
        • descriptionstringoptional

          Description of the operation.

      • CreateNetsHostedEcomPaymentRequestoptional
        • scaExemptionstringoptional

          Delegated, LowValue, Force3ds

        • redirectUrlsobjectoptional
          • returnUrlstringoptional

            Gets or sets redirect URL for successful operation.

        • typestringoptional

          NetsHostedEcom

        • orderNumberstringoptional

          Identifier defined by the merchant. As best practice is recommended to generate a unique order number for each payment but the same order number can be used several times if desired. Digits and letters are allowed except special characters.

        • orderDescriptionstringoptional

          Merchant order description.

        • reconciliationReferencestringoptional

          Merchant reference.

        • amountinteger (int32)optional

          Transaction amount described as the lowest monetary unit for the given currency without punctuation marks and excluding any fees.

        • currencyCodestringoptional

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

        • paymentMethodDetailsundefinedoptional

          Additional payment information.

          • oneOfoptional

            Depending on a certain value, only one of the request bodies below is relevant.

            • PaymentWithTokenoptional
              • tokenstringoptional
              • tokenSecretstringoptional
              • isRecurringbooleanoptional
              • recurringTypestringoptional

                Subscription, CardOnFile

              • typestringoptional

                PaymentWithToken

            • InitialPaymentMethodTokenizationDetailsoptional
              • expiryDatestring (date)optional
              • intervalDaysinteger (int32)optional
              • typestringoptional

                InitialPaymentMethodTokenizationDetails

            • MerchantInitiatedPaymentWithTokenoptional
              • tokenstringoptional
              • tokenSecretstringoptional
              • merchantInitiatedTransactionTypestringoptional

                UnscheduledCardOnFile, DelayedCharge, NoShow

              • typestringoptional

                MerchantInitiatedPaymentWithToken

            • SepaDirectDepositTypeAoptional
              • ibanstringoptional
              • customerEmailstringoptional
              • typestringoptional

                SepaDirectDepositTypeA

            • SepaDirectDepositTypeCoptional
              • ibanstringoptional
              • customerEmailstringoptional
              • mandateUrlstringoptional
              • typestringoptional

                SepaDirectDepositTypeC

        • processingstringoptional

          None, Verify, Authorize, Sale

        • customerundefinedoptional

          Individual or company customer.

          • oneOfoptional

            Depending on a certain value, only one of the request bodies below is relevant.

            • CompanyCustomeroptional
              • registrationNumberstringoptional
              • companyNamestringoptional
              • contactFirstNamestringoptional
              • contactLastNamestringoptional
              • typestringoptional

                Company

              • customerNumberstringoptional

                Gets or sets optional customer identifier.

              • addressobjectoptional
                • address1stringoptional
                • address2stringoptional
                • citystringoptional
                • postalCodestringoptional
                • countryCodestringoptional

                  AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW

              • emailstringoptional

                Gets or sets individual customer or company contact email.

              • phonestringoptional

                Gets or sets individual customer or company contact phone number.

            • IndividualCustomeroptional
              • firstNamestringoptional

                Gets or sets individual customer or company contact first name.

              • lastNamestringoptional

                Gets or sets individual customer or company contact last name.

              • typestringoptional

                Individual

              • customerNumberstringoptional

                Gets or sets optional customer identifier.

              • addressobjectoptional
                • address1stringoptional
                • address2stringoptional
                • citystringoptional
                • postalCodestringoptional
                • countryCodestringoptional

                  AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW

              • emailstringoptional

                Gets or sets individual customer or company contact email.

              • phonestringoptional

                Gets or sets individual customer or company contact phone number.

        • basketarrayoptional

          Items in the order (required for invoice payments).

          • itemNumberstringoptional

            A form of "barcode" that is unique for that product. It is the common SKU concept.

          • titlestringoptional

            Indicates the name of the item.

          • quantityinteger (int32)optional

            Quantity of item ordered.

          • unitPriceinteger (int32)optional

            Price for single item.

          • vatPercentagenumber (double)optional

            VAT applied to item purchased. It is a nullable value: if VAT is present it means that UnitPrice is VAT included. If value is null or equal to 0 VAT is not included into UnitPrice.

          • discountPercentagenumber (double)optional

            Numeric description of the discount that is applied on the product.

          • includesHandlingbooleanoptional

            Specifies whether the handling is provided in the item data. If set to "true", it means that handling is included for this product.

          • includesShippingbooleanoptional

            Specifies whether the shipping is provided in the item data. If set to "true" it means that shipping is included with this product.

          • unitCodestringoptional

            Assigned to each item. The unit code should start from 0 and it will get incremented based on the number of items.

        • payPageConfigurationobjectoptional
          • paymentMethodActionInfoListarrayoptional

            Gets or sets list of payment method actions.

            • paymentMethodstringoptional

              AmericanExpress, DinersClubInternational, JCB, Maestro, MasterCard, Visa, PproSepaDirectDebit, Sofortbanking, PayPal

            • namestringoptional
            • feeinteger (int32)optional
            • cardTypestringoptional

              All, Debit, Credit

            • cardOriginstringoptional

              International, Domestic, EU, NonEU

            • cardProductTypestringoptional

              All, Private, Corporate

            • bininteger (int32)optional
            • actionstringoptional

              Allow, Reject

          • languagestringoptional

            EN, DK, NL, ET, FI, FR, DE, IT, LV, LT, NO, PL, PT, RU, ES, SE

          • pageTypestringoptional

            Multipage, Singlepage, Custom

          • templateNamestringoptional
        • descriptionstringoptional

          Description of the operation.

      • CreateMotoPaymentRequestoptional
        • cardDetailsobjectoptional
          • panstringoptional

            Gets or sets card number.

          • expiryYearinteger (int32)optional

            Gets or sets expiry year.

          • expiryMonthinteger (int32)optional

            Gets or sets expiry month.

          • validationCodestringoptional

            Gets or sets CVV code.

        • typestringoptional

          Moto

        • orderNumberstringoptional

          Identifier defined by the merchant. As best practice is recommended to generate a unique order number for each payment but the same order number can be used several times if desired. Digits and letters are allowed except special characters.

        • orderDescriptionstringoptional

          Merchant order description.

        • reconciliationReferencestringoptional

          Merchant reference.

        • amountinteger (int32)optional

          Transaction amount described as the lowest monetary unit for the given currency without punctuation marks and excluding any fees.

        • currencyCodestringoptional

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

        • paymentMethodDetailsundefinedoptional

          Additional payment information.

          • oneOfoptional

            Depending on a certain value, only one of the request bodies below is relevant.

            • PaymentWithTokenoptional
              • tokenstringoptional
              • tokenSecretstringoptional
              • isRecurringbooleanoptional
              • recurringTypestringoptional

                Subscription, CardOnFile

              • typestringoptional

                PaymentWithToken

            • InitialPaymentMethodTokenizationDetailsoptional
              • expiryDatestring (date)optional
              • intervalDaysinteger (int32)optional
              • typestringoptional

                InitialPaymentMethodTokenizationDetails

            • MerchantInitiatedPaymentWithTokenoptional
              • tokenstringoptional
              • tokenSecretstringoptional
              • merchantInitiatedTransactionTypestringoptional

                UnscheduledCardOnFile, DelayedCharge, NoShow

              • typestringoptional

                MerchantInitiatedPaymentWithToken

            • SepaDirectDepositTypeAoptional
              • ibanstringoptional
              • customerEmailstringoptional
              • typestringoptional

                SepaDirectDepositTypeA

            • SepaDirectDepositTypeCoptional
              • ibanstringoptional
              • customerEmailstringoptional
              • mandateUrlstringoptional
              • typestringoptional

                SepaDirectDepositTypeC

        • processingstringoptional

          None, Verify, Authorize, Sale

        • customerundefinedoptional

          Individual or company customer.

          • oneOfoptional

            Depending on a certain value, only one of the request bodies below is relevant.

            • CompanyCustomeroptional
              • registrationNumberstringoptional
              • companyNamestringoptional
              • contactFirstNamestringoptional
              • contactLastNamestringoptional
              • typestringoptional

                Company

              • customerNumberstringoptional

                Gets or sets optional customer identifier.

              • addressobjectoptional
                • address1stringoptional
                • address2stringoptional
                • citystringoptional
                • postalCodestringoptional
                • countryCodestringoptional

                  AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW

              • emailstringoptional

                Gets or sets individual customer or company contact email.

              • phonestringoptional

                Gets or sets individual customer or company contact phone number.

            • IndividualCustomeroptional
              • firstNamestringoptional

                Gets or sets individual customer or company contact first name.

              • lastNamestringoptional

                Gets or sets individual customer or company contact last name.

              • typestringoptional

                Individual

              • customerNumberstringoptional

                Gets or sets optional customer identifier.

              • addressobjectoptional
                • address1stringoptional
                • address2stringoptional
                • citystringoptional
                • postalCodestringoptional
                • countryCodestringoptional

                  AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW

              • emailstringoptional

                Gets or sets individual customer or company contact email.

              • phonestringoptional

                Gets or sets individual customer or company contact phone number.

        • basketarrayoptional

          Items in the order (required for invoice payments).

          • itemNumberstringoptional

            A form of "barcode" that is unique for that product. It is the common SKU concept.

          • titlestringoptional

            Indicates the name of the item.

          • quantityinteger (int32)optional

            Quantity of item ordered.

          • unitPriceinteger (int32)optional

            Price for single item.

          • vatPercentagenumber (double)optional

            VAT applied to item purchased. It is a nullable value: if VAT is present it means that UnitPrice is VAT included. If value is null or equal to 0 VAT is not included into UnitPrice.

          • discountPercentagenumber (double)optional

            Numeric description of the discount that is applied on the product.

          • includesHandlingbooleanoptional

            Specifies whether the handling is provided in the item data. If set to "true", it means that handling is included for this product.

          • includesShippingbooleanoptional

            Specifies whether the shipping is provided in the item data. If set to "true" it means that shipping is included with this product.

          • unitCodestringoptional

            Assigned to each item. The unit code should start from 0 and it will get incremented based on the number of items.

        • payPageConfigurationobjectoptional
          • paymentMethodActionInfoListarrayoptional

            Gets or sets list of payment method actions.

            • paymentMethodstringoptional

              AmericanExpress, DinersClubInternational, JCB, Maestro, MasterCard, Visa, PproSepaDirectDebit, Sofortbanking, PayPal

            • namestringoptional
            • feeinteger (int32)optional
            • cardTypestringoptional

              All, Debit, Credit

            • cardOriginstringoptional

              International, Domestic, EU, NonEU

            • cardProductTypestringoptional

              All, Private, Corporate

            • bininteger (int32)optional
            • actionstringoptional

              Allow, Reject

          • languagestringoptional

            EN, DK, NL, ET, FI, FR, DE, IT, LV, LT, NO, PL, PT, RU, ES, SE

          • pageTypestringoptional

            Multipage, Singlepage, Custom

          • templateNamestringoptional
        • descriptionstringoptional

          Description of the operation.

    Request body

    {
        "scaExemption": "Delegated",
        "redirectUrls": {
            "returnUrl": "string"
        },
        "type": "MerchantHostedEcom",
        "orderNumber": "string",
        "orderDescription": "string",
        "reconciliationReference": "string",
        "amount": 0,
        "currencyCode": "AED",
        "paymentMethodDetails": {
            "token": "string",
            "tokenSecret": "string",
            "isRecurring": true,
            "recurringType": "Subscription",
            "type": "PaymentWithToken"
        },
        "processing": "None",
        "customer": {
            "registrationNumber": "string",
            "companyName": "string",
            "contactFirstName": "string",
            "contactLastName": "string",
            "type": "Company",
            "customerNumber": "string",
            "address": {
                "address1": "string",
                "address2": "string",
                "city": "string",
                "postalCode": "string",
                "countryCode": "AF"
            },
            "email": "string",
            "phone": "string"
        },
        "basket": [
            {
                "itemNumber": "string",
                "title": "string",
                "quantity": 0,
                "unitPrice": 0,
                "vatPercentage": 0,
                "discountPercentage": 0,
                "includesHandling": true,
                "includesShipping": true,
                "unitCode": "string"
            }
        ],
        "payPageConfiguration": {
            "paymentMethodActionInfoList": [
                {
                    "paymentMethod": "AmericanExpress",
                    "name": "string",
                    "fee": 0,
                    "cardType": "All",
                    "cardOrigin": "International",
                    "cardProductType": "All",
                    "bin": 0,
                    "action": "Allow"
                }
            ],
            "language": "EN",
            "pageType": "Multipage",
            "templateName": "string"
        },
        "description": "string"
    }

    Responses

    • 201Createdoptional
      • paymentIdstringoptional

        A unique ID identifying each payment initiated towards Unified System at any point.Generated once a payment has been initiated and returned in response.

      • paypageURLstringoptional

        Url built by Unified System allowing customers to complete payment in a configured paypage.

    • 400Bad Requestoptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    • 422Client Erroroptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    • 500Server Erroroptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    {
        "paymentId": "string",
        "paypageURL": "string"
    }

    Get details of a payment.

    GET /{paymentId}

    At any point after a payment has been created a merchant is able to retrieve all details related to that payment. They can do so by sending the PaymentId of the specific transaction they are looking for to this endpoint and if the response is successful, they should receive a response will all the details of that payment included.

    Parameters

    • Authorizationstringrequired

      Authorization header using the Bearer scheme.

    • paymentIdstringrequired

      A unique ID identifying each payment initiated towards Unified System at any point.Generated once a payment has been initiated and returned in response.

    Get details of a payment.

    var client = new RestClient("https://sandbox.unifiedapi.nets.eu/api/v1/payments//%7BpaymentId%7D");
    var request = new RestRequest(Method.GET);
    request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
    IRestResponse response = client.Execute(request);

    Responses

    • 200Successoptional
      • currencyCodestringoptional

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

      • orderNumberstringoptional

        Identifier defined by the merchant. As best practice is recommended to generate a unique order number for each payment but the same order number can be used several times if desired. Digits and letters are allowed except special characters.

      • terminalIdstringoptional
      • orderDescriptionstringoptional
      • summaryobjectoptional
        • orderAmountnumber (double)optional

          Payment amount described as the lowest monetary unit for the given currency without punctuation marks and excluding any fees for a given order. For example 100,00 EUR is noted as '10000' and 9.99 USD is noted as '999'.

        • authorizedAmountnumber (double)optional

          Amount authorized for this payment described as the lowest monetary unit for the given currency without punctuation marks. For example: 100,00 EUR is noted as '10000' and 9.99 USD is noted as '999'.

        • capturedAmountnumber (double)optional

          Amount captured for this payment described as the lowest monetary unit for the given currency without punctuation marks. For example: 100,00 EUR is noted as '10000' and 9.99 USD is noted as '999'. Check this parameter to confirm the payment is made.

        • refundedAmountnumber (double)optional

          Amount refunded for this payment described as the lowest monetary unit for the given currency without punctuation marks. For example: 100,00 EUR is noted as '10000' and 9.99 USD is noted as '999'. Check this parameter to check amount refunded for a given payment.

        • feenumber (double)optional

          Fee set to the payment methods, described as the lowest monetary unit without punctuation marks. For example: 100,00 NOK is noted as '10000' and 9.99 USD is noted as '999'. The fee will be added to the original amount.

        • authorizationIdstringoptional

          The unique ID given to an authorized transaction by the Issuer.

      • paymentDetailsobjectoptional
        • paymentMethodTypestringoptional

          Card, DirectBankTransfer, Prepaid

        • paymentMethodstringoptional

          AmericanExpress, DinersClubInternational, JCB, Maestro, MasterCard, Visa, PproSepaDirectDebit, Sofortbanking, PayPal

        • paymentMethodDescriptionstringoptional

          List with a short description of PaymentMethod accepted.

        • cardDetailsobjectoptional
          • maskedPanstringoptional

            Card number used for this transaction, masked with asterisks.

          • tokenstringoptional

            Token value used in subsequent transaction to identify the transaction. It is independent of the PAN and is not considered as hash value. It is the merchant's responsibility to store tokens in secure way and restrict access to data on need to know basis. The merchant undertakes not to store tokens on frontend system exposed to the internet or directly on mobile devices.

          • expiryYearstringoptional

            Expiry year for the card used for this payment on the format YY.

          • expiryMonthstringoptional

            Expiry month for the card used for this payment on the format MM.

      • customerundefinedoptional
        • oneOfoptional

          Depending on a certain value, only one of the request bodies below is relevant.

          • CompanyCustomeroptional
            • registrationNumberstringoptional
            • companyNamestringoptional
            • contactFirstNamestringoptional
            • contactLastNamestringoptional
            • typestringoptional

              Company

            • customerNumberstringoptional

              Gets or sets optional customer identifier.

            • addressobjectoptional
              • address1stringoptional
              • address2stringoptional
              • citystringoptional
              • postalCodestringoptional
              • countryCodestringoptional

                AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW

            • emailstringoptional

              Gets or sets individual customer or company contact email.

            • phonestringoptional

              Gets or sets individual customer or company contact phone number.

          • IndividualCustomeroptional
            • firstNamestringoptional

              Gets or sets individual customer or company contact first name.

            • lastNamestringoptional

              Gets or sets individual customer or company contact last name.

            • typestringoptional

              Individual

            • customerNumberstringoptional

              Gets or sets optional customer identifier.

            • addressobjectoptional
              • address1stringoptional
              • address2stringoptional
              • citystringoptional
              • postalCodestringoptional
              • countryCodestringoptional

                AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW

            • emailstringoptional

              Gets or sets individual customer or company contact email.

            • phonestringoptional

              Gets or sets individual customer or company contact phone number.

      • authorizationsarrayoptional
        • amountinteger (int32)optional

          Amount for a given payment.

        • dateTimestring (date-time)optional

          Timestamp in format YYYY-MM-DDTHH:MM:SS.milliseconds+TZ.

        • descriptionstringoptional

          Optional value that can be added.

      • capturesarrayoptional
        • amountinteger (int32)optional

          Amount for a given payment.

        • dateTimestring (date-time)optional

          Timestamp in format YYYY-MM-DDTHH:MM:SS.milliseconds+TZ.

        • descriptionstringoptional

          Optional value that can be added.

      • refundsarrayoptional
        • amountinteger (int32)optional

          Amount for a given payment.

        • dateTimestring (date-time)optional

          Timestamp in format YYYY-MM-DDTHH:MM:SS.milliseconds+TZ.

        • descriptionstringoptional

          Optional value that can be added.

    • 400Bad Requestoptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    • 422Client Erroroptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    • 500Server Erroroptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    {
        "currencyCode": "AED",
        "orderNumber": "string",
        "terminalId": "string",
        "orderDescription": "string",
        "summary": {
            "orderAmount": 0,
            "authorizedAmount": 0,
            "capturedAmount": 0,
            "refundedAmount": 0,
            "fee": 0,
            "authorizationId": "string"
        },
        "paymentDetails": {
            "paymentMethodType": "Card",
            "paymentMethod": "AmericanExpress",
            "paymentMethodDescription": "string",
            "cardDetails": {
                "maskedPan": "string",
                "token": "string",
                "expiryYear": "string",
                "expiryMonth": "string"
            }
        },
        "customer": {
            "registrationNumber": "string",
            "companyName": "string",
            "contactFirstName": "string",
            "contactLastName": "string",
            "type": "Company",
            "customerNumber": "string",
            "address": {
                "address1": "string",
                "address2": "string",
                "city": "string",
                "postalCode": "string",
                "countryCode": "AF"
            },
            "email": "string",
            "phone": "string"
        },
        "authorizations": [
            {
                "amount": 0,
                "dateTime": "2019-08-24T14:15:22Z",
                "description": "string"
            }
        ],
        "captures": [
            {
                "amount": 0,
                "dateTime": "2019-08-24T14:15:22Z",
                "description": "string"
            }
        ],
        "refunds": [
            {
                "amount": 0,
                "dateTime": "2019-08-24T14:15:22Z",
                "description": "string"
            }
        ]
    }

    Refund a payment.

    POST /{paymentId}/Refund

    Merchants can refund a payment to the customer simply by accessing this endpoint. In order to do so, they need to provide the total amount that needs to be refunded, alongside a textual description and a basket of all the items that the refund is being issued for.
    Refund is different from cancelation solely based on the fact of whether money has been pulled from the bank account of the customer and transferred to the merchant. If money has been pulled from the bank account the merchant can perform a refund. If money has not been pulled, then merchant needs to perform a cancelation. This means that a refund must be preceded by a capture call.

    Parameters

    • Authorizationstringrequired

      Authorization header using the Bearer scheme.

    • paymentIdstringrequired

      A unique ID identifying each payment initiated towards Unified System at any point.Generated once a payment has been initiated and returned in response.

    Refund a payment.

    var client = new RestClient("https://sandbox.unifiedapi.nets.eu/api/v1/payments//%7BpaymentId%7D/Refund");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/json");
    request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
    request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

    Request body

    • amountinteger (int32)optional

      Transaction amount described as the lowest monetary unit for the given currency without punctuation marks and excluding any fees.

    • descriptionstringoptional

      Description of the operation.

    • basketarrayoptional

      Items in the order (required for invoice payments).

      • itemNumberstringoptional

        A form of "barcode" that is unique for that product. It is the common SKU concept.

      • titlestringoptional

        Indicates the name of the item.

      • quantityinteger (int32)optional

        Quantity of item ordered.

      • unitPriceinteger (int32)optional

        Price for single item.

      • vatPercentagenumber (double)optional

        VAT applied to item purchased. It is a nullable value: if VAT is present it means that UnitPrice is VAT included. If value is null or equal to 0 VAT is not included into UnitPrice.

      • discountPercentagenumber (double)optional

        Numeric description of the discount that is applied on the product.

      • includesHandlingbooleanoptional

        Specifies whether the handling is provided in the item data. If set to "true", it means that handling is included for this product.

      • includesShippingbooleanoptional

        Specifies whether the shipping is provided in the item data. If set to "true" it means that shipping is included with this product.

      • unitCodestringoptional

        Assigned to each item. The unit code should start from 0 and it will get incremented based on the number of items.

    Request body

    {
        "amount": 0,
        "description": "string",
        "basket": [
            {
                "itemNumber": "string",
                "title": "string",
                "quantity": 0,
                "unitPrice": 0,
                "vatPercentage": 0,
                "discountPercentage": 0,
                "includesHandling": true,
                "includesShipping": true,
                "unitCode": "string"
            }
        ]
    }

    Responses

    • 200Successoptional
      • paymentIdstringoptional

        A unique ID identifying each payment initiated towards Unified System at any point.Generated once a payment has been initiated and returned in response.

    • 400Bad Requestoptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    • 422Client Erroroptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    • 500Server Erroroptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    {
        "paymentId": "string"
    }

    Automatically capture a payment.

    POST /{paymentId}/Sale

    An automatic payment capture can be realized with services/goods that are available to the customer at the time of the occurrence of the transaction (eg. digital goods and services). Due to the nature of digital goods, merchants are able to automatically capture money from the customers account. This is because digital goods are usually delivered right on the spot and they do not have constraints like physical products or hospitality services where the merchant can only capture money once the user has started to use those goods. Automatic payment capture bypasses the authorization stage and goes directly to capturing the money from the customer.

    Parameters

    • Authorizationstringrequired

      Authorization header using the Bearer scheme.

    • paymentIdstringrequired

      A unique ID identifying each payment initiated towards Unified System at any point.Generated once a payment has been initiated and returned in response.

    Automatically capture a payment.

    var client = new RestClient("https://sandbox.unifiedapi.nets.eu/api/v1/payments//%7BpaymentId%7D/Sale");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/json");
    request.AddHeader("Authorization", "Bearer REPLACE_BEARER_TOKEN");
    request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

    Request body

    • descriptionstringoptional

      Description of the operation.

    Request body

    {
        "description": "string"
    }

    Responses

    • 200Successoptional
      • paymentIdstringoptional

        A unique ID identifying each payment initiated towards Unified System at any point.Generated once a payment has been initiated and returned in response.

    • 400Bad Requestoptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    • 422Client Erroroptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    • 500Server Erroroptional
      • typestringoptional
      • titlestringoptional
      • statusinteger (int32)optional
      • detailstringoptional
      • instancestringoptional
    {
        "paymentId": "string"
    }