Payment
mPay
Cancel Payment

API Information

Name: mPAY Cancel Payment

Description: It will cancel the payment record with an order reference number. This order reference number will be used in future to cancel the payment made by MPay.

Basic Info

Basic
Method: POST
Endpoint: <API_BASE_URL>/mapi/api/v1/payment/mpay/cancel
 
---
 
REQUEST HEADERS:
x-api-token: <REQUIRED>
Content-Type: application/json

Request Body

JSON
{
  "cancelServiceRequest": {
    "properties": {
      "property": [
        {
          "name": "timestamp",
          "value": "20110416183040"
        },
        {
          "name": "status-code",
          "value": "6009"
        },
        {
          "name": "status-description",
          "value": "Duplicate Service Reference Number"
        },
        {
          "name": "customer-email",
          "value": "test.user@SDG.gov.ae"
        },
        {
          "name": "epay-sptrn",
          "value": "im_wmmh5akdx3jyn73yqsbmzqy8szsrcd"
        },
        {
          "name": "epay-degtrn",
          "value": "2332233432"
        },
        {
          "name": "epay-timestamp",
          "value": "20110415231012"
        },
        {
          "name": "epay-spcode",
          "value": "INSURANCEMARKET"
        },
        {
          "name": "epay-servcode",
          "value": "XYZ"
        },
        {
          "name": "epay-amount",
          "value": "100"
        }
      ]
    },
    "messageDigest": "ABCDEFGHIJKLMNOP" // hashed value for checksum
  }
}

Response Body

Success
JSON
{
  "cancelServiceRequestResponse": {
    "statusCode": "00",
    "statusDescription": "success",
    "epay-sptrn": "im_wmmh5akdx3jyn73yqsbmzqy8szsrcd", // order reference number generated against the payment record
    "serviceTransactionTime": "2011-04-16T11:22:30",
    "transactionAmount": "100"
  }
}
Failed (Checksum Failed)
JSON
{
  "cancelServiceRequestResponse": {
    "statusCode": "33",
    "statusDescription": "Checksum Failed",
    "epay-sptrn": "",
    "serviceTransactionTime": "",
    "transactionAmount": ""
  }
}
Failed (Internal System Error)
JSON
{
  "cancelServiceRequestResponse": {
    "statusCode": "99",
    "statusDescription": "Internal System Error",
    "epay-sptrn": "",
    "serviceTransactionTime": "",
    "transactionAmount": ""
  }
}
Failed (Validation Error)
JSON
{
  "code": "VALIDATION_ERROR",
  "message": "property[0].name must be string", // shows respective field validation error
  "type": "WARN"
}