Card payments via partner (India)

Overview

This is a payment method that supports purchase and refund processing via partner by using payment cards. You can perform purchases through this method by using Payment Page and Gate, refunds by using Gate.

General information

Payment method type card payments via partner
Countries and regions IN
Payment currencies INR
Currency conversion on the ECommPay side *
Purchases +
Payouts
Stored credentials payments
Full refunds +
Partial refunds
Chargebacks
Special considerations
Obtaining access to the payment method and access fee refer to your ECommPay key account manager

* Refer to your ECommPay key account manager for more details.

Interaction diagram

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

Operations support

  Interfaces Amounts, INR
Payment Page CMS Plugins Gate Dashboard (Old Dashboard) minimum maximum
Purchases + + 1.00 400,000.00
Full refunds +

Processing scenarios

To perform a purchase operation, you need to redirect customer to the service, while to perform a refund, you need to receive a request from a customer via your web service.

Figure: Purchase by using Payment Page

Figure: Purchase by using Gate

Figure: Refund by using Gate

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 this 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 this 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 when 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 payment method.
  8. The payment platform receives the purchase request for payment processing from Payment Page.
  9. The payment platform performs the internal purchase request processing and sends it to the partner service.
  10. The purchase request is processed on the partner service side.
  11. The partner service generates the data for redirecting the customer to its website form and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the partner website.
  14. The customer completes all the required payment steps.
  15. The payment is processed on the partner side.
  16. The result is displayed to the customer on the partner website.
  17. The customer is redirected to Payment Page.
  18. The partner service sends the result notification to the payment platform.
  19. The payment platform sends a callback with the payment result to the web service.
  20. The payment platform sends the result to Payment Page.
  21. 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 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 this payment method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • 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
    • customer_id—the unique ID of the customer within your project
  2. The currency of payment can only be INR.
  3. If you need to have payment form displayed with the method selected, set the force_payment_method parameter to card-partner and the payment_extra_param parameter to the card-debit value.
  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 must include project, customer and payment IDs, the currency and the amount of a payment and signature, as shown in the following example:

    { project_id: 101,
      payment_id: 'X03936'
      payment_currency: 'INR',
      payment_amount: 1000,
      customer_id: '123',
      signature: "kUi2x9dKHAVNU0xh4yo+52Kt8KU\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }

Callback format

This 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 10.00 INR purchase made in the 101 project.

Figure: Example of a successful purchase callback

{
        "project_id": 101,
        "payment": {
            "id": "ECT_TEST_1573806126471",
            "type": "purchase",
            "status": "success",
            "date": "2019-11-15T08:53:26+0000",
            "method": "Card partner",
            "sum": {
                "amount": 1000,
                "currency": "INR"
            },
            "description": ""
        },
        "customer": {
            "phone": "7999999999"
        },
        "operation": {
            "id": 123,
            "type": "sale",
            "status": "success",
            "date": "2019-11-15T08:53:26+0000",
            "created_date": "2019-11-15T08:51:59+0000",
            "request_id": "74f6e3f7b46f7d8cff8181c4741254d189fa359e45bdcc5-00066938",
            "sum_initial": {
                "amount": 1000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "INR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1,
                "payment_id": "3",
                "auth_code": "",
                "date": "2019-11-15T14:23:16+0000"
            }
        },
        "signature": "Jkz0YBAfiJB/19c3koPwCgY07nRZF4oWX5x+DJ5DcakB5L8piga2Uzg=="
    }

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

Figure: Example of a declined purchase callback

{
        "project_id": 101,
        "payment": {
            "id": "ECT_TEST_1573806126471",
            "type": "purchase",
            "status": "decline",
            "date": "2019-11-15T08:53:26+0000",
            "method": "Card partner",
            "sum": {
                "amount": 300000000,
                "currency": "INR"
            },
            "description": ""
        },
        "customer": {
            "phone": "7999999999"
        },
        "operation": {
            "id": 123,
            "type": "sale",
            "status": "decline",
            "date": "2019-11-15T08:53:26+0000",
            "created_date": "2019-11-15T08:51:59+0000",
            "request_id": "74f6e3f7b46f7d8cff8181c4741254d189fa359e45bdcc5-00066938",
            "sum_initial": {
                "amount": 300000000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 300000000,
                "currency": "INR"
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit",
            "provider": {
                "id": 1,
                "payment_id": "3",
                "auth_code": "",
                "date": "2019-11-15T14:23:16+0000"
            }
        },
        "signature": "Jkz0YBAfiJB/19c3koPwCgY07nRZF4oWX5x+DJ5DcakB5L8piga2Uzg=="
    }

Related topics

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

Purchases by using Gate

General information

In this 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. Perform the redirection of a customer to the partner service.
  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 when using Gate

  1. A customer initiates a purchase through partner 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 partner service.
  7. The request is processed on the partner side.
  8. The partner service sends the data for redirecting the customer to the partner service to the payment platform.
  9. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the partner service.
  11. The customer completes all the payment steps required.
  12. The payment is processed on the partner side.
  13. The result is displayed to the customer.
  14. The customer is redirected to the merchant's web service.
  15. The partner service sends the payment result notification to the payment platform.
  16. The 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 payment method and provide the information on the format of callbacks with purchase results.

Request format

There are several things you must consider when making purchase requests by using this method:

  1. You send purchase requests by sending the v2/payment/card-partner/sale request by using the POST HTTP method.
  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 payment—purchase information:
      • amount—purchase amount in minor units
      • currency—purchase currency in the ISO-4217 alpha-3 format
      • extra_param—in order to make purchases by using this method the card-debit value must be specified
    • Object customer—customer information:
      • id—the unique ID of the customer within your project
      • ip_address—IP-address
      • first_name—name
      • last_name—last name
      • phone—phone number
      • email—email address
    • Object return_url—contains the URLs to which customer is redirected while or after payment processing:
      • success—URL to return customer to the web service after the payment is completed.
  3. The currency of purchase can only be INR.
  4. If required, you can also add any other additional parameters Gate supports.

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

Figure: Example of a purchase request

 {
    "general": {
        "project_id": 101,
        "payment_id": "ECP_TEST_15392667771145",
        "signature": "Uhka8CiYAlDlc2wRq60vlSmTTCb0Zp0KYV4NP64Pn2ja9u0filH8Z03Gr0wh8Q=="
    },
    "payment": {
        "amount": 501,
        "currency": "INR",
        "extra_param": "card-debit"
    },
    "customer": {
        id: "589256",
        "ip_address": "1.1.1.1",
        "first_name": "Mary",
        "last_name": "Smith",
        "phone": "76575657657676",
        "email": "smith@example.com"
    },    
    "return_url": {
      "success": "http://example.com/success"
}

Formats of the customer redirection data

To redirect a customer from the web service to the partner site, 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 parameter, and use these parameters when opening the HTML page using the method specified in the redirect_data.method parameter.

The following is the callback fragment containing the token for purchase.

"redirect_data":{ 
      "body":{  },
      "method":"POST",
      "url":"https://test.cashfree.com/billpay/order/example123"
   }

Callback format

The standard format for callbacks is used to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 10.00 INR purchase made in the 101 project.

Figure: Example of a successful purchase callback

{
        "project_id": 101,
        "payment": {
            "id": "ECT_TEST_1573806126471",
            "type": "purchase",
            "status": "success",
            "date": "2019-11-15T08:53:26+0000",
            "method": "Card partner",
            "sum": {
                "amount": 1000,
                "currency": "INR"
            },
            "description": ""
        },
        "customer": {
            "phone": "7999999999"
        },
        "operation": {
            "id": 123,
            "type": "sale",
            "status": "success",
            "date": "2019-11-15T08:53:26+0000",
            "created_date": "2019-11-15T08:51:59+0000",
            "request_id": "74f6e3f7b46f7d8cff8181c4741254d189fa359e45bdcc5-00066938",
            "sum_initial": {
                "amount": 1000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "INR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1,
                "payment_id": "3",
                "auth_code": "",
                "date": "2019-11-15T14:23:16+0000"
            }
        },
        "signature": "Jkz0YBAfiJB/19c3koPwCgY07nRZF4oWX5x+DJ5DcakB5L8piga2Uzg=="
    }

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

Figure: Example of a declined purchase callback

{
        "project_id": 101,
        "payment": {
            "id": "ECT_TEST_1573806126471",
            "type": "purchase",
            "status": "decline",
            "date": "2019-11-15T08:53:26+0000",
            "method": "Card partner",
            "sum": {
                "amount": 300000000,
                "currency": "INR"
            },
            "description": ""
        },
        "customer": {
            "phone": "7999999999"
        },
        "operation": {
            "id": 123,
            "type": "sale",
            "status": "decline",
            "date": "2019-11-15T08:53:26+0000",
            "created_date": "2019-11-15T08:51:59+0000",
            "request_id": "74f6e3f7b46f7d8cff8181c4741254d189fa359e45bdcc5-00066938",
            "sum_initial": {
                "amount": 300000000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 300000000,
                "currency": "INR"
            },
            "code": "20101",
            "message": "Decline due to amount or frequency limit",
            "provider": {
                "id": 1,
                "payment_id": "3",
                "auth_code": "",
                "date": "2019-11-15T14:23:16+0000"
            }
        },
        "signature": "Jkz0YBAfiJB/19c3koPwCgY07nRZF4oWX5x+DJ5DcakB5L8piga2Uzg=="
    }

Related topics

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

Refunds by using Gate

General information

This method supports processing of full refunds. In this method, any refund follows the usual procedure which is common to Gate: merchant's web service sends a request with all the required parameters and signature to ECommPay URL, Gate accepts the request, the payment platform sends the callback with the payment result to the web service. The full sequence of the refund process is provided below.

Figure: Refund sequence when using Gate

  1. A customer orders a refund using the merchant's service.
  2. Merchant's web service sends the request for the refund 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 refund request to the partner service.
  7. The payment is processed on the partner side.
  8. The partner 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 refund result from the web service.

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

Request format

There are several things you must consider when making refund requests by using this method:

  1. You perform a refund by sending the request to v2/payment/card-partner/refund by using the POST HTTP method.
  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 payment—refund information:
      • description—comment or description
  3. If required, you can also add any other additional parameters Gate supports.

Thus, a correct refund request must include project and payment IDs, description of the refund, as shown in the following example:

Figure: Example of a refund request

{
  "general": {
    "project_id": 101,
    "payment_id": "ECT_TEST_1572258898441234343232",
    "signature": "NUpXRpdrU/rRcwEa/jQYoYbXA/YIc/dgeuncPmD/BJZGZvt59GbTSAUKHI/WrQ=="
  },
  "payment": {
    "amount": 1000,
    "description":"test_refund"
  }

Callback format

The standard callback format is used to deliver refund results. For more information, see Callbacks.

The following is the example of a callback with an information about successful 350.00 INR refund in the 197 project.

Figure: Example of a successful refund callback

{
        "project_id": 197,
        "payment": {
            "id": "TEST_554862",
            "type": "purchase",
            "status": "refunded",
            "date": "2020-09-09T10:02:18+0000",
            "method": "Card partner",
            "sum": {
                "amount": 0,
                "currency": "INR"
            },
            "merchant_refund_id": "TEST_554862",
            "description": "TEST_554862"
        },
        "customer": {
            "id": "1",
            "phone": "1234567890"
        },
        "operation": {
            "id": 90266010010271,
            "type": "refund",
            "status": "success",
            "date": "2020-09-09T10:02:18+0000",
            "created_date": "2020-09-09T09:46:14+0000",
            "request_id": "6b77b588d77d5c27be31be7b72bf9adf...b1c85eda238b73cac-00090267",
            "sum_initial": {
                "amount": 35000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 35000,
                "currency": "INR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1751,
                "payment_id": "4952688",
                "auth_code": ""
            }
        },
        "signature": "WUZUy26FHZglsro9PYFr89suJAciQ...5Fev4NtHl56VGTgX9m/g=="
    }

The following is the example of a callback for a refund declined as the amount in the refund requested is greater than the amount in the initial payment.

Figure: Example of a declined refund callback

{
        "project_id": 197,
        "payment": {
            "id": "TEST_554863",
            "type": "purchase",
            "status": "success",
            "date": "2020-09-09T10:02:18+0000",
            "method": "Card partner",
            "sum": {
                "amount": 35000,
                "currency": "INR"
            },
            "merchant_refund_id": "TEST_554863",
            "description": "TEST_554863"
        },
        "customer": {
            "id": "1",
            "phone": "1234567890"
        },
        "operation": {
            "id": 90266010010272,
            "type": "refund",
            "status": "decline",
            "date": "2020-09-09T10:02:18+0000",
            "created_date": "2020-09-09T09:46:14+0000",
            "request_id": "6b77b588d77d5c27be31be7b72bf9adf...b1c85eda238b73cac-00090268",
            "sum_initial": {
                "amount": 35000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 35000,
                "currency": "INR"
            },
            "code": "3283",
            "message": "Refund amount more than init amount"
            }
        },
        "signature": "WUZUy26FHZglsro9PYFr89suJAciQ...5Fev4NtHl56VGTgX9m/g=="
    }

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