Amazon Pay

Introduction

Amazon Pay is a payment method which allows to process payments in Indian rupiahs and US dollars by using e-wallets in India. This method supports payouts.

This article provides information about working with the Amazon Pay method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Interaction diagram

Payment processing by using the Amazon Pay method involves the merchant's web service, one of ecommpay interfaces, the ecommpay payment platform, and technical facilities of the Amazon Pay service.

Operations support

Various platform interfaces can be used to process payments and perform operations using the Amazon Pay method. Payouts can be processed by using Gate and Dashboard. At the same time, regardless of the interfaces used, the following limitations are applicable.

When working with the Amazon Pay the following limitations are applicable.

Processing scenarios

To initiate a payout by using the Amazon Pay method you need to notify the customer via the web service.

Figure: Payout by using Gate

General information

To process a payout through Gate by using the Amazon Pay method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of payout processing are provided below.

Information about the formats of requests and callbacks used for processing payouts by using the Amazon Pay method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending payout requests by using the Amazon Pay method:

1. To initiate each payout send a separate POST request to the /v2/payment/wallet/amazonpay/payout endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/payout.
2. Each request must include the following objects and parameters:
   • Object general—general payout information:
     • project_id—project identifier obtained from ecommpay during integration
     • payment_id—payment identifier unique within the project
     • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) details
   • Object payment—payment information:
     • amount—payout amount in the smallest currency unit
     • currency—payout currency code in the ISO-4217 alpha-3 format
   • Object customer—customer information:
     • id—customer identifier unique within the project
     • ip_address—customer IP address relevant for the initiated payout
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email address
     • address—customer postal address
   • Object account—recipient e-wallet account information:
     • number—recipient phone number linked to the e-wallet account
3. Additionally, any other parameters included in the specification can be used.

Thus, a correct payout request by using the Amazon Pay method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, as well as account number and signature.

{
  "general": {
    "project_id": 818,
    "payment_id": "ORDER_I1558600157",
    "signature": "+K6jllym+PtOdESkijfsBeR6bKROUsslA=="
  },
  "payment": {
    "amount": 150000,
    "currency": "INR"
  },
  "customer": {
    "id": "24900",
    "ip_address": "192.0.2.0",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "email": "Lovelace@example.com",
    "address": "Delhi, Main st., 20"
  },
  "account": {
    "number": "9811181996"
  }
}

{
  "general": {
    "project_id": 818,
    "payment_id": "ORDER_I1558600157",
    "signature": "+K6jllym+PtOdESkijfsBeR6bKROUsslA=="
  },
  "payment": {
    "amount": 150000,
    "currency": "INR"
  },
  "customer": {
    "id": "24900",
    "ip_address": "192.0.2.0",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "email": "Lovelace@example.com",
    "address": "Delhi, Main st., 20"
  },
  "account": {
    "number": "9811181996"
  }
}

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 information about a 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+qF3DeORTLYTv9j77k62uanWEo1T2Me0w=="
    }

The following is the example of a callback with information about 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": "cbac006fd0a89157d364b58a98e7-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": "UvYafKv8g7aXBIqVVt8F+7erV2ugNHq6Wv3lJE8Q=="
    }

Useful links

The following articles can be useful when implementing payouts via Gate:

• Interaction concepts—about the interaction with the payment platform by using Gate.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
• Payouts—about processing of payouts by using Gate.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.