JIjiopay
Mandate

Revoke Mandate

Cancels an active mandate.

post/subscription/mandate/cancel

Request

  • Base URL
    https://services.jiopay.co.in/api
  • URL
    https://services.jiopay.co.in/api/subscription/mandate/cancel
  • Auth
    HTTP bearer

Request body

client_idstring required

Client identifier.

subscription_refidstring required

Subscription reference of the mandate to revoke.

merchant_txn_nostring required

Merchant transaction number for this revoke request.

reasonstring required

Reason for revocation.

send_email'Y' | 'N'

Trigger an email notification for this request.

send_sms'Y' | 'N'

Trigger an SMS notification for this request.

Example request

{
  "client_id": "11182576a878438aa94ef7bee1507764f08d74131e41dc75",
  "subscription_refid": "Subsc42",
  "merchant_txn_no": "SUb48756644234",
  "reason": "User requested cancellation"
}

Response

OK

statusCodeinteger
statusDescstring
subscription_refidstring
secureHashstring
amountstring
authCodestring
requestTypestring
errorDescriptionstring
customerEmailIDstring
paymentModestring
respDescriptionstring
errorCodestring
authAmountstring
paymentInstIDstring
customerMobileNostring
responseCodestring
paymentSubInstTypestring
merchantIdstring
merchantTxnNostring
umnstring
mandateIdstring
txnIDstring
addlParam1string
addlParam2string

Example response

{
  "statusCode": 200,
  "statusDesc": "SUCCESS",
  "subscription_refid": "SUB4543879",
  "amount": "1000.00",
  "authCode": "ABC123",
  "requestType": "REVOKE_MANDATE",
  "errorDescription": "Transaction successful",
  "customerEmailID": "test@jiopay.in",
  "paymentMode": "Card",
  "respDescription": "Transaction successful",
  "errorCode": "0000",
  "authAmount": "1.00",
  "paymentInstID": "XXXX XXXX XXXX 0005",
  "customerMobileNo": "9876543210",
  "responseCode": "0000",
  "paymentSubInstType": "DC",
  "merchantId": "JP2000000000030",
  "merchantTxnNo": "s3456234",
  "umn": "MA0B4000736540",
  "mandateId": "MA0B4000736540",
  "txnID": "77MT000011336104",
  "addlParam1": "TEST123",
  "addlParam2": "TEST456"
}

Changes

No recorded changes to this operation across all 1 revision of this API.