Neteller

Overview

Note:

Two technical implementations are currently supported for working with the Neteller method: the new one described in this section and the old one described in the section Neteller (legacy).

Details about the difference between these implementations and how to switch from the old implementation to the new one should be clarified with the ecommpay key account manager.

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 and Dashboard.

General information

Payment method type	digital wallet payments
Payment instruments	digital wallets
Countries and regions	all countries, except AF, BJ, BQ, BI, BL, CF, CG, CU, DJ, ER, EH, GA, GM, GN, GQ, GW, GY, IR, IQ, KN, KZ, KG, LA, LR, LY, MG, MF, MW, ML, MR, MN, MS, MM, NR, NE, NU, NF, KP, PW, PG, SX, SL, SS, SD, SR, SY, TD, TJ, TL, TG, TM, US, UZ, YE *
Payment currencies	refer to your ecommpay key account manager
Currency conversion	on the ecommpay side *
Purchases	+
Payouts	+
Stored credentials payments	–
Full refunds	–
Partial refunds	–
Chargebacks	–
Notes	Payment Page can be opened in any way except embedded into a web page (iframe)
Onboarding and access fee	refer to your ecommpay key account manager

* Refer to your ecommpay key account manager for more information

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 technical facilities of Neteller.

Operations support

	Interfaces				Amounts
	Payment Page	CMS Plug-ins	Gate	Dashboard	minimum	maximum
Purchases	+		+	–	–	–
Payouts	–	–	+	+	–	–

Processing scenarios

In the Neteller method, purchases and refunds follow different processing procedures. To perform a purchase operation, you need to redirect customer to the Neteller service, while to initiate a payout, you need to receive a request from the customer via the web service.

Figure: Purchase by using Payment Page

Figure: Purchase by using Gate

Figure: 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 method, 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 the Neteller method 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: Purchase by using Payment Page

A customer initiates a purchase on the merchant's web service.
The web service sends the request for Payment Page opening to the specified ecommpay URL.
The request for opening is redirected to the payment platform.
The payment platform performs the initial request processing that involves validation of the required parameters and signature.
Requested Payment Page is generated into the ecommpay payment platform as specified in the project settings and the request parameters.
Payment Page is displayed to the customer.
The customer selects the Neteller method.
The payment platform receives the purchase request for payment processing from Payment Page.
The payment platform performs the internal purchase request processing and sends it to the Neteller service.
The purchase request is processed on the Neteller service side.
The Neteller service generates the data for redirecting the customer to its website form and sends it to the payment platform.
The payment platform sends the customer redirection data to Payment Page.
The customer is redirected to the Neteller website.
The customer completes all the payment steps required.
The payment is processed on the Neteller side.
The customer is redirected to Payment Page.
The Neteller service sends the result notification to the payment platform.
The payment platform sends a callback with the payment result to the web service.
The payment platform sends the result to Payment Page.
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:

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—customer ID unique within the project
It is recommended to specify the user email address associated with the Neteller account in the customer_account_number additional parameter. If the request is missing the parameter, on Payment Page the additional field is displayed to the customer to input missing data. For more details about submission of additional payment information, see Submission of additional payment information.
If you need to have payment form displayed with the Neteller method selected, set the force_payment_method parameter to neteller-wallet.
If required, you can also add any other additional parameters Payment Page supports.
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, customer email address, as well as signature, as shown in the following example:

    { project_id: 123,
      payment_id: 'X03936', 
      payment_amount: 1000, 
      payment_currency: 'EUR',  
      customer_id: 'customer1',
      customer_account_number: 'test@example.com',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yT4DqtVUkDJrOcZzUCwX6R\/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.

The following is the example of a callback with an information about successful 10.00 EUR purchase in the 210 project.

Figure: Example of a successful purchase callback

{
    "project_id": 210,
    "payment": {
        "id": "ORDER_ID_1584627953",
        "type": "purchase",
        "status": "success",
        "date": "2020-03-19T14:26:25+0000",
        "method": "neteller",
        "sum": {
            "amount": 1000,
            "currency": "EUR"
        },
        "description": "Neteller purchase success"
    },
    "account": {
        "number": "netellertest@example.com"
    },
    "customer": {
        "id": "123"
    },
    "operation": {
        "id": 202,
        "type": "sale",
        "status": "success",
        "date": "2020-03-19T14:26:25+0000",
        "created_date": "2020-03-19T14:25:54+0000",
        "request_id": "55e5e198a25827fc92c11262bb75936a0e9ddb1756169dd960b47aeb-00000001",
        "sum_initial": {
            "amount": 1000,
            "currency": "EUR"
        },
        "sum_converted": {
            "amount": 1000,
            "currency": "EUR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 1987,
            "payment_id": "1584627957265",
            "auth_code": "",
            "date": "2020-03-19T14:26:24+0000"
        }
    },
    "signature": "rv9EhRK3W1eRPzvlzZ3e3tttjgANs3z0Vi5OmH7GJ4qFqg=="
}

The following is the example of a callback for a purchase declined due to a time-out.

Figure: Example of a declined purchase callback

{
    "project_id": 210,
    "payment": {
        "id": "ORDER_ID_1584627954",
        "type": "purchase",
        "status": "decline",
        "date": "2020-03-19T14:26:25+0000",
        "method": "neteller",
        "sum": {
            "amount": 1000,
            "currency": "EUR"
        },
        "description": "Neteller purchase decline"
    },
    "account": {
        "number": "netellertest@example.com"
    },
    "customer": {
        "id": "123"
    },
    "operation": {
        "id": 203,
        "type": "sale",
        "status": "decline",
        "date": "2020-03-19T14:26:25+0000",
        "created_date": "2020-03-19T14:25:54+0000",
        "request_id": "55e5e198a25827fc92c11262bb75936a0e9ddb1756169dd960b47aeb-00000001",
        "sum_initial": {
            "amount": 1000,
            "currency": "EUR"
        },
        "sum_converted": {
            "amount": 1000,
            "currency": "EUR"
        },
        "code": "20602",
        "message": "Time-out",
        "provider": {
            "id": 1988,
            "payment_id": "1584627957266",
            "auth_code": "",
            "date": "2020-03-19T14:26:24+0000"
        }
    },
    "signature": "rv9EhRK3W1eRPzvlzZ3e3tttjgANs3z0Vi5OmH7GJ4qFqg=="
}

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:

Send a request with all the required parameters and signature to the ecommpay URL.
Perform the redirection of a customer to the Neteller service.
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

A customer initiates a purchase through Neteller on the merchant's web service side.
The web service sends the request for processing the purchase by using Gate to the specified ecommpay URL.
The payment platform receives the request for processing the purchase from Gate.
The payment platform performs the initial request processing that includes validation of the required parameters and signature.
The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
The payment platform performs the internal payment request processing and redirects the request to the Neteller service.
The request is processed on the Neteller side.
The Neteller service sends the data for redirecting the customer to the Neteller service to the payment platform.
The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
The customer is redirected from the web service to the Neteller service.
The customer completes all the payment steps required.
The payment is processed on the Neteller side.
The customer is redirected to the merchant's web service.
The Neteller service sends the payment result notification to the payment platform.
The payment platform sends a callback to the web service.
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:

You send purchase requests by sending the /v2/payment/wallet/neteller/sale request by using the POST HTTP method. This is an e-wallet payments request group: /v2/payment/wallet/{payment_method}/sale.
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 payment—payment information:
  - amount—purchase amount in minor units
  - currency—purchase currency in ISO-4217 alpha-3 format
- Object customer—customer information:
  - ip_address—customer IP address
  - id—unique ID within the merchant project
- Object account—customer account information:
  - number—email address associated with the Neteller account. According to the operation protocol of the Neteller service it is required to validate the values that the customers specify on the web service side and allow only those values which correspond to the format of an email address.
If required, you can also add any other additional parameters Gate supports.
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, currency and amount of the purchase, as well as customer information, as shown in the following example:

Figure: Example of a purchase request

{
  "general": {
    "project_id": 123,
    "payment_id": "ID_178",
    "signature": "PJkV8ej\/UG0Di8hTng6JvC7Y3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 100,
    "currency": "EUR"
  },
  "customer": {
    "ip_address": "1.1.1.1",
    "id": "customer1"
  },
  "account": {
    "number": "test@example.com"
  }
}

Formats of the customer redirection data

To redirect a customer from the web service to the Neteller 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": {
    "body": {},
    "method": "GET",
    "url": "https://api.test.com/alternatepayments/v1/redirect?example"
    }

Callback format

The Neteller 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 10.00 EUR purchase in the 210 project.

Figure: Example of a successful purchase callback

{
    "project_id": 210,
    "payment": {
        "id": "ORDER_ID_1584627953",
        "type": "purchase",
        "status": "success",
        "date": "2020-03-19T14:26:25+0000",
        "method": "neteller",
        "sum": {
            "amount": 1000,
            "currency": "EUR"
        },
        "description": "Neteller purchase success"
    },
    "account": {
        "number": "netellertest@example.com"
    },
    "customer": {
        "id": "123"
    },
    "operation": {
        "id": 202,
        "type": "sale",
        "status": "success",
        "date": "2020-03-19T14:26:25+0000",
        "created_date": "2020-03-19T14:25:54+0000",
        "request_id": "55e5e198a25827fc92c11262bb75936a0e9ddb1756169dd960b47aeb-00000001",
        "sum_initial": {
            "amount": 1000,
            "currency": "EUR"
        },
        "sum_converted": {
            "amount": 1000,
            "currency": "EUR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 1987,
            "payment_id": "1584627957265",
            "auth_code": "",
            "date": "2020-03-19T14:26:24+0000"
        }
    },
    "signature": "rv9EhRK3W1eRPzvlzZ3e3tttjgANs3z0Vi5OmH7GJ4qFqg=="
}

The following is the example of a callback for a purchase declined due to a time-out.

Figure: Example of a declined purchase callback

{
    "project_id": 210,
    "payment": {
        "id": "ORDER_ID_1584627954",
        "type": "purchase",
        "status": "decline",
        "date": "2020-03-19T14:26:25+0000",
        "method": "neteller",
        "sum": {
            "amount": 1000,
            "currency": "EUR"
        },
        "description": "Neteller purchase decline"
    },
    "account": {
        "number": "netellertest@example.com"
    },
    "customer": {
        "id": "123"
    },
    "operation": {
        "id": 203,
        "type": "sale",
        "status": "decline",
        "date": "2020-03-19T14:26:25+0000",
        "created_date": "2020-03-19T14:25:54+0000",
        "request_id": "55e5e198a25827fc92c11262bb75936a0e9ddb1756169dd960b47aeb-00000001",
        "sum_initial": {
            "amount": 1000,
            "currency": "EUR"
        },
        "sum_converted": {
            "amount": 1000,
            "currency": "EUR"
        },
        "code": "20602",
        "message": "Time-out",
        "provider": {
            "id": 1988,
            "payment_id": "1584627957266",
            "auth_code": "",
            "date": "2020-03-19T14:26:24+0000"
        }
    },
    "signature": "rv9EhRK3W1eRPzvlzZ3e3tttjgANs3z0Vi5OmH7GJ4qFqg=="
}

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: Payout by using Gate

A customer orders a payout through the Neteller system.
Merchant's web service sends the request for the payout processing by using Gate to the appropriate ecommpay URL.
Gate redirects the request to the ecommpay payment platform.
The payment platform performs all the necessary checks and processes the request.
The reply with the request processing results is sent to the merchant's web service. For more information, see Response format.
The payment platform redirects the payout request to the Neteller service.
The payout is processed on the Neteller side.
Neteller sends the result notification to the payment platform.
The payment platform sends a callback with the payment result to the web service.
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:

You send payout requests by sending the /v2/payment/wallet/neteller/payout request by using the POST HTTP method. This is an e-wallet payments request group /v2/payment/wallet/{payment_method}/payout.
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 payment—payout information:
  - amount—payout amount
  - currency—payout currency in the ISO-4217 alpha-3 format
- Object customer—customer information:
  - ip_address—customer IP address
  - id—unique ID within the merchant project
- Object account—account information:
  - number—email address associated with the Neteller account. According to the operation protocol of the Neteller service it is required to validate the values that the customers specify on the web service side and allow only those values which correspond to the format of an email address.
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, account number (for crediting), customer IP address, currency and amount of the payout, as shown in the following example:

Figure: Example of a payout request

  "general": {
    "project_id": 200,
    "payment_id": "123",
    "signature": "8ff12bcdfa8496f8e93fd937f563d07...ad0d4bbe4c527be=="
   },
  "payment": {
    "amount": 1000,
    "currency": "EUR"
   },
  "customer": {
    "id": "customer1",
    "ip_address": "1.2.3.4"
   },
  "account":{
    "number": "netellertest@example.com"
   },
  }

Callback format

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

The following is the example of a callback with an information about successful 10.00 EUR payout in the 210 project.

Figure: Example of a successful payout callback

{
    "project_id": 210,
    "payment": {
        "id": "ORDER_ID_1584628087",
        "type": "payout",
        "status": "success",
        "date": "2020-03-19T14:28:57+0000",
        "method": "neteller",
        "sum": {
            "amount": 1000,
            "currency": "EUR"
        },
        "description": "Neteller payout success"
    },
    "account": {
        "number": "netellertest@example.com"
    },
    "customer": {
        "id": "123"
    },
    "operation": {
        "id": 1000000201,
        "type": "payout",
        "status": "success",
        "date": "2020-03-19T14:28:57+0000",
        "created_date": "2020-03-19T14:28:11+0000",
        "request_id": "e03c2b85a7f816f0ecf0a7cdd955515f5390dcb0a3de74525-00000002",
        "sum_initial": {
            "amount": 1000,
            "currency": "EUR"
        },
        "sum_converted": {
            "amount": 1000,
            "currency": "EUR"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 1987,
            "payment_id": "1595720491729",
            "auth_code": "",
            "date": "2020-03-19T14:28:56+0000"
        }
    },
    "signature": "uQEJSDLG1wgoVwMwrbOPS9o+EV09aBakCA8xoeSkDpF/CCIYl1xbVw=="
}

The following is the example of a callback for a payout declined due to a time-out.

Figure: Example of a declined payout callback

{
    "project_id": 210,
    "payment": {
        "id": "ORDER_ID_1584628087",
        "type": "payout",
        "status": "decline",
        "date": "2020-03-19T14:28:57+0000",
        "method": "neteller",
        "sum": {
            "amount": 1000,
            "currency": "EUR"
        },
        "description": "Neteller payout decline"
    },
    "account": {
        "number": "netellertest@example.com"
    },
    "customer": {
        "id": "123"
    },
    "operation": {
        "id": 1000000201,
        "type": "payout",
        "status": "decline",
        "date": "2020-03-19T14:28:57+0000",
        "created_date": "2020-03-19T14:28:11+0000",
        "request_id": "e03c2b85a7f816f0ecf0a7cdd955515f5390dcb0a3de74525-00000002",
        "sum_initial": {
            "amount": 1000,
            "currency": "EUR"
        },
        "sum_converted": {
            "amount": 1000,
            "currency": "EUR"
        },
        "code": "20602",
        "message": "Time-out",
        "provider": {
            "id": 1988,
            "payment_id": "1595720491720",
            "auth_code": "",
            "date": "2020-03-19T14:28:56+0000"
        }
    },
    "signature": "uQEJSDLG1wgoVwMwrbOPS9o+EV09aBakCA8xoeSkDpF/CCIYl1xbVw=="
}

Payouts by using Dashboard

When working with Dashboard, you can process single and mass payouts by using the Neteller method.

To process a single payout, open the payout form, specify all required parameters (including the payment method), send a request and verify that the payout has been processed.
To process a mass payout, prepare and upload a file with information about all target payouts, send a batch request, and verify that the payouts have been processed.

Use a CSV file structured according to the requirements presented in the Mass payments data section. The payout parameters must comply with the requirements (you do not have to generate a signature because it is specified by Dashboard).

More information about processing payouts by using Dashboard is presented in a separate section.

Testing

General information

For the Neteller method the testing of purchases by using Payment Page and Gate, 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 be only BRL, EUR, GBP, JPY, RUB, USD and the interfaces of the payment forms emulator of Payment Page and Neteller differ from 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:

Send a correct test request for Payment Page opening to the payment platform.
If the neteller-wallet method was not specified in the request—select the method on the emulator page.
Specify a random email address in the data entry field.
Click the Success or Decline button (depending on the amount specified in the request).
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, do the following:

Send a correct test request for purchase to the payment platform.
Accept a callback with redirection data.
Go to the received URL and click the Success or Decline button (depending on the amount specified in the request).
Accept a callback with information about the payment result.

The full information about purchase 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 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.

Overview

General information

Interaction diagram

Operations support

Processing scenarios

Purchases by using Payment Page

General information

Request format

Callback format

Related topics

Purchases by using Gate

General information

Request format

Formats of the customer redirection data

Callback format

Related topics

Payouts by using Gate

General information

Request format

Callback format

Related topics

Payouts by using Dashboard

Testing

General information

Test payments statuses

Purchases by using Payment Page

Purchases by using Gate

Payouts by using Gate

Analysis of payments results