GlobePay e-wallet

Overview

GlobePay is an Indian payment method that allows you to receive payments from customers, perform payouts to customers by means of e-wallets. Purchases are performed by using Payment Page and Gate, payouts—by using Gate.

General information

Payment method type Payments by using e-wallets
Countries and regions IN
Payment currencies
Currency conversion
Purchases +
Payouts +
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes
Onboarding and access fee Refer to your key account manager ECommPay

Interaction diagram

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



Operations support

  Interfaces Amounts in any of supported currencies
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) minimum maximum
Purchases + + 1.00
Payouts +

Processing scenarios

In the GlobePay method, to perform a purchase operation, you need to redirect a customer to the GlobePay service, while a payout is performed with the notification of a customer through the web service.

Figure: Purchase by using Payment Page procedure diagram



Figure: Purchase by using Gate procedure diagram



Figure: Payout by using Gate procedure diagram



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 GlobePay 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 GlobePay 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 GlobePay method.
  8. The payment platform receives the purchase request for payment processing from Payment Page.
  9. The payment platform performs the purchase request processing and sends the customer redirection data to Payment Page
  10. The customer is redirected to the GlobePay service. Payment session time is limited to 15 minutes.
  11. The customer completes all the payment steps required to perform a purchase by using the e-wallet.
  12. The payment is processed on the GlobePay side.
  13. The result is displayed to the customer on the GlobePay website.
  14. The customer is redirected to Payment Page.
  15. The GlobePay service sends the result notification to the payment platform.
  16. The payment platform sends a callback with the payment result to the web service.
  17. The payment platform sends the result to Payment Page.
  18. 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 GlobePay 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 GlobePay 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 be EUR, GBP or USD.
  3. To preselect GlobePay as the payment method on Payment Page for customers, pass the code globepay 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 GlobePay 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 in the GlobePay method must include project, customer and payment IDs, the currency and the amount of a payment, as shown in the following example:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 10000, 
      payment_currency: 'USD', 
      customer_id: '123',
      project_id: 0, 
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+529vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

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

Callback format

The GlobePay 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 100,00 USD purchase from the customer e-wallet testing@globepayinc.com made in the 580 project.

Figure: Example of a successful purchase callback

{
        "project_id": 580,
        "payment": {
            "id": "TEST_1554293313510",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-03T12:20:16+0000",
            "method": "GlobePay",
            "sum": {
                "amount": 10000,
                "currency": "USD"
            },
            "description": "TEST_1554293313510"
        },
        "account": {
            "number": "testing@globepayinc.com"
        },
        "customer": {
            "id": "155622456523"
        },
        "operation": {
            "id": 31036000000993,
            "type": "sale",
            "status": "success",
            "date": "2019-04-03T12:20:16+0000",
            "created_date": "2019-04-03T12:18:40+0000",
            "request_id": "ff650d304f361b234",
            "sum_initial": {
                "amount": 10000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "USD"
            },
            "provider": {
                "id": 1216,
                "payment_id": "gq2Z",
                "date": "2019-04-03T12:20:12+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "pZr95f+rAb1cm1CW5usL9Ocz/pNyYH6kA3sXwBWwx++iJkwHWAbQAxSfiZi9jA=="
    }
}

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

Figure: Example of a declined purchase callback

{
        "project_id": 580,
        "payment": {
            "id": "ECT_TEST_15548005973333",
            "type": "purchase",
            "status": "decline",
            "date": "2019-04-09T10:31:34+0000",
            "method": "GlobePay",
            "sum": {
                "amount": 10000,
                "currency": "USD"
            },
            "description": ""
        },
        "customer": {
            "id": "15562245652344"
        },
        "operation": {
            "id": 33577000001150,
            "type": "sale",
            "status": "decline",
            "date": "2019-04-09T10:31:34+0000",
            "created_date": "2019-04-09T09:31:34+0000",
            "request_id": "d1b8413f8a9927c458",
            "sum_initial": {
                "amount": 10000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "USD"
            },
            "provider": {
                "id": 1216,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "mXgF40MMwqLr6mwHrXwwy7umbCaOTqg3LL0YU2lRo13MXSlk9cPLA4CbuVMCnAsq7Yrw=="
    }
}

Related topics

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

Purchase by using Gate

General information

In the GlobePay 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 the redirection of a customer to the GlobePay service.
  3. Get the callback with the payment result from the payment platform.

The full sequence and particularities of the purchase processes are provided below.



Figure: Purchase sequence by using Gate

  1. A customer initiates a purchase through GlobePay 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 payment request processing and sends the callback with the redirection data in the redirect_data object to the web service.
  7. The customer is redirected from the web service to the GlobePay service. Payment session time is limited to 15 minutes.
  8. The customer completes all the payment steps required to perform a purchase by using the e-wallet.
  9. The payment is processed on the GlobePay side.
  10. The result is displayed to the customer.
  11. The customer is redirected to the merchant's web service.
  12. The GlobePay service sends the payment result notification to the payment platform.
  13. The ECommPay payment platform sends a callback to the web service.
  14. 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 GlobePay 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 GlobePay method:
  1. You perform purchase by sending the /v2/payment/wallet/globepay/sale request by using POST (HTTP) method. This request refers to the payments by using e-wallets request group: /v2/payment/wallet/{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—customer IP address
    • Object payment—purchase information:
      • amount—purchase amount
      • currency—purchase currency in the ISO-4217 alpha-3 format
  3. Additionally pass the following parameters:
    • Object return_url—the URLs to which the customer is redirected during or after the payment process:
      • return—URL to return customer to the web service during any step before the payment is completed with a click of the return button
      • success—after a successfully completed payment
      • decline—after a declined payment
  4. The currency of payment can be EUR, GBP or USD.
  5. If required, you can also add any other additional parameters Gate supports.

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

Figure: Purchase request example

{
    "general": {
        "project_id": 255,
        "payment_id": "TEST_15392667771145",
        "signature": "Uhka8CiYAlDlc2wRq60vlSmTTCb0Zp0KrMr5cAVZNLP64Pn2ja9u0filH8Z03Gr0wh8Q=="
    },
    "customer": {
        "id": "123",
        "ip_address": "185.123.193.224"
    },
    "payment": {
        "amount": 10000,
        "currency": "USD"
    },
    "return_url": {
      "return": "http://example.com/return",
      "success": "http://example.com/success",
      "decline": "http://example.com/decline"
    }
}

Formats of the customer redirection data

To redirect a customer from the web service to the GlobePay 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": {
                        "email_address": "info@pay.com",
                        "currency": "USD",
                        "price": "100.00",
                        "item_id": 31036000000993,
                        "item_name": "TEST_1554293313510",
                        "tax_rate": "",
                        "postage": "",
                        "quantity": 1,
                        "button_type": "buy_now",
                        "custom": "",
                        "success_url": "https://mycompany.com/process/complete-redirect?wsid=",
                        "cancel_url": "https://mycompany.com/process/complete-redirect?wsid=",
                        "callback_url": "https://test.com/globepay/"
                    },
                    "method": "POST",
                    "url": "https://www.globepayinc.com/make_payment.php"
                }

Callback format

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

The following is the example of a callback with an information about successful 100,00 USD purchase from the customer e-wallet testing@globepayinc.com made in the 580 project.

Figure: Example of a succeed purchase callback

{
        "project_id": 580,
        "payment": {
            "id": "TEST_1554293313510",
            "type": "purchase",
            "status": "success",
            "date": "2019-04-03T12:20:16+0000",
            "method": "GlobePay",
            "sum": {
                "amount": 10000,
                "currency": "USD"
            },
            "description": "TEST_1554293313510"
        },
        "account": {
            "number": "testing@globepayinc.com"
        },
        "customer": {
            "id": "155622456523"
        },
        "operation": {
            "id": 31036000000993,
            "type": "sale",
            "status": "success",
            "date": "2019-04-03T12:20:16+0000",
            "created_date": "2019-04-03T12:18:40+0000",
            "request_id": "ff650d304f361b234",
            "sum_initial": {
                "amount": 10000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "USD"
            },
            "provider": {
                "id": 1216,
                "payment_id": "gq2Z",
                "date": "2019-04-03T12:20:12+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "pZr95f+rAb1cm1CW5usL9Ocz/pNyYH6kA3sXwBWwx++iJkwHWAbQAxSfiZi9jA=="
    }
}

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

Figure: Example of a declined purchase callback

{
        "project_id": 580,
        "payment": {
            "id": "ECT_TEST_15548005973333",
            "type": "purchase",
            "status": "decline",
            "date": "2019-04-09T10:31:34+0000",
            "method": "GlobePay",
            "sum": {
                "amount": 10000,
                "currency": "USD"
            },
            "description": ""
        },
        "customer": {
            "id": "15562245652344"
        },
        "operation": {
            "id": 33577000001150,
            "type": "sale",
            "status": "decline",
            "date": "2019-04-09T10:31:34+0000",
            "created_date": "2019-04-09T09:31:34+0000",
            "request_id": "b8413f8a9927c458",
            "sum_initial": {
                "amount": 10000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "USD"
            },
            "provider": {
                "id": 1216,
                "payment_id": "",
                "auth_code": ""
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "mXgF40MMwqbgMQ7RfLkBf7umbCaOTqg3LL0YU2lRo13MXSlk9cPLA4CbuVMCnAsq7Yrw=="
    }
}

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 GlobePay 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 sequence by using Gate

  1. A customer orders a payout through the GlobePay 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 GlobePay service.
  7. The payout is processed on the GlobePay side.
  8. GlobePay 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 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 GlobePay payment method and provide the information on the format of callbacks with payout 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 payout requests in the GlobePay method:
  1. You perform purchase by sending the /v2/payment/wallet/globepay/payout request by using POST (HTTP) method. This request refers to the payments by using e-wallets request group: /v2/payment/wallet/{payment_method}/payout.
  2. The following objects and parameters must be specified in any request:
    • Object general—general payout information:
      • project_id—project identifier
      • payment_id—unique payout identifier
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
    • Object customer—customer information:
      • id—identifier
      • ip_address—IP address
    • Object account—customer account information:
      • number—number
    • Object payment—payout information:
      • amount—payout amount
      • currency—purchase currency in the ISO-4217 alpha-3 format
  3. The currency of payment can be EUR, GBP, INR or USD.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payout request in the GlobePay method must include project, customer, and payment IDs, customer IP address, currency and amount of the payout, and the account number for funds crediting, as shown in the following example:

Figure: Example of a payout request

{
    "general": {
        "project_id": 199,
        "payment_id": "Payment_2",
        "signature": "2tlMuYxLW9Yu6RETr8pdrQgJguu0BQjXWH6naCA9Ts6o4EVPjLyfbOQ+9ajAteg5lPk96Q=="
  },
    "customer": {
        "id": "customer123",
        "ip_address": "1.1.1.1" 
  },
    "account": {
        "number": "testing@globepayinc.com"
  },
    "payment": {
        "amount": 10000,
        "currency": "USD"
  }
}

Callback format

The GlobePay 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 100,00 USD payout made to the customer123 customer ID in the 199 project.

Figure: Example of a successful payout callback

{
        "project_id": 580,
        "payment": {
            "id": "test_0008",
            "type": "payout",
            "status": "success",
            "date": "2019-04-09T10:00:36+0000",
            "method": "GlobePay",
            "sum": {
                "amount": 10000,
                "currency": "USD"
            },
            "description": ""
        },
        "account": {
            "number": "info@canvas-pay.com"
        },
        "customer": {
            "id": "customer123"
        },
        "operation": {
            "id": 35748000001152,
            "type": "payout",
            "status": "success",
            "date": "2019-04-09T10:00:36+0000",
            "created_date": "2019-04-09T10:00:25+0000",
            "request_id": "99cf0cca787c79f9d",
            "sum_initial": {
                "amount": 10000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "USD"
            },
            "provider": {
                "id": 1216,
                "payment_id": "gq2Zo5acppGu",
                "date": "2019-04-09T10:00:26+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "pN9TQOzYZwmo+d44P1mQOzUpRJ1R3LmWkN6Xmg+jk+Oi9V9n0cJm8gMGB2vCHABuvoSQ=="
    }
}

The following is the example of a callback for a payout rejected due to insufficient funds on merchant balance.

Figure: Example of a declined payout callback

{
        "project_id": 580,
        "payment": {
            "id": "test_0008",
            "type": "payout",
            "status": "decline",
            "date": "2019-04-09T10:00:36+0000",
            "method": "GlobePay",
            "sum": {
                "amount": 10000,
                "currency": "USD"
            },
            "description": ""
        },
        "account": {
            "number": "info@canvas-pay.com"
        },
        "customer": {
            "id": "customer123"
        },
        "operation": {
            "id": 35748000001152,
            "type": "payout",
            "status": "decline",
            "date": "2019-04-09T10:00:36+0000",
            "created_date": "2019-04-09T10:00:25+0000",
            "request_id": "99cf0cca787c79f9d",
            "sum_initial": {
                "amount": 10000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "USD"
            },
            "provider": {
                "id": 1216,
                "payment_id": "gq2Zo5acppGu",
                "date": "2019-04-09T10:00:26+0000",
                "auth_code": ""
            },
            "code": "3028",
            "message": "Insufficient funds on merchant balance"
        },
        "signature": "pN9TQOzYZwmo+d44P1mQOzUpRJ1R3LmWkN6Xmg+jk+Oi9V9nrtJm8gMGB2vCHABuvoSQ=="
    }
}

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