Crypto

Overview

Crypto is a payment method that allows customers to perform payments by using e-wallets that support cryptocurrencies (cryptocurrency wallets). Purchases through this method are available by using Payment Page and Gate, payouts by using Gate.

General information

Payment method type payments by using e-wallets that support cyptocurencies
Countries and regions all countries, except DZ, BO, EC, NP, PK, KH, IR, KP *
Payment currencies EUR, GBP, RUB, USD
Currency conversion on the ECommPay side *
Purchases +
Payouts +
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes
  • supported cryptocurrencies: Bitcoin (BTC), Bictoin Cash (BCH), Dogecoin (DOGE), Litecoin (LTC), #MetaHash (MHC), Ripple (XRP), SounDAC (XSD), Tether (USDT) *
Onboarding and access fee refer to your ECommPay key account manager

* Refer to your ECommPay key account manager for additional information.

Interaction diagram

Payment processing by using the Crypto payment method requires merchant's web service, one of ECommPay interfaces, the ECommPay payment platform, as well as the Crypto service.



Operations support

  Interfaces Amounts Times **
Payment Page CMS Plugins Gate Dashboard (Old Dashboard) minimum maximum basic threshold
Purchases + + * * * *
Payouts + 45.00 EUR

* Refer to your ECommPay key account manager for additional information

** The basic and threshold times are defined as follows:

  • The basic time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
  • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ECommPay technical support.

Processing scenarios

In the Crypto method, purchases and payouts follow different processing procedures. To perform a purchase operation, you need to redirect customer to the provider's service, while to initiate a payout, you need to notify customer by using the merchant's 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 Crypto 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 Crypto method selected. For more information about preselecting payment methods, see in Preselecting payment method. The full sequence and particularities of the purchase process are provided below.



Figure: Purchase sequence when using Payment Page

  1. Customer initiates a purchase by using the web service.
  2. The merchant web service sends to the specified ECommPay URL the purchase request for processing the purchase by using Payment Page.
  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 Crypto 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 provider's service.
  10. The purchase request is processed on the provider's service side.
  11. The provider's 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 provider's website.
  14. The customer completes all the required payment steps. The required steps differ depending on the provider which processes the payment. Refer to your ECommPay key account manager for more information.
  15. The payment is processed on the provider's side.
  16. The result is displayed to the customer on the provider's website.
  17. The customer is redirected to Payment Page.
  18. The provider's 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 Crypto 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 Crypto 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 following customer data needs to be specified on Payment Page. Refer to your ECommPay key account manager for more information on the necessity of using theses parameters.
    • customer_first_name—first name
    • customer_last_name—last name
    • customer_email—email
    • customer_country—country in the ISO 3166-1 alpha-2 format
    • customer_day_of_birth—date of birth in the DD-MM-YYYY format

    If at least one of these parameters needs to be specified and was not included in the request, the payment platform requires additional data and the corresponding procedure is used—Additional payment information submission.

  3. If you need to have payment form displayed with the Crypto method selected, set the force_payment_method parameter to crypto. Also, depending on the provider processing the payment, it is possible to preselect the cryptocurrency while preselecting the payment method by specifying the cryptocurrency code (ticker symbol) in the payment_methods_options parameter. As a consequence the customer is not able to switch to another cryptocurrency when making the purchase. The value of the parameter must be specified according to the following format—{"currency_id":["..."]}, where ... is the code (ticker symbol) of the cryptocurrency. Example of a valid value—{"currency_id":["BTC"]}. Refer to your ECommPay key account manager for information regarding the possibility of preselecting cryptocurrency.
  4. If required, you can also add any other additional parameters Payment Page supports.
  5. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the Crypto method must include project, customer and payment IDs, the currency and the amount of a payment, as well as customer data and signature, as shown in the following example:

project_id: '398',
      payment_id: '115', 
      payment_currency: 'EUR',
      payment_amount: 1500,
      customer_id: '123',
      customer_first_name: 'Mary',
      customer_last_name: 'Smith',
      customer_email: 'smith@example.com',
      customer_country: 'TR',
      customer_day_of_birth": '12-12-1990',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\
                         /RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="

For information about all parameters available in the Crypto method, see Payment Page invocation parameters.

Callback format

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

The following is the example of a callback containing information about successful 15.00 EUR purchase made in the 398 project.

Figure: Example of a successful purchase callback

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "method": "crypto",
            "sum": {
                "amount": 1500,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002814,
            "type": "sale",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 1500,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1500,
                "currency": "EUR"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148947",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

The following is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "method": "crypto",
            "sum": {
                "amount": 500,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002815,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 500,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 500,
                "currency": "EUR"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148948",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

Related topics

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

Purchases by using Gate

General information

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

  1. Send a request with all the required parameters and signature to the ECommPay URL.
  2. Perform the redirection of a customer to the provider's 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 when using Gate

  1. A customer initiates a purchase on the merchant web service by using the Crypto method.
  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 provider's service.
  7. The request is processed on the provider's side.
  8. The provider's service sends the data for redirecting the customer to the provider's 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 provider's service.
  11. The customer completes all the required payment steps.
  12. The payment is processed on the provider's side.
  13. The result is displayed to the customer.
  14. The customer is redirected to the merchant's web service.
  15. The provider's service sends the payment result notification to the payment platform.
  16. The 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 Crypto 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 Crypto method:
  1. You send purchase requests by sending the request to /v2/payment/crypto/sale by using POST (HTTP) method.
  2. 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—purchase information:
      • amount—purchase amount in minor units
      • currency—payment currency in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—the unique ID of the customer within your project
      • ip_address—IP address
      • first_name—first name
      • last_name—last name
      • email—email
      • country—country in the ISO 3166-1 alpha-2 format
      • day_of_birth—date of birth in the DD-MM-YYYY format
    • Object return_url—the URLs to which the customer is redirected during or after the payment process:
      • success—after a successfully completed payment
      • decline—after a declined payment
  3. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Crypto method must include project, customer and payment IDs, signature, amount and currency of the purchase, customer data and URLs for customer redirection, as shown in the following example:

Figure: Example of a purchase request

{
  "general": {
    "project_id": 398,
    "payment_id": "115",
    "signature": "cMlzFj8zqZJbum1wysO3wE0qLdboEYQAteO62aewWX7xcG+Ttb0fhuenWNptFZg=="
  },
  "payment": {
    "amount": 1000,
    "currency": "EUR"
  },
  "customer": {
    "id": "123",
    "ip_address": "1.1.1.1",
    "first_name": "Mary",
    "last_name": "Smith",
    "email": "smith@example.com",
    "country": "TR",
    "day_of_birth": "12-12-1990"
  },
    "return_url": {
      "success": "http://example.com/success",
      "decline": "http://example.com/decline"
    }
}

Formats of the customer redirection data

To redirect a customer from the web service to the Crypto 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://checkout.bestpaycard.com/example"
		}

Callback format

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

The following is the example of a callback containing information about successful 10.00 EUR purchase made in the 398 project.

Figure: Example of a successful purchase callback

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "method": "crypto",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002814,
            "type": "sale",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148947",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

The following is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "method": "crypto",
            "sum": {
                "amount": 500,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002815,
            "type": "sale",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 500,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 500,
                "currency": "EUR"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148948",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

Related topics

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

Payouts by using Gate

General information

To perform a payout through the Crypto 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 when using Gate

  1. A customer initiates a payout.
  2. Merchant's web service sends the request for the payout processing by using Gate to the appropriate ECommPay URL.
  3. The payment platform receives the request for processing the payout by using Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends to the web service response with request receipt confirmation and correctness check result. For more information, see Response format.
  6. The payment platform redirects the payout request to the provider's service.
  7. The payout is processed on the provider's side.
  8. The provider's service sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. The customer receives the notification about the payout result from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Crypto 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 Crypto method:
  1. You send payout requests by sending the request to /v2/payment/crypto/payout by using POST (HTTP) method.
  2. 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 in minor units
      • currency—payment currency in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • ip_address—IP address
      • first_name—first name
      • last_name—last name
      • email—email
      • country—country in the ISO 3166-1 alpha-2 format
    • Object account—customer account data:
      • wallet_address—cryptocurrency wallet address
      • crypto_currency—symbol of the cryptocurrency supported by the wallet, e.g. BTC, ETH, DOGE.
  3. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Crypto method must include project and payment IDs, signature, amount and currency of the payout, customer and account data, as shown in the following example:

Figure: Example of a payout request

{
  "general": {
    "project_id": 398,
    "payment_id": "115",
    "signature": "cMlzFj8zqZJbum1wysO3wE0qLdboEYQAteO62aewWX7xcG+Ttb0fhuenWNptFZg=="
  },
  "payment": {
    "amount": 5000,
    "currency": "EUR"
  },
  "customer": {
    "ip_address": "1.1.1.1",
    "first_name": "Mary",
    "last_name": "Smith",
    "email": "smith@example.com",
    "country": "TR"
  },
    "account": {
      "wallet_address": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
      "crypto_currency": "BTC"
    }
}

Callback format

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

The following is the example of a callback containing information about successful 50.00 EUR payout made in the 398 project.

Figure: Example of a successful payout callback

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "payout",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "method": "crypto",
            "sum": {
                "amount": 5000,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002814,
            "type": "payout",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 5000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 5000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148947",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

The following is the example of a callback for a payout declined due to amount or frequency limitation.

Figure: Example of a declined payout callback

{
        "project_id": 398,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "payout",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "method": "crypto",
            "sum": {
                "amount": 4000,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002815,
            "type": "payout",
            "status": "decline",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 4000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 4000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1288,
                "payment_id": "148948",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit"
        },
        "signature": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

Related topics

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

Analysis of payments results

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