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:
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:
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.paymentMethodto your server.
From your server, make a /payments request, specifying:
- paymentMethod: The
paymentComponentData.paymentMethodfrom 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
- reference: Your unique reference for this payment.
- amount: The amount that the shopper needs to pay.
The /payments response contains an
actionobject 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
From your server, make a POST /payments/details request providing:
actionComponentData.detailsobject 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:
- For GrabPay PayLater:
Present the payment result
resultCode values you can receive for GrabPay are:
|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.|
|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.|
|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.