Appendix · Enums
Payin bankCode enum
Use uppercase platform codes for bankCode when creating payin orders. bankName is only a display column in the table below; new integrations do not send it.
| bankCode | Display name | Notes |
|---|---|---|
EASYPAISA | EASYPAISA | Easypaisa wallet |
JAZZCASH | JAZZCASH | JazzCash wallet |
PAYLINK | PAYLINK | PayLink |
QRANDLAUNCH | QRANDLAUNCH | QR / checkout |
Payout bankCode enum
Use uppercase codes below for bankCode. bankName is only a display column in the table below; new integrations do not send it. For wallet types, prefer payee_mobile; for bank types, prefer payee_account.
| bankCode | Display name | Type |
|---|---|---|
JAZZCASH | JAZZCASH | Wallet |
EASYPAISA | EASYPAISA | Wallet |
ABHI FINANCE SERVICES LIMITED | ABHI FINANCE SERVICES LIMITED | Bank |
AFT | AFT | Bank |
AFT IBFT | AFT IBFT | Bank |
ADVANS | ADVANS | Bank |
AL MEEZAN INVESTMENT MANAGEMENT LIMITED | AL MEEZAN INVESTMENT MANAGEMENT LIMITED | Bank |
ALHABIB | ALHABIB | Bank |
ALBARKA | ALBARKA | Bank |
ALFALAH | ALFALAH | Bank |
ALLIED | ALLIED | Bank |
APNA | APNA | Bank |
ASKARI | ASKARI | Bank |
BOK | BOK | Bank |
BYKEA | BYKEA | Bank |
BANKISLAMI | BANKISLAMI | Bank |
BURJ | BURJ | Bank |
CENTRAL DIRECTORATE OF NATIONAL SAVINGS | CENTRAL DIRECTORATE OF NATIONAL SAVINGS | Bank |
CENTRAL DIRECTORATE OF NATIONAL SAVINGS (CDNS) | CENTRAL DIRECTORATE OF NATIONAL SAVINGS (CDNS) | Bank |
CENTRAL DIRECTORATE OF NATIONAL SAVINGS – 1IBFT IMD ADDITION | CENTRAL DIRECTORATE OF NATIONAL SAVINGS – 1IBFT IMD ADDITION | Bank |
CITI | CITI | Bank |
DUBAIISLAMIC | DUBAIISLAMIC | Bank |
EZ WAGE | EZ WAGE | Bank |
FINCA | FINCA | Bank |
FINJA | FINJA | Bank |
FWBL | FWBL | Bank |
FAYSAL | FAYSAL | Bank |
FIRST MICROFINANCE BANK | FIRST MICROFINANCE BANK | Bank |
HBL | HBL | Bank |
HBL ASSET MANAGEMENT | HBL ASSET MANAGEMENT | Bank |
HABIB METRO BANK – BULK 1IBFT | HABIB METRO BANK – BULK 1IBFT | Bank |
HABIBMETRO | HABIBMETRO | Bank |
HUMRAH FINANCIAL SERVICES | HUMRAH FINANCIAL SERVICES | Bank |
ICBC | ICBC | Bank |
JS | JS | Bank |
KASB | KASB | Bank |
KBL | KBL | Bank |
KEENU | KEENU | Bank |
MCB | MCB | Bank |
MCB-ARIF HABIB | MCB-ARIF HABIB | Bank |
MIB | MIB | Bank |
MEEZAN | MEEZAN | Bank |
MOBILINKBANK PAKISTAN | MOBILINKBANK PAKISTAN | Bank |
NAYAPAY | NAYAPAY | Bank |
NBP | NBP | Bank |
NBP FUND MANAGEMENT LIMITED | NBP FUND MANAGEMENT LIMITED | Bank |
NBP1 | NBP1 | Bank |
NIB | NIB | Bank |
NRSP | NRSP | Bank |
NATIONAL BANK | NATIONAL BANK | Bank |
NUMBERS PRIVATE LIMITED | NUMBERS PRIVATE LIMITED | Bank |
PAYMAX | PAYMAX | Bank |
PAYMAX1 | PAYMAX1 | Bank |
PUNJABBANK | PUNJABBANK | Bank |
SADAPAY | SADAPAY | Bank |
SCB | SCB | Bank |
SEEDCREED FINANCIAL SERVICES LIMITED | SEEDCREED FINANCIAL SERVICES LIMITED | Bank |
SIMPAISA | SIMPAISA | Bank |
SIND | SIND | Bank |
SAMBA | SAMBA | Bank |
SILK | SILK | Bank |
SINDHBANK | SINDHBANK | Bank |
SONERI | SONERI | Bank |
SUMMIT | SUMMIT | Bank |
TAG | TAG | Bank |
TEZPAY | TEZPAY | Bank |
UBL | UBL | Bank |
UPAISA | UPAISA | Bank |
WASEELA | WASEELA | Bank |
ZTBL1 | ZTBL1 | Bank |
CDNS | CDNS | Bank |
KHYBER | KHYBER | Bank |
MCB ISLAMIC BANK | MCB ISLAMIC BANK | Bank |
TELENOR MICROFINANCE BANK | TELENOR MICROFINANCE BANK | Bank |
U MICROFINANCE BANK | U MICROFINANCE BANK | Bank |
UNITED | UNITED | Bank |
TAMEER MICROFINANCE BANK | TAMEER MICROFINANCE BANK | Bank |
STANDARD CHARTERED BANK | STANDARD CHARTERED BANK | Bank |
SINDH MICRO FINANCE BANK | SINDH MICRO FINANCE BANK | Bank |
SME BANK | SME BANK | Bank |
Field naming
| Scenario | Field | Notes |
|---|---|---|
| Payer | payer_mobile | Mobile (required for PKR payin, real 03 + 9 digits) |
| Payer | payer_realname | Name |
| Payer | payer_email | |
| Payer | payer_id_no | ID number |
| Payee | payee_realname | Name |
| Payee | payee_account | Account |
| Payee | payee_mobile | Mobile |
| Payee | payee_email | |
| Payee | payee_id_no | ID number |
| Common | remark | Top-level remark |
| Common | extJson | Extension object |
| Channel | bankCode | Used by payin and payout; legacy bankName is accepted but ignored |
Deprecated: metadata, countryCode/currency on create, bankName for new integrations, receiverName, receiverAccount, receiverBankCode, receiverBankName, receiverPhone.
Payout order status
| status | Terminal | Notes |
|---|---|---|
created | no | Created |
market_available | no | Listed on task market (P2P) |
processing | no | In progress |
completed | yes | Success, webhook sent |
failed | yes | Failed |
cancelled | yes | Cancelled, freeze released |
Payin order status
| status | Terminal | Notes |
|---|---|---|
created | no | Created |
processing | no | In progress |
completed | yes | Settled, webhook sent |
failed | yes | Failed |
cancelled | yes | Cancelled |
Fees & netAmount
| Order type | Fee | netAmount |
|---|---|---|
| payin | amount × rate + fixed | amount - fee (credited) |
| payout | amount × rate + fixed | amount + fee (frozen) |
Callback orderType
| Value | Meaning |
|---|---|
payin | Payin completed |
payout | Payout completed |
extJson
Optional JSON object for merchant-specific data; stored as-is. Do not put required payer/payee fields only inside extJson.
Onboarding deliverables
| Item | To merchant |
|---|---|
merchantNo | Yes |
| Platform RSA public key (PEM) | Yes (webhook verify) |
| Merchant RSA public key (PEM) | Submit to SoPay |
Default callbackUrl | Configured (used when payout notifyUrl is empty) |
| Fee rules | Configured by ops |