Google Pay Card Payments - S2S Integration JSON API

1. Show Google Pay as a separate option when Google Pay is set up on your customer’s device (Know how to check if Google Pay Cards is available on the customer’s device).
2. Trigger payment when the user clicks Pay with Google Pay Cards on your checkout.

​

Prerequisites

• Sign up for a Razorpay account.
• Generate API Keys on the Dashboard.
• Configure payment capture settings on the Dashboard.
• Follow the Razorpay S2S Integration documentation.
• You must have a PCI compliance certificate to get this feature enabled on your account.

​

Integration Steps

​

Step 1: Download the SDKs

​

Step 2: Add Dependencies in Build Gradle File

dependencies {
    ...
      implementation(name:'tez-client-api-0.9.4', ext:'aar')
      implementation 'com.android.support:customtabs:26.1.0'
      implementation 'com.google.android.gms:play-services-tasks:15.0.1
      implementation 'com.google.android.gms:play-services-wallet:18.0.0'
    ...
}

​

Step 3: Check if Gpay Cards is Supported

1. The Google Pay app is installed, and
2. Valid cards or bank accounts (UPI) are added to your customer’s Google pay account.

​

Step 3.1: Integrate the following code snippet in your app

Task task = null;
Context context = .this;
try {
   task = mPaymentClient.isReadyToPay(context,jsonObjectRequest(payload));
} catch (NoSuchAlgorithmException e) {
   e.printStackTrace();
}

task.addOnCompleteListener(new OnCompleteListener() {
   public void onComplete(Task task) {
       boolean result = task.getResult();
       if (result == true) {
          //Google Pay card is available & ready for transaction
       } else {
	    //Google Pay card either isn't available or set up for usage. 
       }
   }
});

​

Step 3.2: Check if Google Pay Cards is set up

"apiVersion": 2,
"apiVersionMinor": 0,
"allowedPaymentMethods"​:[
   {
​      "type"​:​ ​"CARD",
​       "parameters"​:​ {
​              "allowedCardNetworks"​ ​:​ ​["VISA", "MASTERCARD"],
         }
​   },
   {
​       "type"​:​ ​"UPI",
​   }
]

​

Step 4: Create an Order

• An order should be created for every payment.
• You can create an order using the Orders API. It is a server-side API call. Know how to authenticate Orders API.
• The order_id received in the response should be passed to the checkout. This ties the Order with the payment and secures the request from being tampered.

curl -X POST https://api.razorpay.com/v1/orders
-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-H 'content-type:application/json'
-d '{
    "amount": 50000,
    "currency": "INR",
    "receipt": "rcptid_11",
    "partial_payment": true,
    "first_payment_min_amount": 23000
}'
```java: Java
try {
  JSONObject orderRequest = new JSONObject();
  orderRequest.put("amount", 50000); // amount in the smallest currency unit
  orderRequest.put("currency", "INR");
  orderRequest.put("receipt", "order_rcptid_11");

  Order order = razorpay.Orders.create(orderRequest);
} catch (RazorpayException e) {
  // Handle Exception
  System.out.println(e.getMessage());
}
```Python: Python
import razorpay
client = razorpay.Client(auth=("api_key", "api_secret"))

DATA = {
    "amount": 50000,
    "currency": "INR",
    "receipt": "receipt#1",
    "notes": {
        "key1": "value3",
        "key2": "value2"
    }
}
client.order.create(data=DATA)
```php: PHP
$order  = $client->order->create([
  'receipt'         => 'order_rcptid_11',
  'amount'          => 50000, // amount in the smallest currency unit
  'currency'        => 'INR'// [See the list of supported currencies](/payments/international-payments#supported-currencies).)
]);
```csharp: .NET
Dictionary options = new Dictionary();
options.Add("amount", 50000); // amount in the smallest currency unit
options.add("receipt", "order_rcptid_11");
options.add("currency", "INR");
Order order = client.Order.Create(options);
```ruby: Ruby
options = amount: 50000, currency: 'INR', receipt: ''
order = Razorpay::Order.create
```javascript: Node.js
var options = {
  amount: 50000,  // amount in the smallest currency unit
  currency: "INR",
  receipt: "order_rcptid_11"
};
instance.orders.create(options, function(err, order) {
  console.log(order);
});
```json: Response
{
    "id": "order_DBJOWzybf0sJbb",
    "entity": "order",
    "amount": 50000,
    "amount_paid": 0,
    "amount_due": 50000,
    "currency": "INR",
    "receipt": "rcptid_11",
    "status": "created",
    "attempts": 0,
    "notes": [],
    "created_at": 1566986570
}

​

Step 5: Create a Payment

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/payments/create/json \
-H "Content-Type: application/json" \
 -d '{
  "amount": "100",
  "currency": "INR",
  "email": "gaurav.kumar@example.com",
  "contact": "9000090000",
  "order_id": "order_EKwxwAgItmmXdp",
  "provider": "google_pay",
  "ip": "192.168.0.103",
  "user_agent": "Mozilla/5.0",
  "description": "Test payment"
}'
```json: Response
{
  "razorpay_payment_id": "pay_ERNEungCtXpZqM",
  "next": [
    {
      "action": "invoke_sdk",
      "provider": "google_pay",
      "provider_data": {
        "google_pay": {
          "card": {
            "supported_networks": [
              "Visa",
              "MasterCard"
            ],
            "gateway_reference_id": "XXXXXX"
          },
          "upi": {
            "payee_vpa": "gaurav.kumar@exampleupi",
            "mcc": "0000",
            "gateway_reference_id": "XXXXXX"
          }
        }
      }
    },
    {
      "action": "poll",
      "url": "https://api.razorpay.com/v1/payments/pay_ERNEungCtXpZqM"
    }
  ]
}

​

Request Parameters

​

Response Parameters

• invoke_sdk: Contains the payload needed to create loadPaymentData payload as specified by the Google SDK specification. Use this to create the payload and pass it to the customer’s device. Use the same to invoke the Google Pay app on the user’s android app.
• poll: Contains the URL you must poll to fetch the payment status (authorized or failed).

​

Step 6: Prepare payload for Initiating Payment to Google

{
  "apiVersion": 2,
  "apiVersionMinor": 0,
  "allowedPaymentMethods": [
    {
      "type": "UPI",
      "parameters": {
        "payeeVpa": "",
        "payeeName": "Some Name",
        "referenceUrl": "Website URL",
        "mcc": "",
        "transactionReferenceId": ""
      },
      "tokenizationSpecification": {
        "type": "DIRECT"
      }
    },
    {
      "type": "CARD",
      "parameters": {
        "allowedCardNetworks": [
          "VISA",
          "MASTERCARD"
        ]
      },
      "tokenizationSpecification": {
        "type": "PAYMENT_GATEWAY",
        "parameters": {
          "gateway": "razorpayindia",
          "gatewayMerchantId": "",
          "gatewayTransactionId": ""
        }
      }
    }
  ],
  "transactionInfo": {
    "currencyCode": "INR",
    "totalPrice": "5000.00",
    "totalPriceStatus": "FINAL"
  }
}

​

Request Parameters

​

Parameter | Data Type | Description | Required?

​

apiVersion | Integer | The Google Pay API version used. The current version is 2. | Y

​

apiVersionMinor | Integer | The Google Pay API minor version used. The current version is 0. | Y

​

allowedPaymentMethods | Array | An array of objects for each method to be allowed. In this case, it will have two objects one each for UPI and Cards respectively. Each of the objects are explained in subsequent tables. | Y

​

transactionInfo.currencyCode | string | The value is INR. | Y

​

transactionInfo.totalPrice | string | The payment amount passed in the API request in step 5. The amount here is in INR. | Y

​

UPI Object

​

Google Pay Field | Razorpay Field | Value

​

parameters.payeeVpa required | provider_data.google_pay.upi.payee_vpa | This is your VPA created by Razorpay. This will be provided by Razorpay in payment response in step 5.

​

parameters.payeeName required | NA | You need to pass the user-facing business name for your business.

​

parameters.referenceUrl optional | NA | Your website URL for this specific payment. You may pass your website URL here.

​

parameters.mcc required | provider_data.google_pay.upi.mcc | This is a digit category code for your business. This will be provided by Razorpay in payment response in step 5.

​

parameters.transactionReferenceId required | provider_data.google_pay.upi.gateway_reference_id | This is a unique ID generated for this UPI payment. This will be provided by Razorpay in payment response in step 5.

​

Card Object

​

Google Pay Field | Razorpay Field | Value

​

parameters.allowedCardNetworks required | provider_data.google_pay.card.supported_networks | This field indicates the card networks to be supported by Google. This will be provided by Razorpay in payment response in step 5. * You will need to transform network names in block letters.For example, convert Visa to VISA and MasterCard to MASTERCARD.

​

tokenizationSpecification.type required | DIRECT | Always Direct.

​

tokenizationSpecification.parameters.gateway required | razorpayindia | Always razorpayindia.

​

tokenizationSpecification.parameters.gatewayMerchantId required | NA | This is the Razorpay merchant ID for your Razorpay account. You can find this by logging in to the Dashboard and clicking the user icon on the top right corner.

​

Step 7: Invoke Google Pay App

mPaymentClient.loadPaymentData(MainActivity.this,transactionPayload,LOAD_PAYMENT_DATA_REQUEST_CODE​);

​

Step 8: Handle response from Google Pay App (Optional)

@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
   if (requestCode == LOAD_PAYMENT_DATA_REQUEST_CODE​) {
       switch (resultCode) {
           case Activity.RESULT_OK: //payment was successful
               String paymentData = WalletUtils.getPaymentDataFromIntent(data);
               break;
           case Activity.RESULT_FIRST_USER: //internal error, something went wrong
               int statusCode = data.getIntExtra(WalletConstants.EXTRA_ERROR_CODE, WalletConstants.INTERNAL_ERROR);
               handleResultStatusCode(click here)(statusCode);
               break;
           case Activity.RESULT_CANCELED: //the transaction was cancelled by USER
               break;
       }
   }
}

private void handleResultStatusCode(int statusCode) {
   switch (statusCode) {
       case WalletConstants.ERROR_CODE_BUYER_ACCOUNT_ERROR:
           break;
       case WalletConstants.ERROR_CODE_MERCHANT_ACCOUNT_ERROR:
           break;
       case WalletConstants.ERROR_CODE_UNSUPPORTED_API_VERSION:
       case WalletConstants.INTERNAL_ERROR:
       case WalletConstants.DEVELOPER_ERROR:
       default:
           Toast.makeText(this,"Internal error", Toast.LENGTH_SHORT).show();
           //throw new IllegalStateException("Internal error.");
   }
}

​

Step 9: Verify Payment Status

• Fetch Payments API
• Payments Webhooks (Recommended)
• Orders Webhooks (Recommended)