UPI

Overview

UPI (Unified Payments Interface) is a payment method that allows customers to perform payments by using bank transferring of the Indian banks. Purchases are performed by using Payment Page and Gate, refunds—by using Gate, payouts—by using Gate and Dashboard.

General information

Payment method type bank payments
Payment instruments bank accounts
Countries and regions IN
Payment currencies INR, USD
Currency conversion On ecommpay side
Purchases +
Payouts +
Stored credentials payments –
Full refunds +
Partial refunds +
Chargebacks –
Notes –
Onboarding and access fee Refer to your ecommpay key account manager

Interaction diagram

Payment processing by using the UPI payment method requires merchant's web service, one of ecommpay interfaces, and the ecommpay payment platform, as well as UPI service which is supported interactions with banks.



Operations support

  Interfaces Amounts, INR/ USD Times **
Payment Page CMS Plug-ins Gate Dashboard minimum maximum Basic Threshold
Purchases + – + – * * * *
Payouts – – + + * * * *
Full refunds – – + – – – * *
Partial refunds – – + – – – * *

* Refer to your ecommpay account manager for more information.

** The basic and threshold times are defined as follows:

  • The basic time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
  • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ecommpay technical support.

Processing scenarios

To perform a purchase operation, you need to redirect a customer to the UPI service, while to initiate a refund or a payout, you need to receive a request from a customer via your web service and then notify the customer about funds crediting.

Figure: Purchase by using Payment Page



Figure: Purchase by using Gate



Figure: Refund by using Gate



Figure: Payout 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.

Purchase by using Payment Page

General information

In the UPI 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 have Payment Page opened with the UPI method selected. For more information about preselecting payment methods, see in Preselecting payment methods.

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 UPI method.
  8. The payment platform receives the purchase request for payment processing.
  9. The payment platform performs the internal purchase request processing and sends it to the UPI service.
  10. The purchase request is processed on the UPI service side.
  11. The service generates the data for redirecting the customer to its payment 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 UPI service.
  14. The customer completes all the payment steps required.
  15. The payment is processed on UPI side.
  16. The result is displayed to the customer on the service.
  17. The customer is redirected to Payment Page.
  18. UPI sends the result notification to the payment platform.
  19. The payment platform sends a callback with the payment result information to the web service.
  20. The payment platform sends the result information 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 UPI 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 requesting a payment through the UPI 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—customer ID unique within the project
  2. There are more mandatory parameters:
    • customer_first_name—first name
    • customer_last_name—last name
    • customer_email—email address
    • customer_city—city of residence
    • customer_street—street of residence
    • customer_building—building number of residence
    • identify_doc_number—number of the identity document Permanent Account N​umber (PAN), should content 10 characters: 5 letters, 4 numbers, 1 letter or number.

    If the parameters are not passed in the request for Payment Page opening, they are requested from customer on additional page.

  3. The currency of a payment can only be INR or USD.
  4. If you need to have payment form displayed with the UPI method selected, set the force_payment_method parameter to upi.
  5. If required, you can also add any other additional parameters Payment Page supports.
  6. 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 UPI method must include project and payment IDs, the currency and the amount of the payment, and customer data, as shown in the following example:

EPayWidget.run(
    { project_id: 198, 
      payment_id: '3936',
      payment_amount: 250, 
      payment_currency: 'USD', 
      customer_id: 'customer1',
      customer_first_name: 'John',
      customer_last_name: 'Johnson',
      customer_email: 'John@mail.com',
      customer_city: 'Delhi',
      customer_street: 'New Delhi',
      customer_building: '123A',
      identify_doc_number: 'EHFGA5967A',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vySODJr...=="
    }
)

For information about all parameters available in the UPI method, see Parameters for opening payment form.

Callback format

The UPI 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 2.50 USD purchase from the customer in the 580 project.

Figure: Example of a successful purchase callback

   {
        "project_id": 580,
        "payment": {
            "id": "TEST_Ref1215267492448813313",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-03T10:58:10+0000",
            "method": "UPI",
            "sum": {
                "amount": 250,
                "currency": "USD"
            },
            "description": "TEST_Ref1215267492448813313"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 49572000001893,
            "type": "sale",
            "status": "success",
            "date": "2019-09-03T10:58:10+0000",
            "created_date": "2019-09-03T09:43:12+0000",
            "request_id": "d2debda97843c0c",
            "sum_initial": {
                "amount": 250,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 17993,
                "currency": "INR"
            },
            "provider": {
                "id": 1309,
                "payment_id": "fcccab5d465e",
                "date": "2019-09-03T09:43:50+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "KsbudtqaOTFGb+ZXwrbhzGeMTSuNsAX1+3YOdDt32jvfh9NDU/MiK94...=="
    }

The following is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

 {
        "project_id": 580,
        "payment": {
            "id": "TEST_REFUNDUPIIINR1567592437",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-06T07:41:03+0000",
            "method": "UPI",
            "sum": {
                "amount": 250,
                "currency": "INR"
            },
            "description": "TEST_REFUNDUPIIINR156759437"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 48853000002113,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-06T07:41:03+0000",
            "created_date": "2019-09-06T07:25:26+0000",
            "request_id": "60a7b84844677185e",
            "sum_initial": {
                "amount": 250,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 250,
                "currency": "INR"
            },
            "provider": {
                "id": 1309,
                "payment_id": ""
            },
            "code": "603",
            "message": "Auto decline"
        },
        "signature": "fsSFeOQTuMoMwRDptS21wQuWHUoxDWr/0Y2veJcIJBHpg7lIjl7...=="
    }

Related topics

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

Purchase by using Gate

General information

In the UPI 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 UPI 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 by using Gate

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

Channel 1. Request format

There are several things you must consider when using purchase requests in the UPI method:
  1. You perform refunds by sending the /v2/payment/bank-transfer/upi/sale request by using POST (HTTP) method. This is a bank transferring request group: /v2/payment/bank-transfer/{payment_method}/sale
  2. The following objects and parameters must be specified in any request:
    • Object general—general purchase information:
      • project_id—project identifier
      • payment_id—unique purchase 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 ID of the customer within the merchant project
      • ip_address—customer IP address
      • first_name—first name
      • last_name—last name
      • email—email address
      • city—city of residence
      • street—street of residence
      • building—building number of residence
      • Object identify—information about the document which establishes identity:
        • doc_number—number of the identity document Permanent Account N​umber (PAN), should consist of 10 characters: 5 letters, 4 digits, 1 letter or number
    • Object payment—purchase information:
      • amount—purchase amount
      • currency—payout currency in the ISO-4217 alpha-3 format.
  3. The currency of a payment can only be INR or USD.
  4. If required, you can also add any other additional parameters Gate supports.

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

Figure: Example of a purchase request

{
    "general": {
        "project_id": 2990,
        "payment_id": "payment_id",
        "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIip...=="
    },
    "customer": {
      "ip_address": "1.1.1.1",
      "id": "123"
      "email": "Johnson@mail.com",
      "first_name": "John",
      "last_name": "Johnson",
      "city": "Delhi",
      "street": "New Delhi",
      "building": "123A",
      "identify": {
            "doc_number": "EHFGA5967A"
    },
    "payment": {
      "amount": 250,
      "currency": "USD"
    }
}

Channel 2. Request format

There are several things you must consider when using purchase requests in the UPI method:
  1. You perform refunds by sending the /v2/payment/bank-transfer/upi/sale request by using POST (HTTP) method. This is a bank transferring request group: /v2/payment/bank-transfer/{payment_method}/sale
  2. The following objects and parameters must be specified in any request:
    • Object general—general purchase information:
      • project_id—project identifier
      • payment_id—unique purchase 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:
      • ip_address—customer IP address
      • first_name—first name
      • last_name—last name
      • email—email address
      • phone—phone number
    • Object payment—purchase information:
      • amount—purchase amount
      • currency—payout currency in the ISO-4217 alpha-3 format
    • Object account—information about the virtual payment address of the customer:
      • number—virtual payment address (depending on the payment processing provider the parameter may not be mandatory, for more information refer to the ecommpay key account manager)
    • Object return_url—URL for redirecting a customer from the bank website:
      • success—URL for redirecting a customer after a performed purchase
  3. The currency of a payment can only be INR or USD.
  4. If required, you can also add any other additional parameters Gate supports.

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

Figure: Example of a purchase request

{
    "general": {
        "project_id": 200,
        "payment_id": "payment_id",
        "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIip...=="
    },
    "customer": {
      "ip_address": "1.1.1.1",
      "email": "Johnson@mail.com",
      "first_name": "John",
      "last_name": "Johnson",
      "phone": "312567890"
    },
    "payment": {
      "amount": 250,
      "currency": "USD"
    },
    "account": {
        "number": "123456@ABC"
    },
    "return_url": {
        "success": "http://merchant.com/returnurl.asp"
    }
}

Formats of the customer redirection data

To redirect a customer from the web service to the UPI 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 redirection data.

 "redirect_data": {
                    "body": [],
                    "method": "GET",
                    "url": "https://pay.com/collect/pay/M-ce2f-11e9-9f3e-9f869464802f?xtid=CATH-ST"
                }

Callback format

The UPI 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 2.50 USD purchase from the customer in the 580 project.

Figure: Example of a successful purchase callback

   {
        "project_id": 580,
        "payment": {
            "id": "TEST_Ref1215267492448813313",
            "type": "purchase",
            "status": "success",
            "date": "2019-09-03T10:58:10+0000",
            "method": "UPI",
            "sum": {
                "amount": 250,
                "currency": "USD"
            },
            "description": "TEST_Ref1215267492448813313"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 49572000001893,
            "type": "sale",
            "status": "success",
            "date": "2019-09-03T10:58:10+0000",
            "created_date": "2019-09-03T09:43:12+0000",
            "request_id": "d2debda97843c0c",
            "sum_initial": {
                "amount": 250,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 17993,
                "currency": "INR"
            },
            "provider": {
                "id": 1309,
                "payment_id": "fcccab5d465e",
                "date": "2019-09-03T09:43:50+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "KsbudtqaOTFGb+ZXwrbhzGeMTSuNsAX1+3YOdDt32jvfh9NDU/MiK94...=="
    }

The following is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

 {
        "project_id": 580,
        "payment": {
            "id": "TEST_REFUNDUPIIINR1567592437",
            "type": "purchase",
            "status": "decline",
            "date": "2019-09-06T07:41:03+0000",
            "method": "UPI",
            "sum": {
                "amount": 250,
                "currency": "INR"
            },
            "description": "TEST_REFUNDUPIIINR156759437"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 48853000002113,
            "type": "sale",
            "status": "decline",
            "date": "2019-09-06T07:41:03+0000",
            "created_date": "2019-09-06T07:25:26+0000",
            "request_id": "60a7b84844677185e",
            "sum_initial": {
                "amount": 250,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 250,
                "currency": "INR"
            },
            "provider": {
                "id": 1309,
                "payment_id": ""
            },
            "code": "603",
            "message": "Auto decline"
        },
        "signature": "fsSFeOQTuMoMwRDptS21wQuWHUoxDWr/0Y2veJcIJBHpg7lIjl7...=="
    }

Related topics

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

Refunds by using Gate

General information

UPI supports full and partial refunds processing by using Gate: 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: Refund sequence by using Gate

  1. A customer orders a refund by using merchant's web service.
  2. Merchant's web service sends the refund request for processing the payout 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 check 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 UPI service.
  7. The refund is processed on UPI side.
  8. UPI 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 information about the receipt of the requested funds from the web service.

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

Request format

There are several things you must consider when using refund requests in the UPI method:
  1. You perform refunds by sending the /v2/payment/bank-transfer/upi/refund request by using POST (HTTP) method. This is a bank transferring request group: /v2/payment/bank-transfer/{payment_method}/refund
  2. The following objects and parameters must be specified in any request:
    • Object general—general payment information:
      • project_id—project identifier
      • payment_id—unique payment 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:
      • ip_address—customer IP address
    • Object payment—refund information:
      • description—comment or description
      • amount—refund amount in minor units (mandatory for partial refund only)
      • currency—refund currency in ISO-4217 alpha-3 format (mandatory for partial refund only)
  3. If required, you can also add any other additional parameters Gate supports.

Thus, a correct refund request in the UPI method must include project and payment IDs, customer IP address, description and amount of the partial refund, as shown in the following example:

Figure: Example of a refund request 

{
   "general": {    
    "project_id": 239,    
    "payment_id": "refund_02",   
    "signature": "of8k9xerKSK4XL1QFaDH3p9Mh0CIcjmOwSwKJ7KLTZYO5...=="
  },  
   "customer": {    
     "ip_address": "1.2.3.4" 
  },  
   "payment": {    
     "amount": 100,
     "currency": "USD",
     "description": "refund_02"
 }
}

Callback format

The UPI method uses the standard format for callbacks to deliver refund results. For more information, see Callbacks.

Here is an example of callback with an information about successful 1.00 USD refund for the customer account in the 580 project.

Figure: Example of a successful refund callback

{
        "project_id": 580,
        "payment": {
            "id": "TEST_7492448813313334",
            "type": "purchase",
            "status": "partially refunded",
            "date": "2019-09-03T11:20:07+0000",
            "method": "UPI",
            "sum": {
                "amount": 100,
                "currency": "USD"
            },
            "description": "TEST_7492448813313334"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 49572000001897,
            "type": "refund",
            "status": "success",
            "date": "2019-09-03T11:20:07+0000",
            "created_date": "2019-09-03T11:05:07+0000",
            "request_id": "225baf528bbd401",
            "sum_initial": {
                "amount": 150,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 10796,
                "currency": "INR"
            },
            "provider": {
                "id": 1309,
                "payment_id": "REF-2456-4d0da54c-e6bd-4070-af92-da8c826d8645",
                "date": "2019-09-03T11:05:07+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "eCv6ySrrAYJVkh+oK/zF9iMfXB8ZYu2ITT0EfM...=="
    }

Here is an example of callback for a refund declined due to incorrect acquirer settings.

Figure: Example of a declined refund callback

{
        "project_id": 580,
        "payment": {
            "id": "TEST_267492448813313334",
            "type": "purchase",
            "status": "partially refunded",
            "date": "2019-09-06T07:41:07+0000",
            "method": "UPI",
            "sum": {
                "amount": 100,
                "currency": "USD"
            },
            "description": "TEST_267492448813313334"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 49572000002071,
            "type": "refund",
            "status": "decline",
            "date": "2019-09-06T07:41:08+0000",
            "created_date": "2019-09-06T07:41:06+0000",
            "request_id": "57938102bf03",
            "sum_initial": {
                "amount": 100,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "USD"
            },
            "provider": {
                "id": 1309,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20503",
            "message": "Incorrect acquirer settings"
        },
        "signature": "p3y5ZHqoFeD6S1ECuJYdHoflju3DSimozOWngEC...=="
    }

Related topics

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

Payout by using Gate

General information

To perform a payout through the UPI 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 UPI 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 provider service.
  7. The payout is processed on the provider side.
  8. Provider 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 UPI 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 UPI method:
  1. You perform payouts by sending the /v2/payment/bank-transfer/upi/payout request by using POST (HTTP) method. This is an online banking 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 payment—payout information:
      • amount—payout amount
      • currency—payout currency in the ISO-4217 alpha-3 format.
    • Object customer—customer information:
      • id—customer identifier on the web service side
      • ip_address—IP address
      • first_name—first name
      • last_name—last name
      • phone—phone number
      • email—email address
      • address—postal address
    • Object account—recipient account information:
      • number—recipient account number
  3. If required, you can also add any other additional parameters Gate supports.

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

Figure: Example of a payout request 

{
  "general": {
    "project_id": 818,
    "payment_id": "ORDER_I1558600157",
    "signature": "+K6jllym+PtObocZ1yS...xfWJTXdESkijfsBeR6bKROUsslA=="
  },
  "payment": {
    "amount": 150000,
    "currency": "INR"
  },
  "customer": {
    "id": "24900",
    "ip_address": "1.2.3.4",   
    "first_name": "Ada",
    "last_name": "Lovelace",
    "phone": "321654987",
    "email": "Lovelace@mail.com",
    "address": "Delhi, Main st., 20"
  },
  "account": {
    "number": "johndoe@upi"
  }
}

Callback format

The UPI 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 1000.00 INR payout made in the 239 project.

Figure: Example of a successful payout callback

{
        "project_id": 239,
        "payment": {
            "id": "ORDER53",
            "type": "payout",
            "status": "success",
            "date": "2020-05-21T13:23:32+0000",
            "method": "UPI",
            "sum": {
                "amount": 100000,
                "currency": "INR"
            },
            "description": "description"
        },
        "account": {
            "number": "johndoe@upi"
        },
        "customer": {
            "id": "24901"
        },
        "operation": {
            "id": 1386,
            "type": "payout",
            "status": "success",
            "date": "2020-05-21T13:23:32+0000",
            "created_date": "2020-05-21T13:23:28+0000",
            "request_id": "e48da2df266940ce5f534c84cae31237ca774b6fb-00000002",
            "sum_initial": {
                "amount": 100000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "INR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1309,
                "payment_id": "15141-1589360772-26",
                "auth_code": ""
            }
        },
        "signature": "UvYafKv8g7aXBIqVVEWAl7KCF8y...Wt8F+7erV2ugNHq6Wv3lJE8Q=="
    }

The following is the example of a callback for a declined payout.

Figure: Example of a declined payout callback

{
        "project_id": 239,
        "payment": {
            "id": "ORDER54",
            "type": "payout",
            "status": "decline",
            "date": "2020-05-21T13:23:32+0000",
            "method": "UPI",
            "sum": {
                "amount": 1000,
                "currency": "INR"
            },
            "description": "description"
        },
        "account": {
            "number": "johndoe@upi"
        },
        "customer": {
            "id": "24900"
        },
        "operation": {
            "id": 1386,
            "type": "payout",
            "status": "decline",
            "date": "2020-05-21T13:23:32+0000",
            "created_date": "2020-05-21T13:23:28+0000",
            "request_id": "e48da2df266940ce5fdc7ae31237ca774b6fb-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "INR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 1309,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "UvYafKv8g7aXBIqVVEWAl7KCF8y...Wt8F+7erV2ugNHq6Wv3lJE8Q=="
    }

Related topics

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

Payouts by using Dashboard

When working with Dashboard, you can process single and mass payouts by using the UPI method.

  • To process a single payout, open the payout form, specify all required parameters (including the payment method), send a request and verify that the payout has been processed.

  • To process a mass payout, prepare and upload a file with information about all target payouts, send a batch request, and verify that the payouts have been processed.

    Use a CSV file structured according to the requirements presented in the Mass payments data section. The payout parameters must comply with the requirements (you do not have to generate a signature because it is specified by Dashboard).

More information about processing payouts by using Dashboard is presented in a separate section.

Analysis of payments results

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