Our GrabPay Component renders GrabPay in your payment form, and redirects them to GrabPay's webpage.
When making a GrabPay payment, you additionally need to:
Before you begin
This page explains how to add GrabPay to your existing iOS Components integration. The iOS 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 for making API requests.
- Add GrabPay in your test Customer Area.
Show GrabPay in your payment form
To show GrabPay Component in your payment form, you need to:
-
Specify in your /paymentMethods request:
countryCode amount.currency MY MYR PH PHP SG SGD TH THB - Decode the
/paymentMethods
response and find the payment method withtype
grabpay_XX, where XX represents the country.
Make a payment
When the shopper proceeds to pay, the Component invokes the didSubmit
method, containing the data.paymentMethod
from the PaymentComponentDelegate
.
- Pass the
data.paymentMethod
to your server. - From your server, make a /payments request, specifying:
-
paymentMethod.type
: Thedata.paymentMethod
from your client app.
-
curl https://checkout-test.adyen.com/v49/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 paymentsRequest = new 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
: Object containing information about the redirect.
{
"resultCode": "RedirectShopper",
"action": {
"method": "GET",
"paymentData": "Ab02b4c0!BQABAgBlmvU6H9LnijLzrYAgMfopoX...",
"paymentMethodType": "grabpay_SG",
"type": "redirect",
"url": "https://test.adyen.com/hpp/skipDetails.shtml?brandCode=grabpay_SG¤cyCode=SGD..."
},
"details": [
{
"key": "payload",
"type": "text"
}
],
"paymentData": "Ab02b4c0!BQABAgBlmvU6H9LnijLzrYAgMfopoX...",
"redirect": {
"method": "GET",
"url": "https://test.adyen.com/hpp/skipDetails.shtml?brandCode=grabpay_SG¤cyCode=SGD..."
}
}
- Pass the
action
object to your client app. You need this to initialize the Redirect Component.
Handle the redirect
Use the Redirect Component to redirect the shopper to GrabPay. After the shopper is redirected back to your app, make a /payments/details request to check the payment result.
For more information and detailed instructions, refer to Using the Redirect Component.
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 request that they 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 | 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. |
Received | The shopper has completed the payment but the final result is not yet known. | Inform the shopper that you've received their order, and are waiting for the payment to be processed. |
Recurring payments
To make recurring GrabPay payments, you first need to create a shopper token and then make subsequent recurring transactions with the token.
Refer to Tokenization for more information and detailed instructions.
Test and go live
To test your GrabPay integration:
- Contact Grab and register a local phone number and an email address with them for GrabPay. The local phone number needs to be in the country that you want to test GrabPay payments for. For example, to test grabpay_SG you need a Singapore phone number.
- 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.