Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

GCash Redirect Component

Add GCash to your existing iOS Components integration.

If you have an existing iOS Components integration, you can use our Redirect Component to redirect the shopper to GCash's website to complete the payment.

When making an GCash payment, you need to:

Before you begin

This page explains how to add GCash 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 GCash integration:

  1. Make sure that you have set up your back end implementation for making API requests.
  2. Add GCash in your test Customer Area.

Show GCash in your payment form

Include GCash in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.

The response contains paymentMethod.type: gcash.

We provide logos for GCash which you can use on your payment form. For more information, refer to Downloading logos.

Make a payment

When the shopper proceeds to pay, you need to:

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

    • paymentMethod.type: Set this to gcash to redirect to the GCash mobile app or website.
    • returnUrl: The URL where the shopper will be redirected back to after completing the payment. Use the custom URL for your app, for example, my-app://. For more information on setting custom URL schemes, refer to the Apple Developer documentation.
    curl https://checkout-test.adyen.com/v51/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:data.paymentMethod from didSubmit}paymentMethod{/hint}":{
        "type":"gcash"
      },
      "returnUrl":"my-app://"
    }'
    # 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 => "my-app://",
      :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(15000L);
        paymentsRequest.setAmount(amount);
    
        DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
        paymentMethodDetails.setType("gcash");
        paymentsRequest.setPaymentMethod(paymentMethodDetails);
    
        paymentsRequest.setReference("YOUR_ORDER_NUMBER");
        paymentsRequest.setReturnUrl("my-app://");
    
        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" => "my-app://",
      "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': 'my-app://',
       '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 = "sofort"
    };
    var paymentsRequest = new Model.Checkout.PaymentRequest
    {
      Reference = "YOUR_ORDER_NUMBER",
      Amount = amount,
      ReturnUrl = @"gcash",
      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: "my-app://"
    }).then(res => res);

    The /payments response contains:

    • action: Object containing information about the redirect.
    /payments response
    {
       "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"
          }
       ],
       ...
    }
  2. Pass the action object to your client app.

Handle the redirect

  1. Use the Redirect Component to redirect the shopper to GCash.

  2. After the shopper returns to your app, make a POST /payments/details request from your server and provide the data from the didProvide method from your client app.

    /payments/details request
      {
       "{hint:data.paymentData from didProvide}paymentData{/hint}":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
       "{hint:data.details from didProvide}details{/hint}":{
         "payload":"Ab02b4c0!BQABAgCW5sxB4e/=="
       }
    }

    You receive a response containing:

    • resultCode: Use this to present the result to your shopper.
    • pspReference: Our unique identifier for the transaction.

    /payments/details response
    {
    "resultCode": "Authorised",
    "pspReference": "88154795347618C"
    }
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 GCash are:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment has been successful.
Cancelled The shopper cancelled the payment while on GCash's website. Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Error There was an error when the payment was being processed. Inform the shopper that there was an error processing their payment. The response contains a refusalReason, indicating the cause of the error.
Pending 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 completed.

To know the final result of the payment, wait for the AUTHORISATION notification webhook.
Refused The payment was refused by the GCash. Ask the shopper to try the payment again using a different payment method.

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:

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.

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 sure that your server is able to receive RECURRING_CONTRACT as part of your standard notifications. If you have not requested for this additional configuration yet, contact our Support Team.

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.
  • shopperInteractionContAuth
  • recurringProcessingModel: Use Subscription for a series of transactions following a fixed time interval or UnscheduledCardOnFile for contracts with non-fixed time interval.
    curl https://checkout-test.adyen.com/v51/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