Create Withdrawal Order (United Arab Emirates)

API for creating UAE Dirham (AED) withdrawal orders, supporting AE IBAN bank transfers and PAYBY / AANI / EMONEY / DUPAY wallets.

Request Information

• Request URL: /gateway/api/v2/payouts
• Method: POST
• Content-Type: application/json;charset=utf-8

Request Parameters

Parameter	Required	Type	Description
platform_id	Yes	String(6)	Merchant ID
service_id	Yes	String(7)	Service ID, fixed value SVC0004
payout_cl_id	Yes	String(64)	Merchant Order ID
amount	Yes	Integer(10)	Amount (in fils)
notify_url	No	String(256)	Callback URL for transaction results
bank_name	Yes	String(16)	Bank/wallet code, the English bank name is also accepted, Bank List
name	Yes	String(64)	Beneficiary name
number	Yes	String(64)	Beneficiary account: the IBAN for bank transfers, the wallet account for wallets
iban	Conditional	String(34)	UAE IBAN (AE + 21 digits, 23 characters in total), e.g. AE070331234567890123456. Required for bank transfers and AANI wallet; for bank transfers, number is validated as the IBAN when omitted; not needed for PAYBY / EMONEY / DUPAY
phone_number	Conditional	String(11)	Beneficiary mobile number (e.g. 0501234567). Required for bank transfers; for wallets, number is used when omitted
currency	Yes	String(3)	Fixed value: aed
request_time	Yes	Integer(10)	Request time (seconds)
sign_type	No	String(16)	Signature type, fixed value HMAC-SHA256
sign	Yes	String(32|64)	Order Signature

"Conditional" means it depends on the payout method; see the remarks below.

Service ID

• SVC0004 Bank card payout (bank transfer or wallet, selected by bank_name)

Response Example

{
  "error_code": "0000",
  "data": { "payout_id": "POT00000001" }
}

Remarks

Important

In case of a timeout or HTTP 500 error, rely on the order query interface for the status; do not treat it as a failed order.

• Transaction amount is in UAE Dirham (fils)
• Bank transfer: pass the bank code or English bank name in bank_name, iban must be a valid UAE IBAN (AE + 21 digits, 23 characters in total), and phone_number is required
• Wallets (PAYBY / AANI / EMONEY / DUPAY): pass PAYBY, AANI, EMONEY or DUPAY in bank_name and the wallet account in number; see Bank List
  • PAYBY: the wallet account is a 9-digit number starting with 5
  • AANI: wallet account must be 9 digits starting with 5; iban must also be provided (AE + 21 digits)
  • EMONEY / DUPAY: wallet account must be 9 digits starting with 5
• Per-transaction limits: 200 – 10000 AED for bank transfers; wallet per-transaction limits are subject to operations settings
• If the beneficiary details fail validation, the error is returned at creation time and no order is created
• "0000" only means the API call succeeded; call the query interface to confirm the result