EcoPayz

Overview

EcoPayz is a payment method that allows customers to perform purchases by using e-wallets and to make payouts to customers. Purchases are performed by using Payment Page and Gate, payouts by using Gate.

General information

Payment method type digital wallet payments
Payment instruments digital wallets
Countries and regions all countries
Payment currencies ARS, AUD, BGN, BRL, CAD, CHF, CLP, CNY, CZK, DKK, EUR, GBP, HUF, HKD, ILS, JPY, MXN, NOK, PEN, PLN, RUB, RON, SGD, SEK, THB, TRY, USD, ZAR
Currency conversion –
Purchases +
Payouts +
Stored credentials payments –
Full refunds –
Partial refunds –
Chargebacks –
Notes –
Onboarding and access fee Refer to your key account manager ecommpay

Interaction diagram

Payment processing through the EcoPayz payment method requires merchant's web service, one of the interfaces and the payment platform of ecommpay, as well as EcoPayz technical facilities.



Operations support

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

Processing scenarios

In the EcoPayz method, to perform a purchase operation, you need to redirect a customer to the EcoPayz service, while a payout is performed with the notification to a customer via web service.

Figure: Purchase by using Payment Page procedure



Figure: Purchase by using Gate procedure



Figure: Payout by using Gate procedure

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

Purchase by using Payment Page

General information

In the EcoPayz method, to perform 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 EcoPayz 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 sequence by using Payment Page

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

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the EcoPayz 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 EcoPayz method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • customer_id—the unique ID of the customer within your project
    • 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. The currency of payment can be any from the list in General information
  3. To preselect EcoPayz as the payment method on Payment Page for customers, pass the code ecopayz in the force_payment_method parameter in the request for opening.
  4. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available in the EcoPayz method, see Parameters for opening payment form.
  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 EcoPayz method must include project, customer and payment IDs, the currency and the amount of a payment, the email address and phone number of a customer, as shown in the following example:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 2000, 
      payment_currency: 'EUR', 
      project_id: 190,     
      customer_id: 'johna@gmail.com',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvht...=="
    }
)

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

Callback format

The EcoPayz 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 150.00 EUR purchase made by the customer in the 477 project.

Figure: Example of a successful purchase callback

 {
        "project_id": 477,
        "customer": {
            "id": "play6"
        },
        "payment": {
            "id": "3557",
            "type": "purchase",
            "status": "success",
            "date": "2019-12-03T15:27:15+0000",
            "method": "ecopayz",
            "sum": {
                "amount": 15000,
                "currency": "EUR"
            },
            "description": ""
        },
        "account": {
            "number": "1101022542"
        },
        "operation": {
            "id": 50103322,
            "type": "sale",
            "status": "success",
            "date": "2019-12-03T15:27:15+0000",
            "created_date": "2019-12-03T15:26:50+0000",
            "request_id": "864-05015151",
            "sum_initial": {
                "amount": 15000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 15000,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "description": "SUCCESS",
            "provider": {
                "id": 1098,
                "payment_id": "2724010000024105183",
                "result_code": "0",
                "result_message": "OK",
                "auth_code": "",
                "date": "2019-12-03T15:27:05+0000"
            }
        },
        "signature": "Q+q/QKT+tWAdE5RouiVrVADFMK2APdLB3WPJt5G7Cokgzqxvh...=="
    }

The following is the example of a callback for a purchase declined due to the customer has not complete the payment on the service side.

Figure: Example of a declined purchase callback

"project_id": 477,
        "customer": {
            "id": "play7"
        },
        "payment": {
            "id": "30036",
            "type": "purchase",
            "status": "decline",
            "date": "2019-12-03T15:57:36+0000",
            "method": "ecopayz",
            "sum": {
                "amount": 2000,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 50223232,
            "type": "sale",
            "status": "decline",
            "date": "2019-12-03T15:57:36+0000",
            "created_date": "2019-12-03T15:22:34+0000",
            "request_id": "5022458",
            "sum_initial": {
                "amount": 2000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 2000,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "description": "Alt PSP. Operation was declined for an unknown reason",
            "provider": {
                "id": 1098,
                "payment_id": "",
                "result_code": "",
                "result_message": "User has not returned from PS",
                "auth_code": ""
            }
        },
        "signature": "5r1P9Gs3kuSyMDu4rvD7fBTp1NROtvjdotLGY8cTCNyA9/r...=="
    }

Related topics

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

Purchase by using Gate

General information

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

  1. Send a request with all the required parameters and signature to the ecommpay URL.
  2. Perform redirecting customer to the EcoPayz service.
  3. Get the callback with the payment result from the payment platform.

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

Figure: Purchase sequence by using Gate

  1. A customer initiates a purchase through EcoPayz 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 EcoPayz service.
  7. The request is processed on the EcoPayz side.
  8. The EcoPayz service sends the data for redirecting the customer to the EcoPayz service to the payment platform.
  9. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the EcoPayz service.
  11. The customer completes all the payment steps required.
  12. The payment is processed on the EcoPayz side.
  13. The result is displayed to the customer.
  14. The customer is redirected to the merchant's web service.
  15. The EcoPayz service sends the payment result notification to the payment platform.
  16. The ecommpay payment platform sends a callback to the web service.
  17. The customer receives the payment result on the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the EcoPayz payment method and provide the information about formats of the data for redirecting customers and the information about the format of callbacks with payment results. The general information about working with API see in the API Description section.

Request format

There are several things you must consider when using purchase requests in the EcoPayz method:
  1. You perform purchase by sending the request to /v2/payment/ecopayz/sale by using POST (HTTP) method.
  2. The following objects and parameters must be specified in the request:
    • Object general—general purchase 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—the unique ID of the customer within your project
      • ip_address—IP address
    • Object payment—purchase information:
      • amount—purchase amount in minor currency units
      • currency—purchase currency in the ISO-4217 alpha-3 format
    • Object return_url—URL for redirecting a customer from the EcoPayz website:
      • success—URL for redirecting a customer after a performed purchase
      • decline —URL for redirecting a customer after a declined purchase
  3. The currency of payment can be any from the list in General information
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request through the EcoPayz method must include project, payment and customer IDs, customer IP-address and identifier, signature, currency and amount of the purchase, and the return URLs, as shown in the following example:

Figure: Purchase request example

{
    "general": {
      "project_id": 417,
      "payment_id": "payment_123",
      "signature": "PJkV8ejrtyUG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 15000,
      "currency": "EUR"
    },
    "customer": {
      "ip_address": "66.249.79.102",
      "id": "play7"
    },
    "return_url":{
      "decline" : "http://return.url",
      "success" : "http://return.url"
    }
}

Formats of the customer redirection data

To redirect a customer from the web service to the EcoPayz 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": {
                "PaymentPageID": "2724",
                "MerchantAccountNumber": "114276",
                "CustomerIdAtMerchant": "playamo_36156",
                "OnSuccessUrl": "https://play.com/process/complete-redirect/qhebui1o7tnnpia5fcvmgajf42/8288bb7d136c3fd4",
                "OnFailureUrl": "https://play.com/process/complete-redirect/qhebui1o7tnnpia5fcvmgajf42/8288bb7d136c3fd4",
                "Amount": "150.00",
                "TxID": 5015150000003322,
                "Currency": "EUR",
                "TransferUrl": "https://ecoPayz/callback/",
                "CallbackUrl": "https://ecoPayz/callback/",
                "Checksum": "80b055794aa13572d77dcd3107a411a4"
            },
            "method": "POST",
            "url": "https://secure.ecopayz.com/PrivateArea/WithdrawOnlineTransfer.aspx"
    }

Callback format

The EcoPayz 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 150.00 EUR purchase made by the customer in the 477 project.

Figure: Example of a successful purchase callback

 {
        "project_id": 477,
        "customer": {
            "id": "play6"
        },
        "payment": {
            "id": "3557",
            "type": "purchase",
            "status": "success",
            "date": "2019-12-03T15:27:15+0000",
            "method": "ecopayz",
            "sum": {
                "amount": 15000,
                "currency": "EUR"
            },
            "description": ""
        },
        "account": {
            "number": "1101022542"
        },
        "operation": {
            "id": 50103322,
            "type": "sale",
            "status": "success",
            "date": "2019-12-03T15:27:15+0000",
            "created_date": "2019-12-03T15:26:50+0000",
            "request_id": "864-05015151",
            "sum_initial": {
                "amount": 15000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 15000,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "description": "SUCCESS",
            "provider": {
                "id": 1098,
                "payment_id": "2724010000024105183",
                "result_code": "0",
                "result_message": "OK",
                "auth_code": "",
                "date": "2019-12-03T15:27:05+0000"
            }
        },
        "signature": "Q+q/QKT+tWAdE5RouiVrVADFMK2APdLB3WPJt5G7Cokgzqxvh...=="
    }

The following is the example of a callback for a purchase declined due to the customer has not complete the payment on the service side.

Figure: Example of a declined purchase callback

"project_id": 477,
        "customer": {
            "id": "play7"
        },
        "payment": {
            "id": "30036",
            "type": "purchase",
            "status": "decline",
            "date": "2019-12-03T15:57:36+0000",
            "method": "ecopayz",
            "sum": {
                "amount": 2000,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 50223232,
            "type": "sale",
            "status": "decline",
            "date": "2019-12-03T15:57:36+0000",
            "created_date": "2019-12-03T15:22:34+0000",
            "request_id": "5022458",
            "sum_initial": {
                "amount": 2000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 2000,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "description": "Alt PSP. Operation was declined for an unknown reason",
            "provider": {
                "id": 1098,
                "payment_id": "",
                "result_code": "",
                "result_message": "User has not returned from PS",
                "auth_code": ""
            }
        },
        "signature": "5r1P9Gs3kuSyMDu4rvD7fBTp1NROtvjdotLGY8cTCNyA9/r...=="
    }

Related topics

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

Payout by using Gate

General information

To perform a payout through the EcoPayz 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 sequence by using Gate

  1. A customer orders a payout through the EcoPayz system.
  2. Merchant's web service sends the payout request for processing the payout 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 check 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 EcoPayz service.
  7. The payout is processed on the EcoPayz side.
  8. EcoPayz 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 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 EcoPayz payment method and provide the information on the format of callbacks with payout results. The general information about working with API see in the API Description section.

Request format

There are several things you must consider when using payout requests in the EcoPayz method:
  1. You perform payouts by sending the request to /v2/payment/ecopayz/payout by using POST (HTTP) method.
  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—IP address
    • Object account—customer account information:
      • number—account number
    • Object payment—payout information:
      • amount—payout amount in minor currency units
      • currency—payout currency in the ISO-4217 alpha-3 format
  3. The currency of payment can be any from the list in General information
  4. If required, you can also add any other additional parameters Gate supports.

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

Figure: Example of a payout request 

{
  "general": {
    "project_id": 603,
    "payment_id": "10000007",
    "signature": "PJkV8ej\/UG0Di8hTncV+VHq3LwY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
  },
 "account":{
    "number": "1101611729",
 },
 "customer": {
    "id":"cas_65", 
    "ip_address": "248.121.176.220"
  },
  "payment": {
    "amount": 120000,
    "currency": "EUR"
  }
}

Callback format

The EcoPayz 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 1,200.00 EUR payout made for the customer account 1101611729 in the 523 project.

Figure: Example of a successful payout callback

 "project_id": 523,
        "payment": {
            "id": "556",
            "type": "payout",
            "status": "success",
            "date": "2019-12-03T11:57:06+0000",
            "method": "ecopayz",
            "sum": {
                "amount": 120000,
                "currency": "EUR"
            },
            "description": ""
        },
        "account": {
            "number": "1101611729"
        },
        "customer": {
            "id": "cas_65"
        },
        "operation": {
            "id": 50032003322,
            "type": "payout",
            "status": "success",
            "date": "2019-12-03T11:57:06+0000",
            "created_date": "2019-12-03T11:57:05+0000",
            "request_id": "a7e2cc393d1d2",
            "sum_initial": {
                "amount": 120000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 120000,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1098,
                "payment_id": "2724010000024102813",
                "auth_code": "",
                "date": "2019-12-03T11:57:06+0000"
            }
        },
        "signature": "4NlsgAH36yr22zvLn7VlgBKVgfOeb2sXL1t6/C02qHXmQtwjw...=="
    }

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

Figure: Example of a declined payout callback

{  
    "project_id": 1138,
        "payment": {
            "id": "46529",
            "type": "payout",
            "status": "decline",
            "date": "2019-11-25T11:20:42+0000",
            "method": "ecopayz",
            "sum": {
                "amount": 38000,
                "currency": "EUR"
            },
            "description": ""
        },
        "account": {
            "number": "1101776447"
        },
        "customer": {
            "id": "732323"
        },
        "operation": {
            "id": 2100361,
            "type": "payout",
            "status": "decline",
            "date": "2019-11-25T11:20:42+0000",
            "created_date": "2019-11-25T11:20:41+0000",
            "request_id": "6237a2e3434",
            "sum_initial": {
                "amount": 38000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 38000,
                "currency": "EUR"
            },
            "code": "20504",
            "message": "Insufficient funds on acquirer balance",
            "provider": {
                "id": 1098,
                "payment_id": "3942010000024009555",
                "auth_code": "",
                "date": "2019-11-25T11:20:42+0000"
            }
        },
        "signature": "7AtqMilLl019C2Oew3OQBQIJhaDPSCUeM41q7Zc6aB...=="
    }

Related topics

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

Testing

General information

For the EcoPayz method the testing of purchases by using Payment Page and Gate, as well as payouts by using Gate.

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, and the interfaces of the payment forms emulator of Payment Page and EcoPayz 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:

  1. Send a correct test request for Payment Page opening to the payment platform.
  2. If the ecopayz method was not specified in the request—select the method on the emulator page.
  3. Click the Success or Decline button (depending on the amount specified in the request).
  4. Accept a callback with information about the payment result.

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

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. Accept a callback with information about the payment result.

The full information about purchase process by using EcoPayz through Gate is provided in the section Purchase 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 EcoPayz through Gate is provided in the section Payout by using Gate.

Analysis of payments results

As with other payment methods ecommpay offers, when using the EcoPayz 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.