Integration-checklist
Use this checklist before going live with any Simpaisa API family.
1. Onboarding
- Request sandbox credentials from the Simpaisa integration team
- Receive your Merchant ID (MID)
- Confirm which products and regions are enabled for your account
- Configure your postback / webhook URL (dashboard or share with integration team)
2. Authentication
| API family | Action |
|---|---|
| Unified pay-in (BD · NP · EG · IQ) | Obtain api-token; set mode, region, operatorId, version headers |
| PK wallet pay-in | Use merchant credentials per wallet API |
| Pay-out / remittance | Generate RSA 2048-bit PKCS#8 key pair; exchange public key with Simpaisa |
| Cards (PK) | Obtain secretKey for AES card encryption; RSA for request/response signatures |
See API Token Authentication, RSA Signatures & Mutual SSL, and Signature samples.
3. Mutual SSL (pay-out & Remittance — Production)
- Generate client certificate and keystore
- Share certificate with Simpaisa integration team
- Verify TLS 1.2+ and mutual SSL handshake in staging
- Confirm IP whitelisting if required
4. Pay-In Integration
- Implement Initiate → customer flow → Inquire (or Verify for PK wallets)
- Handle webhooks for async final status
- Map status codes for your product
5. Pay-Out Integration (PK)
- Prefund sandbox account (Simpaisa handles sandbox prefunding)
- List banks and map
destinationBankcodes - Register customers before disbursement
- Initiate disbursement with transfer reason code
- Handle disbursement postbacks; reconcile with Get Disbursement
- Monitor balance via Balance Inquiry
6. Pay-Out Integration (BD)
- Obtain bank/branch CSV from integration team
- Initiate disbursement with inline beneficiary details
- Inquire disbursement for status reconciliation
7. Remittance Integration
- Confirm single-API vs double-API flow with your integration POC
- Refresh bank list periodically (weekly/monthly)
- (PK) Optionally verify account title before remitting
- (BD) Obtain the Bank List CSV from your integration POC. You can obtain relevant BankIDs from this CSV
- Map payment purpose codes
- Handle remittance postbacks; use Transaction Inquiry as backup
- Check merchant balance before large batches
8. Pre-production Validation
- End-to-end sandbox test for each enabled operator/channel
- Webhook endpoint returns HTTP
200 - Error handling and retry logic for pending/async states
- Sign-off with Simpaisa integration team before production credentials and fill in the pre-production checklist here: https://simpaisa.atlassian.net/servicedesk/customer/portal/114/create/304