CepBank

Overview

Cepbank is a payment method which to process payments by using bank transfers. Purchases can be processed by using Payment Page and Gate, payouts by using Gate.

General information

Payment method type bank transfers
Countries and regions TR
Payment currencies TRY
Currency conversion on the ECommPay side
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes
  • the purchase amount must be a multiple of 10.00 TRY
  • the payout amount must be a multiple of 50.00 TRY
  • to approve a payment, a customer needs to specify two phone numbers—their own and the recipient's one, both of which are preliminarily specified by the customer by using the chosen bank service. As the recipient's phone number, the customer can use their own second phone number or the number of a third party who can pass or tell the code received from the bank in a SMS. This code is used by the Cepbank representative for withdrawal or deposit of funds by using an ATM
  • purchases must be processed within one hour after customer confirmation (taking into account the working hours of the Cepbank service from 08:00:00 to 01:00:00 (GMT + 3))
Onboarding and access fee refer to your ECommPay key account manager

Interaction diagram

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

Operations support

  Interfaces Amounts, TRY
Payment Page CMS Plug-ins Gate Dashboard minimum maximum
Purchases + + 50.00 1,000.00
Payouts + 10.00 1,000.00

Processing scenarios

When using the Cepbank method, purchases and payouts are processed with the participation of the Cepbank representative.

Figure: Purchase by using Payment Page

Figure: Purchase by using Gate

Figure: Payout by using Gate

Supported banks

Payments through the Cepbank method are carried out through banks that support the work with this method. Banks have their own identifiers, which are used to initiate payouts by using Gate, and to display banks on Payment Page when choosing a payment method. The table below provides information on these banks for informational purposes, it may change without additional notice; for the most recent list of supported banks, contact your ECommPay key account manager.

Table 1. List of supported banks
Bank ID
Akbank 421
Denizbank fastPay 429
Finans Bank 427
Garanti 423
Halk bank 430
Is bankasi 424
ING Bank 425
PTT 428
Vakıfbank 426
YapıKredi 422

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.

Purchases by using Payment Page

General information

In the Cepbank 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 one of the Cepbank 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 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 one of the banks supported by the Cepbank method.
  8. A data input form is displayed on Payment Page. The following customer data must be entered on Payment Page: date of birth, Turkish Identification Number, phone number and the code, which was received from the bank earlier. The customer should also enter the recipient phone number, which can be also belong to the customer, or to a third party, which can communicate the code received from the bank earlier.
  9. The customer enters the date of birth, Turkish Identification Number, their phone number, recipient phone number and the code, received from the bank on Payment Page.
  10. The payment platform receives the purchase request for payment processing by using the Cepbank service.
  11. The payment platform performs the internal purchase request processing and sends it to the Cepbank service.
  12. The purchase request is processed on the Cepbank service.
  13. The Cepbank representative receives the payment data, specified by the customer on Payment Page, and uses it to withdraw the funds in the ATM of the bank, chosen by the customer. The Cepbank representative confirms the withdrawal of funds on the account details page on the Cepbank side.
  14. Cepbank sends the result notification to the payment platform.
  15. The payment platform sends a callback with the payment result to the web service.
  16. The payment platform sends the result to Payment Page.
  17. 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 Cepbank 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 Cepbank 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 TRY.
  3. If you need to have payment form displayed with the Cepbank method selected, set the force_payment_method parameter to cepbank.
  4. If required, you can also add any other additional parameters Payment Page supports.
  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 in the Cepbank method must include project, customer and payment IDs, signature, the currency and the amount of a payment, as shown in the following example:

    { payment_id: 'X03936', 
      payment_amount: 5000, 
      payment_currency: 'TRY',
      customer_id: '123', 
      project_id: 0, 
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySODJrOcZzUCwX6R\/ekpZhkIQg=="
    }

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

Callback format

The Cepbank 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 500.00 TRY purchase in the 239 project.

Figure: Example of a successful purchase callback

{
        "project_id": 239,
        "payment": {
            "id": "66dddb965305392be5b2df6e4d0b15a4",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-22T11:52:08+0000",
            "method": "cepbank",
            "sum": {
                "amount": 50000,
                "currency": "TRY"
            },
            "description": "test"
        },
        "account": {
            "number": "123"
        },
        "customer": {
            "id": "user45",
            "phone": "1123456789"
        },
        "operation": {
            "id": 24367000005221,
            "type": "sale",
            "status": "success",
            "date": "2019-09-22T11:52:08+0000",
            "created_date": "2019-09-22T11:44:52+0000",
            "request_id": "eccd50f4da21b8639eebed46dee235e024a3f4e0b9141e1b1e62",
            "sum_initial": {
                "amount": 50000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 50000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1160,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "BVhi84dW+BtsKItXgjzb5/vE7SLmzV2uixdyYpLg4Jme50HS8Z4B20V1H0ifSRw=="
    }

The following is the example of a callback for a purchase declined due to due to amount or frequency limitation.

Figure: Example of a declined purchase callback

{
        "project_id": 239,
        "payment": {
            "id": "66dddb965305392be5b2df6e4d0b15a4",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-22T11:52:08+0000",
            "method": "cepbank",
            "sum": {
                "amount": 4000,
                "currency": "TRY"
            },
            "description": "test"
        },
        "account": {
            "number": "123"
        },
        "customer": {
            "id": "user45",
            "phone": "1123456789"
        },
        "operation": {
            "id": 24367000005221,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-22T11:52:08+0000",
            "created_date": "2019-09-22T11:44:52+0000",
            "request_id": "eccd50f4da21b8639eebed46dee235e024a3f4e0b9141e1b1e62",
            "sum_initial": {
                "amount": 4000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 4000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1160,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit"
        },
        "signature": "BVhi84dW+BtsKItXgjzb5/vz+q/dRPxdyYpLg4Jme50HS8Z4B20V1H0ifSRw=="
    }

Related topics

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

Purchases by using Gate

General information

When using the Cepbank method, 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. 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 by using Gate

  1. A customer initiates a purchase through Cepbank 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 Cepbank service.
  7. The request is processed on the Cepbank side.
  8. The Cepbank representative receives the payment data, specified by the customer, and uses it to withdraw the funds in the ATM of the bank, chosen by the customer. The Cepbank representative confirms the withdrawal of funds on the personal account details page on the Cepbank side.
  9. The Cepbank service sends the payment result notification to the payment platform.
  10. The payment platform sends a callback to the web service.
  11. The customer receives the payment result from the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Cepbank payment method and provide the information on the format of callbacks with purchase results.

Request format

There are several things you must consider when using purchase requests when using the Cepbank method:
  1. You send purchase requests by sending the /v2/payment/bank-transfer/cepbank/sale request by using the POST HTTP method. This is a bank transfer purchase request group: /v2/payment/bank-transfer/{payment_method}/sale
  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 customer—customer information:
      • id—the unique ID of the customer within your project
      • ip_address—IP address
      • first_name—first name
      • last_name—last name
      • day_of_birth—day of birth
      • phone—customer phone number
      • Object identify—information about the document which establishes identity:
        • doc_number—number of the document (Turkish Identification Number), must contain 11 digits
    • Object account—customer account information:
      • number—recipient phone number. This phone number can also belong to the customer, or to a third party, which can communicate the code received from the bank earlier
      • bank_id—bank identifier
      • security_code—security code
    • Object payment—payment information:
      • amount—purchase amount in minor units
      • currency—purchase currency in ISO-4217 alpha-3 format
  3. The currency of purchase can only be TRY.
  4. If required, you can also add any other additional parameters Gate supports.
  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 in the Cepbank method must include project, customer and payment IDs, signature, customer and account information, currency and amount of the purchase, as shown in the following example:

Figure: Example of a purchase request

{
    "general": {
    "project_id": 125,
    "payment_id": "ID_184",
    "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVLhNN5e7cV+v+AWoXW\/9MTO8yJA=="
  },
  "customer": {
    "id": "test_id",
    "ip_address": "1.1.1.1",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "day_of_birth": "12-10-1990",
    "phone": "12345678900"
    "identify": {
        "doc_number": "111111-1-111"
        },
    },
  "account": {
    "number": "12345678901",
    "bank_id": 250,
    "security_code": "123"
    },
  "payment": {
    "amount": 5000,
    "currency": "TRY"
  }
}

Callback format

The Cepbank 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 500.00 TRY purchase in the 239 project.

Figure: Example of a successful purchase callback

{
        "project_id": 239,
        "payment": {
            "id": "66dddb965305392be5b2df6e4d0b15a4",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-22T11:52:08+0000",
            "method": "cepbank",
            "sum": {
                "amount": 50000,
                "currency": "TRY"
            },
            "description": "test"
        },
        "account": {
            "number": "123"
        },
        "customer": {
            "id": "user45",
            "phone": "1123456789"
        },
        "operation": {
            "id": 24367000005221,
            "type": "sale",
            "status": "success",
            "date": "2019-09-22T11:52:08+0000",
            "created_date": "2019-09-22T11:44:52+0000",
            "request_id": "eccd50f4da21b8639eebed46dee235e024a3f4e0b9141e1b1e62",
            "sum_initial": {
                "amount": 50000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 50000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1160,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "BVhi84dW+BtsKItXgjzb5/vE7SLmzV2uixdyYpLg4Jme50HS8Z4B20V1H0ifSRw=="
    }

The following is the example of a callback for a purchase declined due to due to amount or frequency limitation.

Figure: Example of a declined purchase callback

{
        "project_id": 239,
        "payment": {
            "id": "66dddb965305392be5b2df6e4d0b15a4",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-22T11:52:08+0000",
            "method": "cepbank",
            "sum": {
                "amount": 4000,
                "currency": "TRY"
            },
            "description": "test"
        },
        "account": {
            "number": "123"
        },
        "customer": {
            "id": "user45",
            "phone": "1123456789"
        },
        "operation": {
            "id": 24367000005221,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-22T11:52:08+0000",
            "created_date": "2019-09-22T11:44:52+0000",
            "request_id": "eccd50f4da21b8639eebed46dee235e024a3f4e0b9141e1b1e62",
            "sum_initial": {
                "amount": 4000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 4000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1160,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit"
        },
        "signature": "BVhi84dW+BtsKItXgjzb5/vz+q/dRPxdyYpLg4Jme50HS8Z4B20V1H0ifSRw=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Payouts by using Gate

General information

To perform a payout through the Cepbank 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 one of the supported bank on the web service.
  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 Cepbank service.
  7. The request is processed on the Cepbank side.
  8. The Cepbank representative receives the payment data, specified by the customer, and uses it to deposit the funds by using the ATM of the bank, chosen by the customer. The Cepbank representative confirms the deposit of funds on the personal account details page on the Cepbank side.
  9. Cepbank sends the result notification to the payment platform.
  10. The payment platform sends a callback with the payout result to the web service.
  11. 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 Cepbank 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 Cepbank method:
  1. You send payout requests by sending the /v2/payment/bank-transfer/cepbank/payout request by using the POST HTTP method. This is a bank transfer payout request group: /v2/payment/bank-transfer/{payment_method}/payout.
  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 customer—customer information:
      • id—customer ID, unique within the project
      • first_name—first name
      • last_name—last name
      • day_of_birth—day of birth
      • phone—customer phone number
      • Object identify—information about the document which establishes identity:
        • doc_number—number of the document (Turkish Identification Number), must contain 11 digits
    • Object account—customer account information:
      • number—recipient phone number. This phone number can also belong to the customer, or to a third party, which can communicate the code received from the bank earlier
      • bank_id—bank identifier
      • bank_branch_name—name of the bank branch
      • bank_branch_code —code of the bank branch
      • bank_branch_city—bank branch city
      • iban—customer bank account number (IBAN)
    • Object payment—payment information:
      • amount—purchase amount in minor units
      • currency—purchase currency in ISO-4217 alpha-3 format
  3. The currency of payout can only be TRY.
  4. If required, you can also add any other additional parameters Gate supports.

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

Figure: Example of a payout request

{
    "general": {
    "project_id": 125,
    "payment_id": "ID_184",
    "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVLhNN5e7cV+v+AWoXW\/9MTO8yJA=="
  },
  "customer": {
    "id": "test_id",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "day_of_birth": "12-10-1990",
    "phone": "12345678900"
    "identify": {
        "doc_number": "111111-1-111"
        },
    },
  "account": {
    "number": "12345678901",
    "bank_branch_name": "abc",
    "bank_branch_code": "123",
    "bank_branch_city": "test_city",
    "iban": "test_iban"
    },
  "payment": {
    "amount": 5000,
    "currency": "TRY"
  }
}

Callback format

The Cepbank 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 500.00 TRY payout made to the customer user45 in the 239 project.

Figure: Example of a successful payout callback

{
        "project_id": 239,
        "payment": {
            "id": "2e462f59b36c97cef02a736a273a8c98",
            "type": "payout",
            "status": "success",
            "date": "2019-08-30T08:45:49+0000",
            "method": "cepbank",
            "sum": {
                "amount": 5000,
                "currency": "TRY"
            },
            "description": ""
        },
        "account": {
            "number": "123123213123213"
        },
        "customer": {
            "id": "user45"
        },
        "operation": {
            "id": 45869000001579,
            "type": "payout",
            "status": "success",
            "date": "2019-08-30T08:45:49+0000",
            "created_date": "2019-08-30T08:45:48+0000",
            "request_id": "2995853ac9da9e37154b571c27be7837ed256df4fd301b73",
            "sum_initial": {
                "amount": 5000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 5000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1160,
                "payment_id": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "a+/fpRlG+T6X5Vh4y1tq6IOwwORC2uBopf99tMC1cqCkqGiFQF7XmAFHNo/ClDg=="
    }

The following is the example of a callback for a purchase declined due to due to amount or frequency limitation.

Figure: Example of a declined payout callback

{
        "project_id": 239,
        "payment": {
            "id": "2e462f59b36c97cef02a736a273a8c97",
            "type": "payout",
            "status": "decline",
            "date": "2019-08-30T08:45:49+0000",
            "method": "cepbank",
            "sum": {
                "amount": 4000,
                "currency": "TRY"
            },
            "description": ""
        },
        "account": {
            "number": "123123213123213"
        },
        "customer": {
            "id": "user45"
        },
        "operation": {
            "id": 45869000001579,
            "type": "payout",
            "status": "decline",
            "date": "2019-08-30T08:45:49+0000",
            "created_date": "2019-08-30T08:45:48+0000",
            "request_id": "2995853ac9da9e37154b571c27be7837ed256df4fdd41afebd301b73",
            "sum_initial": {
                "amount": 4000,
                "currency": "TRY"
            },
            "sum_converted": {
                "amount": 4000,
                "currency": "TRY"
            },
            "provider": {
                "id": 1160,
                "payment_id": ""
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit"
        },
        "signature": "a+/fpRlG+T6X5Vh4y1tq6IOwwORC2uBopf99tMC1cqCkqGiFQF7XmAFHNo/ClDw=="
    }

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