GCash Component

Our GCash Component renders GCash 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 GCash 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 GCash integration:

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

Show GCash in your payment form

To present the GCash Component in your payment form:

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

   • countryCode: PH
   • amount.currency: PHP
   • amount.value: The value of the payment.

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

3. Add the GCash Component:
   a. Create a DOM element for GCash, placing it where you want the form to be rendered:

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

   b. Create and mount an instance of the GCash Component using its component name, gcash. 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 gcashComponent =  checkout.create('gcash', {
       onSubmit: handleOnSubmit // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
   }).mount('#gcash-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 PHP.

curl https://checkout-test.adyen.com/v53/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "amount":{
    "currency":"PHP",
    "value":1000
  },
  "{hint:state.data.paymentMethod from onSubmit}paymentMethod{/hint}":{
    "type":"gcash"
  },
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy.."
}'

# 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 => "PHP",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "gcash"
  },
  :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("PHP");
    amount.setValue(1000L);
    paymentsRequest.setAmount(amount);

    DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
    paymentMethodDetails.setType("gcash");
    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" => "PHP",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "gcash"
  ),
  "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': 'PHP'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'gcash'
   },
   '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("PHP", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "gcash"
};
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: "PHP", value: 1000 },
    paymentMethod: {
        type: 'gcash'
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy.."
}).then(res => res);

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

{
"resultCode": "RedirectShopper",
 "action": {
   "method": "GET",
   "paymentData": "Ab02b4c0!BQABAgCSZT7t...",
   "paymentMethodType": "gcash",
   "type": "redirect",
   "url": "https://test.adyen.com/hpp/redirect.shtml?brandCode=.."
},
"details": [
  {
      "key": "payload",
      "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 GCash 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 from 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. For example, payload.
   The parameters can vary based on the payment method configuration. To check which parameters you should submit, always check the details array from the /payments response.
   https://docs.adyen.com/payment-methods/vietnamese-online-banking/web-component#-payments-details-request

   /payments/details request

   {
         "paymentData":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
         "details":{
           "{hint:Verify the parameters from /payments response}payload{/hint}":"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/vietnamese-online-banking/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 GCash 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 GCash are:

Recurring payments

GCash supports recurring transactions. To make recurring transactions, you need to:

1. Create a shopper token.
2. Use the token to make future payments for the shopper.

Create a token

To create a token, include in your /payments request:

• storePaymentMethod: true
• shopperReference: Your unique identifier for the shopper.

When the payment has been settled, you receive a notification webhook containing:

• eventCode: RECURRING_CONTRACT
• originalReference: The pspReference of the initial payment.
• pspReference: This is the token that you need to make recurring payments for this shopper.

Make a payment with a token

To make a payment with the token, include in your /payments request:

• paymentMethod.storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT notification.
  You can also get this value by using the /listRecurringDetails endpoint.
• shopperReference: The unique shopper identifier that you specified when creating the token.
• shopperInteraction: ContAuth
• recurringProcessingModel: Use Subscription for a series of transactions following a fixed time interval or UnscheduledCardOnFile for contracts with non-fixed time interval.
  https://docs.adyen.com/payment-methods/gcash/api-only#recurring-gcash

  • curl
  • Ruby
  • Java
  • PHP
  • Python
  • C#
  • NodeJS

  curl Ruby Java PHP Python C# NodeJS

  curl https://checkout-test.adyen.com/v53/payments \
  -H "x-API-key: YOUR_X-API-KEY" \
  -H "content-type: application/json" \
  -d '{
         "amount":{
            "value":1000,
            "currency":"PHP"
         },
         "paymentMethod":{
            "type":"gcash",
            "storedPaymentMethodId":"7219687191761347"
         },
         "reference":"YOUR_ORDER_NUMBER",
         "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
         "shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
         "shopperInteraction":"ContAuth",
         "recurringProcessingModel": "Subscription"
  }'

  # 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 => "PHP",
      :value => 1000
    },
    :reference => "YOUR_ORDER_NUMBER",
    :paymentMethod => {
      :type => "gcash",
      :storedPaymentMethodId => "7219687191761347"
    },
    :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
    :shopperReference => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
    :merchantAccount => "YOUR_MERCHANT_ACCOUNT",
    :shopperInteraction => "ContAuth",
    :recurringProcessingModel => "Subscription"
  })

  // 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("PHP");
  amount.setValue(15000L);
  paymentsRequest.setAmount(amount);
  
  DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
  paymentMethodDetails.setStoredPaymentMethodId("7219687191761347");
  paymentMethodDetails.setType("gcash");
  paymentsRequest.setPaymentMethod(paymentMethodDetails);
  
  paymentsRequest.setReference("YOUR_ORDER_NUMBER");
  paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");
  paymentsRequest.setShopperReference("YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j");
  paymentsRequest.setShopperInteraction("ContAuth");
  paymentsRequest.setRecurringProcessingModel("Subscription");
  
  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" => "PHP",
      "value" => 1000
    ),
    "reference" => "YOUR_ORDER_NUMBER",
    "paymentMethod" => array(
      "type" => "gcash",
      "storedPaymentMethodId" => "7219687191761347"
    ),
    "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
    "shopperReference" => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
    "recurringProcessingModel" => "Subscription",
    "shopperInteraction" => "ContAuth",
    "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': 'PHP'
     },
     'reference': 'YOUR_ORDER_NUMBER',
     'paymentMethod': {
        'type': 'gcash',
        'storedPaymentMethodId': '7219687191761347'
     },
     'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
     'shopperReference': 'YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j'
     'merchantAccount': 'YOUR_MERCHANT_ACCOUNT',
     'shopperInteraction':'ContAuth',
     'recurringProcessingModel': 'Subscription'
  })

  // 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("PHP", 1000);
  var details = new Model.Checkout.DefaultPaymentMethodDetails{
    Type = "gcash",
    StoredPaymentMethodId = "7219687191761347"
  };
  var paymentsRequest = new Model.Checkout.PaymentRequest
  {
    Reference = "YOUR_ORDER_NUMBER",
    Amount = amount,
    ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
    MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
    ShopperReference = "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
    RecurringProcessingModel = "Subscription",
    ShopperInteraction = "ContAuth",
    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: "PHP", value: 1000 },
      paymentMethod: {
          type: 'gcash',
          storedPaymentMethodId: "7219687191761347"
      },
      reference: "YOUR_ORDER_NUMBER",
      merchantAccount: config.merchantAccount,
      shopperReference: "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
      returnUrl: "https://your-company.com/checkout?shopperOrder=12xy..",
      shopperInteraction: "ContAuth",
      recurringProcessingModel: "Subscription"
  }).then(res => res);

Test and go live

To test successful GCash live payments, you need to use a real mobile number registered with a GCash account.

If you are encountering issues with testing GCash payments, contact our Support Team.

Check the status of GCash test payments in your Customer Area > Transactions > Payments.

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

See also