Accept GCash payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
Before you begin
These instructions explain how to add GCash to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your GCash integration:
Build your payment form for GCash
Include GCash in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.
We provide logos for GCash which you can use on your payment form. For more information, refer to Downloading logos.
If you are using the /paymentMethods to show available payment methods to the shopper, specify the following:
- countryCode: PH
- amount.currency: PHP
- amount.value: The value of the payment.
- channel: Specify Web, iOS, or Android.
The response contains
Make a payment
From your server, make a /payments request, specifying:
In the /payments response, note the
action object. This contains the information needed to redirect the shopper.
Handle the redirect
To complete the payment, redirect the shopper to the
action.urlreturned in the /payments response.
After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
details: object that contains the URL-decoded
redirectResultreturned when the shopper was redirected back to your site.
In the response note the following:
resultCode: use this to present the result to your shopper.
pspReference: our unique identifier for the transaction.
Present the payment result
resultCode values you can receive for GCash are:
|Action to take
|The payment was successful.
|Inform the shopper that the payment has been successful.
|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.
|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.
|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 webhook.
|The payment was refused by the GCash.
|Ask the shopper to try the payment again using a different payment method.
|Action to take
|The transaction failed.
|Cancel the order and inform the shopper that the payment failed.
|The shopper successfully completed the payment.
|Inform the shopper that the payment has been successful and proceed with the order.
|The shopper did not complete the payment.
|Cancel the order and inform the shopper that the payment timed out.
Recurring paymentsGCash supports recurring transactions. To make recurring transactions, you need to:
Create a token
To create a token, include in your /payments request:
- shopperReference: Your unique identifier for the shopper (minimum length three characters).
When the payment has been settled, you receive a webhook containing:
pspReferenceof 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 webhooks. You can enable the RECURRING_CONTRACT event code in the webhook settings page.
Make a payment with a token
To make a payment with the token, include in your /payments request:
pspReferencefrom the RECURRING_CONTRACT webhook.
You can also get this value using the /listRecurringDetails endpoint.
shopperReference: The unique shopper identifier that you specified when creating the token.
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
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.