{"info":{"_postman_id":"d1a82af8-4376-47e0-96f4-d49038c82bc4","name":"Simpaisa REST APIs","description":"

Simpaisa's REST APIs

Simpaisa’s APIs (Application Programming Interfaces) power its platform for communications. Behind these APIs is a software layer connecting payment channels around Pakistan to allow you to charge your users for the offered services

What’s a REST API?

An API is an application programming interface - in short, it’s a set of rules that lets programs talk to each other, exposing data and functionality across the internet in a consistent format.

REST stands for Representational State Transfer. This is an architectural pattern that describes how distributed systems can expose a consistent interface. When people use the term ‘REST API,’ they are generally referring to an API accessed via HTTP protocol at a predefined set of URLs.

These URLs represent various resources - any information or content accessed at that location, which can be returned as JSON, HTML, audio files, or images. Often, resources have one or more methods that can be performed on them over HTTP, like GET, POST, PUT and DELETE.

Simpaisa, for example, provides many separate REST APIs for charging customers, through their SIM credit or wallet account or credit card. And also bank transfer. In Simpaisa’s ecosystem, each payment channel is a product which has its own API, but you will work with each of them in roughly the same way.

What are the supported billing types?

Simpaisa offers two billing types; One-Time-Purchase (with and without token) & Recurring.

One-Time-Purchase

We occasionally hear from merchants who would like to set up a product that their customers can buy, but they don’t want that product to recur. Instead, they want the product to generate one charge to their customer, and that’s all.

Call-Flow(M-Wallet)

$\"alt$

One-Time-Purchase(OTP-Flow-M-Wallet)

$\"alt$

Call-Flow(DCB)

$\"alt$

Recurring

A recurring transaction is an agreement between a customer and our merchant providing services that essentially authorize the charging of periodic, automatic payments during a set amount of time. The transaction can be charged on a weekly, monthly & yearly basis.

All the recurring are controlled & scheduled by Simpaisa, as per the defined set of configurations for merchants' products/services. Which ease the implementation process for our merchants; as they don't have to worry about the renewal management & hitting their users timely.

Call-Flow (M-Wallets)

$\"alt$

Call-Flow (DCB)

$\"alt$

SimPaisa Base Recursion

$\"alt$

Merchant Base Recursion

$\"alt$

What are the other features, actually?

HE Authorization

In certain markets, Consumer identification can be carried out by fetching Consumer specific information such as MSISDN from HTTP request headers. Authorization with help of Header Enrichment allows you to build an even more seamless payment flow whereby user authorization can be carried out with one click only. \nNote that as Header Enrichment is not available for all payment channels, it is recommended that you always implement a PIN authorization flow as a fallback in case Header Enrichment authorization fails.

Free-Trial

A free-trial is a handy way of letting your product/service sell itself. By opting for a free trial of your product, the customer gets a timebox for using your product - ranging from a day to a week or a month. A free trial lets users experience the product first-hand, understand its functionalities and see if the product delivers the right value for them before buying it.\nThe magic of a free-trial only helps simplify your acquisition process. This can be implemented by providing quality customer support, offering incentives (coupons, discounts, et cetera), and offering a smooth onboarding experience.

Note that free-trial is not available for all payment channels.

Bucket

Bucket often looks like a free-trial strategy at the outset. However, it's about allowing users to enjoy premium services as paid users. If users fail to be charged due to insufficient amount, the users can still be hooked to the services & the system park the users in the bucket. On the backend, the system will keep on trying to charge the users for a defined period of time. And if they fail to be charged after maximum attempts, user's subscriptions will be discontinued.

Note: Not applicable for M-wallets.

Retries

Occasionally customers' payment may fail to be collected. If the customers' payment mode & account is still active, Simpaisa will be able to retry the payment until getting the successful charge in response or reaches maximum hits. Merchants will be sent the postback/callback for the successful charge or in case all hits are exhausted or subscription has been disabled by any other reason.

URL Address

URL address that you need to use to connect to SimPaisa:

Live

DCB

https://api.simpaisa.com

Wallets

https://wallets.simpaisa.com

Cards

https://payment.simpaisa.com

Staging

https://staging.simpaisa.com

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Simpaisa's REST APIs","slug":"simpaisas-rest-apis"},{"content":"What’s a REST API?","slug":"whats-a-rest-api"},{"content":"What are the supported billing types?","slug":"what-are-the-supported-billing-types"},{"content":"What are the other features, actually?","slug":"what-are-the-other-features-actually"},{"content":"URL Address","slug":"url-address"}],"owner":"12014193","collectionId":"d1a82af8-4376-47e0-96f4-d49038c82bc4","publishedId":"TzCHAV4L","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-03-24T15:03:38.000Z"},"item":[{"name":"Wallets REST APIs","item":[{"name":"Transaction Call-Back","item":[],"id":"cb4b84ce-cd97-4bec-94c7-337011f1e026","description":"

When a status changes, SimPaisa uses the given callback URL to send an HTTP POST request to an external system.

A call-back sent in the following cases:

At initial transaction whether it is a fail or success.

When Retries are exhausted a success or fail post-back is sent.

At every success recursion.

When user deliberately signoffs through SimPaisa.

Sample Call-Back Request:

{\"status\":\"0000\",\"message\":\"Success\",\"msisdn\":\"3xxxxxxxxx\",\"operatorId\":\"10000x\",\"merchantId\":\"1000xxx\",\"transactionId\":\"xxxxxxxx\",\"amount\":\"1\",\"createdTimestamp\":\"2020-09-18 16:40:19.603\",\"updatedTimestamp\":\"2020-09-18 16:40:30.884\",\"userKey\":\"xxxxxxxxx\",\"transactionType\":\"0\"}

Headers:

POST

Accept: text/plain, application/json, application/*+json

Content-Type: application/json

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"99d7c7ec-9fb1-433f-b22c-45e120271886"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"473ed4d7-e64e-4c92-9db8-b9aee063469c"}}],"_postman_id":"cb4b84ce-cd97-4bec-94c7-337011f1e026"},{"name":"Initiate Transaction","id":"18ae8a91-1519-4cfb-bb34-6d55cf738afc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"100000x\",\r\n \"amount\": \"xx\",\r\n \"transactiontType\": \"\",\r\n \"msisdn\": \"3xxxxxxxxx\",\r\n \"userKey\": \"xxxxxxxx\",\r\n \"operatorId\": 10000x\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{uri}}/v2/wallets/transaction/initiate","description":"

Initiate transaction resource instance allows triggering the OTP-based transaction(s). This will send the OTP to the customer device which needs to be provided under the Verify Transaction call. If the transactionType parameter is \"1\" so it will be considered subscription-based.

Note: Current only Easypaisa supports subscription-based charging. For which, the OTP expiry time is 15 minutes

\n","urlObject":{"protocol":"{{protocol}}","path":["v2","wallets","transaction","initiate"],"host":["{{uri}}"],"query":[],"variable":[]}},"response":[{"id":"019bb435-ccf0-4862-bf01-d2f8c5115dad","name":"Initiate Transaction-One-Time-Charge/amount","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"100000x\",\r\n \"operatorId\": \"10000x\",\r\n \"userKey\": \"xxxxxx\",\r\n \"msisdn\": \"3xxxxxxxxx\",\r\n \"transactionType\": \"0\",\r\n \"amount\": \"xxxx\",\r\n \"productReference\": \"xxxxx-xxxx-xxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{uri}}/v2/wallets/transaction/initiate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"msisdn\": \"3xxxxxxxxxx\",\n \"operatorId\": \"10000x\",\n \"merchantId\": \"100000x\",\n \"transactionId\": \"xxxxxxx\"\n}"},{"id":"38efaa44-94df-4acc-ad3c-b5a58fc04d4b","name":"Initiate Transaction-PrdouctId","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"100000x\",\r\n \"productId\": \"100x\",\r\n \"transactionType\": \"1\",\r\n \"msisdn\": \"3xxxxxxxxx\",\r\n \"userKey\": \"xxxxxxxx\",\r\n \"operatorId\": 10000x\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{uri}}/v2/wallets/transaction/initiate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"msisdn\": \"3xxxxxxxxx\",\n \"operatorId\": \"10000x\",\n \"merchantId\": \"100000x\",\n \"transactionId\": \"xxxxxxx\"\n}"},{"id":"506c73d1-724b-47f1-a7c3-f5f8b4039467","name":"ALFA Initiate Transaction","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"100000x\",\r\n \"operatorId\": \"100012\",\r\n \"productId\" : \"xxxx\",\r\n \"userKey\": \"xxxxxx\",\r\n \"transactionType\":\"0\",\r\n \"msisdn\": \"3xxxxxxxxx\",\r\n \"accountNumber\" : \"930003009542301\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{uri}}/v2/wallets/transaction/initiate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"msisdn\": \"3xxxxxxxxx\",\n \"operatorId\": \"100012\",\n \"merchantId\": \"100000x\"\n}"},{"id":"51bb8d04-9e56-473b-be4d-570df0ea619c","name":"HBL Initiate Transaction","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"1000xxx\",\r\n \"operatorId\": \"100014\",\r\n \"amount\": \"x\",\r\n \"userKey\": \"xxxxxxx\",\r\n \"transactionType\": \"0\",\r\n \"msisdn\": \"3466245388\",\r\n \"cnic\": \"6888666877797\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/wallets/transaction/initiate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"msisdn\": \"3xxxxxxxx\",\n \"operatorId\": \"100014\",\n \"merchantId\": \"1000xxx\"\n}"},{"id":"b3c62131-49c1-4845-bc0d-a16a43d0847f","name":"Initiate Transaction-Subscription/amount","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"100017x\",\r\n \"operatorId\": \"10000x\",\r\n \"amount\": xx,\r\n \"transactionType\": \"1\",\r\n \"subscriptionPeriod\": \"S1D\",\r\n \"userKey\": \"xxxxxxxxxxxx\",\r\n \"msisdn\": \"3xxxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{uri}}/v2/wallets/transaction/initiate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"","value":"","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"msisdn\": \"3xxxxxxxxx\",\n \"operatorId\": \"10000x\",\n \"merchantId\": \"1000xxx\",\n \"transactionId\": \"xxxxxxxx\"\n}"}],"_postman_id":"18ae8a91-1519-4cfb-bb34-6d55cf738afc"},{"name":"Verify Transaction","id":"f34d8aee-ec9e-4e26-8c45-690f3f60b4b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"100000x\",\r\n \"amount\": \"1\",\r\n \"msisdn\": \"3xxxxxxxxx\",\r\n \"transactionType\": \"1\",\r\n \"userKey\": \"xxxxxxxx\",\r\n \"operatorId\": 10000x,\r\n \"otp\": \"xxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/v2/wallets/transaction/verify","description":"

The above API is used to verify the validated OTP sent to the user mentioned MSISDN. For verification and payment to proceed, the users are required to manually enter the MPIN on their designated device.

Note :\nFor one-time-charge, if OTP flow is not allowed only Verify-Payment API will be used and it's not compulsory to pass the \"OTP\" parameter if passed it must be vacant.

\n","urlObject":{"protocol":"{{protocol}}","path":["v2","wallets","transaction","verify"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"5415c275-fcc6-455e-8d75-84f99cff724a","name":"Verify Transaction-one-time-charge/amount","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"100000x\",\r\n \"operatorId\": \"10000x\",\r\n \"userKey\": \"xxxxxxxxx\",\r\n \"msisdn\": \"3xxxxxxxxxx\",\r\n \"transactionType\": \"0\",\r\n \"amount\": \"xxxx\",\r\n \"otp\": \"xxxx\",\r\n \"productReference\": \"xxxx-xxxx-xxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{uri}}/v2/wallets/transaction/initiate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"msisdn\": \"3xxxxxxxxx\",\n \"operatorId\": \"10000x\",\n \"merchantId\": \"100000x \",\n \"transactionId\": \"xxxxxxxx\"\n}"},{"id":"779237bc-53d9-4185-9a9e-55d2c944c91c","name":"Verify Transaction-productId","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"100000x\",\r\n \"productId\":\"100x\",\r\n \"msisdn\": \"3xxxxxxxxx\",\r\n \"transactionType\": \"1\",\r\n \"userKey\": \"xxxxxxxx\",\r\n \"operatorId\": 10000x,\r\n \"otp\": \"xxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{uri}}/v2/wallets/transaction/verify"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"msisdn\": \"3xxxxxxxxx\",\n \"operatorId\": \"10000x\",\n \"merchantId\": \"100000x\",\n \"transactionId\": \"xxxxxxxx\"\n}"},{"id":"bb34c031-07f9-453a-a25a-00aaeec41a71","name":"Verify Transaction-Subscription/amount","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"1000xxx\",\r\n \"operatorId\": \"10000x\",\r\n \"subscriptionPeriod\": \"S1D\",\r\n \"amount\": 1,\r\n \"transactionType\": \"1\",\r\n \"userKey\": \"5869487715314030000\",\r\n \"msisdn\": \"3xxxxxxxxx\",\r\n \"otp\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{uri}}/v2/wallets/transaction/initiate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"msisdn\": \"3xxxxxxxxx\",\n \"operatorId\": \"10000x\",\n \"merchantId\": \"1000xxx \",\n \"transactionId\": \"xxxxxxx\"\n}"},{"id":"c1e3a24e-f0be-4b09-ad75-62c2054c37e1","name":"HBL Verify Transaction","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"1000xxx\",\r\n \"operatorId\": \"100014\",\r\n \"amount\": \"x\",\r\n \"userKey\": \"xxxxx\",\r\n \"transactionType\": \"0\",\r\n \"msisdn\": \"3466245388\",\r\n \"cnic\": \"6888666877797\",\r\n \"otp\": \"xxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/v2/wallets/transaction/verify"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"msisdn\": \"3xxxxxxxxx\",\n \"operatorId\": \"100014\",\n \"merchantId\": \"1000xxx\",\n \"transactionId\": \"xxxxxxxx\"\n}"},{"id":"db039c92-f765-4d8d-82bb-d94a9b83713e","name":"Alfa Verify Transaction","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"100000x\",\r\n \"operatorId\": \"100012\",\r\n \"productId\" : \"xxxx\",\r\n \"userKey\": \"xxxxx\",\r\n \"transactionType\":\"0\",\r\n \"msisdn\": \"3xxxxxxxxx\",\r\n \"otp\":\"12341234\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/v2/wallets/transaction/verify"},"_postman_previewlanguage":"json","header":[{"key":"conte","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"msisdn\": \"3xxxxxxxxx\",\n \"operatorId\": \"100012\",\n \"merchantId\": \"100000x\"\n}"}],"_postman_id":"f34d8aee-ec9e-4e26-8c45-690f3f60b4b6"}],"id":"c5a8ba53-1ba7-4d65-8ec7-ca945a077745","description":"

What are wallets?

Wallets are mobile phone based digital accounts, offering quick & easy payment services to their customers. Users can pay bills, transfer money, buy airtime, and can do a lot more in a snap-of-a-finger.

Who are our wallet partners?

For payments with wallet accounts, Simpaisa is partnered with the two of the largest wallet providers in Pakistan; Easypaisa & Jazzcash, with almost 5-6 million active users in a month collectively.

What is the flow of transaction?

Wallet transaction flow is distributed on the basis of transactionType variable value. So, if the transactionType variable is absent in the request or passed with value 0, it'll be considered a One-Time-charge. One-Time-charge can also be with or without OTP flow it's up to the merchant's request. Contrarily, the value 1 in transactionType determines that transaction is of subscription in nature. In addition from back-end, a token will be generated which will hold user subscription-interval and the amount through which the user is charged. Tokenization flow will be provided on the merchant request.

Note: Users other than Telenor and Jazz will not get any dialogue pop-up rather they have to accept or reject transaction with in the wallet application and will also be notified through notification.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"28545cf1-1977-43f3-8dfa-cfa345194baf"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8384a662-ed0b-463b-b866-26e0e0022001"}}],"_postman_id":"c5a8ba53-1ba7-4d65-8ec7-ca945a077745"},{"name":"DCB REST APIs","item":[{"name":"Transaction Call-Back","item":[],"id":"90df70d6-7f6c-445c-8bc6-1d67571f9382","description":"

When a status changes, SimPaisa uses the given callback URL to send an HTTP POST request to an external system.

A call-back sent in the following cases:

At initial transaction whether its a fail or success.

When Retries are exhausted a success or fail post-back is sent.

At every success recursion.

When user deliberately signoffs through SimPaisa.

Sample Call-Back Request:

{message=Recursion-Successful, userId=xxxxxxxx, productID=xxxx, transactionID=xxxxxxxx, isRecurring=1, msisdn=xxxxxxxxxx, operatorID=10000x, status=1, amount=xx.x}

Headers:

POST

Accept: text/plain, application/json, application/*+json

Content-Type: application/json

\n","_postman_id":"90df70d6-7f6c-445c-8bc6-1d67571f9382"},{"name":"Initiate Transaction","id":"c5b5bf73-0e28-44cb-9472-66a3d02abe17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n\"merchantId\":\"100000x\", \r\n\"productId\": 100x, \r\n\"msisdn\":\"3xxxxxxxxx\", \r\n\"userKey\":\"xxxxxxxx\", \r\n\"operatorId\":10000x \r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/v2/dcb/transaction/initiate","description":"

Initiate transaction resource instance allows triggering OTP against the user msisdn.

\n","urlObject":{"protocol":"{{protocol}}","path":["v2","dcb","transaction","initiate"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"eea9c8d2-49cc-4587-93b2-0ed860f06daf","name":"Initiate Transaction","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"100000x\",\r\n \"productId\": 100x,\r\n \"msisdn\": \"3xxxxxxxxx\",\r\n \"userKey\": \"xxxxxxxx\",\r\n \"operatorId\": 10000x\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/v2/dcb/transaction/initiate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"msisdn\": \"3xxxxxxxxx\",\n \"operatorId\": \"100000x\",\n \"merchantId\": \"100000x\",\n \"transactionId\": \"xxxxxxxx\"\n}"}],"_postman_id":"c5b5bf73-0e28-44cb-9472-66a3d02abe17"},{"name":"Verify Transaction","id":"eebf0bb3-415c-489b-b3cf-0bbca2925f75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"100000x\",\r\n \"productId\": xxxx,\r\n \"msisdn\": \"3xxxxxxxxx\",\r\n \"userKey\": \"xxxxxxxxxx\",\r\n \"operatorId\": 10000x\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/v2/dcb/transaction/verify","description":"

The above API verifies the validated OTP sent on user MSISDN whether it's recursive or one-time-charge.

\n","urlObject":{"protocol":"{{protocol}}","path":["v2","dcb","transaction","verify"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0eeba48e-2ca6-40ab-a449-4b50f54c165d","name":"Verify Transaction","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n\"merchantId\":\"100000x\", \r\n\"productId\": 100x, \r\n\"msisdn\":\"3xxxxxxxxx\", \r\n\"userKey\":\"xxxxxxxx\", \r\n\"operatorId\":10000x, \r\n\"otp\" : \"xxxx\"\r\n }","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/v2/dcb/transaction/verify"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"msisdn\": \"3xxxxxxxxx\",\n \"operatorId\": \"10000x\",\n \"merchantId\": \"100000x\",\n \"transactionId\": \"xxxxxxxx\"\n}"}],"_postman_id":"eebf0bb3-415c-489b-b3cf-0bbca2925f75"}],"id":"5f4a4238-d0a3-4aba-a8e5-cc32cf47a7e5","description":"

What is DCB?

DCB lets any mobile user pay online by charging purchases to their phone bill. It works on smartphones, feature phones, desktop devices, tablets, and smart TV-s. It provides the simplest checkout experience out of any online payment method

Who are our DCB partners?

For payments with DCB, Simpaisa is partnered with all of the operators available in Pakistan.

What is the flow of transaction ?

For initializing a payment, all you need to do is integrate the SimPaisa provided API's and all the necessary credentials will be provided by our team. DCB can be one-time-charge and recursive that can be configured against the provided productId .

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"d5c27df1-dae9-4936-b381-067eb6dfbd91"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"7953ed34-f276-443c-b806-c9471f36aa93"}}],"_postman_id":"5f4a4238-d0a3-4aba-a8e5-cc32cf47a7e5"},{"name":"Card APIs","item":[{"name":"URL","id":"1dba8b04-f92f-43a4-b0e8-c400d8687a2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocol}}://{{url}}/card/registrationfull?OrderId=xxx&Amount=xxx&Currency=PKR&MerchantId=100000x&RedirectUrl=http://www.xyz.com","description":"

The above provided URI prompts the user towards the payment page, provided with the valid parameters.

\n","urlObject":{"protocol":"{{protocol}}","path":["card","registrationfull"],"host":["{{url}}"],"query":[{"key":"OrderId","value":"xxx"},{"key":"Amount","value":"xxx"},{"key":"Currency","value":"PKR"},{"key":"MerchantId","value":"100000x"},{"key":"RedirectUrl","value":"http://www.xyz.com"}],"variable":[]}},"response":[],"_postman_id":"1dba8b04-f92f-43a4-b0e8-c400d8687a2e"},{"name":"Finalize Transaction","id":"8df73a26-ccf7-46dd-9115-3163ca436859","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"orderId\": \"xxxx\",\r\n \"merchantId\": \"1000xxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/card/finalize","description":"

Finalize API lets the user know regarding the payment status.

\n","urlObject":{"protocol":"{{protocol}}","path":["card","finalize"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"1027f19c-9883-4378-a3aa-57b85979e703","name":"Finalize Transaction-Any other response returned by ubl that was not previously observed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"orderId\": \"xxxx\",\r\n \"merchantId\": \"1000xxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/card/finalize"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 26 Nov 2020 21:44:20 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"createdDate\": \"2020-11-26 15:59:47.0\",\n \"Amount\": \"x.x\",\n \"message\": \"*message returned by ubl finzalize api\",\n \"transactionId\": \"xxxxxxxx\",\n \"status\": \"0038\"\n}"},{"id":"15ce94dd-6203-4ffd-8214-8cb875022116","name":"Finalize Transaction-Insufficient-Funds","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"orderId\": \"xxxx\",\r\n \"merchantId\": \"1000xxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/card/finalize"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 26 Nov 2020 21:44:20 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"createdDate\": \"2020-11-26 15:59:47.0\",\n \"Amount\": \"x.x\",\n \"message\": \"Not sufficient funds\",\n \"transactionId\": \"xxxxxxxx\",\n \"status\": \"0009\"\n}"},{"id":"216072bf-aa13-4d7b-a819-70b807029555","name":"Finalize Transaction-Sucess","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"orderId\": \"xxxx\",\r\n \"merchantId\": \"1000xxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/card/finalize"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 26 Nov 2020 21:44:20 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"createdDate\": \"2020-11-26 16:15:32.0\",\n \"Amount\": \"x.x\",\n \"message\": \"Request Processed Successfully\",\n \"transactionId\": \"xxxxxxxx\",\n \"status\": \"0000\"\n}"},{"id":"45f805f0-8a71-4c66-87e1-d0c12d668530","name":"Finalize Transaction-Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"orderId\": \"xxxx\",\r\n \"merchantId\": \"1000xxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocol}}://{{url}}/card/finalize","protocol":"{{protocol}}","host":["{{url}}"],"path":["card","finalize"],"query":[{"key":"","value":"application/json","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 26 Nov 2020 21:44:20 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Transaction-Failed\",\n \"status\": \"0012\"\n}"},{"id":"7a85c4d4-e6af-4dad-921a-8adf07883fb0","name":"Finalize Transaction-Do-Not-Honor-Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"orderId\": \"xxxx\",\r\n \"merchantId\": \"1000xxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/card/finalize"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 26 Nov 2020 21:44:20 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"createdDate\": \"2020-11-26 15:59:47.0\",\n \"Amount\": \"x.x\",\n \"message\": \"Do not honor\",\n \"transactionId\": \"xxxxxxxx\",\n \"status\": \"0037\"\n}"},{"id":"96f514e7-eb3b-4a7a-845f-e2d44993c511","name":"Finalize Transaction-User-Cancel-Transaction ","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"orderId\": \"xxxx\",\r\n \"merchantId\": \"1000xxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/card/finalize"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 26 Nov 2020 21:44:20 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"createdDate\": \"2020-11-26 18:29:22.0\",\n \"Amount\": \"x.x\",\n \"message\": \"Transaction Cancelled by Payer\",\n \"transactionId\": \"xxxxxxxx\",\n \"status\": \"0036\"\n}"}],"_postman_id":"8df73a26-ccf7-46dd-9115-3163ca436859"}],"id":"89552620-b478-4663-ba98-90656e6357cc","description":"

What is Card?

A bank card is a payment card issued by a bank. It may be a debit card, where the money is paid in before a transaction can take place, or it may be a credit card, in which a loan is given. Sometimes spelled bankcard.

Who are our Card partners?

For payment, simpaisa has partnered with all the available banks through which payment can be processed and provides the user ease of transactions.

What is the flow of transaction?

Cards are one of the most popular ways to pay online, with broad global reach. There are different types of cards and a bit of step in the process. At the start, the provided GET URL will be consumed through any browser which lets the user to make a transaction. For the ease of user or regarding the status of transaction Finalize API will be called through which all the possible responses can be fetched provided with the valid orderId.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"17615570-ddb0-4eb7-a74f-1725af08c36b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"5c172e49-5ee0-4dc8-a3ef-3544e1f4c090"}}],"_postman_id":"89552620-b478-4663-ba98-90656e6357cc"},{"name":"1-Bill Payment","item":[{"name":"Initiate Transaction","id":"c9e2fab2-5ac7-4758-b35a-e14ca2ed2259","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"100000x\",\r\n \"amount\": \"25\",\r\n \"userKey\": \"xxxxxxxxxxxxxx\",\r\n \"msisdn\": \"xxxxxxxxxx\",\r\n \"transactionType\": \"x\",\r\n \"operatorId\": 100011\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/1link/transaction/initiate","urlObject":{"protocol":"{{protocol}}","path":["1link","transaction","initiate"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3a70c629-ab27-43c0-92af-6eeca3be2bb0","name":"Initiate Transaction-Prepaid","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"100000x\",\r\n \"amount\": \"xx\",\r\n \"userKey\": \"xxxxxxxxxxxxxx\",\r\n \"msisdn\": \"xxxxxxxxxx\",\r\n \"transactionType\": \"2\",\r\n \"operatorId\": 100011\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/1link/transaction/initiate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Set-Cookie","value":"JSESSIONID=DFCBBF26B6FC6A569BA1D321D1C1577D; Path=/; Secure; HttpOnly"},{"key":"Date","value":"Thu, 18 Feb 2021 13:19:23 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"userKey\": \"xxxxxxxxxxxxxxx\",\n \"operatorId\": \"100011\",\n \"merchantId\": \"100000x\",\n \"amount\": \"xx\",\n \"msisdn\": \"3xxxxxxxxx\",\n \"transactionId\": \"xxxxxxxx\"\n}"},{"id":"fed51c1c-8d4e-43fa-af6d-2dc1ba92d88b","name":"Initiate Transaction-PostPaid","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"100000x\",\r\n \"amount\": \"xx\",\r\n \"userKey\": \"xxxxxxxxxxxxxx\",\r\n \"msisdn\": \"xxxxxxxxxx\",\r\n \"transactionType\": \"3\",\r\n \"operatorId\": 100011\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/1link/transaction/initiate"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"},{"key":"Keep-Alive","value":"timeout=60","description":"","type":"text"},{"key":"Connection","value":"keep-alive","description":"","type":"text"},{"key":"Date","value":"Thu, 18 Feb 2021 13:19:23 GMT","description":"","type":"text"},{"key":"Set-Cookie","value":"JSESSIONID=DFCBBF26B6FC6A569BA1D321D1C1577D; Path=/; Secure; HttpOnly","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"userKey\": \"xxxxxxxxxxxxxxx\",\n \"operatorId\": \"100011\",\n \"merchantId\": \"100000x\",\n \"amount\": \"xx\",\n \"msisdn\": \"3xxxxxxxxx\",\n \"transactionId\": \"xxxxxxxx\"\n}"}],"_postman_id":"c9e2fab2-5ac7-4758-b35a-e14ca2ed2259"},{"name":"Verify Transaction","id":"c8c93799-9ae4-4216-833f-626d58b594e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"1000004\",\r\n \"operatorId\": \"100011\",\r\n \"transactionId\": \"48974437\",\r\n \"paymentToken\": \"10007739547064912936\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/1link/transaction/verify","urlObject":{"protocol":"{{protocol}}","path":["1link","transaction","verify"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f4d307e9-f2d6-4e8f-b4f2-335e61a606ba","name":"Verify Transaction","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"100000x\",\r\n \"operatorId\": \"100011\",\r\n \"transactionId\": \"xxxxxxxx\",\r\n \"paymentToken\": \"xxxxxxxxxxxxxxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/1link/transaction/verify"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 24 Mar 2021 14:11:22 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"merchantId\": \"100000x\",\n \"operatorId\": \"100011\",\n \"paymentToken\": \"xxxxxxxxxxxxxxxxxxxx\",\n \"transactionId\": \"xxxxxxxx\",\n \"amount\": \"x.x\",\n \"dateCreated\": \"2021-03-15 17:59:07.0\",\n \"paymentTokenExpiryDateTime\": \"2021-03-30 17:59:07.0\",\n \"datePaid\": \"null\"\n}"}],"_postman_id":"c8c93799-9ae4-4216-833f-626d58b594e3"}],"id":"ae6003bb-7cea-4814-bab3-efd72daeec0c","description":"

What is One-Bill Payment?

1BILL simplifies the user-experience in electronic bill payments. With a unique customer ID, 1BILL eliminates the need of selecting billers individually from the drop-down menu for payments. Lesser steps, lesser screen-flows, hence an improved and quick user-experience for the payments.

What is the flow of transaction?

Through initiate end-point, a unique consumer number is generated which can be paid through any banking mobile application partnered with 1-link. Though it's all up to the client whether the transaction should be Prepaid or Postpaid.

\n","_postman_id":"ae6003bb-7cea-4814-bab3-efd72daeec0c"},{"name":"OTC","item":[{"name":"Initiate","id":"ad021974-a239-48c1-8a7e-43b691178fc5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userKey\": \"xxxxxxxxxxxxxxxxxx\",\r\n \"merchantId\": \"1000xxx\",\r\n \"operatorId\": \"10000x\",\r\n \"amount\": \"x.xx\",\r\n \"msisdn\": \"xxxxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/v2/wallets/transaction/initiate","urlObject":{"protocol":"{{protocol}}","path":["v2","wallets","transaction","initiate"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ea2e82b9-8160-43b4-bed9-abb8bdec245b","name":"Initiate","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userKey\": \"xxxxxxxxxxxxxxxxxx\",\r\n \"merchantId\": \"1000xxx\",\r\n \"transactionType\":\"6\",\r\n \"operatorId\": \"10000x\",\r\n \"amount\": \"x.xx\",\r\n \"msisdn\": \"xxxxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/v2/wallets/transaction/initiate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Set-Cookie","value":"JSESSIONID=71835607CC18B61399C79CC7C9D887D5; Path=/; Secure; HttpOnly"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Date","value":"Mon, 22 Feb 2021 11:37:57 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"msisdn\": \"3xxxxxxxxx\",\n \"merchantId\": \"1000xxx\",\n \"operatorId\": \"10000x\",\n \"paymentToken\": \"xxxxxxxxx\",\n \"paymentTokenExpiryDateTime\": \"01/03/2021 04:37 PM\",\n \"transactionId\": \"48973224\"\n}"}],"_postman_id":"ad021974-a239-48c1-8a7e-43b691178fc5"},{"name":"Verify","id":"80522293-623b-482a-9d75-18f137356e1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"paymentToken\": \"xxxxxxx\",\r\n \"orderId\": \"xxxxxxx\",\r\n \"merchantId\": \"1000xxx\",\r\n \"transactionType\": \"6\",\r\n \"operatorId\": \"10000x\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/v2/wallets/transaction/verify","urlObject":{"protocol":"{{protocol}}","path":["v2","wallets","transaction","verify"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"aeb75889-8337-4eed-96af-d7b00714fd4c","name":"Inquire","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"paymentToken\": \"xxxxxxx\",\r\n \"orderId\": \"xxxxxxx\",\r\n \"merchantId\": \"1000xxx\",\r\n \"transactionType\": \"6\",\r\n \"operatorId\": \"10000x\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/v2/wallets/transaction/verify"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"merchantId\": \"1000xxx\",\n \"operatorId\": \"10000x\",\n \"orderId\": \"xxxxxxxx\",\n \"amount\": \"x.xx\",\n \"transactionDateTime\": \"29/10/2020 08:38 PM\"\n}"}],"_postman_id":"80522293-623b-482a-9d75-18f137356e1e"}],"id":"41874694-4ff6-4da5-bad7-950807b19d35","_postman_id":"41874694-4ff6-4da5-bad7-950807b19d35","description":""},{"name":"Request & Response Elements","item":[],"id":"2d2cf6ff-84e5-4dee-aa16-1c2887bbdd18","description":"

How request/response variables are defined?

Below listed are the request & response variables expected to sent & received. The expected values & the data type are defined as follow:

productId `long`

Productid is Simpaisa defined unique value against the service offered by the merchant. Each product-id is bind to the agreed price point.\n

msisdn `varchar`

Mobile Station International Subscriber Directory Number \n(MSISDN) is a number used to identify a mobile phone number \ninternationally\n

merchantId `long`

MerchantId is the uniquely defined value against the merchant.\n

userKey `varchar`

Consumer's unique identifier that merchants have to provide to uniquely identify the consumer.\n

transactionType `boolean`

transactionType param identifies for which type of transaction the user should prompt. For now, this parameter can only be used in wallet API's.\n

0-One-Time-Purchase

1-Recurring

2-Prepaid(1-Link)

3-Postpaid(1-Link)

4-Card

5-Card Inquiry

6-OTC

subscriptionPeriod `varchar`

Above mentioned param can only be used when a subscription is \ntaken against the passed amount.\n

S1D=1 day of subscription

S1W=1 week of subscription

S1Y=1 year of subscription

operatorId `long`

OperatorID: Unique Identifier of Telcos. i.e.\n

100001 = Mobilink - DCB

100002 = Telenor - DCB

100003 = Zong - DCB

100004 = Warid - DCB

100005 = Ufone - DCB

100007 = EasyPaisa - Wallets

100008 = Jazz Cash - Wallets

100010 = Card - Banking

100011 = 1Link - E-Banking

100012 = Alfa - Wallets

100014 = HBL-Konnect - Wallets

token `varchar`

A uniquely generated tokenid will be passed through which one can identify which recursion is to be called. \n

orderId `Int`

A uniquely generated Id with a max of integers must be passed.\n

accountNumber`Int`

 User account number which is uniquely defined against alfa account.\n

cnic `Int`

 The user's 13 digit account number is needed for the HBL-Konnect wallet transaction against which the account is created.\n

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"fd6d2236-429d-42f4-9639-5de4d35a35c6"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b304d84b-21fa-4060-8e6d-a8bec3cd5c2a"}}],"_postman_id":"2d2cf6ff-84e5-4dee-aa16-1c2887bbdd18"},{"name":"API Responses","item":[],"id":"80f06cb5-7edb-4188-9856-176380149079","description":"

What could be the possible API responses?

Charging APIs Responses:

SUCCESS - 0000

When the call is a success.

Invalid-Operator - 0001

When the user inputs the wrong operator ID.

Invalid-Product/Amount - 0002

When the user inputs the wrong Product ID.

Invalid-Merchant - 0003

When the user inputs the wrong Merchant ID.

Invalid-Value - 0004

When invalid parameters are sent in the request.

Invalid-Call - 0005

When invalid api is called e.g. init API incase of jazzcash.

Channel-Rejected-Transaction - 0006

When the transaction has been rejected by the payment partner.

No-Response-From-Operator - 0007

When our system fails to get any response from the payment partner or request a timeout.

Invalid-Account - 0008

when the user doesn't exist.

Not-Enough-Balance - 0009

when user does not have sufficient funds or balance.

OTP-Expired - 0010

When the user does not enter received OTP within a specific time span (e.g. in DCB, after 30 minutes the OTP expires).

Invalid-OTP - 0011

when user has entered the wrong OTP.

Transaction-Failed - 0012

when payment did not occur.

Bucket-Activated - 0013

when user does not have sufficient balance and gets a bucket against a product.

Free-trial-Activated - 0014

The user gets a free-trial against a product for a defined period.

Invalid-Flow - 0015

The operator is disabled against a product.

Threshold-Exceeded - 0016

The user unsubscribes and tries to subscribe on the same product within 24 Hours.

Already-Subscribed - 0017

A subscribed user against a product tries to subscribe again for the same product.

Request-In-Progress - 0018

When one request is in progress to complete and the user goes for another.

Invalid-Userkey - 0019

when null or empty userkey is passed.

Channel-Auth-Failed - 0020

when wrong credentials are passed at the client-side.

Channel-Failed-Transaction - 0021

when the user enters the wrong pin, session timeout occurs or cancels the transaction.

Subscriber-Not-Found - 0022

When the wrong operatorID is passed or user msisdn is ported to another operator.

Method-Not-Allowed - 0023

when pin less transaction is disabled by the client-side.

Invalid-MobileNo - 0025

The user inputs the wrong mobile number.

Operator-Disabled - 0026

The operator is yet not configured or enabled for the merchant.

Amount-Beyound-Limit - 0027

when the amount is greater than set by the client set amount.

Token-Expired - 0028

when the user's token has expired.

Product-Disabled - 0029

The product is off against a merchant.

Invalid-Pin - 0031

when the wrong MPIN is entered.

Channel-Invalid-Call - 0033

As soon as the client payment method is turned off.

Invalid-Token - 0034

when the user token is not valid.

Token-Not-Found - 0036

when no token is found in the database.

Invalid-CNIC - 0039

When entered CNIC is not valid.

INVALID_ACCOUNT_NUMBER -0041

When Invalid Account Number is entered.

System-Failure - 9999

The server isn't responding properly.

Unsubscribe API Responses:

Recurring Disabled Successfully - 0000

When user subscription is disabled.

User not Found - 0001

When the user is not found or isn't active in the system.

Card API Responses:

Request Processed Successfully- 0000

When the transaction is successfully processed.

Transaction-Failed- 0012

When invalid orderid, registration failed or orderid isn't in our system.

Transaction Cancelled by Payer- 0036

When users cancel the transaction.

Not sufficient funds- 0009

When the user account is with insufficient funds.

Do not honor- 0037

When users card performs irregularly.

message returned by ubl finzalize api- 0038

Any new response which is not previously observed till the current date.

Note: Responses are possible to be updated as per future needs.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"45317978-3897-4d97-a131-bd2a4bf6c3cb"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"2aed5f34-d99e-4165-8e8e-dde27e23cce7"}}],"_postman_id":"80f06cb5-7edb-4188-9856-176380149079"},{"name":"Transaction Call-Back","item":[],"id":"94e7eacc-d546-4508-a5b8-c53f12db447d","description":"

When a status changes, SimPaisa uses the given callback URL to send an HTTP POST request to an external system.

A call-back sent in the following cases:

At initial transaction whether its a fail or success.

When Retries are exhausted a success or fail post-back is sent.

At every success recursion.

When user deliberately signoffs through SimPaisa.

Sample Call-Back Request:

{message=Recursion-Successful&userId=xxxxxxxxx&productID=1xxx&transactionID=15076504&isRecurring=1&msisdn=3xxxxxxxxx&operatorID=10000x&status=1&amount=3.0}

Headers:

POST

Accept: text/plain, application/json, application/*+json

Content-Type: application/json

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b4ba011a-640d-476e-9a2e-33e5c92826da"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e427f8bc-b14e-4b29-8ac7-d80171a721de"}}],"_postman_id":"94e7eacc-d546-4508-a5b8-c53f12db447d"},{"name":"Merchant Base Recursion API","item":[{"name":"URL","id":"89110415-7841-48f4-8a04-f00655471c38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"1000xxx\",\r\n \"token\": \"xxxxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/recurring/charge","description":"

The purpose of this API is to Token API is to manage merchant-based recursion. Merchant can use the endpoint to charge users on defined time and on defined price points. SimPaisa will respond back with success or failure and post back on API.

\n","urlObject":{"protocol":"{{protocol}}","path":["recurring","charge"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"a714493b-d4d8-41b9-8d73-46ad35605f4f","name":"URL","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"1000xxx\",\r\n \"token\": \"xxxxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/wallet/transaction/token"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"responseCode\": \"0000\",\n \"message\": \"Success\",\n \"transactionId\": \"xxxxxxxx\"\n}"}],"_postman_id":"89110415-7841-48f4-8a04-f00655471c38"}],"id":"9a8795ac-cd76-4496-a18f-c6fe52f0eb96","description":"

The API allows the merchant to perform recurring charge against active token shared at the time of subscription or user registration.\nAPI will response success if token hasn't expired or requested as per defined interval.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"afa84f38-a601-49f8-ab31-9c07bf841685"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"391ecadd-cef6-494a-aa9e-a4a58362c501"}}],"_postman_id":"9a8795ac-cd76-4496-a18f-c6fe52f0eb96"},{"name":"Unsubscribe API","item":[{"name":"Unsubscribe","id":"e2936717-7026-4251-8d52-75a5ef63363e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"1000xxx\",\r\n \"userKey\": \"xxxxxxxxxxx\",\r\n \"productId\": \"xxxx\",\r\n \"type\":\"wallet\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/v2/transaction/unsubscribe","urlObject":{"protocol":"{{protocol}}","path":["v2","transaction","unsubscribe"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"7923ce23-0789-4f96-9877-5f990e99f8b2","name":"Unsubscribe","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"1000xxx\",\r\n \"userKey\": \"xxxxxxxxxx\",\r\n \"productId\": \"xxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{url}}/v2/transaction/unsubscribe"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"responseCode\": \"0000\",\n \"message\": \"Recurring Disabled Successfully\"\n}"}],"_postman_id":"e2936717-7026-4251-8d52-75a5ef63363e"}],"id":"d3850030-7b82-4f11-8151-ec63da0ab7de","description":"

The purpose of the Un-subscription API endpoint is to unsubscribe active users from the recursive product. The endpoint must be integrated with the merchant portal through which consumers can deliberately unsubscribe from the SimPaisa services. Post-Back is also sent through which merchants can identify if one has unsubscribed.\nThe API allows the merchant to perform recurring charges against active token shared at the time of subscription or user registration.\nSaved token will also be removed if one has called the above API.

\n
type param if provided shall contain value wallet or dcb. By default it's dcb
\n

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"ff17d657-d161-41bd-b719-612fa1400485"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"940b28cf-bef0-46c1-8534-18eb451bcf71"}}],"_postman_id":"d3850030-7b82-4f11-8151-ec63da0ab7de"},{"name":"Transacton Inquiry","item":[{"name":"Inquiry","id":"162f27d1-7e3e-4100-89fc-0aee5a1f9858","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"1000xxx\",\r\n \"userKey\": \"xxxxxxxxxxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{uri}}/inquire/v2/wallets","urlObject":{"protocol":"{{protocol}}","path":["inquire","v2","wallets"],"host":["{{uri}}"],"query":[],"variable":[]}},"response":[{"id":"d8a6c0fb-9bbb-43bb-affe-527f08ad668b","name":"Inquire","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"1000xxx\",\r\n \"userKey\": \"xxxxxxxxxxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocol}}://{{uri}}/inquire/v2/wallets"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Tue, 30 Mar 2021 12:06:09 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"0000\",\n \"message\": \"Success\",\n \"msisdn\": \"xxxxxxxxxx\",\n \"operatorId\": \"10000x\",\n \"merchantId\": \"1000xxx\",\n \"transactionId\": \"xxxxxxxx\",\n \"amount\": \"x\",\n \"createdTimestamp\": \"2021-03-30 17:01:11.734\",\n \"userKey\": \"xxxxxxxxxxxxxxxx\",\n \"transactionType\": \"x\"\n}"}],"_postman_id":"162f27d1-7e3e-4100-89fc-0aee5a1f9858"}],"id":"11181777-293a-4286-910f-3e21278e507c","_postman_id":"11181777-293a-4286-910f-3e21278e507c","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"fd41d2ef-7452-41a9-8dbd-eae0ddd00a3d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"1cc1c3a6-6064-45a2-8dc7-4ead14d3712c"}}]}

Simpaisa's REST APIs

What’s a REST API?

What are the supported billing types?

One-Time-Purchase

Call-Flow(M-Wallet)

One-Time-Purchase(OTP-Flow-M-Wallet)

Call-Flow(DCB)

Recurring

Call-Flow (M-Wallets)

Call-Flow (DCB)

SimPaisa Base Recursion

Merchant Base Recursion

What are the other features, actually?

HE Authorization

Free-Trial

Bucket

Retries

URL Address

Live

DCB

Wallets

Cards

Staging

A call-back sent in the following cases:

Sample Call-Back Request:

Headers:

What are wallets?

Who are our wallet partners?

What is the flow of transaction?

A call-back sent in the following cases:

Sample Call-Back Request:

Headers:

What is DCB?

Who are our DCB partners?

What is the flow of transaction ?

What is Card?

Who are our Card partners?

What is the flow of transaction?

What is One-Bill Payment?

What is the flow of transaction?

How request/response variables are defined?

productId long

msisdn varchar

merchantId long

userKey varchar

transactionType boolean

0-One-Time-Purchase

1-Recurring

2-Prepaid(1-Link)

3-Postpaid(1-Link)

4-Card

5-Card Inquiry

6-OTC

subscriptionPeriod varchar

S1D=1 day of subscription

S1W=1 week of subscription

S1Y=1 year of subscription

operatorId long

100001 = Mobilink - DCB

100002 = Telenor - DCB

100003 = Zong - DCB

100004 = Warid - DCB

100005 = Ufone - DCB

100007 = EasyPaisa - Wallets

100008 = Jazz Cash - Wallets

100010 = Card - Banking

100011 = 1Link - E-Banking

100012 = Alfa - Wallets

100014 = HBL-Konnect - Wallets

token varchar

orderId Int

accountNumberInt

cnic Int

What could be the possible API responses?

Charging APIs Responses:

SUCCESS - 0000

Invalid-Operator - 0001

Invalid-Product/Amount - 0002

Invalid-Merchant - 0003

Invalid-Value - 0004

productId `long`

msisdn `varchar`

merchantId `long`

userKey `varchar`

transactionType `boolean`

subscriptionPeriod `varchar`

operatorId `long`

token `varchar`

orderId `Int`

accountNumber`Int`

cnic `Int`