Verify Payment Status

The Payment Status API allows merchants to retrieve the current status of a transaction or refund. By passing a paymentId, merchants can obtain detailed information about the status of either a sales transaction or a refund. The transaction type can be identified as either sales or refund based on the transactionType field.

Merchants should pass either a transaction’s paymentId or a refund’s paymentId to retrieve the appropriate status.

Request Parameters

Parameter	Mandatory	Description	Type	Example
`paymentId`	Yes	The unique identifier for the transaction or refund.	String	`"paycbaff3b9dc5443f0ba0997970ebeddfa"`

curl --location --request GET '{{baseUrl}}/transaction/status/{paymentId}' \
--header 'Authorization: Basic <base64-encoded-clientId:clientSecret>' \
--header 'X-Signature: <generated_signature>' \
--header 'X-MERCHANT-BROWSER-FINGERPRINT: 8357426ac73fcd60b17355ab7de60421' \
--header 'X-MERCHANT-USER-AGENT: <user-agent>' \
--header 'X-MERCHANT-DOMAIN: https://www.xyz.com' \
--header 'X-MERCHANT-IP: 123.123.123.123'

Sample Responses

To ensure the integrity and authenticity of the payment status, it is crucial to verify the HMAC signature before processing the payment status update (described in Signature Verification for Payment Response).

{
  "resCode": 200,
  "status": "success",
  "data": {
    "paymentId": "paycbaff3b9dc5443f0ba0997970ebeddfa",
    "orderId": "wb-bf35c7de-1e8f-425a-8833-bc23d609b256",
    "receiptId": "",
    "paymentStatus": "pending",
    "paymentMethod": "card",
    "transactionType": "sales",
    "amount": "1.000",
    "currency": "OMR",
    "initiatedAt": "2025-05-29T07:21:19.845Z",
    "completedAt": "2025-05-29T07:21:19.846Z",
    "signature": "10ff8c4ddbeb8fcf24fcc110acb31599690a8057ecd3a7141b22354f9b73337f",
    "description": "Transaction pending",
    "paymentDetails": {
      "cardNetwork": "visa",
      "cardType": "credit",
      "cardUsageType": "domestic"
    }
  }
}

{
  "resCode": 200,
  "status": "success",
  "data": {
    "paymentId": "paycbaff3b9dc5443f0ba0997970ebeddfa",
    "orderId": "wb-bf35c7de-1e8f-425a-8833-bc23d609b256",
    "receiptId": "",
    "paymentStatus": "success",
    "paymentMethod": "card",
    "transactionType": "refund",
    "amount": "1.000",
    "currency": "OMR",
    "initiatedAt": "2025-05-29T07:21:19.845Z",
    "completedAt": "2025-05-29T07:21:19.846Z",
    "signature": "10ff8c4ddbeb8fcf24fcc110acb31599690a8057ecd3a7141b22354f9b73337f",
    "description": "Refund success"
  }
}

Failure Responses

ResCode	Status	Description
404	failure	Transaction not found for paymentId
401	failure	Missing Authorization header
401	failure	Invalid or inactive client credentials
500	failure	Internal server error