UseePay Open API
UseePay PortalMechant Dashboard
Product Docs
Product Docs
  • V2.0
  • V1.0
UseePay PortalMechant Dashboard
Product Docs
Product Docs
  • V2.0
  • V1.0
  1. About Payment Methods
  • Integration
    • Welcome to the UseePay Demo Page
    • Payment Product Overview
      • Hosted Checkout Integration Guide
      • Embedded Checkout Integration Guide
      • Express Checkout Integration Guide
      • Server to Server Integration Guide
    • About Payment Methods
      • Affirm
      • AfterPay_ClearPay
      • Bank Transfer
      • Blik
      • Card
      • Cashapp
      • iDEAL
      • Kakao Pay
      • Klarna
      • Konbini
      • Korean Card
      • Naver pay
      • Payco
      • Pay with Link
      • Pix
      • Pse
      • Samsung Pay
      • Tmoney
      • Toss Pay
      • Trustly
      • TrueMoney
      • Maya
      • GCash
      • ApplePay
        • Apple Pay
        • Apple Pay Web Integration (API Integration)
      • GooglePay
        • Google Pay
        • Google Pay Web Integration (API Integration)
      • common
        • _shared-client-os-type
    • Subscription
      • Get started with Subscription
    • Online payment
      • Get started with online payments
    • Payment Capabilities
      • Adaptive Price
      • Supported Payment Methods for Checkout
    • Checkout session
      • Checkout Session Guide
  • Developer
    • Introduction
    • Authentication
    • Integrate Local Payment Methods
    • Error code
      • last_payment_error documentation
      • Errors
    • Best Integration
      • Quickly create a paymentIntent for a subscription
      • Auto-Charge Subscription Guide
    • Payment Intents
      • Payment Intent Overview
      • Quickly create a paymentIntent
      • Create a PaymentIntent
      • Retrieve a PaymentIntent
      • Update a PaymentIntent
      • Confirm a PaymentIntent
      • Cancel a PaymentIntent
      • Capture a PaymentIntent
      • List all payment intents
    • Customers
      • Create a customer
      • Retrieves a customer
      • Update a customer
      • List all customers
    • Subscriptions
      • Create a subscription
      • Retrieves a subscription
      • Update a subscription
      • List all subscriptions
      • Cancel a subscription
    • Invoices
      • Create a invoice
      • Retrieves a invoice
      • List all invoices
      • Pay a invoice
    • Payment Methods
      • Retieve Payment Method Session
    • Mandates
      • Create a mandate
      • Retrieves a mandate
      • List all mandates
    • Refunds
      • Create a refund
      • Retrieves a refund
      • List all refunds
    • Webhooks
      • Webhook Integration Guide(version 2026-04)
      • Integration details
        • Supported Webhook Events
        • Webhook Activation/Signature Verification Steps
        • Webhook events for example
        • Dispute Webhook Integration Document
        • Difference between version 2026-04 and 2026-10-10
      • archive
        • 2024-10-10
          • Webhook Integration Guide(version 2024-10-10)
      • Create a webhook
      • Retrieves a webhook
      • Update a webhook
      • List all webhooks
    • Embedded Checkout
      • UseePay Elements Appearance
      • Payment Element
      • Payment Element (Deferred Intent)
      • Express Checkout Element
      • Checkout Session Element
    • Payment Method Configuration
      • Retieve Payment Method Configuration
    • Checkout Session
      • Create Checkout Session
      • Retrieve Checkout Session
    • Trackers
      • upload trackers
      • Retrieve a tracker
    • Capture
      • Capture Overview
      • List captures by intent id
    • Payement Attempt
      • ECI Indicator (3-D Secure) Reference
      • Retrieve PaymentAttempt
    • Schemas
      • CheckoutSessionCreateRequest
      • PaymentMethod
      • CreatePaymentIntentRequest
      • LineItem
      • Customer
      • Address
      • ProductData
      • Shipping
      • SubscriptionData
      • Error
      • DiscountPeriodConfig
      • DeviceData
      • CheckoutSessionResponse
      • ErrorResponse
      • Order
      • Product
      • PaymentMethodOptions
      • RiskControlOptions
      • Mandate
      • PaymentIntent
      • Billing
      • Card
      • AliPay
      • Wallet
      • Klarna
      • WechatPay
      • Refund
      • Subscription
      • Recurring
      • PriceData
      • SubscriptionItem
      • Invoice
      • NextAction
      • Webhook
      • CollectableOptions
      • PaymentLink
      • last_payment_error
      • discount_period_config
      • Capture
      • three_ds
      • PaymentAttempt
      • konbini
      • client_pm_options
  • Message
    • Messaging Element
  • About Testing
    • Test Cards
    • ApplePay&GooglePay
  • Reconciliation
    • SFTP Access for Reconciliation
  • FAQ
    • Unable to receive Webhook notifications
    • FAQ
    • Introduction
  1. About Payment Methods

GCash

GCash is a digital wallet available to customers in the Philippines.

Overview#

PropertyDetails
Markets (consumer)PH
Consumer currenciesPHP, USD, CNY, HKD
Authentication methodsREDIRECT
Authentication timeout10 mins
Minimum payment amountSubject to channel rules
Maximum payment amountSubject to channel rules
Payment instrumentDIGITAL_WALLET
Recurring paymentsYes
Separate capturesNo
RefundFull · Partial · Multiple
Refund validity365 days
DisputesNo

Payment Flow#

1.
Customer selects GCash at checkout.
2.
Customer is redirected to the GCash payment page to complete authorization.
3.
After payment is completed, the customer is returned to the merchant site.
4.
The merchant receives the payment result from UseePay.

Notes#

GCash is available for customers in the Philippines.
The billing address country must be set to PH.

Integration Guide#

Create a PaymentIntent#

Set billing.address.country to PH when creating the PaymentIntent.
Request example (Java SDK)
Response example — GCash (PHP)
{
    "id": "1012608162326154014",
    "code": "0000",
    "message": "Approved or completed successfully",
    "amount": 1,
    "currency": "PHP",
    "status": "requires_customer_action",
    "description": "T-shirt",
    "confirm": true,
    "orderType": "sale",
    "mode": "payment",
    "sale": true,
    "merchant_no": "500000000007381",
    "app_id": "www.pay.com",
    "create_at": "2026-08-16T15:26:01Z",
    "modify_at": "2026-08-16T15:26:01Z",
    "merchant_order_id": "Pjpo5cKNgR3TvcYmKCaMr",
    "refunded_amount": 0,
    "next_action": {
        "type": "redirect",
        "redirect": {
            "method": "GET",
            "url": null,
            "content_type": null,
            "app_url": "https://psp.ac.gcash.com/page/simulation-wallet/acwallet/alipayconnectcode.html?code=281666040097QW0J8YeXj8YNYs0cyhH0dGLV&pspName=TRUEMONEY&loadMode=2",
            "package_name": "com.iap.linker_portal"
        }
    },
    "return_url": "https://www.yourstore.com",
    "client_secret": "7397b3312dc48e23589988f1bfb6dea1",
    "auto_capture": true,
    "order_id": "1012608162326154014",
    "latest_payment_attempt": "pa_13MKOH7E87400",
    "payment_attempt": {
        "id": "pa_13MKOH7E87400",
        "billing": {
            "address": {
                "country": "PH",
                "city": null,
                "postcode": null,
                "state": null,
                "line1": null,
                "line2": null
            },
            "email": null,
            "name": null,
            "phone": null,
            "date_of_birth": null,
            "first_name": null,
            "last_name": null
        },
        "merchant_no": "500000000007381",
        "app_id": "www.pay.com",
        "create_at": "2026-08-16T15:26:01Z",
        "modify_at": "2026-08-16T15:26:02Z",
        "api_version": null,
        "payment_intent_id": "1012608162326154014",
        "checkout_session_id": null,
        "merchant_order_id": "Pjpo5cKNgR3TvcYmKCaMr",
        "order_id": "1012608162326154014",
        "invoice_id": null,
        "subscription_id": null,
        "customer_id": null,
        "mandate_id": null,
        "payment_method_id": null,
        "payment_method_details": {
            "type": "gcash"
        },
        "return_url": "https://www.yourstore.com"
    },
    "setup_future_usage": false
}
Response example — GCash (USD via DCC)
{
    "id": "1012608191543155291",
    "code": "0000",
    "message": "Approved or completed successfully",
    "amount": 1,
    "currency": "THB",
    "status": "requires_customer_action",
    "description": "T-shirt",
    "confirm": true,
    "orderType": "sale",
    "mode": "payment",
    "sale": true,
    "merchant_no": "500000000007381",
    "app_id": "www.pay.com",
    "create_at": "2026-08-19T07:43:17Z",
    "modify_at": "2026-08-19T07:43:17Z",
    "merchant_order_id": "xA7-B4v0vdMAI5ZmngH8J",
    "refunded_amount": 0,
    "next_action": {
        "type": "redirect",
        "redirect": {
            "method": "GET",
            "url": "https://open-sea-global.gcash.com/api/open/v1/ac/cashier/self/codevalue/checkout.htm?codeValue=281666040098ZCZj0cQfR7QW0VzTlQov3Tbk&loadMode=2",
            "content_type": null,
            "app_url": null,
            "package_name": "com.iap.linker_portal"
        }
    },
    "return_url": "https://www.yourstore.com",
    "client_secret": "df0b71bb3a3b0ddc72cec65590f5bb51",
    "auto_capture": true,
    "order_id": "1012608191543155291",
    "latest_payment_attempt": "pa_13NGBCP2MA800",
    "payment_attempt": {
        "id": "pa_13NGBCP2MA800",
        "billing": {
            "address": {
                "country": "TH",
                "city": null,
                "postcode": null,
                "state": null,
                "line1": null,
                "line2": null
            },
            "email": null,
            "name": null,
            "phone": null,
            "date_of_birth": null,
            "first_name": null,
            "last_name": null
        },
        "merchant_no": "500000000007381",
        "app_id": "www.pay.com",
        "create_at": "2026-08-19T07:43:17Z",
        "modify_at": "2026-08-19T07:43:19Z",
        "api_version": null,
        "payment_intent_id": "1012608191543155291",
        "checkout_session_id": null,
        "merchant_order_id": "xA7-B4v0vdMAI5ZmngH8J",
        "order_id": "1012608191543155291",
        "invoice_id": null,
        "subscription_id": null,
        "customer_id": null,
        "mandate_id": null,
        "payment_method_id": null,
        "payment_method_details": {
            "type": "gcash"
        },
        "return_url": "https://www.yourstore.com"
    },
    "presentment_detail": {
        "country": null,
        "amount": null,
        "currency": "USD"
    },
    "setup_future_usage": false
}
When status is requires_customer_action, redirect the customer using the URL in next_action.redirect:
Use url for PC web and mobile web scenarios.
Use app_url for in-app and mini app scenarios.

Payment Method Options#

Use payment_method_options.gcash to specify the client environment when initiating a GCash payment.
For the full parameter reference, value descriptions, client scenario table, and request examples, seeClient and OS Type Options
Previous
Maya
Next
Apple Pay
Built with