Skip to main content
Before reading this API document, please check API Description Guide

​
Transaction Limits

Transaction TypeLimit (Unit: EGP)
CollectionEgyptian Pound: 5-30000
DisbursementEgyptian Pound: 20-30000

​
Collection API

​
Collection Application

Brief Description:
  • Create a collection order
URL: /egp/collect/apply Note: appId needs to use EGP corresponding, user payment success will increase EGP balance Parameters:
Parameter NameRequiredTypeDescription
appIdYesLongBusiness ID (obtained from backend, needs to pass the corresponding Business ID based on the currency in the URL)
orderIdYesStringMerchant order number (must be unique, length no more than 48)
nameYesStringPayer name
phoneYesStringPayer mobile number
emailYesStringPayer email address
amountYesStringTransaction amount
payTypeYesStringPayment Method Type
inBankCodeYesStringPayment Method Code
callBackUrlYesStringRedirect URL after successful payment
callBackFailUrlYesStringRedirect URL after failed payment
notifyUrlNoStringCallback URL
subjectYesStringPayment remark
bodyNoStringRemark details
partnerUserIdYesStringUnique user identifier (e.g., userId), used for risk control system, must be valid, otherwise it will affect the transaction. Format: digits, 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 field description
Parameter NameTypeDescription
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
payUrlStringPayment link
signStringSignature

​
Collection Query

Brief Description:
  • Query collection order
URL: /egp/collect/query Parameters:
Parameter NameRequiredTypeDescription
appIdYesLongBusiness ID (obtained from backend, needs to pass the corresponding Business ID based on 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 field description
Parameter NameTypeDescription
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
amountStringTransaction amount
actualAmountStringReceived amount
feeStringTransaction fee
statusIntegerStatus (0 Not Started, 1 In Progress, 2 Success (final), 3 Failed (final), -1 Exception Pending Confirmation)
payTimeStringPayment success time (when status=2), format: yyyy-MM-dd HH:mm:ss (Egypt Time)
errorMsgStringFailure reason (when status=3)
signStringSignature

​
Payment Methods

CurrencyPayment Type (payType)Payment Code (inBankCode)LimitStatusDescription
EGPEWALLETREFERENCE_CODE10-30000AvailableFawry Wallet
EGPEWALLETVODAFONE5-30000AvailableVodafone Wallet
EGPEWALLETR2P10-30000MaintenanceMWallet USSD Push Payment
EGPEWALLETOTP5-30000MaintenanceVodafone OTP Verification Payment

​
Disbursement API

  1. Transactions submitted before 3:00 PM on business days will arrive on the same day (business days are Sunday to Thursday, Egypt’s weekend is Friday and Saturday).
  1. Transactions submitted after 3:00 PM on business days will be successful on the next business day.
    • For example: transactions submitted after 3:00 PM on Thursday will be processed successfully on Sunday.
  2. Local weekends or public holidays do not process disbursement transactions, need to wait until the next business day to process

​
Disbursement Application

Brief Description:
  • Create a disbursement order
URL: /egp/pay/apply Parameters:
Parameter NameRequiredTypeDescription
appIdYesLongBusiness ID (obtained from backend, needs to pass the corresponding Business ID based on the currency in the URL)
orderIdYesStringMerchant order number (must be unique, length no more than 48)
amountYesStringTransaction amount (Unit: Egyptian Pound)
accountTypeYesStringPayment Method Type
bankCodeYesStringPayment Method Code
accountNoYesStringUser bank/wallet account number (wallet account please use +2 prefix mobile number format)
nameYesStringRecipient name
phoneYesStringRecipient mobile number (please use +2 prefix mobile number format)
emailYesStringRecipient email address
notifyUrlNoStringCallback URL
subjectNoStringPayment remark (transaction title, product name, payment reason)
bodyNoStringRemark details
partnerUserIdYesStringUnique user identifier (e.g., userId), used for risk control system, must be valid, otherwise it will affect the transaction. Format: digits, letters, or symbols -~!@#$%&*()_
signYesStringSignature
request (when accountType is EWALLET type) 
{
  "appId": 1054,
  "orderId": "M100000450012",
  "amount": "500",
  "accountType": "EWALLET",
  "bankCode": "MEEZA",
  "accountNo": "+201012345678",
  "name": "john doe",
  "phone": "+201012345678",
  "email": "johndoe@cashfree.com",
  "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": "M100000450012",
    "orderNo": "1525091710234210109",
    "sign": "LmhUnkw5j0pMiimsG8rKwdNNZGvXH5MpSmD6mdHZwq1SQwuK5BohmdEoqKB/jkMk28o3da4Cxh6Q+tW97+yTCemRrF+dMaHA73rpOeUuujKQl/UcFvJuMhfLBa2tp09L71NzoBqpPD6aXf37mYAz8E1HmERwFPpac5FVxIYanHG8cqmMLJYsVmHTSxWavgWU03ys9UczBePkBiR8sl2FSOhFABB0wAP28lswrV/ABS68IsLKtyd1fyI3GBfSbIK5nDEEnlE+EdElFdLs9taAxJImeVF1x4eT47+bkPJ2qS8z3K8QGzKLF3W+8SiRZGfSwDTsLKH+2Vycvy5auRl+ag=="
  }
}
Response data field description
Parameter NameRequiredType
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
signStringSignature

​
Disbursement Query

Brief Description:
  • Query disbursement order
URL: /egp/pay/query Parameters:
Parameter NameRequiredTypeDescription
appIdYesLongBusiness ID (obtained from backend, needs to pass the corresponding Business ID based on the currency in the URL)
orderIdYesStringMerchant order number
orderNoNoStringPlatform order number (faster response)
signYesStringSignature
request 
{
  "appId": 1000,
  "orderId": "M100000450012",
  "orderNo": "1525091710234210109",
  "sign": "ZxkVZL+GAyv0VhvWn4IvuYahTzxgQuthkuV2ONWiqIfIDb2avvHlFOUJVzqZi1q8CPHXZm1ltanRTRVTxfsuftLvGeDioUHglWt46/RU6c1OPznpLGsZ35Q3n5tW2y1EnOsxPynXBFLuDQy+aZ3l9u6AQ30T0zQexMGT+IxuFkmUp02g/6juaHa5ZgNMv7lN67ixIp162wrM7OJuaOif872QijSceRdZhzaMGImAwB0D4MosRV4WMBOKkwgPdmS7GuZN66YUidXk3wTGqX3MYRw6M0kj4eNegSUwPXvp4q4p0KO8Y3xUMld54GY2ApX3WN3CBtC/vpJqEszjGBbbGg=="
}
response — Order failed 
{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {
    "orderId": "M100000450012",
    "orderNo": "1525091710234210109",
    "amount": "500",
    "fee": "0",
    "status": 3,
    "errorMsg": "الطلب غير موجود",
    "sign": "KKuvCl0SuNANJs+l2ogDaJm8pmV+Hi+Xa7q27vJ6D1Ehs4aOp13kRbITfJAhczh3T81BE9qwHeJaYwf+r0EypKM9TL6pMwfG8Az4gRy1D57wiUaVjl2PWcvbEqrn1hL0b+btkjvAM9I+CcSv+wuOW3/uku17Ws3FhgJLj9sFsQUBAPjDO+758VnwBytCOLBmljLBXyKgNgpmFQ1/DNkqWl0UNzyLK45Zw3yf5NiwhEFbvW0jlOWlfu/ql4hluISUQG573jEoFCBEnQLb2tQoRZj1QYNRCXPf5lbej0vzqbEwvR9h+ZOf255t1MocJkdIe463DTV5U3KZdVT87HMagw=="
  }
}
response — Order successful 
{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {
    "orderId": "M100000450012",
    "orderNo": "1525091710234210109",
    "amount": "500",
    "fee": "10",
    "status": 2,
    "payTime": "2024-03-01 23:59:59",
    "sign": "khPtOmGq+cpKX0HFAI/lbP0dx4oVyNAnL5oLsdmhDJdASlQm0yg5I3o+MhImYggEsL6c2bo5fP29t54OZFqSdQDfIuNDvGbAMAr4mRBxc0hoHLkBLyyagfVPBLyQA1JY8XV3ZL4ySzQ3ZQnMCfrh2K39ueUuz6HpZ03Hj0KYijVRCXAZaio/L5jfLBT12QXmvIfAHa8s/k9flhK05ENHPep3zjj/MZGOEaX7jkEJLfjK0duypDCa61BRQjM+oePOdVsgleIl1Yf98UAxMDZ/A3912KFHEb+/jvmdnulNbiJFyuT1fEe+j2teUgw3vFsZAtwNWAgxhC7UO+N0Q5z4EA=="
  }
}
Response data field description
Parameter NameTypeDescription
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
amountStringTransaction amount
feeStringTransaction fee
statusIntegerStatus (0 Not Started, 1 In Progress, 2 Success (final), 3 Failed (final), -1 Exception Pending Confirmation)
payTimeStringPayment success time (when status=2), format: yyyy-MM-dd HH:mm:ss (Egypt Time)
errorMsgStringPayment failure reason (when status=3)
signStringSignature

​
Payment Methods

CurrencyPayment Type (accountType)Payment Code (bankCode)LimitStatusDescription
EGPEWALLETMEEZA20-30000AvailableMeezaWallet is a mobile number–based e-wallet under Egypt’s Meeza payment network, supporting account type identification based on the phone number and enabling payouts to local wallets such as Vodafone Cash, Orange Money, and Etisalat Cash.
EGPEWALLETOPAY20-30000AvailableOpayCard
EGPBANK_ACCOUNTABP20-30000AvailableAllBank Inc
EGPBANK_ACCOUNTAAIB20-30000AvailableArab African International Bank
EGPBANK_ACCOUNTABC20-30000AvailableArab Banking Corporation - Egypt
EGPBANK_ACCOUNTABK20-30000AvailableAl Ahli Bank of Kuwait – Egypt
EGPBANK_ACCOUNTABRK20-30000AvailableAl Baraka Bank Egypt
EGPBANK_ACCOUNTADIB20-30000AvailableAbu Dhabi Islamic Bank – Egypt
EGPBANK_ACCOUNTAIB20-30000AvailableArab Investment Bank
EGPBANK_ACCOUNTARAB20-30000AvailableArab Bank
EGPBANK_ACCOUNTARIB20-30000AvailableArab International Bank
EGPBANK_ACCOUNTAUB20-30000AvailableAhly United Bank
EGPBANK_ACCOUNTAUDI20-30000AvailableAudi Bank
EGPBANK_ACCOUNTBBE20-30000AvailableATTIJARIWAFA BANK EGYPT S.A.E
EGPBANK_ACCOUNTBDC20-30000AvailableBanque Du Caire
EGPBANK_ACCOUNTBLOM20-30000AvailableBlom Bank Egypt
EGPBANK_ACCOUNTBOA20-30000AvailableBank of Alexandria
EGPBANK_ACCOUNTCAE20-30000AvailableCredit Agricole
EGPBANK_ACCOUNTCIB20-30000AvailableCommercial International Bank
EGPBANK_ACCOUNTCITI20-30000AvailableCitibank
EGPBANK_ACCOUNTEALB20-30000AvailableEgyptian Arab Land Bank
EGPBANK_ACCOUNTEDBE20-30000AvailableExport Development Bank of Egypt
EGPBANK_ACCOUNTEGB20-30000AvailableEgyptian Gulf Bank
EGPBANK_ACCOUNTENBD20-30000AvailableEmirates National Bank of Dubai
EGPBANK_ACCOUNTFAIB20-30000AvailableFaisal Islamic Bank of Egypt
EGPBANK_ACCOUNTHDB20-30000AvailableHousing And Development Bank
EGPBANK_ACCOUNTHSBC20-30000AvailableHSBC
EGPBANK_ACCOUNTIDBE20-30000AvailableIndustrial Development Bank of Egypt
EGPBANK_ACCOUNTMASH20-30000AvailableMashreq Bank
EGPBANK_ACCOUNTMIDB20-30000AvailableMisr Iran Development Bank
EGPBANK_ACCOUNTMISR20-30000AvailableBanque Misr
EGPBANK_ACCOUNTNBAD20-30000AvailableNational Bank of Abu Dhabi
EGPBANK_ACCOUNTNBE20-30000AvailableNational Bank of Egypt
EGPBANK_ACCOUNTNBG20-30000AvailableNational Bank of Greece
EGPBANK_ACCOUNTNBK20-30000AvailableNational Bank of Kuwait – Egypt
EGPBANK_ACCOUNTNSB20-30000AvailableNasser Social Bank
EGPBANK_ACCOUNTPDAC20-30000AvailableThe Principal Bank for Development and Agri.
EGPBANK_ACCOUNTQNB20-30000AvailableQatar National Bank Alahli
EGPBANK_ACCOUNTSAIB20-30000AvailableSociete Arabe Internationale De Banque
EGPBANK_ACCOUNTSCB20-30000AvailableSuez Canal Bank
EGPBANK_ACCOUNTUB20-30000AvailableThe United Bank
EGPBANK_ACCOUNTUNB20-30000AvailableUnited National Bank
Last modified on April 17, 2026