GrabPay Component

Add GrabPay to your Components integration.

Our GrabPay Component renders GrabPay in your payment form. As with other redirect payment methods, you need to use createFromAction to redirect the shopper, and handle the redirect after the shopper returns to your website.

Before you begin

This page explains how to add GrabPay to your existing Web Components integration. The Web Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your GrabPay integration:

Make sure that you have set up your back end implementation, and created an instance of AdyenCheckout.
Add GrabPay in your Customer Area.

Show GrabPay in your payment form

To present the GrabPay Component in your payment form:

From your server, make a POST /paymentMethods request specifying:

Country countryCode amount.currency
Malaysia MY MYR
Singapore SG SGD
Philippines ¹ PH PHP

¹ GrabPay PayLater is not available in Philippines.

The response will contain the GrabPay paymentMethod.type:
- grabpay_MY if the shopper is in Malaysia paying with Malaysian Ringgit.
- grabpay_PH if the shopper is in the Philippines paying with Philippine Peso.
- grabpay_SG if the shopper is in Singapore paying with Singapore Dollars.

Pass the full response from the /paymentMethods call as the paymentMethodsResponse object when creating an instance of the AdyenCheckout.

For this example, we'll use a scenario where the shopper is in Singapore. Add the GrabPay Component:
a. Create a DOM element for GrabPay, placing it where you want the form to be rendered:

<div id="grabpay-container"></div>

b. Create and mount an instance of the GrabPay Component using its component name, grabpay_SG. This renders a button on your payment form.

function handleOnSubmit(state, component) {
    // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
    state.isValid // True or false. Specifies if all the information that the shopper provided is valid.
    state.data // Provides the data that you need to pass in the `/payments` call.
    component // Provides the active component instance that called this event.
}
const grabpayComponent =  checkout.create('grabpay_SG', {
    onSubmit: handleOnSubmit // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
}).mount('#grabpay-container');

When the shopper selects the payment method, the Component calls the onSubmit event, which contains a state.data object including the shopper's selected payment method. If your integration is set up correctly, the state.data is passed on to your server.

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

Depending on the type of GrabPay payment, you need to provide different parameters to the /payments endpoint.

Wallet
PayLater

To make a regular GrabPay Wallet payment:

From your server, make a POST /payments request, specifying:

paymentMethod: The state.data.paymentMethod from the onSubmit event from your front end.
reference: Your unique reference for this payment.
amount: The amount that the shopper needs to pay.
returnUrl: The URL where the shopper will be redirected back to after completing the payment. The URL should include the protocol: http:// or https://. For example, https://your-company.com/checkout/. You can also include your own additional query parameters, for example, shopper ID or order reference number.

Here is how you would make a payment for 10 SGD.

https://docs.adyen.com/payment-methods/grabpay/web-component#payments

curl https://checkout-test.adyen.com/v67/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
     "amount": {
       "currency": "SGD",
       "value": 1000
     },
     "reference": "YOUR_ORDER_NUMBER",
     "{hint:state.data.paymentMethod from onSubmit}paymentMethod{/hint}": {
       "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(1000L);
    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);

To make a GrabPay PayLater payment:

From your server, make a POST /payments request, specifying:

paymentMethod: The state.data.paymentMethod from the onSubmit event from your front end.
reference: Your unique reference for this payment.
amount: The amount that the shopper needs to pay.
returnUrl: The URL where the shopper will be redirected back to after completing the payment. The URL should include the protocol: http:// or https://. For example, https://your-company.com/checkout/. You can also include your own additional query parameters, for example, shopper ID or order reference number.
deliveryAddress: The address where the purchased goods should be delivered.
lineItems: Price and product information about the purchased items, to be included on the invoice sent to the shopper.

Here is how you would make a payment for 10 SGD.

https://docs.adyen.com/payment-methods/grabpay/web-component#payments-installment

curl https://checkout-test.adyen.com/v67/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",
    "deliveryAddress": {
        "city": "Singapore",
        "country": "SG",
        "houseNumberOrName": "109",
        "postalCode": "179097",
        "street": "North Bridge Road"
    },
    "lineItems":[
      {
         "quantity":"1",
         "taxPercentage":"2100",
         "description":"Shoes",
         "id":"Item #1",
         "amountIncludingTax":"400",
         "productUrl": "URL_TO_PURCHASED_ITEM",
         "imageUrl": "URL_TO_PICTURE_OF_PURCHASED_ITEM"
      }
   ]
}'

# 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",
  :deliveryAddress => {
      :city => "Singapore",
      :country => "SG",
      :houseNumberOrName => "109",
      :postalCode => "179097",
      :street => "North Bridge Road"
  },
  :lineItems => [
    {
       :quantity =>"1",
       :taxPercentage =>"2100",
       :description =>"Shoes",
       :id =>"Item #1",
       :amountIncludingTax =>"400",
       :productUrl => "URL_TO_PURCHASED_ITEM",
       :imageUrl => "URL_TO_PICTURE_OF_PURCHASED_ITEM"
    }
  ]
})

// 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..");

    Address deliveryAddress = new Address();
    deliveryAddress.setCity("Singapore");
    deliveryAddress.setCountry("SG");
    deliveryAddress.setHouseNumberOrName("109");
    deliveryAddress.setPostalCode("179097");
    deliveryAddress.setStreet("North Bridge Road");

    List<LineItem> lineItems = new ArrayList<>();
    lineItems.add(
            new LineItem()
                    .quantity(1L)
                    .taxPercentage(2100L)
                    .description("Shoes")
                    .id("Item #1")
                    .amountIncludingTax(400L)
                    .productUrl("URL_TO_PURCHASED_ITEM")
                    .imageUrl("URL_TO_PICTURE_OF_PURCHASED_ITEM")
    );

    paymentsRequest.setLineItems(lineItems);

    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",
  "deliveryAddress" => [
     "city" => "Singapore",
     "country" => "SG",
     "houseNumberOrName" => "109",
     "postalCode" => "179097",
     "street" => "North Bridge Road"
  ],
  "lineItems" => [
     [
        "quantity" => "1",
        "taxPercentage" => "2100",
        "description" => "Shoes",
        "id" => "Item #1",
        "amountIncludingTax" => "400",
        "productUrl" => "URL_TO_PURCHASED_ITEM",
        "imageUrl" => "URL_TO_PICTURE_OF_PURCHASED_ITEM"
     ]
  ]
);
$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',
   'deliveryAddress': {
        'city': 'Singapore',
        'country': 'SG',
        'houseNumberOrName': '109',
        'postalCode': '179097',
        'street': 'North Bridge Road'
    },
    'lineItems': [
        {
            'quantity': '1',
            'taxPercentage': '2100',
            'description': 'Shoes',
            'id': 'Item #1',
            'amountIncludingTax': '400',
            'productUrl': 'URL_TO_PURCHASED_ITEM',
            'imageUrl': 'URL_TO_PICTURE_OF_PURCHASED_ITEM'
        }
    ]
})

// 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_REFERENCE",
  Amount = amount,
  ReturnUrl = "https://your-company.com/checkout?shopperOrder=12xy..",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  DeliveryAddress = new Model.Checkout.Address
  {
       City = "Singapore",
       Country = "SG",
       HouseNumberOrName = "109",
       PostalCode = "179097",
       Street = "North Bridge Road"
  },
  LineItems = new List<LineItem>
  {
    new LineItem(Quantity:1, TaxPercentage:2100, Description:"Shoes", Id:"Item #1", AmountIncludingTax:400, ProductUrl:"URL_TO_PURCHASED_ITEM", ImageUrl:"URL_TO_PICTURE_OF_PURCHASED_ITEM"),
  },
  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..",
    deliveryAddress: {
        city: "Singapore",
        country: "SG",
        houseNumberOrName: "109",
        postalCode: "179097",
        street: "North Bridge Road"
    },
    lineItems: [
      {
        quantity: "1",
        taxPercentage: "2100",
        description: "Shoes",
        id: "Item #1",
        amountIncludingTax: "400",
        productUrl: "URL_TO_PURCHASED_ITEM",
        imageUrl: "URL_TO_PICTURE_OF_PURCHASED_ITEM"
      }
    ]
}).then(res => res);

The /payments response contains an action object with the information needed to redirect the shopper.

https://docs.adyen.com/payment-methods/afterpaytouch/web-component#-payments-response

/payments response

{
   "resultCode":"RedirectShopper",
   "action":{
      "paymentMethodType":"grabpay_SG",
      "method":"GET",
      "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=...",
      "type":"redirect"
   }
}

If your integration is set up correctly, the action object is passed from your server to the client.

Handle the redirect

Handling the redirect works the same way for all redirect payment methods:

Call createFromAction, passing the action object from the previous step. This will return a new Component that you need to mount:
```
checkout.createFromAction(action).mount('#my-container');
```
The Component redirects the shopper to complete the payment.
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-decoded redirectResult returned when the shopper was redirected back to your site.
https://docs.adyen.com/payment-methods/afterpaytouch/web-component#-payments-details-request
/payments/details request
curl https://checkout-test.adyen.com/v67/payments/details \ -H "x-API-key: YOUR_X-API-KEY" \ -H "content-type: application/json" \ -d '{ "details": { "redirectResult": "eyJ0cmFuc1N0YXR1cyI6IlkifQ==" } }'
The /payments/details response contains:
- resultCode: Use this to present the payment result to your shopper.
- pspReference: Our unique identifier for the transaction.
https://docs.adyen.com/payment-methods/afterpaytouch/web-component#-payments-details-response
/payments/details response
{ "resultCode": "Authorised", "pspReference": "88154795347618C" }

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.

https://docs.adyen.com/payment-methods/grabpay/api-only#-payments-details-response

/payments/details response

{
    "resultCode": "Authorised",
    "pspReference": "88154795347618C",
    "additionalData": {
        "paymentMethodVariant": "grabpay_postpaid_SG"
    }
}

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.

Test and go live

To test your GrabPay integration:

Contact our Support Team to register for a 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 test payments in your Customer Area > Transactions > Payments.

Before you can accept live payments, you need to submit a request for GrabPay in your live Customer Area.