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 |
Philippines | PH | PHP |
Singapore | SG | SGD |
Get the corresponding paymentMethod.type
from the response.
Make a payment
In your /payments request, specify:
paymentMethod.type
: grabpay_XX, where XX is the country code. You can also refer to the/paymentMethods
response you received.- returnUrl: The URL where the shopper will be redirected back to after they complete the payment.
curl https://checkout-test.adyen.com/v66/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
"amount": {
"currency": "SGD",
"value": 1000
},
"reference": "YOUR_ORDER_NUMBER",
"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_NUMBER",
: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_NUMBER");
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_NUMBER",
"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_NUMBER',
'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 Model.Checkout.Amount("SGD", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
Type = "grabpay_SG"
};
var paymentRequest = new Adyen.Model.Checkout.PaymentRequest
{
Reference = "YOUR_ORDER_NUMBER",
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_NUMBER",
merchantAccount: config.merchantAccount,
returnUrl: "adyencheckout://your.package.name"
}).then(res => res);
The /payments response contains:
-
action.url
: Link to where you should redirect your shopper. -
action.method
: GET. The HTTP request method that you should use. After the shopper completes the payment, they will be redirected back to yourreturnURL
using the same method.
{
"resultCode":"RedirectShopper",
"action":{
"method":"GET",
"paymentData":"Ab02b4c0!BQABAgCSZT7t...",
"paymentMethodType":"grabpay_MY",
"type":"redirect",
"url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=..."
},
"details":[
{
"key":"redirectResult",
"type":"text"
}
],
...
}
Handle the redirect
To complete a GrabPay payment, you need to redirect the shopper to GrabPay.
-
To complete the payment, redirect the shopper to the
action.url
returned 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 or app, check the payment result by making a /payments/details request, specifying:
-
paymentData
: The value your received in the /payments response. -
details.redirectResult
: Object that was returned when the shopper was redirected back to your website or app.
-
resultCode
: Use this to present the result to your shopper. -
pspReference
: Our unique identifier for the transaction.
-
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 notification. | 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 notification webhooks to know the outcome of the payment. The notification webhooks you can receive for 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. |
Recurring payments
To make recurring GrabPay payments:
-
In your initial payment request, create a shopper token specifying:
-
storePaymentMethod
: true -
shopperReference
: Your unique identifier for the shopper (minimum length three characters). -
shopperInteraction
: Ecommerce
-
- When you make a /payments/details request after the shopper is redirected back to your website or app, save the
recurringDetailReference
that you receive in theadditionalData
of the response. This is your token. -
Make subsequent recurring transactions specifying a
paymentMethod
with:-
type
: The GrabPay type, for example grabpay_SG. -
recurringDetailReference
: The token you received in the/payments/details
response.
-
Refer to Tokenization for more information and detailed instructions.
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.