Callbacks

Webhook API version

Please refer below mentioned callback parameters reference:

Scroll inside to view more
Parameter
Description
bankAccountUniqueId
Unique hash for the customer bank account used for transaction
bankCode
IIN for the customer bank account used for transaction
collectType
Type of collect
gatewayMandateId
upiRequestId passed in the request.
gatewayReferenceId
Customer reference number (rrn).
gatewayResponseCode
Response code returned by gateway for the transaction. Refer this.
gatewayResponseMessage
Verbose response message returned by gateway for the transaction.
gatewayResponseStatus
Response status returned by gateway
gatewayTransactionId
UPI request id returned by gateway for the transaction.
initiatedBy
Describes whether PAYER or PAYEE has initiated the mandate.
isMarkedSpam
Stringified boolean flag if the payee is marked as spam.
isVerifiedPayee
Stringified boolean flag if the payee is a verified vpa.
mandateName
Name of the mandate.
mandateApprovalTimestamp
Time instant at which create mandate request was approved
mandateTimestamp
Timestamp of when the mandate request was attempted
maskedAccountNumber
Masked account number for the customer bank account used for transaction.
merchantChannelId
Unique id for the channel via which request is made.
merchantCustomerId
Merchant generated unique id for customer
merchantId
Unique id for merchant.
merchantRequestId
Merchant generated request id as passed
orgMandateId
Refers to upiRequestId used during creation of the mandate.
pauseEnd
Date until which mandate is paused
pauseStart
Date from which mandate is paused
payeeMcc
Merchant Category Code of the payee merchant. If Payee is a customer it will be '0000' else it will be a 4 digit numeric string.
payeeMerchantCustomerId
Merchant generated unique id for customer
recurrencePattern
Recurrence Pattern for Mandate. Denotes at what frequency mandate can be executed.
recurrenceRule
Recurrence Rule for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern.
recurrenceValue
Recurrence Value for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern.
role
Role of the customer for this mandate. PAYER / PAYEE
shareToPayee
Denotes whether mandate should be shared with payee or not. For Onetime mandate, value can be true or false and for recurring mandate it is always true. Default value is true.
transactionType
Type of Mandate Creation.
seqNumber
Denotes the recurring cycle of mandate execution. Will be received only during mandate executions.
umn
Vpa used for execution of mandate.
validityEnd
Date until which mandate can be executed.

UDIR Callbacks Parameters

Scroll inside to view more
Parameter
Description
payerVpa
Vpa of payer
payeeVpa
Vpa of Payee
merchantId
Unique id for merchant.
merchant_channel_id
Unique id for the channel via which request is made.
merchant_customer_id
Merchant generated unique profile id for customer as passed in the request
customer_mobile_number
Customer mobile number
transaction_amount
Amount of transaction
adj_amount
Amount of transaction with which complaint was raised
adj_flag
Reason flag for complaint. Refer this.
adj_Code
Reason code for complaint. Refer this.
crn
Complaint reference number returned by NPCI
gateway_response_code
Response code returned by gateway for the transaction.
gateway_response_status
Response status returned by gateway
gateway_complaint_id
UPI request id passed in the request.
message
Response message returned by gateway
org_sett_resp_code
Original settlement response code
gateway_reference_id
Complaint / customer reference id
Last updated 2 years ago