Our iOS Drop-in renders in your payment form, and redirects the shopper to to complete the payment.
When making a payment, you additionally need to:
- Collect shopper information. Required only for PayLater payments.
- Handle the redirect result after the shopper returns to your website.
Before you begin
This page explains how to add to your existing iOS Drop-in integration. The iOS Drop-in integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Drop-in integration guide.
Before starting your integration:
- Make sure that you have set up your back end implementation, and added Drop-in to your payment form.
- Add GrabPay in your test Customer Area.
Show GrabPay in your payment form
Drop-in uses the countryCode
and the amount.currency
from your /paymentMethods request to show the available payment methods to your shopper.
To show in your payment form, specify in your /paymentMethods request:
Country | countryCode | amount.currency |
---|---|---|
Malaysia | MY | MYR |
Singapore | SG | SGD |
Philippines 1 | PH | PHP |
1 GrabPay PayLater is not available in Philippines.
After the shopper selects , Drop-in invokes the didSubmit
method which contains data.paymentMethod
.
Collect additional information in your payment form
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
When the shopper proceeds to pay, Drop-in invokes the didSubmit
method which contains data.paymentMethod
. Depending on the type of payment, Wallet or PayLater, you need to provide different parameters in the /payments request.
- Pass
data.paymentMethod
to your server. -
From your server, make a /payments request, specifying:
- paymentMethod: The
state.data.paymentMethod
from thedidSubmit
event from your front end. - reference: Your unique reference for this payment.
- amount: The amount that the shopper needs to pay.
- returnUrl: The URL the shopper will be redirected back to after they complete the payment.
curl https://checkout-test.adyen.com/v68/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 the information needed to redirect the shopper.
- paymentMethod: The
- Pass the
action
object to your client app. Drop-in needs this to redirect the shopper to .
Handle the redirect result
Drop-in redirects the shopper to where they complete the payment.
- To inform Drop-in when the shopper returns to your app, implement the following in your
UIApplicationDelegate
:
func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey: Any] = [:]) -> Bool {
RedirectComponent.applicationDidOpen(from: url)
return true
}
After Drop-in completes the action, it invokes the didProvide
method.
- From your server, make a POST /payments/details request providing the
data
from thedidProvide
method from your client app.
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 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 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.