Skip to main content
Before reading this API documentation, please make sure to review API Guide

​
Transaction Limits

Transaction TypeLimit (Unit: PHP)
Collection100-50000
Disbursement1-50000

​
Collection API

​
Collection Application

Description:
  • Create a collection order.
URL: /php/collect/apply Note: AppId must correspond to the Philippine Peso (PHP), and upon successful payment, the user’s PHP balance will be topped up. Parameters:
NameRequiredTypeDescription
appIdYesLongBusiness ID (obtain from the backend, must pass the correct business ID according to the currency in the URL).
orderIdYesStringMerchant order number (must be unique, max length 48).
nameYesStringPayee name (format: upper/lowercase letters with spaces allowed, 1-30 chars, “firstName middleName lastName” (middleName optional, special characters supported: ! -)).
phoneYesStringReal phone number (format: starts with 09, numeric only, 11 digits). Valid if it matches the format.
emailYesStringReal email.
amountYesStringTransaction amount (unit: ₱, up to 2 decimal places; do not add symbols such as “,”). Range: 50-49999.
payTypeYesStringTransaction type.
inBankCodeYesStringPayment Method.
callBackUrlYesStringRedirect URL after successful payment.
callBackFailUrlYesStringRedirect URL after failed payment.
notifyUrlNoStringCallback notification URL.
subjectNoStringPayment note.
bodyNoStringPayment details.
partnerUserIdYesStringUnique user identifier (e.g., userId). Used by risk control systems, must be real and valid. Format: numbers, letters, or symbols -~!@#$%&*()_.
signYesStringSignature.
request 
{
    "appId": 1054,
    "orderId": "M233323000059",
    "amount": "300",
    "phone": "09230219312",
    "email": "23423@qq.com",
    "name": "test",
    "inBankCode": "PH_QRPH_DYNAMIC",
    "payType": "QR",
    "partnerUserId": "149597870",
    "sign": "af0gAHkUOyYHu9owQp8NJ4mPEeUW4vuJcjdxqLIzrVw8AvpLSjD1DXupReSG/CyuSkFRyiIvCp5u703AuGGmfgD2gKDH3Ywau41bAbG2jnHJ8mtjiSJ5iWUzanyd4Kr7d1+rETbzUl7/BkW3t0X8UUFdqpxwG8DPUjAwUKfplWDHV7koG51Ozexd80DCsmW6eWdouAZ1uNXGLYmV3ftE3BmfNRtuv1C5bfTJWrTEIOxbF6g2uYOFZTlIgrQgd7/2PsAYwQQXNz8Q8CYl4OxqCv4pXJxaLWPbR5tqZu9og5kn32C9aHW/NlU1y39vzz+4ef81yPAqUV9oHlSMSPrMmw=="
}
response 
{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M233323000059",
        "orderNo": "6023071013539074",
        "payUrl": "https://a.api-uat.php.com/1L9zQS2",
        "bankCode": "GCASH_STATIC_VA",
        "bankNo": "PC0007I10000035",
        "qrCode": "00020101021228760011ph.ppmi.p2m0111OPDVPHM1XXX0315777148000000017041652948137245442930503001520460165303608540810000.php Of Mandalu62310010ph.allbank05062110000803***88310012ph.ppmi.qrph0111OPDVPHM1XXX63042763",
        "sign": "YEoA8Y2JzQFGVzwJSqmemm1Kfv/bfyIfCqv2dp7RNzT5B72AQvdD+nt2nR4sL1HWscvmNHyVt5ovAi7MMhy3ziih/sMph+wPx4YjH3W1h5DyBvSlWvaKfKrK5ViomZ0pPYWydwRHnnRnicxToHK9S6qtSy7Q73O0hdz4hJ9p41Th3ycBl2Q9SeqSZYSY1ohcPDhdyRf2y0prb8rHgpBKzxZ5BKX/1bsE9OmsSEHAEYT8OGgko6aNe8XPAhr4G48cpWTftvnGQuzh0O65nuZRI/PF+Axt2zJCVbFHDDSREI9NlAT82ebDqhlVdxQzKE67D1nxgjb3dPmDUYHOBpmwxQ=="
    }
}
Response Data Parameters
NameTypeDescription
orderIdStringMerchant order number (must be unique).
orderNoStringPlatform order number.
payUrlStringPayment link.
bankNoStringRepayment account number (VA).
bankCodeStringChannel code (VA).
qrCodeStringQR code content (can be used to generate QR).
signStringSignature.

​
Collection Query

Description:
  • Create a collection order.
  • When payType=PAYMENT_GATEWAY, the orderNo will be returned synchronously and can be queried directly.
  • For other payment methods, after asynchronous notification, query again with orderNo for confirmation.
URL: /php/collect/query Parameters:
NameRequiredTypeDescription
appIdYesLongBusiness ID (obtain from the backend, must pass the correct business ID according to the currency in the URL).
orderIdYesStringMerchant order number.
orderNoNoStringPlatform order number (faster response).
signYesStringSignature.
request 
{
    "appId": 1054,
    "orderId": "M22222000028",
    "sign": "EmyJGm3ELzG4FsOd0Krs9ncbSjo4oTGuXWML+7djYla3+VAwd9wS17z38p/7U2ZAjroO04XrE7YXcB1o76Dtyipj3h3bJzs7FYma1QNkMUdt9hh7m8U6hMsMQX7vIWHtXNwz4pbTSC75+kQWXaCew7KoE6LXECdJU8AISgNgeki2TK9R0pCfshr0Z2SZBPeuT6OvIH5LdmqgdZhuqnffGU2qnXk4KMkO848e6/WALLBR+LE1wyKHfPnYVcuKSMVYxkvKyyIL5JIPEgW0o5bh4RCbaUn3NZtyYwrU1uQ3ZDFRThm9j6XAQP+LBlmq3nOePqBtp/VDVarRaV+7FbQg3A=="
}
response 
{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M22222000028",
        "orderNo": "6023042811314347",
        "amount": "50000.00",
        "actualAmount": "0.00",
        "fee": "0.00",
        "status": 1,
        "sign": "fP433ygWVDLVGxYkVnIJj7riGq0U3vyVX+MbBAImxfGLZkZcEAHVEoVYuULZSmXAAXKRSyd67WlDNm+24pougM54ofAoH4HMtCL2tfCoBReFyz3z02AGKkrKE2xWhSpWoqfQoBvzwuN5iGMMu0s9Q1YvqiwJ8WDVIENnmiIyD8qDJN7caHTW2US14/faG+69AvnuIgJ/nu7/jogOlgEYdZdVYU7gcRDE+d47KjlFGswQkJ/h/uzV7cWtUqrtOO7ZnZ3/z33Xx8awokX36QoYcPSWAU0h+Ij9O9402HNhm1eTbYcLU0uI/z8xCAtyAI/tTyiFijpiNlxUKQj+zKsILw=="
    }
}
Response Data Parameters
NameTypeDescription
orderIdStringMerchant order number (must be unique).
orderNoStringPlatform order number.
amountStringTransaction amount.
actualAmountStringReceived amount.
feeStringHandling fee.
statusIntegerStatus (0: Not started, 1: Collecting, 2: Success, 3: Failed, 4: Partial, 5: Overpaid, -1: Exception pending confirmation).
payTimeStringPayment success time (present when status=2,4,5) (Philippines Time), format: yyyy-MM-dd HH:mm:ss
errorMsgStringFailure reason (present when status=3).
signStringSignature.

​
Payment Methods

CurrencyPayment Type (payType)Payment Code (inBankCode)LimitStatusDescription
PHPQRPH_QRPH_DYNAMIC100-50000AvailableQRPH Dynamic Code
PHPPAYMENT_GATEWAYGCASH_QR100-50000AvailableGCash Wallet (Activation)
PHPPAYMENT_GATEWAYGCASH_URL100-50000AvailableGCash Wallet (Direct)
PHPPAYMENT_GATEWAYGRPY_URL100-50000AvailableGrabPay Wallet
PHPPAYMENT_GATEWAYPAYMAYA_URL100-50000AvailablePayMaya Wallet

​
Payout API

​
Payout Apply

Description:
  • Create a payout order.
URL: /php/pay/apply Parameters:
NameRequiredTypeDescription
appIdYesLongBusiness ID (obtain from backend, must match the business ID according to the currency in the URL).
orderIdYesStringMerchant order number (must be unique, max length 48).
amountYesStringTransaction amount (unit: ₱, accurate to 2 decimals; do not include punctuation such as “,”).
accountTypeYesStringAccount type: EWALLET (e-wallet), BANK_ACCOUNT (bank).
bankCodeYesStringWallet code and bank code.
accountNoYesStringUser’s bank/wallet account number.
nameYesStringRecipient name (Format: English letters, allows spaces, 1-30 chars, “firstName middleName lastName”, middleName optional, supports ’.-).
phoneYesStringReal phone number (Format: starts with 09, digits only, 11 digits total).
emailYesStringReal email address.
notifyUrlNoStringCallback URL.
subjectNoStringPayment remark (transaction title, product name, payment reason).
bodyNoStringDetailed remark.
partnerUserIdYesStringUnique user identifier (e.g., userId), required for risk control. Must be valid. Format: digits, letters, or common symbols -~!@#$%&*()_.
signYesStringSignature.
request（When accountType = BANK_ACCOUNT） 
{
    "appId": 1054,
    "orderId": "M100000450012",
    "amount": "500",
    "accountType": "BANK_ACCOUNT",
    "bankCode": "BDO",
    "accountNo": "09876543210",
    "name": "john doe",
    "phone": "09876543210",
    "email": "johndoe@cashfree.com",
    "subject": "iphone13",
    "body": "ProMotion technology with adaptive refresh rates up to 120Hz",
    "partnerUserId": "149597870",
    "sign": "I1PeK3eJOVsFFNowxVRqMXpeWm1lr/BcRpBi8WsW4wVo1+5CC3JsrFq/m/L2O69NzKHvtDWi4zia3DL3dPut0yMyUyqL91LNCSaeISbGsQPlhEsQpyTOryS/RKOfsrn2Xo37SCF/phAvndOk2jwwGwqM5xLz1ms9Ukl85wv27QFNrXIMxK2p18oe7MpMYrgf+xvEBE/VqCtKMtN9pO449wWwXzHWNPbZ76s4pAvKwRE9yXQDr7Iw14Dktcnl1FoLM4gWM/obkO+mz6SyAGDuXhVh/+OD/IGNiCyTCNq6ciQY28UnCFV6ZIP40gxsFhfBJKbK+Raw7y1Bh912ifYfug=="
}
response 
{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M100000450013",
        "orderNo": "3023062014149637",
        "sign": "LmhUnkw5j0pMiimsG8rKwdNNZGvXH5MpSmD6mdHZwq1SQwuK5BohmdEoqKB/jkMk28o3da4Cxh6Q+tW97+yTCemRrF+dMaHA73rpOeUuujKQl/UcFvJuMhfLBa2tp09L71NzoBqpPD6aXf37mYAz8E1HmERwFPpac5FVxIYanHG8cqmMLJYsVmHTSxWavgWU03ys9UczBePkBiR8sl2FSOhFABB0wAP28lswrV/ABS68IsLKtyd1fyI3GBfSbIK5nDEEnlE+EdElFdLs9taAxJImeVF1x4eT47+bkPJ2qS8z3K8QGzKLF3W+8SiRZGfSwDTsLKH+2Vycvy5auRl+ag=="
    }
}
Response Data Description
NameTypeDescription
orderIdStringMerchant order number (must be unique).
orderNoStringPlatform order number.
signStringSignature.

​
Disbursement Query

Description:
  • Query disbursement order.
URL: /php/pay/query Parameters:
NameRequiredTypeDescription
appIdYesLongBusiness ID (obtain from backend, must match the business ID according to the currency in the URL).
orderIdYesStringMerchant order number.
orderNoNoStringPlatform order number (faster response).
signYesStringSignature.
request 
{
    "appId": 1000,
    "orderId": "M1234567111",
    "orderNo": "3022111516571436",
    "sign": "ZxkVZL+GAyv0VhvWn4IvuYahTzxgQuthkuV2ONWiqIfIDb2avvHlFOUJVzqZi1q8CPHXZm1ltanRTRVTxfsuftLvGeDioUHglWt46/RU6c1OPznpLGsZ35Q3n5tW2y1EnOsxPynXBFLuDQy+aZ3l9u6AQ30T0zQexMGT+IxuFkmUp02g/6juaHa5ZgNMv7lN67ixIp162wrM7OJuaOif872QijSceRdZhzaMGImAwB0D4MosRV4WMBOKkwgPdmS7GuZN66YUidXk3wTGqX3MYRw6M0kj4eNegSUwPXvp4q4p0KO8Y3xUMld54GY2ApX3WN3CBtC/vpJqEszjGBbbGg=="
}
response — Order Failed 
{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M1234567111",
        "orderNo": "3022111516571436",
        "amount": "100000.00",
        "fee": "0.00",
        "status": 3,
        "errorMsg": "Đơn hàng không tồn tại",
        "sign": "KKuvCl0SuNANJs+l2ogDaJm8pmV+Hi+Xa7q27vJ6D1Ehs4aOp13kRbITfJAhczh3T81BE9qwHeJaYwf+r0EypKM9TL6pMwfG8Az4gRy1D57wiUaVjl2PWcvbEqrn1hL0b+btkjvAM9I+CcSv+wuOW3/uku17Ws3FhgJLj9sFsQUBAPjDO+758VnwBytCOLBmljLBXyKgNgpmFQ1/DNkqWl0UNzyLK45Zw3yf5NiwhEFbvW0jlOWlfu/ql4hluISUQG573jEoFCBEnQLb2tQoRZj1QYNRCXPf5lbej0vzqbEwvR9h+ZOf255t1MocJkdIe463DTV5U3KZdVT87HMagw=="
    }
}
response — Order Successful 
{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M1234567112",
        "orderNo": "3022111517401574",
        "amount": "100000.00",
        "fee": "1003.00",
        "status": 2,
        "payTime": "2024-03-01 23:59:59",
        "sign": "khPtOmGq+cpKX0HFAI/lbP0dx4oVyNAnL5oLsdmhDJdASlQm0yg5I3o+MhImYggEsL6c2bo5fP29t54OZFqSdQDfIuNDvGbAMAr4mRBxc0hoHLkBLyyagfVPBLyQA1JY8XV3ZL4ySzQ3ZQnMCfrh2K39ueUuz6HpZ03Hj0KYijVRCXAZaio/L5jfLBT12QXmvIfAHa8s/k9flhK05ENHPep3zjj/MZGOEaX7jkEJLfjK0duypDCa61BRQjM+oePOdVsgleIl1Yf98UAxMDZ/A3912KFHEb+/jvmdnulNbiJFyuT1fEe+j2teUgw3vFsZAtwNWAgxhC7UO+N0Q5z4EA=="
    }
}
Response Data Description
NameTypeDescription
orderIdStringMerchant order number (must be unique).
orderNoStringPlatform order number.
amountStringTransaction amount.
feeStringTransaction fee.
statusIntegerStatus (0 Not Started, 1 Processing, 2 Success (final), 3 Failed (final), -1 Exception Pending Confirmation).
payTimeStringPayment success time (available when status=2) (Philippines time), format: yyyy-MM-dd HH:mm:ss.
errorMsgStringReason for payment failure (available when status=3).
signStringSignature.

​
Payment Methods

CurrencyPayment Type (accountType)Payment Code (bankCode)LimitStatusDescription
PHPEWALLETGCASH1-50000AvailableGCash Wallet
PHPEWALLETCOINS1-50000AvailableCoins Wallet
PHPEWALLETPAYMAYA1-50000AvailablePayMaya Wallet
PHPEWALLETGRABPAY1-50000AvailableGrabPay Wallet
PHPEWALLETSHOPEE1-50000AvailableShopeePay Wallet
PHPEWALLETOMNIPAY1-50000AvailableOmniPay Wallet
PHPBANK_ACCOUNTABP1-50000AvailableAllBank Inc.
PHPBANK_ACCOUNTALIP1-50000AvailableAlipay Philippines Inc
PHPBANK_ACCOUNTAUB1-50000AvailableAsia United Bank
PHPBANK_ACCOUNTBDO1-50000AvailableBanco de Oro
PHPBANK_ACCOUNTBMB1-50000AvailableBangko Mabuhay
PHPBANK_ACCOUNTBOC1-50000AvailableBank Of Commerce
PHPBANK_ACCOUNTBPI1-50000AvailableBank of the Philippine Islands
PHPBANK_ACCOUNTBPIDB1-50000AvailableBPI Direct BanKO, Inc., A Savings Bank
PHPBANK_ACCOUNTBRB1-50000AvailableBinangonan Rural Bank (BRBDigital)
PHPBANK_ACCOUNTCBC1-50000AvailableChina Banking Corporation(China Bank)
PHPBANK_ACCOUNTCBS1-50000AvailableChina Bank Savings, Inc
PHPBANK_ACCOUNTCCI1-50000AvailableCIS BAYAD CENTER INC
PHPBANK_ACCOUNTCEBRUR1-50000AvailableCebuana Lhuillier Rural Bank, Inc.
PHPBANK_ACCOUNTCIMB1-50000AvailableCIMB Bank Philippines, Inc.
PHPBANK_ACCOUNTCMG1-50000AvailableCAMALIG BANK
PHPBANK_ACCOUNTCRB1-50000AvailableCOMMUNITY RURAL BANK OF ROMBLON, INC
PHPBANK_ACCOUNTCRD1-50000AvailableCARD Bank
PHPBANK_ACCOUNTCSB1-50000AvailableCitystate Savings Bank
PHPBANK_ACCOUNTCSI1-50000AvailableCARD SME BANK INC
PHPBANK_ACCOUNTCTBC1-50000AvailableCtbc Bank (Philippines) Corp.
PHPBANK_ACCOUNTDBI1-50000AvailableDungganon Bank
PHPBANK_ACCOUNTDBP1-50000AvailableDevelopment Bank of the Philippines
PHPBANK_ACCOUNTDCI1-50000AvailableDUMAGUETE CITY DEVELOPMENT BANK, INC.
PHPBANK_ACCOUNTDCP1-50000AvailableDCPay Philippines Inc.
PHPBANK_ACCOUNTDOP1-50000AvailableDEVT. BANK OF THE PHILIPPINES
PHPBANK_ACCOUNTEQB1-50000AvailableEquicom Savings Bank
PHPBANK_ACCOUNTEWB1-50000AvailableEast-West Banking Corporation
PHPBANK_ACCOUNTEWR1-50000AvailableEast West Rural Bank (Green Bank)
PHPBANK_ACCOUNTGTB1-50000AvailableGoTyme Bank
PHPBANK_ACCOUNTIBI1-50000AvailableISLA Bank
PHPBANK_ACCOUNTING1-50000AvailableING Bank N.V.
PHPBANK_ACCOUNTJPM1-50000AvailableJP Morgan Chase Bank, N.A.
PHPBANK_ACCOUNTLBP1-50000AvailableLand Bank of the Philippines
PHPBANK_ACCOUNTLSB1-50000AvailableLEGAZPI SAVINGS BANK INC
PHPBANK_ACCOUNTLUL1-50000AvailableLULU FINANCIAL SERVICES (PHILS), INC.
PHPBANK_ACCOUNTMBP1-50000AvailableMaybank Philippines
PHPBANK_ACCOUNTMCC1-50000AvailableMINDANAO CONSOLIDATED COOPERATIVE
PHPBANK_ACCOUNTMET1-50000AvailableMetrobank
PHPBANK_ACCOUNTMSB1-50000AvailableMalayan Bank
PHPBANK_ACCOUNTONB1-50000AvailableOne Network Bank
PHPBANK_ACCOUNTOWN1-50000Availableownbank
PHPBANK_ACCOUNTPAP1-50000AvailablePalawanPay
PHPBANK_ACCOUNTPAR1-50000AvailablePartner Rural Bank(Cotabato) Inc.
PHPBANK_ACCOUNTPBB1-50000AvailablePhilippine Business Bank
PHPBANK_ACCOUNTPBCOM1-50000AvailablePhilippine Bank of Communications
PHPBANK_ACCOUNTPNB1-50000AvailablePhilippine National Bank
PHPBANK_ACCOUNTPNS1-50000AvailablePNB Savings Bank
PHPBANK_ACCOUNTPRB1-50000AvailableProducers Bank
PHPBANK_ACCOUNTPSB1-50000AvailablePhilippine Savings Bank
PHPBANK_ACCOUNTPTC1-50000AvailablePhilippine Trust Company
PHPBANK_ACCOUNTPVB1-50000AvailablePhilippine Veterans Bank
PHPBANK_ACCOUNTQCB1-50000AvailableQueen City Development Bank, Inc.
PHPBANK_ACCOUNTQRB1-50000AvailableQuezon Capital Rural Bank
PHPBANK_ACCOUNTRBG1-50000AvailableRURAL BANK OF GUINOBATAN, INC.
PHPBANK_ACCOUNTRCBC1-50000AvailableRizal Commercial Banking Corp. (RCBC)
PHPBANK_ACCOUNTRSB1-50000AvailableRobinsons Bank
PHPBANK_ACCOUNTRSBI1-50000AvailableRcbc Savings Bank Inc.
PHPBANK_ACCOUNTSBA1-50000AvailableSterling Bank Of Asia
PHPBANK_ACCOUNTSBC1-50000AvailableSecurity Bank
PHPBANK_ACCOUNTSEB1-50000AvailableSEABANK PH
PHPBANK_ACCOUNTSPY1-50000AvailableStarpay Corporation
PHPBANK_ACCOUNTSSB1-50000AvailableSun Savings Bank
PHPBANK_ACCOUNTTSB1-50000AvailableTHE STANDARD CHARTERED BANK
PHPBANK_ACCOUNTTYC1-50000AvailableTayocash
PHPBANK_ACCOUNTUBP1-50000AvailableUnion Bank Of The Philippines
PHPBANK_ACCOUNTUCBSB1-50000AvailableUCBP Savings bank
PHPBANK_ACCOUNTUCPB1-50000AvailableUnited Coconut Planters Bank (UCPB)
PHPBANK_ACCOUNTUSS1-50000AvailableUSSC Money Services
PHPBANK_ACCOUNTWDB1-50000AvailableWealth Development Bank
PHPBANK_ACCOUNTYUANSB1-50000AvailableYuanta Savings Bank
PHPBANK_ACCOUNTZTI1-50000AvailableZYBI TECH, INC.
Last modified on April 17, 2026