QRPH Payment

Guidelines for Monitoring QRPH Transactions:

  1. For Transactions with fundSource.type as maya-wallet: Utilize the id (or payment ID) where the last 12 digits or characters align with the Maya App receipt. This ensures accurate tracking and correlation with Maya App receipts.
  2. For Transactions with fundSource.type as qrph: Identify the transaction using the receiptNumber values. The receiptNumber serves as the issuer-generated reference number also mirrored in their issuer receipts. This approach ensures a reliable method for transaction identification and reconciliation.

QRPH Payment using Maya Wallet

When a Maya Wallet account is used for QRPH payment, the fundSource.type value is set as maya-wallet and have the following fundSource specifications.

ℹ️ The fundSource specifications outlined below apply to both the webhook and response payload of Retrieve Payment (GET) endpoints.

FieldTypeFormatDescription
typeREQUIREDstringConstant value: maya-wallet
A string type of the fund source
idREQUIREDstringUUIDA unique identifier of the fund source in Maya’s system
description REQUIREDstringThis field contains a masked account ID of the Maya Wallet account only showing the last 4 digits
details REQUIREDobjectThis field may contain account holder information
details.firstName REQUIREDstringThis field may contain the account holder’s first name;
If not available, the value is statically set to ******
details.middleName REQUIREDstringThis field may contain the account holder’s middle name;
If not available, the value is statically set to ******
details.lastName REQUIREDstringThis field may contain the account holder’s last name;
If not available, the value is statically set to ******
details.msisdn REQUIREDstringThis field may contain the account holder’s phone number;
If not available, the value is statically set to ******
details.email REQUIREDstringMay contain the account holder’s email address;
If not available, the value is statically set to ******
details.profileId REQUIREDstringThis field may contain the account holder’s Maya profile ID;
If not available, the value is statically set to ******
details.masked REQUIREDstringThis field may contain the masked msdisdn, which only shows the last 4 digits;
If not available, the value is statically set to ******
details.hashstringIn the BETA stage; a hash value of the Maya Account customer identity number; may be used to identify a Maya consumer account uniquely; this parameter is in the beta stage, which means only selected merchants may receive this hash value

Sample fundSource

{
    "type": "maya-wallet",
    "id": "e2564ba3-c7c9-48f9-905e-029a9b4b988c",
    "description": "******eee4",
    "details": {
      "firstName": "MAYA",
      "middleName": "JUAN",
      "lastName": "CRUZ",
      "msisdn": "+639172220366",
      "profileId": "712393985914",
      "email": "******",
      "masked": "********0366",
      "hash": "4DIAF1P5iPCKCdmVDww8ot7xiSapq3mqgakStzPbUbc="
    }
  }

Sample PAYMENT_SUCCESS Webhook payload

Customer view in Maya App

Customer view in Maya App

The Payment ID (aa59a630d8b8) reflected in the Maya App receipt is the last 12 digits or characters of the "id": "e732f996-cb87-4120-b712-166d8183c01d" in the webhook payload notification.

{
  "id": "e732f996-cb87-4120-b712-166d8183c01d",
  "isPaid": true,
  "status": "PAYMENT_SUCCESS",
  "amount": "500",
  "currency": "PHP",
  "canVoid": true,
  "canRefund": true,
  "canCapture": false,
  "createdAt": "2024-09-04T16:10:00.194Z",
  "updatedAt": "2024-09-04T16:10:51.154Z",
  "fundSource": {
    "type": "maya-wallet",
    "id": "e2564ba3-c7c9-48f9-905e-029a9b4b988c",
    "description": "******eee4",
    "details": {
      "firstName": "MAYA",
      "middleName": "JUAN",
      "lastName": "CRUZ",
      "msisdn": "+639172220366",
      "profileId": "712393985914",
      "email": "******",
      "masked": "********0366",
      "hash": "4DIAF1P5iPCKCdmVDww8ot7xiSapq3mqgakStzPbUbc="
    }
  },
  "receiptNumber": "102938576837",
  "requestReferenceNumber": "1625127550",
  "paymentTokenId": "******",
  "receipt": {
    "transactionId": "31f887de-22f4-a541-4262-efbc4d5cd65c",
    "batchNo": "20240905",
    "receiptNo": "102938576837",
    "approval_code": "5cd65c",
    "approvalCode": "5cd65c"
  },
  "approvalCode": "5cd65c"
}

Sample PAYMENT_FAILED Webhook payload

{
  "id": "e732f996-cb87-4120-b712-166d8183c01d",
  "isPaid": false,
  "status": "PAYMENT_FAILED",
  "amount": "500",
  "currency": "PHP",
  "canVoid": false,
  "canRefund": false,
  "canCapture": false,
  "createdAt": "2024-09-04T16:10:00.194Z",
  "updatedAt": "2024-09-04T16:10:51.154Z",
  "fundSource": {
    "type": "maya-wallet",
    "id": "e2564ba3-c7c9-48f9-905e-029a9b4b988c",
    "description": "******eee4",
    "details": {
      "firstName": "MAYA",
      "middleName": "JUAN",
      "lastName": "CRUZ",
      "msisdn": "+639172220366",
      "profileId": "712393985914",
      "email": "******",
      "masked": "********0366",
      "hash": "4DIAF1P5iPCKCdmVDww8ot7xiSapq3mqgakStzPbUbc="
    }
  },
  "requestReferenceNumber": "1625127550",
  "paymentTokenId": "******",
  "errorCode": "PY0016",
  "errorMessage": "[PY0016] Payment processor service error"
}

QRPH Payment using other Wallets

When using other wallets (non-Maya wallets) for QRPH payment, the fundSource.type value is set as qrph and have the following fundSource specifications.

ℹ️ The fundSource specifications outlined below apply to both the webhook and response payload of Retrieve Payment (GET) endpoints.

FieldTypeFormatDescription
typeREQUIREDstringConstant value: qrph
A string type of the fund source
idREQUIREDstringUUIDA unique identifier of the fund source in Maya’s system
description REQUIREDstringThis field contains the account ID of the fund source
details REQUIREDobjectThis field may contain the hash field
details.hashstringIn the BETA stage; a hash value of the Maya Account customer identity number; may be used to identify a Maya consumer account uniquely; this parameter is in the beta stage, which means only selected merchants may receive this hash value

Sample fundSource

{
    "type": "qrph",
    "id": "e6688dfa-ef9a-b20e-4d4c-4f450c01d49f",
    "description": "********4123",
    "details": {
      "hash": "4DIAF1P5iPCKCdmVDww8ot7xiSapq3mqgakStzPbUbc="
    }
 }

Sample PAYMENT_SUCCESS Webhook payload

GCash

Customer view in GCash App

Customer view in GCash App

The QRPH Invoice No. (411611) reflected in the GCash App receipt is the"receiptNumber": "411611" in the webhook payload notification.

{
  "id": "afad9f99-7934-4c28-901f-0df724e6fa9a",
  "isPaid": true,
  "status": "PAYMENT_SUCCESS",
  "amount": "1",
  "currency": "PHP",
  "canVoid": true,
  "canRefund": true,
  "canCapture": false,
  "createdAt": "2024-01-12T06:40:11.000Z",
  "updatedAt": "2024-01-12T06:40:33.000Z",
  "fundSource": {
    "type": "qrph",
    "id": "f95c62d1-2955-4ec0-b340-75285c4e08af",
    "description": "********4123",
    "details": {
      "hash": "4DIAF1P5iPCKCdmVDww8ot7xiSapq3mqgakStzPbUbc="
    }
  },
  "receiptNumber": "411611",
  "requestReferenceNumber": "78e9646e-be6f-48ed-a009-a6ffb3b305b5"
}

Shopeepay

Customer view in Shopeepay

Customer view in Shopeepay

The Instapay Receipt No. (525721) reflected in the Shopeepay App receipt is the"receiptNumber": "525721" in the webhook payload notification.

{
  "id": "52a80aa8-95c4-470a-9834-fa3c6ed59780",
  "isPaid": true,
  "status": "PAYMENT_SUCCESS",
  "amount": "1",
  "currency": "PHP",
  "canVoid": false,
  "canRefund": true,
  "canCapture": false,
  "createdAt": "2024-01-11T11:25:48.000Z",
  "updatedAt": "2024-01-11T11:26:14.000Z",
  "fundSource": {
    "type": "qrph",
    "id": "9dbc3061-c51a-4c18-bf71-cce34bd752c6",
    "description": "*****5238",
    "details": {
      "hash": "4DIAF1P5iPCKCdmVDww8ot7xiSapq3mqgakStzPbUbc="
    }
  },
  "receiptNumber": "525721",
  "requestReferenceNumber": "78e9646e-be6f-48ed-a009-a6ffb3b305b5"
}

Sample PAYMENT_FAILED Webhook payload

{
  "id": "e732f996-cb87-4120-b712-166d8183c01d",
  "isPaid": false,
  "status": "PAYMENT_FAILED",
  "amount": "200",
  "currency": "PHP",
  "canVoid": false,
  "canRefund": false,
  "canCapture": false,
  "createdAt": "2024-09-04T16:18:12.482Z",
  "updatedAt": "2024-09-04T16:18:50.793Z",
  "fundSource": {
    "type": "qrph",
    "id": "e6688dfa-ef9a-b20e-4d4c-4f450c01d49f",
    "description": "********4123",
    "details": {
      "hash": "4DIAF1P5iPCKCdmVDww8ot7xiSapq3mqgakStzPbUbc="
    }
  },
  "requestReferenceNumber": "1625127550",
  "errorCode": "PY0016",
  "errorMessage": "[PY0016] Payment processor service error"
}