Tokenization Finalize — JazzCash

Once the payment cycle is complete on the hosted page, the customer is redirected to the return URL provided in the GET call. On the return URL, call the Finalize API to show the final payment status to the customer.

---

Endpoint

Method	POST
Path	/v2/wallets/transaction/finalize
Sandbox	https://sandbox.simpaisa.com/v2/wallets/transaction/finalize
Production	https://payin.simpaisa.com/v2/wallets/transaction/finalize

---

Headers

Header	Required	Description
Content-Type	Yes	application/json
mode	Yes	payin
region	Yes	PK
operatorId	Yes	100008
version	Yes	3.0

---

Request Parameters

Parameter	Required	Type	Length	Description
merchantId	Yes	String	7	A unique ID provided by Simpaisa to represent each merchant
operatorId	Yes	String	6	Payment channel ID
orderId	Yes	String	6	Generated by the merchant to track the transaction

---

Response Parameters

Parameter	Description
status	A Simpaisa response code indicating whether your request succeeded or failed
message	A human-readable explanation corresponding to the status code
msisdn	Customer contact number linked to the wallet account
operatorId	Payment channel ID
merchantId	A unique ID provided by Simpaisa to represent each merchant
sourceId	A Simpaisa-issued token referencing the customer's saved wallet credentials, used in follow-up tokenized payments to charge the account without re-authentication
transactionId	Uniquely generated ID to track every transaction

---

Sample

curl --location 'https://sandbox.simpaisa.com/v2/wallets/transaction/finalize' \
  --header 'Content-Type: application/json' \
  --header 'mode: payin' \
  --header 'region: PK' \
  --header 'operatorId: 100008' \
  --header 'version: 3.0' \
  --data '{
    "merchantId": "xxxx",
    "operatorId": "100008",
    "orderId": "xxxx"
  }'

Request

{
  "merchantId": "xxxx",
  "operatorId": "100008",
  "orderId": "xxxx"
}

Successful response

{
  "status": "xxxxxx",
  "message": "xxxxxx",
  "msisdn": "xxxxxxxxx",
  "operatorId": "xxxxxxxx",
  "merchantId": "xxxxxxxx",
  "sourceId": "sp_xxxxxxxxxxxxxxxx",
  "transactionId": "xxxxxxxxx"
}

info

The sourceId (SP token) is used for Direct Charge or Delink of the customer's account.