Body
Check Mandate Status
This api can be used by Merchant for checking the status of the mandate for both Payer and Payee side. Using this API, the recent status of the mandate / (mandate action) can be found. Recent status of the mandate is denoted by gatewayResponseStatus field in the response if upiRequestId is not passed in the requestBody. Based on different scenarios gatewayResponseStatus can have multiple values like SUCCESS, PENDING, FAILURE, REVOKED, PAUSE, COMPLETED, DECLINED, EXPIRED depending upon the current status of the mandate. Refer to table below for different value of gatewayResponseCode and gatewayResponseStatus. If upiRequestId is passed in the requestBody, then gatewayResponseStatus denotes the status of that particular action (UPDATE, REVOKE, PAUSE and UNPAUSE) taken on mandate.
Note
This API hits TSP Server with a timeout of 60 seconds.
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/mandates/status
Headers
Content-Type
*
string
Required
application/json
x-merchant-id
*
string
Required
Will be shared while onboarding.
x-merchant-channel-id
*
string
Required
Will be shared while onboarding.
Accept
*
string
Required
application/json
x-timestamp
*
string
Required
This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.
Parameter
orgMandateId
*
String
Mandatory
gatewayMandateId returned in create mandate
Constraints: 35 character alphanumeric unique id
role
*
String
Mandatory
Defines the role of the customer in the mandate
Values: PAYER | PAYEE
udfParameters
JSON string
optional
Stringified JSON for udf parameters
upiRequestId
String
Optional
gatewayMandateId returned for update, revoke, pause, unpause operations.
Constraints:35 character alphanumeric.
200 : Success
Response Body
status
*
String
Mandatory
PSP status of the API
Values:SUCCESS, FAILURE
responseCode
*
String
Mandatory
PSP response code for the API
Values:Refer error code section
responseMessage
*
String
Mandatory
PSP response code for the API
Values:Refer error code section
payload
json
amount
*
String
Mandatory
Amount for mandate
Values:Numeric String with two decimals. As passed for amount in request.
amountRule
*
String
Mandatory
Rule on Mandate Amount. If amountRule is MAX, then mandate can be executed for amount less than or equal to the passed amount . If amountRule is EXACT, then mandate should always be executed for the same amount.
Values:As passed for amountRule in request.
bankAccountUniqueId
*
String
Mandatory
Unique id for the selected bank account
Values:bankAccountUniqueId in the response of Fetch Accounts api call. As passed for bankAccountUniqueId in request.
blockFund
String
optional
Defines whether customer's fund should be blocked or not. For onetime mandate it can be true or false. Default value is false.
Values:String - true, false
expiry
String
optional
Timestamp upto which mandate creation request is valid. It will only be present if mandate is initiated by PAYEE.
Values:Timestamp in YYYY-MM-DDTHH:MM:SS+05:30 format, request timestamp plus expiry minutes passed in request.
gatewayMandateId
*
String
Mandatory
UPI request id returned by gateway for the mandate
Values:As passed for upiRequestId in request
gatewayReferenceId
*
String
Mandatory
Customer reference number (rrn) for the mandate operation.
gatewayResponseCode
*
String
Mandatory
Response code returned by gateway for the mandate operation.
Values:Refer table below.
gatewayResponseMessage
*
String
Mandatory
Response message returned by gateway for the mandate operation.
gatewayResponseStatus
*
String
Mandatory
Response status returned by gateway
Values:SUCCESS, FAILURE
initiatedBy
*
String
Mandatory
Describes whether PAYER or PAYEE has initiated the mandate.
Values:As passed for initiatedBy in request.
mandateType
String
optional
Defines the type of mandate operation
Values: CREATE, UPDATE, REVOKE, PAUSE, UNPAUSE
mandateApprovalTimestamp
String
Optional
Time instant at which create mandate request was approved. Only present if mandate type is create and approved.
Values:YYYY-MM-DDTHH:MM:SS+05:30.
mandateName
*
String
Mandatory
Name of the mandate.
Values:As passed for mandateName in request.
mandateTimestamp
*
String
Mandatory
Timestamp of when this request was attempted
Values:YYYY-MM-DDTHH:MM:SS+05:30
merchantChannelId
*
String
Mandatory
Unique id for the merchant channel.
Values:As passed for x-merchant-channel-id in request headers
merchantCustomerId
String
Optional
Merchant generated unique profile id for customer
Values:Alphanumeric string with dot(.). Maximum length is 256. As passed for merchantCustomerId in request.
merchantId
*
String
Mandatory
Unique id for the merchant.
Values:As passed for x-merchant-id in request headers
merchantRequestId
*
String
Mandatory
Merchant generated id for the mandate request.
Values:As passed for merchantRequestId in request body.
orgMandateId
*
String
Mandatory
upiRequestId of the create request.
Values:As passed for upiRequestId in the request.
payeeMcc
*
String
Mandatory
Merchant Category Code of the payee merchant.
payeeName
String
optional
Name of the Payee involved in mandate.
payeeVpa
*
String
Mandatory
VPA of payee
Values:As passed for payeeVpa in request
payerName
String
optional
Name of the Payer involved in mandate.
payerRevocable
*
String
Mandatory
Defines whether mandate is revocable by PAYER or not. For onetime mandate it can be true or false. Default value is true.
Values:String - true, false
payerVpa
*
String
Mandatory
VPA of payer
Values:As passed for payerVpa in request
recurrencePattern
*
String
Mandatory
Recurrence Pattern for Mandate
Values:As passed for recurrencePattern in request
recurrenceRule
String
conditional
Recurrence Rule for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern.
Values:As passed for recurrenceRule in request
recurrencValue
String
conditional
Recurrence Value for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern.
Values:As passed for recurrencValue in request.
refUrl
*
String
Mandatory
Reference url for the mandate. It will be same value if passed in request else it will be a default url.
remarks
String
optional
Any mandate summary. If pssed in request, it will be same in response else a default value is send.
role
*
String
Mandatory
Role of the customer for this mandate.
Values:PAYER, PAYEE
shareToPayee
*
String
Mandatory
Descibes whether mandate will be shared with payee or not. For onetime mandate it can be true or false. Default value is true.
Values:String - true, false.
transactionType
*
String
Mandatory
Type of Mandate Creation
Values:As passed for transactionType in request.
umn
String
optional
Unique Mandate Number used for execution of the mandate. Will be sent only if mandate is initiated by Payer.
validityEnd
*
String
Mandatory
Date before which mandate can be executed.
Values:As passed for validityEnd in request
validityStart
*
String
Mandatory
Date after which mandate can be executed.
Values:As passed for validityStart in request
pauseEnd
String
Optional
Defines the date on which the mandate should unpause. It will only be present if mandateType is PAUSE, UNPAUSE.
Constraint: Date in "YYYY/MM/DD"
pauseStart
String
Optional
Defines the date from which the mandate should pause. It will only be present if mandateType is PAUSE, UNPAUSE.
Constraint: Date in "YYYY/MM/DD"
currentBlockedAmount
String
Optional
Remaining blocked amount in the mandate. Only for SBMD
udfParameters
json String
Optional
Udf parameters as passed in the request.
Values:As passed for udfParameters in request