Amazon Pay

General information

Interaction diagram

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

Operations support

Processing scenarios

To initiate a payout by using Amazon Pay service, you need to receive a request from a customer via your web service and then notify the customer about funds crediting.

Figure: Payout by using Gate procedure

The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.

General information

To perform a payout through the Amazon Pay 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.

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

Request format

1. You perform payouts by sending the request by using POST (HTTP) method to /v2/payment/wallet/amazonpay/payout. This is an e-wallets payment request group: /v2/payment/wallet/{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
     • email—email address
     • address—postal address
   • Object account—recipient e-wallet account information:
     • number—recipient phone number linked to the e-wallet account
3. If required, you can also add any other additional parameters Gate supports.

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

{
  "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",
    "email": "Lovelace@mail.com",
    "address": "Delhi, Main st., 20"
  },
  "account": {
    "number": "5588994446666"
  }
}

Callback format

The Amazon Pay 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 INR payout made in the 197 project.

{
        "project_id": 197,
        "payment": {
            "id": "Payout-test-2-2209",
            "type": "payout",
            "status": "success",
            "date": "2020-09-22T08:50:56+0000",
            "method": "amazonpay",
            "sum": {
                "amount": 10000,
                "currency": "INR"
            },
            "description": ""
        },
        "account": {
            "number": "9811181996"
        },
        "customer": {
            "id": "1",
            "phone": "9811181996"
        },
        "operation": {
            "id": 77184010013601,
            "type": "payout",
            "status": "success",
            "date": "2020-09-22T08:50:56+0000",
            "created_date": "2020-09-22T08:50:51+0000",
            "request_id": "0584a6d51e85-00077185",
            "sum_initial": {
                "amount": 10000,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "INR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1811,
                "payment_id": "161818558",
                "auth_code": "",
                "date": "2020-09-22T08:50:55+0000"
            }
        },
        "signature": "Rgj9JJvd+qF3DeORTLYTv9j77kUKJCGX+ke/PssMBtYNomcgE/lGPKDEqXzxcGyxg/MOk+l62uanWEo1T2Me0w=="
    }

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

{
         "project_id": 197,
        "payment": {
            "id": "Payout-test-1-2209",
            "type": "payout",
            "status": "decline",
            "date": "2020-09-22T07:52:30+0000",
            "method": "amazonpay",
            "sum": {
                "amount": 100,
                "currency": "INR"
            },
            "description": ""
        },
        "account": {
            "number": "9811181996"
        },
        "customer": {
            "id": "1",
            "phone": "9811181996"
        },
        "operation": {
            "id": 72455010013601,
            "type": "payout",
            "status": "decline",
            "date": "2020-09-22T07:52:30+0000",
            "created_date": "2020-09-22T07:52:27+0000",
            "request_id": "cbac006fd0a891571e020690f6cef1c39002d916-a52fb6bcda08b86a4fdb6271feb7d364b58a98e7-00072456",
            "sum_initial": {
                "amount": 100,
                "currency": "INR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "INR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 1811,
                "payment_id": "",
                "auth_code": ""
            },
        "signature": "UvYafKv8g7aXBIqVVEWAl7KCF8y...Wt8F+7erV2ugNHq6Wv3lJE8Q=="
    }

Related topics

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

• Interaction concepts
• Signature generation and verification
• Payment models and statuses
• Information of operations performing

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