eFAWATEERcom BANK API

(0 reviews)

Billers

URLS:

Environment	Method	URL
Mock	GET	https://eu1.anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/4be2e19f-42da-4571-80fd-19077a31ce58/efawateercom-bank-exp-api/1.0.7/m/billers
Dev	GET	https://maictrldev.capitalbank.jo/efawateercom-bank-api/v1/billers
Stage	GET	https://maictrlstg.capitalbank.jo/efawateercom-bank-api/v1/billers
Prod	GET	To be updated

Description : This endpoint allows the channel or internal bank services to get the billers list registered with the eFAWATEERcom system.

Channels or internal services that want to know detailed information on the eWATEERcom registered billers will send the getbillerslist call to Mule, Mule application will fetch billers list from the eFAWATEERcom and give back to the calling service in JSON format.

Mulesoft Request:

Mandatory Headers: client_id, client_secret, x-channel-id, x-client-trace-id, x-bank-id

Optional Headers: Authorization, x-user-id, x-sub-channel-id, x-debug-flag, x-customer-id

Mulesoft Response:

Success Response: (200)

Response Body: application/json

Field Name	Type	Length	Occurrence	Description	Validation
status	Object		M
success	Boolean		M	true false
code	String	10	M	Error Code	“0” incase of success or Error Code
reasonCode	String	50	O	Error Type or Error category	Add this tag only incase of error
arabicMessage	String	200	M	English message translated to Arabic	تمت العملية بنجاح in case of success or arabic translated error in case of known errors
englishMessage	String	200	M	Description about the processing	“The Operation has been Successfully Completed” Or error Description
End of status
response	Object		O		Present if success = true
billersList	Object		M
recCount	Integer		M
systemMarketing	Object		O
enMsg	String	200	O
arMsg	String	200	O
enImg	String	200	O
arImg	String	200	O
End of systemMarketing
billersRec	Object		C		If recCount > 0 then mandatory
billerRec	Array		M		Repeatable
billerInfo	Object
code	Integer		M
integrationType	String	20	M
stmtBankCode	Integer	3	M
website	string	50	M
email	String	50	M
phone	String	20	M
order	Integer		O
End of billerInfo
billerName	Object		M
enShortName	String	20	M
arShortName	String	20	M
enName	String	50	M
arName	String	50	M
End of billerName
billerMarketing	Object		O
enLogo	String	200	O
arLogo	String	200	O
enMsg	String	200	O
arMsg	String	200	O
enImg	String	200	O
arImg	String	200	O
end of billerMarketing
billerCategory	Object		M
enShortName	String	20	M
arShortName	String	20	M
enName	String	50	M
arName	String	50	M
order	Integer		O
End of billerCategory
billerServices	Object		M
billerService	Array		M		Repeatable
serviceInfo	Object		M
code	Integer		M
type	String	50	M
enShortDesc	String	20	M
arShortDesc	String	20	M
enDesc	String	50	M
arDesc	String	50	M
paymentType	Enum, String	15	M		Enum: Postpaid Prepaid
billingNoRequired	Boolean		C
containsPrepaidCats	Boolean		C
order	Integer		O
billType	Enum, String	13	O		Enum: Recurring OneOff
End of serviceInfo
serviceMarketing	Object		O
enMsg	String	200	O
arMsg	String	200	O
enImg	String	200	O
arImg	String	200	O
End of serviceMarketing
billingInfo	Object		C		Exists if (billingNoRequired = true)
enShortDesc	String	20	M
arShortDesc	String	20	M
enDesc	String	50	M
arDesc	String	50	M
enImg	String	200	O
arImg	String	200	O
regex	String	150	O
End of billingInfo
prepaidCategories	Object		C		Exists if (containsPrepaidCats = true)
prepaidCatInfo	Array		M		Repeatable
code	Integer		M
type	String	50	M
enShortDesc	String	20	M
arShortDesc	String	20	M
enDesc	String	50	M
arDesc	String	50	M
order	Integer		O
End of prepaidCatInfo
End of prepaidCategories
End of billerService
End of billerServices
End of billerRec
End of billersRec
End of billersList
End of response

{
"status": {
"success": true,
"code": "200",
"arabicMessage": "تمت العملية بنجاح",
"englishMessage": "The Operation has been Successfully Completed"
},
"response": {
"billersList": {
"recCount": 2,
"billersRec": {
"billerRec": [
{
"billerInfo": {
"code": "1004",
"integrationType": "Online",
"stmtBankCode": "10",
"website": "www.orange.jo",
"email": "123@123.com",
"phone": "+962752485965"
},
"billerName": {
"enShortName": "Orange Mobile",
"arShortName": "اورانج خلوي",
"enName": "Orange Mobile",
"arName": "اورانج خلوي"
},
"billerCategory": {
"enShortName": "TELC",
"arShortName": "الاتصالات",
"enName": "Telecommunication",
"arName": "الاتصالات"
},
"billerServices": {
"billerService": [
{
"serviceInfo": {
"code": "61313",
"type": "Mobile_Bill_Payment",
"enShortDesc": "Mobile Bill Payment",
"arShortDesc": "دفع فواتير",
"enDesc": "Mobile Bill Payment",
"arDesc": "دفع فواتير",
"paymentType": "Postpaid"
},
"billingInfo": {
"enShortDesc": "Enter Billing Number",
"arShortDesc": "ادخل رقم الدفع",
"enDesc": "Enter Billing Number",
"arDesc": "ادخل رقم الدفع"
}
},
{
"serviceInfo": {
"code": "31049",
"type": "mobile_prepaid_nosbnos",
"enShortDesc": "Mobile Nosbnos",
"arShortDesc": "بطاقات نص بنص",
"enDesc": "Mobile Prepaid Nosbnos",
"arDesc": "شحن بطاقات نص بنص",
"paymentType": "Prepaid",
"billingNoRequired": "true",
"containsPrepaidCats": "true"
},
"billingInfo": {
"enShortDesc": "Enter Mobile Number",
"arShortDesc": "أدخل رقم الهاتف",
"enDesc": "Enter Mobile Number",
"arDesc": "أدخل رقم الهاتف"
},
"prepaidCategories": {
"prepaidCatInfo": [
{
"code": "2894",
"type": "Nos_B_Nos_JD_2",
"enShortDesc": "Nos B Nos 2",
"arShortDesc": "نص بنص 2",
"enDesc": "Nos B Nos 2",
"arDesc": "نص بنص 2"
},
{
"code": "2895",
"type": "Nos_B_Nos_JD_5",
"enShortDesc": "Nos B Nos 5",
"arShortDesc": "نص بنص 5",
"enDesc": "Nos B Nos 5",
"arDesc": "نص بنص 5"
}
]
}
}
]
}
},
{
"billerInfo": {
"code": "1131",
"integrationType": "Online",
"stmtBankCode": "2",
"website": "www.total.jo",
"email": "123@123.com",
"phone": "+962787654332"
},
"billerName": {
"enShortName": "Total Jordan",
"arShortName": "توتال الاردن",
"enName": "Total Jordan",
"arName": "توتال الاردن"
},
"billerCategory": {
"enShortName": "FUGS",
"arShortName": "وقود و غاز",
"enName": "Fuel and Gas",
"arName": "وقود و غاز"
},
"billerServices": {
"billerService": [
{
"serviceInfo": {
"code": "81915",
"type": "Prepaid",
"enShortDesc": "Total Card",
"arShortDesc": "بطاقة توتال",
"enDesc": "Total Card",
"arDesc": "بطاقة توتال",
"paymentType": "Prepaid",
"billingNoRequired": "true",
"containsPrepaidCats": "false"
},
"billingInfo": {
"enShortDesc": "Enter Card Number",
"arShortDesc": "ادخل رقم البطاقه",
"enDesc": "Enter Card Number",
"arDesc": "ادخل رقم البطاقه"
}
}
]
}
}
]
}
}
}
}

Sample Error Response:

Error codes :

400:

content-type: JSON

{
"success": false,
"code": "400",
"reasonCode": "BadRequest",
"arabicMessage": "",
"englishMessage": "Invalid json value was provided"
}

Billers

Reviews