Crypto

General information

* 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

* 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 the customer to the provider's service, while to initiate a payout, you need to notify the customer by using the merchant's web service.

Figure: Purchase by using Payment Page

Figure: Payout by using Gate

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 methods. The full sequence and particularities of the purchase process are provided below.

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—Submission of additional payment information.

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. In some cases (depending on the payment processing provider), if the request contains the email address of the customer in the customer_email parameter, then after a successful or declined payment the payment platform sends an email with the payment result information to that address.
5. If required, you can also add any other additional parameters Payment Page supports.
6. 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 Parameters for opening payment form.

Callback format

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

In some cases (depending on the payment processing provider), a callback notifying about a successful purchase can contain additional payment information in the following parameters in the crypto object:

• blockchain_url—a link to a third party service for tracking payment information
• exchange_rate—the exchange rate the cryptocurrency to the fiat currency, which is used for payment processing
• address—a crypto address which is used by the customer for purchase processing
• crypto_currency—cryptocurrency symbol, which is used for payment processing

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

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

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

• Interaction concepts
• Signature generation and verification
• Payment models and statuses
• Information of operations performing

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.

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

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, BCH, USDT, ETH (for information about supported cryptocurrencies, refer to your ecommpay key account manager).
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:

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

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

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

• Interaction concepts
• Signature generation and verification
• Payment models and statuses
• Information of operations performing

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.