GCash via Checkout.com

Accept GCash payments from customers in the Philippines with Checkout.com as the payment service provider (PSP). The customer selects GCash, confirms the payment in GCash, and returns to your site.

Supported workflows

Workflow	Supported
Payrails SDK	✔
Payrails API	✔
Delayed / Manual Capture	✖
Instant Capture	✔
Cancel / Void	✖
Refund / Reverse	✔
Save Instruments	✖
Merchant Initiated Transaction (MIT)	✖

Before you begin

Complete these steps before you send your first GCash payment through Checkout.com:

Set up a Checkout.com integration in your workspace. Follow the Checkout.com integration setup guide if you don’t have one yet.
Ask Checkout.com to enable Alipay+ and GCash on your Checkout.com processing channel.
In the Payrails Portal, go to Settings → Integrations, open your Checkout.com integration, select GCash under Payment methods, and save.
Add GCash as a payment option in your workflow.

Request fields for Checkout.com

Send these fields in the authorize request, in addition to the standard authorize fields. Required fields must be present for the payment to succeed. Payrails sends Optional fields to the PSP when you include them.

Field	Status	Description
`meta.order.lines`	Required	At least one line item. Each line needs `id`, `name`, `unitPrice` and a `quantity` of one or more. Sent to Checkout.com as the order items.
`amount`	Required	Must be in `PHP`.
`meta.order.description`	Optional	Sent to Checkout.com as the payment description.
`meta.clientContext.clientType`	Optional	`app` or `wap` sets the GCash terminal type. Any other value, or no value, sends `web`.
`meta.clientContext.osType`	Optional	`ios` or `android`. Sent to Checkout.com as the customer’s operating system.
`meta.customer.name`, `meta.customer.lastName`	Optional	Sent to Checkout.com as the customer name.
`meta.customer.email`	Optional	Sent to Checkout.com as the customer email.
`meta.customer.country.code`	Optional	Sent to Checkout.com as the customer country.

Authorize a GCash payment

Call authorize a payment with gCash as the paymentMethodCode. The response includes the redirect to GCash.

Authorize request

{
  "amount": {
    "value": "500.00",
    "currency": "PHP"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "gCash",
      "amount": {
        "value": "500.00",
        "currency": "PHP"
      }
    }
  ],
  "meta": {
    "customer": {
      "name": "Maria",
      "lastName": "Santos",
      "email": "maria.santos@example.com"
    },
    "order": {
      "description": "Order 1234",
      "lines": [
        {
          "id": "item-1",
          "name": "Phone case",
          "quantity": 1,
          "unitPrice": {
            "value": "500.00",
            "currency": "PHP"
          }
        }
      ]
    },
    "clientContext": {
      "clientType": "web"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}

After the customer confirms the payment, GCash returns them to your success or error URL. Confirm the result through webhook notifications or the execution status before you fulfill the order.

How Checkout.com handles GCash

Checkout.com processes GCash through the Alipay+ network. Payrails creates a payment setup at Checkout.com and confirms it for GCash. The confirmation returns the redirect to GCash.
Payrails sends only order lines of type lineItem, or lines with no type. It skips tax, discount and shipping lines, and lines with no unit price or a zero quantity.
If Checkout.com reports that GCash isn’t ready on your processing channel, the payment fails before Payrails redirects the customer.

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Supported workflows

Before you begin

Request fields for Checkout.com

Authorize a GCash payment

How Checkout.com handles GCash

​Supported workflows

​Before you begin

​Request fields for Checkout.com

​Authorize a GCash payment

​How Checkout.com handles GCash

Supported workflows

Before you begin

Request fields for Checkout.com

Authorize a GCash payment

How Checkout.com handles GCash