Overview
AI may auto fetch bills registered by an end consumer based on pre-defined parameter/s for seamless bill payment experience.
POST /bbps/autofetches
Description
AI may auto fetch bills registered by an end consumer based on pre-defined parameter/s for seamless bill payment experience.
Responses
Status: 200 - OK
{ []
Required: success,traceId
data: ▼ [ []
▼ { []
error: string
hash: string
example: d28ca210e0267a13fa0db18ee96a349dc4578f032e5902192af762763224204a
}
]
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
}Parameters
Header parameters
X-PARTNER-ID*
Integer
Partner Id
Required
Body parameters
body *
{ []
type: ▼ [] string
Registration type. - PARAMS -
billerCustomerParams will be checked for bill parameters. -
PARAMS - transactionId will be used
to fetch bill parameters.
Enum: PARAMS , TRANSACTION_ID
agent: ▼ { []
Required: channel,id
terminalId: [] string
example: 6000011234
geocode: [] string
example: 19.0139,72.8254
imei: [] string
example: 123456789012345
mac: [] string
example: 48-4D-7E-CB-DB-6F
os: [] string
example: iOS
ip: [] string
example: 124.170.23.24
mobile: [] string
example: 9481773053
postalCode: [] string
example: 600001
app: [] string
example: SmartPay
channel: [] string
example: INT
id: [] string
example: AX01AI06512391457204
ifsc: [] string
example: ICIC0000152
}
entries: ▼ [ []
▼ { []
transactionId: ▼ [] string
Setu BillPay Transaction ID.
example: AX30910192192192192
billerCustomerParams: ▼ { []
biller: ▼ { []
Required: id
id: ▼ [] string
The biller ID on BBPS
example: MAHI00000NATIC
}
customer: ▼ { []
Required: billParameters,mobile
billParameters: ▼ [ []
The bill params for fetching the bill
▼ { []
Required: name,value
name: ▼ [] string
The display name of the parameter.
This has to match what is sent in
fields.
example: Loan Number
value: ▼ [] string
The value of the customer parameter
example: 1895159
}
]
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
}
hash: string
example:
d28ca210e0267a13fa0db18ee96a349dc4578f032e5902192af762763224204a
isActive: boolean
example: true
nextFetchDate: string (date)
}
next_fetch_date: string (date)
}
]
}Usage and SDK Samples
CURL
curl -X POST\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api/v1/bbps/autofetches"
Axis Aha!