payment

Check GKash token availability

Check if a member has a valid GKash token (epkey) available for recurring payments. This endpoint: - Searches for the most recent successful GKash payment with an epkey for the member - Returns token availability status - Includes the epkey if available - Shows the last payment reference and date

**Use Cases:**
- Check if a member can make recurring payments
- Verify token availability before initiating recurring payment
- Display token status in member dashboard

**Response:**
- hasToken: true if epkey is available, false otherwise
- epkey: The token value (only if hasToken is true)
- lastPaymentRefNo: Reference number of the last successful payment with token
- lastPaymentDate: Date of the last successful payment with token

get/payment/gkash/token

Query parameters

memberIDstring

Example:TWE-123456

Member ID to check token availability. At least one of memberID or documentID is required. Matched against member_id first, then against document_id as a fallback.

documentIDstring

Example:871215435364

Document ID (IC number) of the member. At least one of memberID or documentID is required. Matched against document_id first, then against member_id as a fallback.

Response

Token status retrieved successfully

successboolean required

Success status

messagestring required

Response message

dataobject required

Token availability data. memberID echoes the identifier that was sent; resolvedMemberID is the member_id stored on the matched payment, which differs when the caller sent an IC number or the record has member_id/document_id swapped.

Example response

{
  "success": true,
  "message": "Token status retrieved successfully",
  "data": {
    "memberID": "871215435364",
    "resolvedMemberID": "TWE-123456",
    "hasToken": true,
    "epkey": "C23CA2EF5425B4879E3117BF1DAE5D361A5A9E351D0650700B14977E32A2E79002056",
    "lastPaymentRefNo": "merchant-reference-712894",
    "lastPaymentDate": "2025-01-15T10:35:05.000Z"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.