Common APIs

Merchant wallet

Query the settlement wallet for your onboarded country.

Item	Value
Method	`GET`
Path	`/api/v1/merchant/wallet`

No query parameters; country/currency come from merchant onboarding (Pakistan: PK / PKR).

Field	Notes
`countryCode`	`PK`
`currency`	`PKR`
`balance`	Available balance (for payouts)
`frozenBalance`	Frozen (in-flight payouts, etc.)
`status`	`1` = active

TIP

Before creating a payout, ensure balance >= netAmount (amount + fee).

Item	Value
Method	`GET`
Path	`/api/v1/merchant/wallet/transactions`

Query: page (default 1), pageSize (default 20, max 100).

Common txType: MERCHANT_PAYOUT_FREEZE, MERCHANT_PAYOUT_SETTLE, MERCHANT_PAYOUT_REFUND, MERCHANT_PAYIN_SETTLE, admin_adjust.

Pakistan payouts require bankCode (platform code, UPPERCASE). Full list:

Type	Examples	Primary field
Wallet	`JAZZCASH`, `EASYPAISA`	`payee_mobile`
Bank	`HBL`, `MCB`, `UBL`, …	`payee_account`

Payin bankCode values: payin bankCode enum.

There is no public “bank list” API; use the appendix tables for integration.