GrabPay Component

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:

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

Show GrabPay in your payment form

To present the GrabPay Component in your payment form:

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

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

   The response will contain the GrabPay paymentMethod.type:

   • 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.

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

3. 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.

Make a payment

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

• paymentMethod: The state.data.paymentMethod from the onSubmit event from your front end.
• 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.

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",
     "{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);

The /payments response contains an action object with type:redirect.

The /payments response contains:

• action.method: GET. The HTTP request method that you should use. After the shopper completes the payment, they will be redirected back to your returnURL using the same method.

{
   "resultCode":"RedirectShopper",
   "action":{
      "method":"GET",
      "paymentData":"Ab02b4c0!BQABAgCSZT7t...",
      "paymentMethodType":"grabpay_SG",
      "type":"redirect",
      "url":"https://test.adyen.com/hpp/skipDetails.shtml?brandCode=grabpay_SG..."
   },
   "details":[
      {
        "key":"redirectResult",
        "type":"text"
      }
   ],
   ...
}

If your integration is set up correctly, the action object is passed from your server to the client, and the action.paymentData temporarily stored on your server.

Handle the redirect

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

1. 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 GrabPay to complete the payment.
2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
   • paymentData: The value your received in the /payments response.
   • details: Object that contains the URL-decoded values of the parameters that were 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

   {
         "paymentData":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
         "details":{
           "redirectResult":"Ab02b4c0!BQABAgCW5sxB4e/=="
         }
   }

   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"
   }

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:

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:

Recurring payments

To make recurring GrabPay payments:

1. 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
2. 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 the additionalData of the response. This is your token.
3. 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:

1. 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.
2. 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.

See also