Overview
Api to get payment status
POST /bbps/bills/payment/response
Description
Api to get payment status
Responses
Status: 200 - OK
{ []
Required: data,success,traceId
data: ▼ { []
Required: refId,status
paymentDetails: ▼ { []
Required: amount,mode,paymentRefId,timestamp
amount: [] integer
mode: string
example: Internet Banking
paymentParams: [] []
paymentRefId: string
example: BD019181220291
timestamp: string
example: 2020-12-12T07:42:00Z
}
status: string
Enum: Processing , Success , Failure
example: Success
transactionId: string
example: AX30910192192192192
additionalInfo: ▼ [ []
▼ { []
Required: name,value
name: string
example: Line item 1
value: string
example: Value 1
}
]
billerId: ▼ [] string
The biller ID on BBPS
example: MAHI00000NATIC
failureReason: ▼ { []
Required: code,message
code: [] string
example: ERR004
message: [] string
example: customer not found
type: string
}
refundStatus: string
Enum: Required , Requested , Processed
example: Required
billerRefId: string
example: ZA6291A177
lastPaidDate: string (date-time)
example: 2020-12-12T07:42:00Z
refId: string
example: HENSVVR4QOS7X1UGPY7JGUV444P10102202
}
success: boolean
example: true
traceId: string
example: C3SFG0O6N88R6UI7EQ
}
Status: 400 - Bad request
{ []
Required: error,success,traceId
error: ▼ { []
Required: code,message
message: string
example: Input is invalid
code: string
example: validation-error
}
success: boolean
traceId: string
example: C3SFG0O6N88R6UI7EQ
}
Status: 500 - Bad request
{ []
Required: error,success,traceId
error: ▼ { []
Required: code,message
message: string
example: Input is invalid
code: string
example: validation-error
}
success: boolean
traceId: string
example: C3SFG0O6N88R6UI7EQ
}
Parameters
Header parameters
X-PARTNER-ID*
Integer
Partner ID
Required
Body parameters
body *
{ []
Required: refId
refId: string
example: LNMSQQR4RKT7X1UGPY7JGUV454PL9T2C689
}
Usage and SDK Samples
CURL
curl -X POST\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api/v1/bbps/bills/payment/response"
Axis Aha!