IQIraQPayAPI Reference

Available Banks

Returns the wallet methods ("banks") enabled for your site. Show these to your user and send the chosen _id as bankId when creating a deposit or withdraw.

GET/v1/available-banks

Optional query: lang=en|ar|ckb|kmr|tr localizes name.

The bank model

NameTypeDescription
_idstringMethod id. Use as bankId. The method code is also accepted.
codestringFIB, QI_CARD, SWITCH, FASTPAY, ZAINCASH, ASIAPAY, NASS_WALLET
namestringDisplay name (localized).
identifierKindstringWhat identifies an account for this method: PHONE | CARD_NO | ACCOUNT_NO | IBAN | USERNAME. Use it to label the field your user fills in for withdrawals.
identifierHintstringExample format to show as placeholder (e.g. 07XX XXX XXXX).
min / maxnumberAllowed amount range in IQD (0 = no limit).
logostring | nullLogo URL when available.

Response

{
  "data": [
    { "_id": "cmv2mgajb000112f9wyi0k9qu", "code": "FIB", "name": "FIB",
      "identifierKind": "PHONE", "identifierHint": "07XX XXX XXXX", "min": 5000, "max": 10000000, "logo": null },
    { "_id": "cmv2mgajm000212f96zp2o0uz", "code": "QI_CARD", "name": "Qi Card",
      "identifierKind": "CARD_NO", "identifierHint": "Card number (10–19 digits)", "min": 5000, "max": 10000000, "logo": null }
  ],
  "status": 200, "responseTime": "18ms", "app_version": "iraqpay-v0.1.0"
}