HomeBank

Overview

HomeBank is a payment method that uses the online banking mechanism for payments performing. Payouts are performed through this method by using Gate.

General information

Payment method type Online banking
Countries and regions Kazakhstan
Payment currencies EUR, KZT, RUB, USD
Currency conversion On the ECommPay side
Purchases
Payouts +
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes Payouts must be completed by a customer within 24 hours after SMS receiving
Onboarding and access fee Refer to your ECommPay key account manager

Interaction diagram

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

Operations support

  Interfaces Amounts *
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) Minimum Maximum
Payouts +

* If the payout amount is less than 4,000.00 KZT, the amount must be a multiple of 2,000.00 KZT, if the payout amount is more than 4,000.00KZT the amount must be a multiple of 1,000.00 KZT.

Processing scenarios

In the HomeBank method, a payout is performed with the notification of a customer through the web service.

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.

Payout by using Gate

General information

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

  1. A customer orders a payout through the HomeBank system.
  2. Merchant's web service sends the request for the payout processing 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 checks 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 HomeBank service.
  7. The payout is processed on the HomeBank side. The customer can withdraw funds at an ATM within 24 hours after receiving the code via SMS to the specified phone number.
  8. HomeBank 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 HomeBank 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 HomeBank method:
  1. You send payout request by using HTTP method POST to /v2/payment/cash-out-kz/homebank/payout. This is a cash request group /v2/payment/cash-out-kz/{payment_method}/payout.
  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
      • phone—phone number
      • ip_address—customer IP address
    • Object payment—payout information:
      • amount—payout amount in the currency minor units
      • currency—payout currency in the ISO-4217 alpha-3 format.
  3. The currency of the payout can be EUR, KZT, RUB, USD.
  4. If required, you can also add any other additional parameters Gate supports.

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

Figure: Example of a payout request

{
    "general": {
      "project_id": 198,
      "payment_id": payment_id,
      "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipT...=="
    },
    "payment": {
      "amount": 3000000,
      "currency": "KZT"
      },
    "customer": {
      "ip_address": "1.1.1.1",
      "id": "12345",
      "phone": "79017525555"
   }
}

Callback format

The HomeBank 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 2,000.00 KZT payout made to the 444567 customer in the 238 project.

Figure: Example of a successful payout callback

"callbackBody": {
        "project_id": 238,
        "payment": {
            "id": "HomeBankPayout100001",
            "type": "payout",
            "status": "success",
            "date": "2018-09-28T12:04:40+0000",
            "method": "homebank-payout",
            "sum": {
                "amount": 200000,
                "currency": "KZT"
            },
            "description": ""
        },
        "customer": {
            "id": "444567",
            "phone": "7074544579"
        },
        "operation": {
            "id": 4780000001432,
            "type": "payout",
            "status": "success",
            "date": "2018-09-28T12:04:40+0000",
            "created_date": "2018-09-28T06:04:34+0000",
            "request_id": "06a2b8c16cb5b",
            "sum_initial": {
                "amount": 200000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 200000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1112,
                "payment_id": "14177704",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "L4FoMZQuq3sukV4IcSDoJWP9i/yJ3P6h7cwMuugDCZj8Q...=="
    }

The following is the example of a callback for a payout declined due to the time out.

Figure: Example of a declined payout callback

   "callbackBody": {
        "project_id": 238,
        "payment": {
            "id": "HomeBankPayout2222233",
            "type": "payout",
            "status": "decline",
            "date": "2018-09-25T12:11:37+0000",
            "method": "homebank-payout",
            "sum": {
                "amount": 200000,
                "currency": "KZT"
            },
            "description": ""
        },
        "customer": {
            "id": "11122233344425223344",
            "phone": "7074544579"
        },
        "operation": {
            "id": 10628000001371,
            "type": "payout",
            "status": "decline",
            "date": "2018-09-25T12:11:37+0000",
            "created_date": "2018-09-25T06:11:33+0000",
            "request_id": "9641ae50a3df53ddb86239bb94fa7f36cb23f056-621b8db64c752f100b1f9401a08d6e9b25afd321",
            "sum_initial": {
                "amount": 200000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 200000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1112,
                "payment_id": "14095141",
                "auth_code": ""
            },
             "code": "20602",
            "message": "Time-out"
        },
        "signature": "aJXdfMsj2Fpl2jnSoyRVslb8wN34GQh38Z4msJofEiHR4jlQnK16JGF3QyIY5gZMB7ZtXTtvzV6FILiRgQOnHg=="
    }
}

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 HomeBank 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.