Crypto

Introduction

Crypto is a payment method which allows you to process payments in euros and US dollars by using cryptocurrency wallets in different countries. This method supports purchases and payouts.

This article provides information about working with the Crypto 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 additional information.

Interaction diagram

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

Operations support

Various platform interfaces can be used to process payments and perform operations using the Crypto method. Purchases can be processed by using Payment Page and Dashboard (using payment links), payouts—by using Gate. At the same time, regardless of the interfaces used, the following properties and limitations are applicable.

When working with the Crypto the following properties and limitations are applicable.

Processing scenarios

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

Figure: Purchase by using Payment Page

Figure: Payout by using Gate

General information

To process a purchase through Payment Page by using the Crypto 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 Crypto 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 sending purchase requests by using the Crypto 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 may be necessary to specify the following parameters on Payment Page. Refer to your ecommpay key account manager for more information on the necessity of using these parameters.
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • customer_email—customer email
   • customer_country—customer country code in the ISO 3166-1 alpha-2 format
   • customer_day_of_birth—customer date of birth in the DD-MM-YYYY format

   If any of these parameters are missing, the payment form may display input fields 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 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.
5. 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 processed or declined payment the payment platform sends an email with the payment result information to that address.
6. If required, you can also add any other additional parameters Payment Page supports.
7. Additionally, any other parameters available for working with Payment Page can be used (details).
8. After all target parameters are specified, generate a signature (details).

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

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "EUR",
   "customer_id": "customer1",
   "customer_first_name": "Mary",
   "customer_last_name": "Smith",
   "customer_email": "customer@example.com",
   "customer_country": "TR",
   "customer_day_of_birth": "12-12-1990',
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "EUR",
   "customer_id": "customer1",
   "customer_first_name": "Mary",
   "customer_last_name": "Smith",
   "customer_email": "customer@example.com",
   "customer_country": "TR",
   "customer_day_of_birth": "12-12-1990',
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

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 with information about a 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"
        },
         "crypto": {
            "exchange_rate": "32378.76267999",
            "address": "emulateBTCaddrjooterthas42ro87b0z",
            "blockchain_url": "https://api.example.com/c4ba632a094c078",
            "crypto_currency": "BTC"
            },
        "signature": "V0zYWk7Oz0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
}

The following is the example of a callback with information about 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": "V0zYWk7OzwfcMBAhpkuXFNqHjYGMdfhycMw=="
}

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 payout through Gate by using the Crypto 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 Crypto 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 Crypto method:

1. To initiate each payout send a separate POST request to the /v2/payment/crypto/payout endpoint.
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
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email
     • country—customer country code 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. Additionally, any other parameters included in the specification can be used.

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

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

{
  "general": {
    "project_id": 398,
    "payment_id": "115",
    "signature": "cMlzFj8zqZJbum1wy62aewWX7xcG+Ttb0fhuenWNptFZg=="
  },
  "payment": {
    "amount": 5000,
    "currency": "EUR"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0",
    "first_name": "Mary",
    "last_name": "Smith",
    "email": "customer@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 with information about a 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": "sale",
            "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": "V0zYWk7OzwfcMBAJJxArOjYGMdfhycMw=="
}

The following is the example of a callback with information about a declined payout.

{
        "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": "V0zYWk7OzwfcMBApkuXFNqHjYGMdfhycMw=="
}

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.