Prerequisites

• Familiarity with Recurly's API v3, webhooks, and basic REST concepts
• Completed the Quickstart guide
• Familiarity with Recurly.js
• A dLocal sandbox and/or production gateway account with GCash enabled
• If you're planning on implementing ecommerce-style (customer-in-session, one-time transactions) flows, contact [email protected] or your CSM to enable the associated feature flag that allows use of the store_billing_info field

Limitations

• GCash one-time payments don't store payment method data for one-time transactions — you must allow customers to select GCash as a payment method in your checkout flow every time, rather than offering a stored account option

Definition

Integration guide

With GCash, the initial payment request differs slightly depending on whether you're creating a subscription or an ecommerce transaction — response handling is the same either way. See below for the specific request for each flow.

Creating a subscription signup

Send a request to the create_purchase method on Recurly's API, including:

• Customer account data — code, name, billing info, phone number, and email address
• Tax ID — the customer's tax ID
• Subscriptions — with plan codes
• The type field set to gcash
• If you're processing an ecommerce transaction instead, the store_billing_info field set to false

[TODO: Dev/PO review — possible issue: this JSON includes // comments (the commented-out three_d_secure_action_result_token_id line and the note on tax_identifier). JSON doesn't support comments — this will throw a parse error if copied verbatim. Consider moving these notes to prose instead.]

{
  "currency": "PHP",
  "account": {
      "code": "account-code",
      "email":"[email protected]",
      "billing_info": {
          "first_name": "First",
          "last_name": "Last",
          "address": {
              "street1": "14 Laurel Road, Florentino Subd.",
              "city": "Brgy. San Antonio",
              "region": "Metro Manila",
              "postal_code": "1234",
              "country": "PH"
          },
          "tax_identifier":"123456789012",
          "store_billing_info": true,
          "type":"gcash"
      }
  },
  "gateway_code": "gateway-code", 
  "subscriptions": [
  {
    "plan_code": "plan-code"
  }
]
}

Creating an ecommerce transaction

Send a request to the create_purchase method on Recurly's API, including:

• Customer account data — code, name, billing info, phone number, and email address
• Line items with specific values or IDs if you're using the line item catalog
• The type field set to gcash
• The store_billing_info field set to false

{
  "currency": "PHP",
  "account": {
      "code": "account-code",
      "email":"[email protected]",
      "billing_info": {
          "first_name": "First",
          "last_name": "Last",
          //"three_d_secure_action_result_token_id": "BSFIYrYdEbdfcnI982gr9Q",
          "address": {
              "street1": "14 Laurel Road, Florentino Subd.",
              "city": "Brgy. San Antonio",
              "region": "Metro Manila",
              "postal_code": "1234",
              "country": "PH"
          },
          "tax_identifier":"123456789012",
          "store_billing_info": false,
          "type":"gcash"
      }
  },
  "gateway_code": "gateway-code", 
  "line_items": [
        {
            "unit_amount": "10.00",
            "quantity": 1,
            "description": "Item Description",
            "type": "charge",
            "tax_code": "physical", // or digital
            "product_code": "product-code"
        }
    ]
}