Neteller (legacy)

Neteller is a payment method to perform payments by using e-wallets. You can perform purchases through this method by using Payment Page and Gate, payouts by using Gate.

Note:

The present technical implementation of the Neteller method is discontinued on May 15th 2020. A new technical implementation is available for working with the Neteller method. It is described in the Neteller section.

For the information on how to switch to a new implementation refer to the key account manager.

General information

Payment method type E-wallet
Countries and regions All countries
Payment currencies Refer to the ecommpay key account manager
Currency conversion –
Purchases +
Payouts +
Stored credentials payments –
Full refunds –
Partial refunds –
Chargebacks –
Special considerations –
Onboarding and access fee Refer to your ecommpay key account manager

Interaction diagram

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



Operations support

Interfaces Amounts Times**
Payment Page Mobile SDKs CMS Plug-ins Gate Dashboard minimum maximum basic threshold
Purchases + + – + – * * * *
Payouts – – – + – * * * *

* Refer to the ecommpay key account manager.

** The basic and threshold times 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 Neteller method, purchases and payouts follow different processing procedures. To perform a purchase operation, you need to pass customer e-wallet number and secret code, while to initiate a payout, you need to notify customer via merchant's web service.

Figure 1. Purchase by using Payment Page


Figure 2. Purchase by using Gate


Figure 3. Payout 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.

Purchases by using Payment Page

General information

In the Neteller methods, when processing a purchase by using Payment Page, the merchant web service should 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 have Payment Page opened with one of the Neteller methods selected. For more information about preselecting payment methods, see in Preselecting payment methods. The full sequence and particularities of the purchase process are provided below.



Figure 4. Purchase sequence in the Payment Page method:
  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 Neteller method.
  8. The form for entering account data is displayed to the customer.
  9. The customer enters wallet number and security code for purchase confirmation.
  10. The payment platform receives the purchase request for payment processing from Payment Page.
  11. The payment platform performs the internal purchase request processing and sends it to the Neteller service.
  12. The account verification and payment processing are performed on the Neteller side.
  13. The Neteller service sends the result notification to the payment platform.
  14. The payment platform sends a callback with the payment result to the web service.
  15. The payment platform sends the result to Payment Page.
  16. 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 Neteller 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 Neteller 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
  2. There are two more mandatory parameters:
    • account_number—customer email address for Neteller account or twelve digit Neteller account number
    • security_code—wallet security code

    If the data is not passed in the request, it is requested additionally from the customer on Payment Page.

  3. If you need to have payment form displayed with the Neteller method selected, set the force_payment_method parameter to neteller.
  4. If required, you can also add any other additional parameters Payment Page supports.
  5. 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 Neteller method must include project and payment IDs, the currency and the amount of a payment in the appropriate currency, account number and security code, as shown in the following example:

EPayWidget.run(
    { payment_id: 'X06936', 
      payment_amount: 10000, 
      payment_currency: 'EUR', 
      project_id: 187, 
      account_number: 'example@gmail.com',
      security_code: '852923',
      signature: "dkreRAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOc
                                                             ZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the Neteller method , see Parameters for opening payment form.

Callback format

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

Note that unlike other payment methods, in the Neteller method, the callbacks contain the customer country code in the country_surcharge_fee parameter of the provider_extra_fields object.

The following is the example of a callback with an information about successful 182.00 USD purchase on account example@gmail.com made by the 6907068 customer in the 312 project.

Figure 5. Example of a successful purchase callback
{
        "project_id": 312,
        "payment": {
            "id": "96225914",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-18T06:32:55+0000",
            "method": "neteller",
            "sum": {
                "amount": 18200,
                "currency": "USD"
            },
            "description": "Payment order: 96225914"
        },
        "account": {
            "number": "example@gmail.com"
        },
        "customer": {
            "id": "6907068"
        },
        "provider_extra_fields": {
            "country_surcharge_fee": "RU"
        },
        "operation": {
            "id": 36449000004271,
            "type": "sale",
            "status": "success",
            "date": "2019-09-18T06:32:55+0000",
            "created_date": "2019-09-18T06:32:50+0000",
            "request_id": "5f65cc668386652ac03d9cbe3e5dd52dcc51553a",
            "sum_initial": {
                "amount": 18200,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 18200,
                "currency": "USD"
            },
            "provider": {
                "id": 1085,
                "payment_id": "317568788373961",
                "date": "2019-09-18T06:32:54+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "C859awYHRm4u8ej8Y1Y6GEglD0u1oiIyJi+EVDTGazOmta0rUR9+PZ7+zOEELIjBTzBu
                                                                     UF3IOgi8WnRQpnvSWA=="
    }
}

The following is the example of a callback for a purchase declined due to incorrect account data entered.

Figure 6. Example of a declined purchase callback
 {
        "project_id": 312,
        "payment": {
            "id": "96185811",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-17T20:04:26+0000",
            "method": "neteller",
            "sum": {
                "amount": 50000,
                "currency": "EUR"
            },
            "description": "Payment order: 96185811"
        },
        "account": {
            "number": "test11@gmail.com"
        },
        "customer": {
            "id": "6907889"
        },
        "provider_extra_fields": {
            "country_surcharge_fee": "RU"
        },
        "operation": {
            "id": 17398000003861,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-17T20:04:26+0000",
            "created_date": "2019-09-17T20:04:22+0000",
            "request_id": "d2d7123f1ad66c5f359fe06f3d6e7c8d4f65bafe6ce499e",
            "sum_initial": {
                "amount": 50000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 50000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1085,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20102",
            "message": "Incorrect account data entered"
        },
        "signature": "gtGOFdvpmp9RwyoAlfjr3DaAjkOAxMx/F3RbdsuS0XgQ6E3Fm+EzxfNGVFBYvrnqT
                                                               ogjx/gz476ROulXSyAnvg=="
    }
}

Related topics

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

Purchases by using Gate

General information

In the Neteller 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. Get the callback with the payment result from the payment platform.

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



Figure 7. Purchase by using Gate
  1. A customer initiates a purchase through Neteller 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 Neteller service.
  7. The account verification and payment processing are performed on the Neteller side.
  8. The Neteller service sends the payment result notification to the payment platform.
  9. The payment platform sends a callback to the web service.
  10. 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 Neteller 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 Neteller method:

  1. You send purchase requests by sending the /v2/payment/neteller/sale request by using HTTP method POST.
  2. The following objects and parameters must be specified in any request:
    • Object general—general purchase information:
      • project_id—project identifier
      • payment_id—unique purchase identifier
    • Object customer—customer information:
      • ip_address—customer IP address
    • Object account—customer account information:
      • number—customer email address for Neteller account or twelve digit Neteller account number
      • security_code—security code for purchase confirmation
    • Object payment—purchase information:
      • amount—purchase amount
      • currency—payout currency in the 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 Neteller method must include project and payment IDs, signature,customer IP address, account number and security code, currency and amount of the purchase, as shown in the following example:

Figure 8. Example of a purchase request
{
  "general": {
    "project_id": 312,
    "payment_id": "96185811",
    "signature": "rfGuKhR6pExygP252sbmz+QzkNFE4KVXXtVXx5uteXLqBoS6qXqsryE+OfV/7SP1v2Rx
                                                                 NXY57PmlCrl/n2lJog=="
  },
  "customer": {
    "ip_address": "37.157.110.144"
  },
  "account": {
    "number": "example@gmail.com",
    "security_code": "063405"
  },
  "payment": {
    "amount": 50000,
    "currency": "EUR"
  }
}

Callback format

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

Note that unlike other payment methods, in the Neteller method, the callbacks contain the customer country code in the country_surcharge_fee parameter of the provider_extra_fields object.

The following is the example of a callback with an information about successful 182.00 USD purchase on account example@gmail.com made by the 6907068 customer in the 312 project.

Figure 9. Example of a successful purchase callback
{
        "project_id": 312,
        "payment": {
            "id": "96225914",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-18T06:32:55+0000",
            "method": "neteller",
            "sum": {
                "amount": 18200,
                "currency": "USD"
            },
            "description": "Payment order: 96225914"
        },
        "account": {
            "number": "example@gmail.com"
        },
        "customer": {
            "id": "6907068"
        },
        "provider_extra_fields": {
            "country_surcharge_fee": "RU"
        },
        "operation": {
            "id": 36449000004271,
            "type": "sale",
            "status": "success",
            "date": "2019-09-18T06:32:55+0000",
            "created_date": "2019-09-18T06:32:50+0000",
            "request_id": "5f65cc668386652ac03d9cbe3e5dd52dcc51553a",
            "sum_initial": {
                "amount": 18200,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 18200,
                "currency": "USD"
            },
            "provider": {
                "id": 1085,
                "payment_id": "317568788373961",
                "date": "2019-09-18T06:32:54+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "C859awYHRm4u8ej8Y1Y6GEglD0u1oiIyJi+EVDTGazOmta0rUR9+PZ7+zOEELIjBTzBu
                                                                     UF3IOgi8WnRQpnvSWA=="
    }
}

The following is the example of a callback for a purchase declined due to incorrect account data entered.

Figure 10. Example of a declined purchase callback
 {
        "project_id": 312,
        "payment": {
            "id": "96185811",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-17T20:04:26+0000",
            "method": "neteller",
            "sum": {
                "amount": 50000,
                "currency": "EUR"
            },
            "description": "Payment order: 96185811"
        },
        "account": {
            "number": "test11@gmail.com"
        },
        "customer": {
            "id": "6907889"
        },
        "provider_extra_fields": {
            "country_surcharge_fee": "RU"
        },
        "operation": {
            "id": 17398000003861,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-17T20:04:26+0000",
            "created_date": "2019-09-17T20:04:22+0000",
            "request_id": "d2d7123f1ad66c5f359fe06f3d6e7c8d4f65bafe6ce499e",
            "sum_initial": {
                "amount": 50000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 50000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1085,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20102",
            "message": "Incorrect account data entered"
        },
        "signature": "gtGOFdvpmp9RwyoAlfjr3DaAjkOAxMx/F3RbdsuS0XgQ6E3Fm+EzxfNGVFBYvrnqT
                                                               ogjx/gz476ROulXSyAnvg=="
    }
}

Related topics

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

Payouts by using Gate

General information

To perform a payout through the Neteller method, merchant's web service sends a request with all the required parameters and signature to ecommpay URL, and receives a callback with the payment result. The full sequence of the payout process is provided below.



Figure 11. Payout by using Gate
  1. A customer orders a payout through the Neteller system.
  2. Merchant's web service sends the request for the payout processing by using Gate to the appropriate ecommpay URL.
  3. Gate redirects the request to the ecommpay payment platform.
  4. The payment platform performs all the necessary checks and processes the request.
  5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
  6. The payment platform redirects the payout request to the Neteller service.
  7. The payout is processed on the Neteller side.
  8. Neteller sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. The customer receives the notification about the payout result from the web service.

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

Request format

There are several things you must consider when using payout requests in the Neteller method:

  1. You send payout requests by sending the /v2/payment/neteller/payout request by using HTTP method POST.
  2. The following objects and parameters must be specified in any request:
    • Object general—general payout information:
      • project_id—project identifier
      • payment_id—unique payout identifier
      • 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—identifier,
      • ip_address—customer IP address
    • Object account—customer account information:
      • number—customer email address for Neteller account or twelve digit Neteller account number
    • Object payment—payout information:
      • amount—payout amount
      • currency—payout currency in the ISO-4217 alpha-3 format.
  3. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Neteller method must include project and payment IDs, customer identifier and IP address, account number (for crediting), currency and amount of the payout, as shown in the following example:

Figure 12. Example of a payout request 
{
  "general": {
    "project_id": 312,
    "payment_id": "413784088",
    "signature": "ohopebbls6vT+YB6X2JOeDRWBysYaTPZOTiLdVLHVIcJf1LUYffzbssFC+E
                                               mfmZ/LemJi0WWPToLdkUd9GWlQw=="
  },
  "customer": {
    "id": "4741986",
    "ip_address": "192.168.0.244"
  },
  "account": {
    "number": "example@gmail.com"
  },
  "payment": {
    "amount": 50000,
    "currency": "EUR"
  }
}

Callback format

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

Note that unlike other payment methods, in the Neteller method, the callbacks contain the customer country code in the country_surcharge_fee parameter of the provider_extra_fields object.

The following is the example of a callback with an information about successful 500.00 EUR payout made by the 4741986 customer in the 312 project.

Figure 13. Example of a successful payout callback
{
        "provider_extra_fields": {
            "country_surcharge_fee": "RU"
        },
        "customer": {
            "id": "123"
        },
        "account": {
            "number": "example@gmail.com"
        },
        "project_id": 312,
        "payment": {
            "id": "413784088",
            "type": "payout",
            "status": "success",
            "date": "2019-09-17T23:43:01+0000",
            "method": "neteller",
            "sum": {
                "amount": 50000,
                "currency": "EUR"
            },
            "description": "Test payout"
        },
        "operation": {
            "id": 16835000003831,
            "type": "payout",
            "status": "success",
            "date": "2019-09-17T23:43:01+0000",
            "created_date": "2019-09-17T23:42:56+0000",
            "request_id": "c38f234dfb744e85924b4d703699ea3a7a59eeb",
            "sum_initial": {
                "amount": 50000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 50000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1085,
                "payment_id": "767568763779702",
                "date": "2019-09-17T23:42:59+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "5+r4dQpRCpaVNo88dfmWPk6SgUgpUiYku7734lsK+Nf5Z1T6ZfGKdx4USE5RGH+0bm7arKrb
                                                                             xWHN3RKTjJNlaw=="
    }
}

The following is the example of a callback for a payout declined due to insufficient funds on merchant balance.

Figure 14. Example of a declined payout callback
{
        "provider_extra_fields": {
            "country_surcharge_fee": "RU"
        },
        "customer": {
            "id": "123"
        },
        "account": {
            "number": "example@gmail.com"
        },
        "project_id": 328,
        "payment": {
            "id": "1684917",
            "type": "payout",
            "status": "decline",
            "date": "2019-07-31T11:46:27+0000",
            "method": "neteller",
            "sum": {
                "amount": 15000,
                "currency": "USD"
            },
            "description": ""
        },
        "errors": [
            {
                "code": "3028",
                "message": "Insufficient funds on merchant balance",
                "description": "public: BALANCE_INSUFFICIENT_FUNDS"
            }
        ],
        "operation": {
            "id": 1055000003525,
            "type": "payout",
            "status": "decline",
            "date": "2019-07-31T11:46:27+0000",
            "created_date": "2019-07-31T11:46:26+0000",
            "request_id": "c9ddbf42779d66a0e49a0efd107e5b73520a7b959573e4f2af",
            "sum_initial": {
                "amount": 15000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 15000,
                "currency": "USD"
            },
            "provider": {
                "id": 1085,
                "payment_id": ""
            },
            "code": "3028",
            "message": "Insufficient funds on merchant balance"
        },
        "signature": "ohkil8ysiElVf+uL+B/Vri0VUmVAr7UCyApnEpf6DoLNvVNAEH3FRCbt8IiT
                                                       jfyVK3zVPeEEn+Gb2opbx/IEw=="
    }
}

Related topics

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

Testing

General information

For the Neteller method the testing of purchases by using Payment Page and Gate and payouts by using Gate are available..

Testing can be performed within a test project, to enable and disable the testing availability, contact ecommpay technical support via support@ecommpay.com.

When performing a test payment, take into account that you must specify the identifier of the test project in the requests, the currency can only be AED, AUD, BGN, BRL, CAD, CHF, DKK, EUR, HUF, INR, JPY, MAD, MYR, MXN, NGN, NOK, PLN, RON, SEK, SGD, TND, TWD, USD, ZAR, and the interface of the payment form emulator of Payment Page may differ from the one used in the production environment.

Test payments statuses

When testing purchases, the final payment status is determined by the amount specified in the request:

  • decline status with 40000 or 40400 amount
  • success status with any other amount

When testing payouts, the final payment status is determined by the amount specified in the request:

  • decline status with 40000 or 40400 amount
  • success status with any other amount

Purchases by using Payment Page

To perform a test purchase by using Payment Page, do the following:

  1. Send a correct test request for Payment Page opening to the payment platform.
  2. If the neteller method was not specified in the request—select the method on the emulator page.
  3. Specify the following in the data entry fields:
    • random email address or a twelve digit account number
    • random six digit security code
  4. Click the Pay button.
  5. Accept a callback with information about the payment result.

The full information about purchase process by using Neteller through Payment Page is provided in the section Purchases by using Payment Page.

Purchases by using Gate

To perform a test purchase by using Gate, send a correct test request to the payment platform and accept a callback with information about the payment result. The full information about payout process by using Neteller through Gate is provided in the section Purchases by using Gate.

Payouts by using Gate

To perform a test payout by using Gate, send a correct test request to the payment platform and accept a callback with information about the payment result. The full information about payout process by using Neteller through Gate is provided in the section Payouts by using Gate.

Analysis of payments results

As with other payment methods ecommpay offers, when using the Neteller 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, 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 allows you to download reports in CSV and XLS formats—by using the tools on the Monitoring and performing 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.