Neteller

Overview

Introduction

Neteller is a payment method which allows to process payments in different currencies by using e-wallets in different countries. This method supports purchases and payouts.

This article provides information about working with the Neteller method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

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 *
One-time purchases +
Credential-on-file purchases –
Full refunds –
Partial refunds –
Payouts +
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, additional information available in the ecommpay shop

* Refer to your ecommpay key account manager for more information.

Interaction diagram

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



Operations support

Various platform interfaces can be used to process payments and perform operations using the Neteller method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links), payouts—by using Gate and Dashboard.

Processing scenarios

To perform a purchase by using the Neteller method, you need to redirect the customer to the Neteller service, while to initiate a payout, you need to notify the customer via the web service.

The customer payment scenario via Payment Page looks like this.

Figure 1. Proceeding to payment


Figure 2. Selecting method


Figure 3. Authentication


Figure 4. Confirming payment


Figure 5. Redirecting to the payment form


Figure 6. Redirecting to the web service


General scenarios of processing purchases and payouts can be presented as follows.

Figure 7. Purchase by using Payment Page


Figure 8. Purchase by using Gate


Figure 9. Payout by using Gate


Purchases by using Payment Page

General information

To process a purchase through Payment Page by using the Neteller method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.



Figure 10. Purchase processing by using Payment Page: step-by-step description
  1. A customer initiates a purchase in the web service.
  2. The web service sends the request for opening Payment Page to the specified ecommpay URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform receives the request and validates the required parameters and signature.
  5. Payment Page is generated based on the project and request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the Neteller method.
  8. The payment platform receives the request for processing the payment by using the Neteller method.
  9. The payment platform processes the request and sends it to the Neteller service.
  10. The request is processed on the Neteller service side.
  11. The data for redirecting the customer to the Neteller service is sent from the Neteller service to the payment platform.
  12. The data for redirecting the customer is sent from the payment platform to Payment Page.
  13. The customer is redirected to the Neteller service.
  14. The customer completes all required payment steps.
  15. The purchase is processed in the Neteller service.
  16. The result information is displayed to the customer in the Neteller service.
  17. The customer is redirected to Payment Page.
  18. The payment platform sends the payment result callback to the web service.
  19. The payment platform sends the result information to Payment Page.
  20. The result information is displayed to the customer on Payment Page.

Information about the formats of requests and callbacks used for processing payments by using the Neteller method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

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

  1. The following parameters required for any payment must be specified:
    • project_id—project identifier obtained from ecommpay during integration
    • payment_id—payment identifier unique within the project
    • payment_currency—payment currency code in the ISO-4217 alpha-3 format
    • payment_amount—payment amount in the smallest currency unit
    • customer_id—customer identifier unique within the project
  2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
  3. Additionally, it is recommended to specify the customer email address associated with the Neteller account in the parameter customer_account_number. If this parameter is missing, the payment form may display the input field for entering the missing values (details are available in Submission of additional payment information).
  4. If you need to have the payment form displayed with the Neteller method selected, set the force_payment_method parameter to neteller-wallet.
  5. Additionally, any other parameters available for working with Payment Page can be used (details).
  6. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the Neteller method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and email address, as well as signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "customer_account_number": "test@example.com",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}
Figure 11. Example of sufficient data in a purchase request
{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "customer_account_number": "test@example.com",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

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

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

Figure 12. Example of callback data indicating that the purchase has been processed
{
    "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": "55e5e198a2580e9ddb1756169dd960b47aeb-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 with information about a declined purchase.

Figure 13. Example of callback data indicating that the purchase has been declined
{
    "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": "55e5e1989ddb1756169dd960b47aeb-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=="
}

Useful links

The following articles can be useful when implementing purchases via Payment Page:

Purchases by using Gate

General information

To process a purchase through Gate by using the Neteller method, the merchant's web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ecommpay URL.
  2. Receive an intermediate callback from the payment platform and redirect the customer to the Neteller service.
  3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.



Figure 14. Purchase processing by using Gate: step-by-step description
  1. A customer initiates a purchase by using the Neteller method in the web service.
  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.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the Neteller service.
  7. The request is processed on the Neteller service side.
  8. The Neteller service sends the redirection data to the payment platform.
  9. The payment platform sends the callback with the redirection data to the web service.
  10. The customer is redirected to the Neteller service.
  11. The customer completes all required payment steps.
  12. The purchase is processed in the Neteller service.
  13. The result is displayed to the customer.
  14. The customer is redirected to the web service.
  15. The payment platform sends the payment result callback to the web service.
  16. The customer receives the payment result information from the web service.

Information about the formats of requests and callbacks used for processing payments by using the Neteller method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the Neteller method:

  1. To initiate each purchase, send a separate POST request to the /v2/payment/wallet/neteller/sale endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/sale.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payment
    • 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.
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the Neteller method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier, IP address and email address, as well as signature.

{
  "general": {
    "project_id": 123,
    "payment_id": "ID_178",
    "signature": "PJkV8ej\/UG0Di8hTng6JvC7Y3Tv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 100,
    "currency": "EUR"
  },
  "customer": {
    "ip_address": "192.0.2.0",
    "id": "customer123"
  },
  "account": {
    "number": "test@example.com"
  }
}
Figure 15. Example of sufficient data in a purchase request
{
  "general": {
    "project_id": 123,
    "payment_id": "ID_178",
    "signature": "PJkV8ej\/UG0Di8hTng6JvC7Y3Tv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 100,
    "currency": "EUR"
  },
  "customer": {
    "ip_address": "192.0.2.0",
    "id": "customer123"
  },
  "account": {
    "number": "test@example.com"
  }
}

Formats of intermediate callbacks for customer redirection

Each payment made with the Neteller method requires redirection of customers from the merchant's web service to the Neteller service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the redirect_data object. The format of such callbacks is standard (details), and the following objects and parameters are included in the redirect_data object:

  • body—object with data to be sent in the request body
  • method—parameter specifying the HTTP method for sending the request (GET or POST)
  • url—parameter containing a link for redirection
Figure 16. redirect_data example
  "redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://www.example.com/pay"
  }

Callback format

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

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

Figure 17. Example of callback data indicating that the purchase has been processed
{
    "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": "55e5e198a2580e9ddb1756169dd960b47aeb-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 with information about a declined purchase.

Figure 18. Example of callback data indicating that the purchase has been declined
{
    "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": "55e5e1989ddb1756169dd960b47aeb-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=="
}

Useful links

The following articles can be useful when implementing purchases via Gate:

Payouts by using Gate

General information

To process a payout through Gate by using the Neteller method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of payout processing are provided below.



Figure 19. Payout processing by using Gate: step-by-step description
  1. A customer initiates a payout by using the Neteller method in the web service.
  2. The web service sends the request for processing the payout by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the Neteller service.
  7. The payout is processed on the side of the Neteller service.
  8. The Neteller service sends the result notification to the payment platform.
  9. The payment platform sends the result callback to the web service.
  10. The customer receives the payout result information from the web service.

Information about the formats of requests and callbacks used for processing payouts by using the Neteller method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending payout requests by using the Neteller method:

  1. To initiate each payout send a separate POST request to the /v2/payment/wallet/neteller/payout endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/payout.
  2. Each request must include the following objects and parameters:
    • Object general—general payout information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) details
    • Object payment—payment information:
      • amount—payout amount in the smallest currency unit
      • currency—payout currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payout
    • 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.
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct payout request by using the Neteller method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier, IP address and email address, as well as signature.

  "general": {
    "project_id": 200,
    "payment_id": "123",
    "signature": "8ff12bcdfa8496f8e93fd94bbe4c527be=="
   },
  "payment": {
    "amount": 1000,
    "currency": "EUR"
   },
  "customer": {
    "id": "customer1",
    "ip_address": "192.0.2.0"
   },
  "account":{
    "number": "netellertest@example.com"
   }
Figure 20. Example of sufficient data in a purchase request
  "general": {
    "project_id": 200,
    "payment_id": "123",
    "signature": "8ff12bcdfa8496f8e93fd94bbe4c527be=="
   },
  "payment": {
    "amount": 1000,
    "currency": "EUR"
   },
  "customer": {
    "id": "customer1",
    "ip_address": "192.0.2.0"
   },
  "account":{
    "number": "netellertest@example.com"
   }

Callback format

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

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

Figure 21. Example of callback data indicating that the payout has been processed
{
    "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": "e03c2b85a7f816f0ecfdcb0a3de74525-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 with information about a declined payout.

Figure 22. Example of callback data indicating that the payout has been declined
{
    "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": "e03c2b85a7f816f0ecf0ab0a3de74525-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": "uQEJSDLG1wgoVwMwr9o+EV09aBakCA8xoeSkDpF/CCIYl1xbVw=="
}

Useful links

The following articles can be useful when implementing payouts via Gate:

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, it is possible to test purchases by using Payment Page and Gate, as well as payouts by using Gate. To enable and disable testing, as well getting assistance with setting up a test project, refer to ecommpay technical support.

When testing payments keep in mind that the test project identifier must be indicated in requests, only BRL, EUR, GBP, JPY, USD currencies can be used, the interfaces of the emulator of Payment Page and Neteller payment forms can differ from the production environment.



Test payments statuses

The final status of test payments and operations is determined by the amount specified in the request.

Test purchases:

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

Test payouts:

  • 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-wallet method was not specified in the request—select the method on the emulator page.
  3. Specify a random email address in the data entry field.
  4. Click the Success or Decline button (depending on the amount specified in the request).
  5. Receive the final callback with information about the payment result.

More information about processing purchases by using the Neteller method via Payment Page is provided in the Purchases by using Payment Page section.

Purchases by using Gate

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

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

More information about processing purchases by using the Neteller method via Gate is provided in the Purchases by using Gate section.

Payouts by using Gate

o process a test payout by using Gate, send a valid test request for a payout to the payment platform and receive a final callback with information about the payout result. More information about processing payouts by using the Neteller method via Gate is provided in the Payouts by using Gate section.

Analysis of payments results

To analyse information about payments made with the Neteller method and other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.

If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.