Neteller

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

* 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.

Figure: Purchase by using Payment Page

Figure: Purchase by using Gate

Figure: Payout by using Gate

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.

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=="
}

{
   "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 Callbacks.

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

{
    "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.

{
    "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:

• Interaction concepts—about the interaction with the payment platform by using Payment Page.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
• One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.

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.

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"
  }
}

{
  "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

  "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 Callbacks.

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

{
    "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.

{
    "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:

• Interaction concepts—about the interaction with the payment platform by using Gate.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
• One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.

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.

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"
   }

  "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 Callbacks.

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

{
    "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.

{
    "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:

• Interaction concepts—about the interaction with the payment platform by using Gate.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
• Payouts—about processing of payouts by using Gate.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.

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

To 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.