ATF24

Overview

ATF24 is a payment method that uses the online banking mechanism for payments performing. Purchases are performed through this method by using Payment Page and 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 Payment must be completed by a customer within 7 days after receipt of the redirection link
Onboarding and access fee Refer to your ECommPay key account manager

Interaction diagram

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



Operations support

  Interfaces Amounts
Payment Page CMS Plug-ins Gate Dashboard Minimum Maximum
Purchases + + 5.00 KZT

Processing scenarios

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

Figure: Purchase by using Payment Page procedure



Figure: Purchase by using Gate 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 ATF24 method, to perform 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 either allow your customer to select the ATF24 methods from the list of other payment methods on Payment Page or have Payment Page opened with the ATF24 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 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 ATF24 payment method.
  8. The page for phone number entering is displayed to the customer on Payment Page.
  9. The customer enters the phone number.
  10. The payment platform receives the purchase request for payment by using the ATF24 method.
  11. The payment platform performs the internal purchase request processing and sends it to the ATF24 service.
  12. The purchase request is processed on the ATF24 service side.
  13. The ATF24 service generates the data for redirecting the customer to its website form and sends it to the payment platform.
  14. The payment platform sends the customer redirection data to Payment Page.
  15. The customer is redirected to the ATF24 service. The customer must complete the payment within 7 days after receipt of the redirection link.
  16. The customer completes all the payment steps required.
  17. The payment is processed on the ATF24 side.
  18. The result is displayed to the customer.
  19. The customer is redirected to Payment Page.
  20. The ATF24 service sends the result notification to the payment platform.
  21. The payment platform sends a callback with the payment result to the web service.
  22. The payment platform sends the result to Payment Page.
  23. A page with the payment result information is displayed to the customer on Payment Page.

The sections that follow provide details the request format and the Payment Page parameters to use in the ATF24 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 must consider when performing a purchase through the ATF24 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 the payment can be EUR, KZT, RUB, USD.
  3. To preselect ATF24 as the payment method on Payment Page for customers, pass the code atf24 in the force_payment_method parameter in the request for opening.
  4. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available in the ATF24 method, see Payment Page invocation parameters.
  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 through the ATF24 method must include project, customer and payment IDs, signature, currency and amount of the purchase, as shown in the following example:

EPayWidget.run(
    { customer_id: '123',
      project_id: 198, 
      payment_id: 'X03936',
      payment_amount: 10000, 
      payment_currency: 'KZT,
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySODJr...=="
    }
)

Callback format

In the ATF24 method, the callbacks that deliver purchase results use the standard format described in Callbacks.

The following is the example of a callback with an information about successful 30,000.00 KZT purchase made by the 1 customer in the 198 project.

Figure: Example of a succeed purchase callback

"callbackBody": {
        "customer": {
            "id": "1",
            "phone": "79017525555"
        },
        "payment": {
            "date": "2019-09-11T16:46:26+0000",
            "id": "0660fb72c46f852c71b70fb4f4ccb58d",
            "method": "atf24",
            "status": "success",
            "sum": {
                "amount": 30000,
                "currency": "KZT"
            },
            "type": "purchase",
            "description": "deposit"
        },
        "project_id": 198,
        "phone": "79017525555",
        "operation": {
            "id": 8000002523,
            "type": "sale",
            "status": "success",
            "date": "2019-09-11T16:46:26+0000",
            "created_date": "2019-09-11T16:42:10+0000",
            "request_id": "6d496bb819538",
            "sum_initial": {
                "amount": 30000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 30000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1115,
                "payment_id": "74521463",
                "date": "2019-09-11T22:45:02+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "oSqSPD2HxeRlnHzNILQONMto4Kik9geDXneREGA+e9p+1...=="
    }

The following is the example of a callback for a purchase rejected due to the time out.

Figure: Example of a declined purchase callback

 "callbackBody": {
        "project_id": 532,
        "payment": {
            "id": "2123292",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-10T11:59:17+0000",
            "method": "atf24",
            "sum": {
                "amount": 500000,
                "currency": "KZT"
            },
            "description": ""
        },
        "customer": {
            "id": "1",
            "phone": "79017525555"
        },
        "operation": {
            "id": 49705000001895,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-10T11:59:17+0000",
            "created_date": "2019-09-03T11:49:14+0000",
            "request_id": "a05a1b72966a05a8226b68fadea",
            "sum_initial": {
                "amount": 500000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 500000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1115,
                "payment_id": "70953275",
                "auth_code": ""
            },
            "code": "20602",
            "message": "Time-out"
        },
        "signature": "+acXy66J1d7wLCbHHJv7DyPFF5i8f1jb4bWtub...=="
    }

Related topics

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

Purchase by using Gate

General information

In the ATF24 methods, 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 redirecting customer to the ATF24 side.
  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 by using Gate

  1. A customer initiates a purchase through one of the ATF24 group banks on the merchant's web service side.
  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 ATF24 service.
  7. The request is processed on the ATF24 side.
  8. The bank service sends the data for redirecting the customer to the selected bank website to the payment platform.
  9. The payment platform sends the callback with the redirection data to the web service.
  10. The customer is redirected from the web service to the ATF24 service. The customer must complete the payment within 7 days after receipt of the redirection link.
  11. The customer completes all the payment steps required.
  12. The payment is processed on the ATF24 side.
  13. The result is displayed to the customer in the ATF24 service.
  14. The customer is redirected to the merchant's web service.
  15. The ATF24 service sends the payment result notification to the payment platform.
  16. The ECommPay 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 ATF24 payment method and provide the information about formats of the data for redirecting customers and the information about the format of callbacks with payment results. The general information about working with API see in the API Description section.

Request format

There are several things you must consider when using purchase requests in the ATF24 method:
  1. You perform purchase by sending the /v2/payment/online-banking/atf24/sale request by using POST (HTTP) method. This is an online banking request group: /v2/payment/online-banking/{payment_method}/sale
  2. The following objects and parameters must be specified in the request:
    • Object general—general purchase 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—the unique ID of the customer within your project
      • ip_address—IP address
      • phone—phone number
    • Object payment—purchase information:
      • amount—purchase amount in minor units
      • currency—purchase currency in ISO-4217 alpha-3 format
  3. The currency of the payment can be EUR, KZT, RUB, USD.
  4. If required, you can also add any other additional parameters Gate supports.

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

Figure: Purchase request example

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

Formats of the customer redirection data

To redirect a customer from the web service to the ATF24 service, 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: lifetime–time in seconds when the payment should be completed, id–payment identifier on the ATF24 service side, and use these parameters when opening the bank's 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": {
                        "lifetime": 604800,
                        "id": 77722445
                    },
                    "method": "GET",
                    "url": "https://homebank.kz/Authorize/Login"
                }

Callback format

In the ATF24 method, the callbacks that deliver purchase results use the standard format described in Callbacks.

The following is the example of a callback with an information about successful 30,000.00 KZT purchase made by the 1 customer in the 198 project.

Figure: Example of a succeed purchase callback

"callbackBody": {
        "customer": {
            "id": "1",
            "phone": "79017525555"
        },
        "payment": {
            "date": "2019-09-11T16:46:26+0000",
            "id": "0660fb72c46f852c71b70fb4f4ccb58d",
            "method": "atf24",
            "status": "success",
            "sum": {
                "amount": 30000,
                "currency": "KZT"
            },
            "type": "purchase",
            "description": "deposit"
        },
        "project_id": 198,
        "phone": "79017525555",
        "operation": {
            "id": 8000002523,
            "type": "sale",
            "status": "success",
            "date": "2019-09-11T16:46:26+0000",
            "created_date": "2019-09-11T16:42:10+0000",
            "request_id": "6d496bb819538",
            "sum_initial": {
                "amount": 30000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 30000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1115,
                "payment_id": "74521463",
                "date": "2019-09-11T22:45:02+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "oSqSPD2HxeRlnHzNILQONMto4Kik9geDXneREGA+e9p+1...=="
    }

The following is the example of a callback for a purchase rejected due to the time out.

Figure: Example of a declined purchase callback

 "callbackBody": {
        "project_id": 532,
        "payment": {
            "id": "2123292",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-10T11:59:17+0000",
            "method": "atf24",
            "sum": {
                "amount": 500000,
                "currency": "KZT"
            },
            "description": ""
        },
        "customer": {
            "id": "1",
            "phone": "79017525555"
        },
        "operation": {
            "id": 49705000001895,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-10T11:59:17+0000",
            "created_date": "2019-09-03T11:49:14+0000",
            "request_id": "a05a1b72966a05a8226b68fadea",
            "sum_initial": {
                "amount": 500000,
                "currency": "KZT"
            },
            "sum_converted": {
                "amount": 500000,
                "currency": "KZT"
            },
            "provider": {
                "id": 1115,
                "payment_id": "70953275",
                "auth_code": ""
            },
            "code": "20602",
            "message": "Time-out"
        },
        "signature": "+acXy66J1d7wLCbHHJv7DyPFF5i8f1jb4bWtub...=="
    }

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