GCash for Payment Setup API

Last updated: April 30, 2026

To accept GCash payments, you must:

Create a payment setup.
Confirm the payment.
Redirect the customer to GCash.

Call the Create a payment setup endpoint.

Information

Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see API endpoints.

post

https://{prefix}.api.checkout.com/payments/setups


1{
2  "amount": 1000,
3  "currency": "PHP",
4  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
5  "payment_methods": {
6    "gcash": {
7      "terminal_type": "app",
8      "os_type": "android"
9    }
10  },
11  "settings": {
12    "success_url": "https://example.com/payments/success",
13    "failure_url": "https://example.com/payments/failure"
14  }
15}

In the request body, provide the following:

Field Description

Field	Description
`amount` number	The payment amount, in the minor currency unit. Minimum: 1 Required
`currency` string	Three-letter ISO 4217 currency code. Supported value: `PHP` Required
`payment_methods.gcash.terminal_type` string	Supported values: `app` `wap` `web` Required
`processing_channel_id` string	The processing channel's unique identifier. Required
`settings.failure_url` string	The URL to redirect the customer to if the payment fails. Format: URI Max length: 1024 Required
`settings.success_url` string	The URL to redirect the customer to if the payment is successful. Format: URI Max length: 1024 Required
`description` string	A description of the payment. Max length: 100
`payment_methods.gcash.os_type` string	The operating system of the customer's device. Required if `terminal_type` is `wap` or `app`. Supported values: `android` `ios`
`reference` string	A reference you can use to identify the payment. Max length: 80

amount

number

The payment amount, in the minor currency unit.
Minimum: 1
Required

currency

string

Three-letter ISO 4217 currency code.
Supported value: PHP
Required

payment_methods.gcash.terminal_type

string

Supported values:

app
wap
web
Required

processing_channel_id

string

The processing channel's unique identifier.
Required

settings.failure_url

string

The URL to redirect the customer to if the payment fails.
Format: URI
Max length: 1024
Required

settings.success_url

string

The URL to redirect the customer to if the payment is successful.
Format: URI
Max length: 1024
Required

description

string

A description of the payment.
Max length: 100

payment_methods.gcash.os_type

string

The operating system of the customer's device.
Required if terminal_type is wap or app.
Supported values:

android
ios

reference

string

A reference you can use to identify the payment.
Max length: 80


1{
2  "id": "set_rcmepwrchqab2wsergcafvijfy",
3  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
4  "amount": 1000,
5  "currency": "PHP",
6  "payment_type": "Regular",
7  "reference": "ORD-5023-4E89",
8  "description": "GCash payment",
9  "payment_methods": {
10    "gcash": {
11      "status": "ready",
12      "flags": []
13    }
14  },
15  "available_payment_methods": [
16    "gcash"
17  ],
18  "settings": {
19    "success_url": "https://example.com/payments/success",
20    "failure_url": "https://example.com/payments/failure"
21  }
22}

The response returns a payment_methods object, which contains the payment methods enabled on your account.

When all required fields are present, the payment_methods.gcash object shows a ready status.

Confirm the payment by calling the Confirm a payment setup endpoint and provide:

The payment setup id as the {id} path parameter.
gcash as the {payment_method_name} path parameter.

post

https://{prefix}.api.checkout.com/payments/setups/{id}/confirm/gcash


1{
2  "id": "pay_bsrduhejxiuerlh32hb5n6dvae",
3  "status": "Pending",
4  "reference": "ORD-5023-4E89",
5  "customer": {
6    "id": "cus_2g4ehcpm6phexgkzahlwxvbgne",
7    "email": "hannah.bret@example.com",
8    "name": "Hannah Bret"
9  },
10  "_links": {
11    "self": {
12      "href": "https://{prefix}.api.checkout.com/payments/pay_bsrduhejxiuerlh32hb5n6dvae"
13    },
14    "redirect": {
15      "href": "https://psp.ac.alipay.com/page/simulation-wallet/acwallet/alipayconnectcode.html?code=281666040099gDeR9hatc6IPfQ0bstyv3kOD&pspName=GCASH&loadMode=2"
16    }
17  }
18}

Redirect the customer to the redirect.href URL from the response. The customer completes the payment on the GCash page and is then redirected back to your settings.success_url or settings.failure_url.

When accepting payments with GCash, you need to display the Alipay+ and GCash logos on your payment interface. To ensure that the logos meet the required brand guidelines, refer to the Brand display guidelines for online payments and Brand display guidelines for cashier payments.

GCash for Payment Setup API

Create a payment setup

Information

Request example

Response example

Confirm the payment

Request example

Response example

Redirect the customer