Introduction

GCash is a mobile E-wallet and online payment platform in the Philippines.

Supported Countries

Philippines

Supported Currencies

Payment (Deposit) Flow

Follow these steps to perform a payment using Nuvei REST API integration:

1. Generate a `sessionToken`

Press here for details.

2. Send a `/payment` Request

Perform the payment by sending a /payment request with its mandatory parameters including:

userTokenId
amount
currency
paymentOption.alternativePaymentMethod class containing:
- paymentMethod: “apmgw_GCash“
deviceDetails class containing: ipAddress
billingAddress class containing: firstName, lastName, email, phone, country
userDetails class containing: firstName, lastName, email, phone, country

Example `/payment` Request

{
  "sessionToken":"<sessionToken from /getSessionToken>",
  "merchantId": "<your merchantId>",
  "merchantSiteId": "<your merchantSiteId>",
  "clientRequestId": "<unique request ID in merchant system>",
  "amount": "1000",
  "currency": "PHP",
  "userTokenId": "<unique customer identifier in merchant system>",
  "clientUniqueId": "<unique transaction ID in merchant system>",
  "paymentOption":{
    "alternativePaymentMethod":{
    "paymentMethod":"apmgw_GCash"
    }
  },
  "deviceDetails":{
    "ipAddress":"<customer's IP address>"   
  },
  "billingAddress":{
    "firstName":"John",
    "lastName":"Smith",
    "phone":"63756747844",
    "email":"[email protected]",
    "country":"PH"
  },
  "userDetails":{
    "firstName":"John",
    "lastName":"Smith",
    "phone":"63756747844",
    "email":"[email protected]",
    "country":"PH"
  },
  "timeStamp":"<YYYYMMDDHHmmss>",
  "checksum":"<calculated checksum>"
}

After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to the URL provided in urlDetails.notificationUrl, which Nuvei recommends including in the /payment request.

Payout (Withdrawal) Flow

A payout can only be performed after userTokenId and userPaymentOptionId are generated from a previous payment transaction.

Send a /payout request and include the userPaymentOptionId, which contains the user’s previously stored APM account details. Press here for an example.

After the transaction is processed, Nuvei sends a DMN that includes the result of the transaction to urlDetails.notificationUrl, which Nuvei recommends including in the /payout request.

User Experience

The user is redirected to a third-party page where the transaction can be completed.
The user enters their mobile phone number.
The user enters their authentication code that was sent to their mobile phone number.
The user logs in to their GCash account by entering their PIN.
The user reviews the payment details and confirms the payment.

The user is redirected to the merchant ReturnUrl.