Our Android Drop-in renders GrabPay in your payment form, and redirects the shopper to GrabPay to complete the payment.
Before you begin
This page explains how to add GrabPay to your existing Android Drop-in integration. The Android Drop-in integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Drop-in integration guide.
Before starting your GrabPay integration:
- Make sure you have set up your back end implementation.
- Add GrabPay in your test Customer Area.
Show GrabPay in your payment form
Drop-in uses the countryCode
and the amount.currency
from your /paymentMethods request to show the available payment methods to your shopper.
To show GrabPay in your payment form, specify in your /paymentMethods request:
Country | countryCode | amount.currency |
---|---|---|
Malaysia | MY | MYR |
Singapore | SG | SGD |
Philippines 1 | PH | PHP |
1 GrabPay PayLater is not available in Philippines.
The response contains the corresponding paymentMethod.type
grabpay_XX where XX is the country code.
Collect additional information in your payment form
Collecting additional information is only needed for GrabPay PayLater payments. However, we highly recommend collecting this information in your initial integration for GrabPay Wallet because it will help save development resources if you plan to enable GrabPay PayLater afterwards.
Collect the following details from the shopper:
- deliveryAddress: The address where the purchased goods should be delivered, including the country, city, street, house number, and postal code.
- lineItems: Price and product information about the purchased items, to be included on the invoice sent to the shopper.
Pass the collected data to your server because you will need it when making a payment. This information will be used by GrabPay to perform risk checks.
Make a payment
When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod
. Depending on the type of GrabPay payment, Wallet or PayLater, you need to provide different parameters in the /payments request.
To make a regular GrabPay Wallet payment:
- Pass the
paymentComponentData.paymentMethod
to your server. -
From your server, make a /payments request, specifying:
- paymentMethod: The
paymentComponentData.paymentMethod
from your client app. - returnUrl: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in the
RedirectComponent.getReturnUrl(context)
. - reference: Your unique reference for this payment.
- amount: The amount that the shopper needs to pay.
curl https://checkout-test.adyen.com/v68/payments \ -H "x-API-key: YOUR_X-API-KEY" \ -H "content-type: application/json" \ -d '{ "amount": { "currency": "SGD", "value": 1000 }, "reference": "YOUR_ORDER_REFERENCE", "paymentMethod": { "type": "grabpay_SG" }, "returnUrl": "https://your-company.com/checkout?shopperOrder=12xy..", "merchantAccount": "YOUR_MERCHANT_ACCOUNT" }'
# Set your X-API-KEY with the API key from the Customer Area. adyen = Adyen::Client.new adyen.api_key = "YOUR_X-API-KEY" response = adyen.checkout.payments({ :amount => { :currency => "SGD", :value => 1000 }, :reference => "YOUR_ORDER_REFERENCE", :paymentMethod => { :type => "grabpay_SG" }, :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..", :merchantAccount => "YOUR_MERCHANT_ACCOUNT" })
// Set YOUR_X-API-KEY with the API key from the Customer Area. // Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments. Client client = new Client("YOUR_X-API-KEY", Environment.TEST); Checkout checkout = new Checkout(client); PaymentsRequest paymentsRequest = new PaymentsRequest(); String merchantAccount = "YOUR_MERCHANT_ACCOUNT"; paymentsRequest.setMerchantAccount(merchantAccount); Amount amount = new Amount(); amount.setCurrency("SGD"); amount.setValue(15000L); paymentsRequest.setAmount(amount); DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails(); paymentMethodDetails.setType("grabpay_SG"); paymentsRequest.setPaymentMethod(paymentMethodDetails); paymentsRequest.setReference("YOUR_ORDER_REFERENCE"); paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy.."); PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area. $client = new \Adyen\Client(); $client->setXApiKey("YOUR_X-API-KEY"); $service = new \Adyen\Service\Checkout($client); $params = array( "amount" => array( "currency" => "SGD", "value" => 1000 ), "reference" => "YOUR_ORDER_REFERENCE", "paymentMethod" => array( "type" => "grabpay_SG" ), "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..", "merchantAccount" => "YOUR_MERCHANT_ACCOUNT" ); $result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area. adyen = Adyen.Adyen() adyen.client.xapikey = 'YOUR_X-API-KEY' result = adyen.checkout.payments({ 'amount': { 'value': 1000, 'currency': 'SGD' }, 'reference': 'YOUR_ORDER_REFERENCE', 'paymentMethod': { 'type': 'grabpay_SG' }, 'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..', 'merchantAccount': 'YOUR_MERCHANT_ACCOUNT' })
// Set your X-API-KEY with the API key from the Customer Area. var client = new Client ("YOUR_X-API-KEY", Environment.Test); var checkout = new Checkout(client); var amount = new Adyen.Model.Checkout.Amount("SGD", 1000); var details = new Adyen.Model.Checkout.DefaultPaymentMethodDetails{ Type = "grabpay_SG" }; var paymentsRequest = new Adyen.Model.Checkout.PaymentRequest { Reference = "YOUR_ORDER_REFERENCE", Amount = amount, ReturnUrl = "https://your-company.com/checkout?shopperOrder=12xy..", MerchantAccount = "YOUR_MERCHANT_ACCOUNT", PaymentMethod = details }; var paymentResponse = checkout.Payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area. const {Client, Config, CheckoutAPI} = require('@adyen/api-library'); const config = new Config(); // Set your X-API-KEY with the API key from the Customer Area. config.apiKey = '[API_KEY]'; config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]'; const client = new Client({ config }); client.setEnvironment("TEST"); const checkout = new CheckoutAPI(client); checkout.payments({ amount: { currency: "SGD", value: 1000 }, paymentMethod: { type: 'grabpay_SG' }, reference: "YOUR_ORDER_REFERENCE", merchantAccount: config.merchantAccount, returnUrl: "https://your-company.com/checkout?shopperOrder=12xy.." }).then(res => res);
The /payments response contains an
action
object with the information needed to redirect the shopper. - paymentMethod: The
If your integration is set up correctly, the action
object is passed from your server to the client.
Check the payment result
Drop-in redirects the shopper to complete the payment. When the shopper returns back to your app, Drop-in provides the actionComponentData
object.
From your server, make a POST /payments/details request providing:
details
: TheactionComponentData.details
object from Drop-in.
You receive a response containing:
resultCode
: Use this to present the payment result to your shopper.pspReference
: Our unique identifier for the transaction.
For GrabPay PayLater, the response also contains additionalData.paymentMethodVariant
— the Adyen sub-variant of the payment method used for the payment request. Possible values:
- For GrabPay Wallet:
grabpay_wallet_SG
,grabpay_sg
,grabpay_wallet_MY
,grabpay_my
,grabpay_wallet_PH
,grabpay_ph
- For GrabPay PayLater:
grabpay_postpaid_SG
,grabpay_instalment4_SG
,grabpay_postpaid_MY
,grabpay_instalment4_MY
.
Present the payment result
Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.
The resultCode
values you can receive for GrabPay are:
resultCode | Description | Action |
---|---|---|
Authorised | The payment was authorised. You will receive the funds in a number of days. | Inform the shopper that the payment was successful. |
Cancelled | The shopper cancelled the payment before it was completed, for example while in the GrabPay app. | Ask the shopper whether they want to continue with the order, or ask them to select a different payment method. |
Refused | The payment was refused by the shopper's card issuer. | Ask the shopper to try the payment again using a different payment method or card. |
Pending or Received |
The shopper has completed the payment but the final result is not yet known. You will receive the final result of the payment in an AUTHORISATION webhook. | Inform the shopper that you've received their order, and are waiting for the payment to be processed. |
If the shopper closed the browser and failed to return to your website, wait for webhooks to know the outcome of the payment. The webhooks you can receive for GrabPay are:
eventCode | success field | Description | Action to take |
---|---|---|---|
AUTHORISATION | false | The transaction failed. | Cancel the order and inform the shopper that the payment failed. |
AUTHORISATION | true | The shopper successfully completed the payment. | Inform the shopper that the payment has been successful and proceed with the order. |
OFFER_CLOSED | true | The shopper did not complete the payment. | Cancel the order and inform the shopper that the payment timed out. |
Test and go live
To test your GrabPay integration:
- Contact our Support Team to register for a GrabPay test wallet. You'll need to fill out a form and provide a phone number (local or international) and an email address. Note that the wallet will have a balance limit depending on the wallet regulations in each market.
- In the simulator, log in to Grab with the phone number you registered, and specify the one-time password you receive on that phone number.
Check the status of the GrabPay test payments in your Customer Area > Transactions > Payments.
Before you can accept live GrabPay payments, you need to submit a request for GrabPay in your live Customer Area.