Bitcoin

Overview

Bitcoin is a payment method of the Digital Asset Clearing House (DACH) service that allows customers to make payments by using cryptocurrency wallets. Purchases are performed by using Payment Page.

General information

Payment method type Payments by using e-wallets
Countries and regions All countries, except BO, DZ, EC, IR, KH, KP, NP, PK *
Payment currencies EUR, GBP, USD
Currency conversion
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes
Onboarding and access fee Refer to your key account manager ECommPay

* The full list of supported countries you can obtain from your key account manager.

Interaction diagram

Payment processing through the Bitcoin payment method requires merchant's web service, Payment Page and the payment platform of ECommPay, as well as DACH service technical facilities that support payment performing by using Bitcoin payment method.



Operations support

  Interfaces Amounts, USD
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) minimum maximum
Purchases + 1.00 10,000.00

Processing scenario

In the Bitcoin method, to perform a purchase operation, you need to redirect a customer to the DACH service.

Figure: Purchase by using Payment Page 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 Bitcoin 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. 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 Bitcoin method.
  8. The customer redirects to the DACH service from Payment Page.
  9. The customer completes all the payment steps required.
  10. The payment is processed on the DACH service side.
  11. A page with the payment result information is displayed to the customer on DACH service.
  12. The customer is redirected to Payment Page.
  13. The Bitcoin service sends the result notification to the payment platform.
  14. The payment platform sends a callback with the payment result to the web service.
  15. The payment platform sends the result to Payment Page.
  16. 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 Bitcoin 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 Bitcoin 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 only be EUR, GBP, or USD.
  3. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available in the Bitcoin method, see Payment Page invocation parameters.
  4. 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 Bitcoin method must include project and payment IDs, the currency and the amount of a payment, as shown in the following example:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 10000, 
      payment_currency: 'USD', 
      customer_id: '123',
      project_id: 35, 
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

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

Callback format

The Bitcoin 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 100,00 USD purchase made by the steave123 customer in the 1124 project.

Figure: Example of a successful purchase callback

{
    {
        "project_id": 1124,
        "payment": {
            "id": "TEST_155558565670178672",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-19T09:33:11+0000",
            "method": "bitcoin",
            "sum": {
                "amount": 10000,
                "currency": "USD"
            },
            "description": "TEST_1555585656701"
        },
        "customer": {
            "id": "steave123"
        },
        "operation": {
            "id": 36219000001440,
            "type": "sale",
            "status": "success",
            "date": "2019-04-19T09:33:11+0000",
            "created_date": "2019-04-19T09:28:06+0000",
            "request_id": "0a18069c",
            "sum_initial": {
                "amount": 10000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "USD"
            },
            "provider": {
                "id": 1190,
                "payment_id": "CPSe9de88191e984d22a9e7a10e391db982",
                "date": "2019-04-19T09:33:10+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "Dn0mFMViSBxcpHTg3KFq7dtK9TP6216dzVezsHSzLKB8ANc3TXJ/D5iBqotcZhnsTA=="
    }
}

The following is the example of a callback for a purchase declined due to insufficient funds on customer account.

Figure: Example of a declined purchase callback

{
     {
        "project_id": 1124,
        "payment": {
            "id": "TEST_15555856567017867",
            "type": "purchase",
            "status": "decline",
            "date": "2019-04-19T09:15:41+0000",
            "method": "bitcoin",
            "sum": {
                "amount": 500,
                "currency": "USD"
            },
            "description": "TEST_1555585656701"
        },
        "customer": {
            "id": "steave123"
        },
        "provider_extra_fields": {
            "wallet": "3LsvQ7LKeaZRsEL2zh61UhspoS3WrR18ci",
            "total": {
                "currency": "BTC",
                "amount": "97292",
                "display": "0.00097292"
            },
            "rate": {
                "from": {
                    "currency": "BTC",
                    "amount": "100000000",
                    "display": "1.00000000"
                },
                "to": {
                    "currency": "USD",
                    "amount": "513916",
                    "display": "5139.16"
                }
            },
            "input": {
                "currency": "BTC",
                "amount": "97292",
                "display": "0.00097292"
            }
        },
        "operation": {
            "id": 20667000001406,
            "type": "sale",
            "status": "decline",
            "date": "2019-04-19T09:15:41+0000",
            "created_date": "2019-04-19T08:35:27+0000",
            "request_id": "501c91495338b81969",
            "sum_initial": {
                "amount": 500,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 500,
                "currency": "USD"
            },
            "provider": {
                "id": 1190,
                "payment_id": "CPS303f6b1e2f2f471780fe8a4ab7613025",
                "date": "2019-04-19T08:37:10+0000",
                "auth_code": ""
            },
           "code": "20105",
            "message": "Insufficient funds on customer account"
        },
        "signature": "C1Tal4Oxmxa1LSuB+kjSg9F4iVxZR7LXJLgyypoxs9xqh4jAShRQ+omlxgu7/ggcg=="
    }
}

Related topics

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

Analysis of payments results

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