Body
List Mandate
This api will be used for getting all the mandates with the requested status. status PENDING means all the mandate requests that requires action. ONGOING mandates means all the mandates that are currently in active state.
COMPLETED means either ONETIME mandate is executed or validityEnd over for the mandate.
PAUSE means the mandate that are currently paused.
INACTIVE means the mandate that are in FAILURE, EXPIRED, DECLINED, etc.
This API returns an array of mandates for the status as passed in the request.
To understand the gatewayResponseCode and gatewayResponseStatus mapping, please refer this table
.
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/mandates/list
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
limit
String
optional
limits the number of mandates
Constraints:Numeric String
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer
Constraints:Alphanumeric string with dot(.). Maximum length is 256.
offset
optional
leaves that many number of mandates starting from the beginning
Constraints:Numeric String
status
*
String
Mandatory
status for which mandates should be listed. PENDING means all the mandate requests that requires action. ONGOING mandates means all the mandates that are currently in active state. COMPLETED means mandate that is either executed for ONETIME mandate or validityEnd over for the mandate. PAUSED means the mandate that are currently paused. INACTIVE means the mandate that are in FAILURE, EXPIRED, DECLINED, etc.
Constraints:PENDING, ONGOING, COMPLETED, PAUSED, INACTIVE, ALL.
udfParameters
json String
optional
Stringified json for udf parameters
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 message for the API
Values:Refer error code section
payload
json
amount
*
String
Mandatory
Amount for mandate
Values:Amount in two decimals. Decimals are mandatory
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 create mandate.
bankAccountUniqueId
*
String
Mandatory
Unique id for the selected bank account
Values:bankAccountUniqueId in the response of Fetch Accounts api call.
blockFund
*
String
Mandatory
Denotes 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 until which mandate request is valid. It will only be present if request is pending for approval for create or update mandate.
Values:Timestamp in YYYY-MM-DDTHH:MM:SS+05:30 format.
gatewayMandateId
*
String
Mandatory
UPI request id returned by gateway for the particular mandate 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
When status is passed as PENDING it can denote status of create or update pending requests otherwise it denotes the current status of the mandate.
Values:SUCCESS, FAILURE, PENDING, REVOKED, PAUSE, COMPLETED, DECLINED, EXPIRED
initiatedBy
*
String
Mandatory
Defines who has initiated the mandate request.
Values:PAYER, PAYEE
isMarkedSpam
String
optional
Flag if the payeeVpa is marked as spam. It will be present if and only if gatewayResponseStatus is PENDING and mandateType is CREATE.
Values:true, false
isVerifiedPayee
String
optional
Flag if the payeeVpa is a verified vpa. It will be present if and only if gatewayResponseStatus is PENDING and mandateType is CREATE.
Values:true, false
mandateApprovalTimestamp
String
Optional
Time instant at which create mandate request was approved. Only present if mandate was initiatedBy PAYEE.
Values:YYYY-MM-DDTHH:MM:SS+05:30.
mandateName
*
String
Mandatory
Name of the mandate
mandateTimestamp
*
String
Mandatory
Timestamp of when the mandate request was initiated. When status is passed as PENDING in request it can be the timestamp of when create or update mandate request was initiated depending on the mandateType field , but for every other status it will be timestamp of when mandate was created.
Values:YYYY-MM-DDTHH:MM:SS+05:30.
mandateType
*
String
Mandatory
Defines the type of mandate
Values:CREATE, UPDATE
merchantChannelId
*
String
Mandatory
Unique id for the merchant channel.
Values:As passed for x-merchant-channel-id in request headers.
merchantCustomerId
*
String
Mandatory
Merchant generated unique 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
optional
Merchant generated id for the mandate request. It will not be present if status is passed as PENDING as initiatedBy is PAYEE.
Values:As passed for merchantRequestId in request body.
orgMandateId
*
String
Mandatory
Refers to upiRequestId used during creation of mandate.
Values:Same as upiRequestId of create mandate.
payeeMcc
*
String
Mandatory
Merchant Category Code of the payee merchant.
pauseEnd
String
optional
Date until which mandate is paused
pauseStart
String
optional
Date from which mandate is paused
payeeName
String
optional
Name of the Payee involved in mandate.
payeeVpa
*
String
Mandatory
VPA of payee.
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.
purpose
*
String
Mandatory
Defines the purpose code of the mandate
Values:Numeric String
recurrencePattern
*
String
Mandatory
Recurrence Pattern for Mandate.
Values:Same as original mandate in create mandate response.
recurrenceRule
String
optional
Recurrence Rule for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern.
Values:Same as original mandate in create mandate response.
recurrencValue
String
optional
Recurrence Value for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern.
Values:Same as original mandate in create mandate response.
refUrl
*
String
Mandatory
Invoice as sent by merchant or reference to the mandate in the form of url.
Values:String. As passed during creation of mandate.
remarks
*
String
Mandatory
Any mandate summary
Values:As passed during mandate operation request.
role
*
String
Mandatory
Defines the role of the customer in the 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 Operation
Values:UPI_MANDATE, QR_MANDATE, INTENT_MANDATE, P2M_MANDATE
umn
String
optional
Unique Mandate Number used for execution of the mandate. It will not be present if mandate is pending for payer approval and payee's merchantCustomerId is passed in the request.
validityEnd
*
String
Mandatory
Values:Date before which mandate can be executed
validityStart
*
String
Mandatory
Values:Date before which mandate can be executed
udfParameters
json String
optional
Udf parameters as passed in the request.
Values:As passed in request
Have questions?
- Need help? Contact support
- LLM? Read llms.txt