Accept GrabPay payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
Before you begin
These instructions explain how to add GrabPay to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your GrabPay integration:
- Make sure that you have set up your back end implementation.
- Add GrabPay in your test Customer Area.
Build your payment form for GrabPay
To show GrabPay in your payment form, you need to:
- Include GrabPay in the list of available payment methods.
- After the shopper selects GrabPay, pass the payment method type to your server:
- grabpay_MY if the shopper is in Malaysia and is paying with Malaysian Ringgit.
- grabpay_PH if the shopper is in the Philippines and is paying with Philippine Peso.
- grabpay_SG if the shopper is in Singapore and is paying with Singapore Dollars.
We provide a GrabPay logo which you can use on your payment form. For more information, refer to Downloading logos for details.
You can also get the paymentMethod.type from the /paymentMethods response as explained in the API-only integration guide. In your /paymentMethods request, specify:
| Country | countryCode | amount.currency |
|---|---|---|
| Malaysia | MY | MYR |
| Singapore | SG | SGD |
| Philippines 1 | PH | PHP |
1 GrabPay PayLater is not available in Philippines.
Get the corresponding paymentMethod.type from the response.
Make a payment
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:
-
Make a /payments request, and specify:
- paymentMethod: grabpay_XX, where XX is the country code. You can also refer to the
/paymentMethodsresponse you received. - returnUrl: The URL where the shopper will be redirected back to after they complete the payment.
- reference: Your unique reference for this payment. Maximum length of 32 characters.
- amount: The amount that the shopper needs to pay.
The /payments response contains an
actionobject with the information needed to redirect the shopper. - paymentMethod: grabpay_XX, where XX is the country code. You can also refer to the
Handle the redirect
- To complete the payment, redirect the shopper to the
action.urlreturned in the /payments response.
When using the HTTP GET method:
For security reasons, when displaying the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.
-
After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
details: Object that contains the URL-decodedredirectResultreturned when the shopper was redirected back to your site.
You receive a response containing:
resultCode: Use this to present the 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.