Get disputes

1.0.0

Online

Overview

API to list disputes

GET /bbps/disputes
Description

API to list disputes

Responses
Status: 200 - List of disputes
{ []
Required: success,traceId
data: ▼ { []
Required: disputes
disputes: ▼ [ []
▼ { []
complaintStatus: ▼ [] string
BBPS Complaint status
Enum: INITIALIZED , ASSIGNED , RE_ASSIGNED ,
 ASSIGNED_TO_BOU ,
ASSIGNED_TO_COU , ASSIGNED_TO_OU , ESCALATED ,
 RESOLVED , UNRESOLVED
example: ASSIGNED
createdAt: ▼ [] string (date-time)
Dispute's creation timestamp
example: 2020-12-12T07:42:00Z
lastModifiedAt: ▼ [] string (date-time)
Dispute's last modified timestamp
example: 2020-12-12T07:42:00Z
responseReason: string
example: SUCCESS
transactionId: ▼ [] string
Setu BillPay Transaction ID.
example: AX30910192192192192
assigned: ▼ [] string
BBPOU to which the complaint is assigned
example: OU Four
partnerRefId: string
example: AX30910192192192192
remarks: ▼ [] string
BBPS Complaint remarks
example: Payment Pending
responseCode: ▼ [] string
Carries the response code indicating success or 
failure of the transaction
example: 0.0
billerId: ▼ [] string
The biller ID on BBPS
example: MAHI00000NATIC
complaintId: ▼ [] string
Complaint ID
example: OP0121046567755
mobile: ▼ [] string minLength:6 maxLength:20
Mobile number with 6, 10 and 20 digits are valid.
Pattern: ^\d{6}(\d{4}(\d{10})?)?$
example: 9481773053
refId: ▼ [] string
Reference ID
example: HENSVVR4QOS7X1UGPY7JGUV444P10461713
}
]
nextPage: string
example: /api/bbps/billers?
search=Aditya&CategoryCode=Loan+Repayment&
CategoryCode=Insurance&after=ABCC00000PTNNS
total: integer
}
error: ▼ { []
Required: code,message
message: string
example: Input is invalid
code: string
example: validation-error
}
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
Query parameters

status

array[String]
Query parameters

limit

Integer
Limit
Query parameters

categories

array[String]
Biller Category
Query parameters

months

array[date] (date)
Month ranges. A full-date notation as defined by 
'RFC 3339, section 5.6' has to be provided but 
only month and year will
be considered.
Query parameters

after

String
Query parameters

transactionIds

array[String]
Transaction IDs
Query parameters

partnerRefIds

array[String]
Partner provided transaction Ids
Query parameters

billerIds

array[String]
The biller ID on BBPS
Query parameters

expand

array[String]
Query parameters

mobile

String
Mobile number with 6, 10 and 20 digits are valid.
Usage and SDK Samples
CURL
curl -X GET\
\
-H "Accept: application/json"\
"/api/v1/bbps/disputes?status=&limit=&categories=&months=&after=&transactionIds=&partnerRefIds=&billerI
ds=&expand=&mobile="
Axis Aha!