Neosurf

Overview

Neosurf is a payment method to process purchases by using Neosurf e-wallet and by using vouchers. Purchases can be processed by using Payment Page and Gate,.

General information

Payment method type
  • e-wallet payments
  • payments by using vouchers
Countries and regions AU, CA, AT, BE, CY, FR, IE, LU, NL, PL, PT, RO, ES, GB, BJ, BF, BI, CM, CF, CD, CG, GQ, GA, GM, GW, GN, CI, KE, MW, ML, MR, MA, MZ, NE, NG, NZ, RW, ST, SN, SL, TZ, TG, UG, ZM, ZW
Payment currencies AUD, BGN, CAD, CHF, CNY, CZK, DKK, EUR, GBP, HKD, HRK, HUF, ILS, INR, MXN, MYR, NOK, NZD, PHP, PLN, RON, RUB, SEK, SGD, THB, TRY, USD, ZAR
Currency conversion
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes
Onboarding and access fee refer to your ECommPay key account manager

Interaction diagram

Payment processing by using the Neosurf payment method requires merchant's web service, one of ECommPay interfaces, and the ECommPay payment platform, as well as the technical facilities of Neosurf.



Operations support

  Interfaces Amounts in any supported currency Times *
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) minimum maximum basic threshold
Purchases + + 0.01 1,000 000.00 22 hours

* The basic and threshold time are defined as follows:

  • The basic time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
  • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ECommPay technical support.

Processing scenarios

In the Neosurf method, to perform a purchase operation, you need to redirect a customer to the Neosurf service.

Figure: Purchase by using Payment Page



Figure: Purchase by using Gate



The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.

Purchase by using Payment Page

General information

In the Neosurf method, when processing a purchase by using Payment Page, the merchant web service is required to send a request with all the required parameters and signature to the ECommPay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can either allow your customer to select the Neosurf method from the list of other payment methods on Payment Page or have Payment Page opened with the Neosurf method selected. For more information about preselecting payment methods, see Preselecting payment methods.



Figure: Purchase by using Payment Page

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the Neosurf method.
  8. The payment platform receives the purchase request for payment processing from Payment Page.
  9. The payment platform performs the internal purchase request processing and sends it to the Neosurf service.
  10. The purchase request is processed on the Neosurf service side.
  11. The Neosurf service generates the data for redirecting the customer to its website form and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the Neosurf website.
  14. The customer selects the means of payement and completes all the required payment steps .
  15. The payment is processed on the Neosurf side.
  16. The result is displayed to the customer on the Neosurf website.
  17. The customer is redirected to Payment Page.
  18. The Neosurf service sends the result notification to the payment platform.
  19. The payment platform sends a callback with the payment result to the web service.
  20. The payment platform sends the result to Payment Page.
  21. A page with the payment result information is displayed to the customer on Payment Page.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Neosurf payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

There are several things you need to consider when using the Neosurf method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—payment amount in minor units
    • customer_id—the ID of the customer within the project
  2. If you need to have payment form displayed with the Neosurf method selected, set the force_payment_method parameter to neosurf.
  3. If required, you can also add any other additional parameters Payment Page supports.
  4. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the Neosurf method must include project, customer, and payment IDs, signature, the currency and the amount of a payment in the appropriate currency, as shown in the following example:

    { 
      payment_id: 'X03936', 
      payment_amount: 1000, 
      payment_currency: 'EUR', 
      project_id: 0, 
      signature: "kUi2x9dKHAVNU0FYldJrxh4U...CUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the Neosurf method , see Payment Page invocation parameters.

Callback format

The Neosurf method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 1.00 EUR purchase made in the 10801 project.

Figure: Example of data in a successful purchase callback

{
        "project_id": 10801,
        "payment": {
            "id": "ECP_TEST_900898",
            "type": "purchase",
            "status": "success",
            "date": "2020-08-03T11:05:11+0000",
            "method": "NeoSurf",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "test payment"
        },
        "customer": {
            "id": "100"
        },
        "operation": {
            "id": 5042576000000972,
            "type": "sale",
            "status": "success",
            "date": "2020-08-03T11:05:11+0000",
            "created_date": "2020-08-03T11:04:08+0000",
            "request_id": "348238e315dad344ea02dade1a144599...440994063c-05042577",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 3201,
                "payment_id": "109726234",
                "auth_code": "",
                "endpoint_id": "neosurf",
                "date": "2020-08-03T11:05:11+0000"
            }
        },
        "signature": "jYsUJ/r8GFOxPglW5GTstB9fyb7Lk2VC4...UBf+/zn8jQmj7WH2w0+EQ=="
    }

The following is the example of a callback for a declined purchase.

Figure: Example of data in a declined purchase callback

{
        "project_id": 10801,
        "payment": {
            "id": "ECP_TEST_178551",
            "type": "purchase",
            "status": "decline",
            "date": "2020-07-31T11:32:11+0000",
            "method": "NeoSurf",
            "sum": {
                "amount": 200,
                "currency": "EUR"
            },
            "description": "test decline"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 86491000000461,
            "type": "sale",
            "status": "decline",
            "date": "2020-07-31T11:32:11+0000",
            "created_date": "2020-07-30T07:26:32+0000",
            "request_id": "a072079ed4a08a0d4d3d13d336b77a...a802115007c9a-00086492",
            "sum_initial": {
                "amount": 200,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 200,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 3201,
                "payment_id": "109689003",
                "auth_code": "",
                "endpoint_id": "neosurf",
                "date": "2020-07-31T11:32:11+0000"
            }
        },
        "signature": "pjZAPbO9+zieWV7l5A49YIpAaQ7H...O67CTG/TUYd72zS8uArr0BZZQfQ=="
    }

Related topics

The following topics might be useful when implementing payments by using Payment Page:

Purchase by using Gate

General information

In the Neosurf method, when processing a purchase by using Gate, the merchant web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ECommPay URL.
  2. Perform the redirection of a customer to the Neosurf service.
  3. Get the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.



Figure: Purchase by using Gate

  1. A customer initiates a purchase through Neosurf on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the Neosurf service.
  7. The request is processed on the Neosurf side.
  8. The Neosurf service sends the data for redirecting the customer to the Neosurf service to the payment platform.
  9. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the Neosurf service.
  11. The customer selects the means of payement and completes all the required payment steps .
  12. The payment is processed on the Neosurf side.
  13. The result is displayed to the customer.
  14. The customer is redirected to the merchant's web service.
  15. The Neosurf service sends the payment result notification to the payment platform.
  16. The payment platform sends a callback to the web service.
  17. The customer receives the payment result on the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Neosurf payment method and provide the information on the format of callbacks with purchase results.

Request format

There are several things you must consider when using purchase requests in the Neosurf method:

  1. You perform purchases by sending the /v2/payment/neosurf/sale request by using POST (HTTP) method.
  2. The following objects and parameters must be specified in any request:
    • Object general—general request identification information:
      • project_id—the project ID obtained from ECommPay
      • payment_id—payment ID unique within the project
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
    • Object customer—customer information:
      • id—the unique ID of the customer within your project
      • ip_address—customer IP address
    • Object payment—payment information:
      • amount—purchase amount in minor units
      • currency—purchase currency in ISO-4217 alpha-3 format
  3. If required, you can also add any other additional parameters Gate supports.
  4. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the Neosurf method must include project, customer and payment IDs, signature, customer IP address, currency and amount of the purchase, as shown in the following example:

Figure: Example of a purchase request

{
    "general": {
    "project_id": 125,
    "payment_id": "ECP_TEST_184",
    "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVLhNN5e7cV+VHq3L
                        wY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
  },
  "customer": {
    "ip_address": "112.56.98.67"
    "id": "123"
    },
  "payment": {
    "amount": 1000,
    "currency": "EUR"
  }
}

Formats of the customer redirection data

To redirect a customer from the web service to the Neosurf site, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and data to be sent in the request body in the redirect_data.body parameter, and use these parameters when opening the HTML page using the method specified in the redirect_data.method parameter.

The following is the callback fragment containing the redirection data.

"redirect_data": {
    "url": "https://pay.neosurf.com",
    "method": "POST",
    "body": {         
            "amount": 100,           
            "currency": "eur",
            "hash": "fsdffr456rlk44rh34vrwf923vfvsnf",
            "language": "en",
            "merchantId": 12123324546,
            "merchantTransactionId": "23423435345656",
            "prohibitedForMinors": "no",
            "subMerchantId": "https://www.shop.mywebsite.com",
            "test": "no",
            "urlOk": "http://time.net/?type=good",
            "urlKo": "http://time.net/?type=no",
            "urlPending": "http://time.net/?type=waiting",
            "urlCallback": "http://time.net/?type=callback",
            "version": 3
    }
  }

Callback format

The Neosurf method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 1.00 EUR purchase made in the 10801 project.

Figure: Example of data in a successful purchase callback

{
        "project_id": 10801,
        "payment": {
            "id": "ECP_TEST_900898",
            "type": "purchase",
            "status": "success",
            "date": "2020-08-03T11:05:11+0000",
            "method": "NeoSurf",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "test payment"
        },
        "customer": {
            "id": "100"
        },
        "operation": {
            "id": 5042576000000972,
            "type": "sale",
            "status": "success",
            "date": "2020-08-03T11:05:11+0000",
            "created_date": "2020-08-03T11:04:08+0000",
            "request_id": "348238e315dad344ea02dade1a144599...440994063c-05042577",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 3201,
                "payment_id": "109726234",
                "auth_code": "",
                "endpoint_id": "neosurf",
                "date": "2020-08-03T11:05:11+0000"
            }
        },
        "signature": "jYsUJ/r8GFOxPglW5GTstB9fyb7Lk2VC4...UBf+/zn8jQmj7WH2w0+EQ=="
    }

The following is the example of a callback for a declined pruchase.

Figure: Example of data in a declined purchase callback

{
        "project_id": 10801,
        "payment": {
            "id": "ECP_TEST_178551",
            "type": "purchase",
            "status": "decline",
            "date": "2020-07-31T11:32:11+0000",
            "method": "NeoSurf",
            "sum": {
                "amount": 200,
                "currency": "EUR"
            },
            "description": "test decline"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 86491000000461,
            "type": "sale",
            "status": "decline",
            "date": "2020-07-31T11:32:11+0000",
            "created_date": "2020-07-30T07:26:32+0000",
            "request_id": "a072079ed4a08a0d4d3d13d336b77a...a802115007c9a-00086492",
            "sum_initial": {
                "amount": 200,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 200,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 3201,
                "payment_id": "109689003",
                "auth_code": "",
                "endpoint_id": "neosurf",
                "date": "2020-07-31T11:32:11+0000"
            }
        },
        "signature": "pjZAPbO9+zieWV7l5A49YIpAaQ7H...O67CTG/TUYd72zS8uArr0BZZQfQ=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Analysis of payments results

As with other payment methods ECommPay offers, when using the Neosurf method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard (Old Dashboard), for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

  • Dashboard (Old Dashboard) allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
  • Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ECommPay technical support.