Payment-method icon

GCash for API only

Add GCash to your API-only integration.

You can add GCash to your existing integration. The following instructions show only what you must add to your integration specifically for GCash.

If an instruction on this page corresponds with a step in the main integration guide, it includes a link to corresponding step of the main integration guide.

Requirements

Requirement Description
Integration type Make sure that you have an existing API-only integration.
Redirect handling Make sure that your existing integration is set up to handle the redirect.
action.type: redirect.
Setup steps Before you begin, add GCash in your Customer Area.

How it works

  1. The shopper selects GCash as the payment method.
  2. The shopper enters their details in the payment form that you build.
  3. When you make the payment request, you include additional information about the items that the shopper intends to purchase, if applicable.
  4. Your existing integration setup will handle the redirect.

Build your payment form

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

You can download the logo for GCash to use in your form.

Get GCash as an available payment method

When you make the /paymentMethods to get available payment methods, specify the following so that GCash is included in the response.

Parameter Values
countryCode PH
amount.currency PHP
amount.value The value of the payment.
channel Specify for example Web, iOS, or Android.

Add additional parameters to your /payments request

You do not need to add any parameters when you make a payment.

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 (minimum length three characters).

When the payment has been settled, you receive a recurring.token.created webhook containing:

  • type: recurring.token.created
  • shopperReference: your unique identifier for the shopper.
  • eventId: the pspReference of the initial payment.
  • storedPaymentMethodId: the token that you need to make recurring payments for this shopper.

Make sure that your server is able to receive the Recurring tokens life cycle events webhook. You can set up this webhook in your Customer Area.

Make a payment with a token

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

  • paymentMethod.storedPaymentMethodId: The storedPaymentMethodId from the recurring.token.created webhook.

    You can also get this value 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.

Test and go live

You can test your GCash integration in two ways: with the Adyen Payment Simulator, or directly with GCash.

Test with Adyen

Use the Adyen Payment Simulator to verify that your GCash integration works correctly with Adyen. You can test during development, before you go live, and after launch. The simulator does not recreate the shopper's journey through the GCash app or website.

This testing option is available by default when you add GCash in your test Customer Area. The payment method type is gcash.

To test a redirect payment:

  1. Start a payment as usual in your integration. The shopper is redirected to an Adyen-hosted simulator page.
  2. Select the payment outcome that you want to test.
  3. Wait for the simulator to return the shopper to your website, then complete the payment as usual. For an Advanced flow, make a /payments/details request.
  4. Confirm that your integration handles the outcome that you selected, and that the payment appears in your Customer Area > Payments > Payment list.

Test directly with GCash

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

If you encounter issues with direct GCash testing, contact our Support Team.

Check the status of direct GCash test payments in your Customer Area > Payments > Payment list.

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

See also