production
development
https://apigateway.bankalfalah.com/bankalfalah/sb
Paths
/v1
post /v1
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
OAuth
OAuth
(oauth2 application)
OAuth Authentication
Token URL
https://apigateway.bankalfalah.com/bankalfalah/sb/oauthproviderapi/oauth2/token
Scopes
GetToken
RequestBody
Required in body
object
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
POST https://apigateway.bankalfalah.com/bankalfalah/sb/MerchantCreate/v1
Try this operation
Definitions
{
"type": "object",
"properties": {
"merchantNumber": {
"type": "string"
},
"mainDetailsReq": {
"type": "object",
"properties": {
"dbaName": {
"type": "string"
},
"businessName": {
"type": "string"
},
"coBrandID": {
"type": "string"
},
"ownershipType": {
"type": "string"
},
"groupLoyaltyID": {
"type": "string"
},
"microfilmNumber": {
"type": "string"
},
"crossRefNumber": {
"type": "string"
},
"merchantLevel": {
"type": "number"
},
"chainAcctNumber": {
"type": "string"
},
"statusCode": {
"type": "string"
},
"cautionCode": {
"type": "string"
},
"remarks": {
"type": "string"
}
}
},
"contactDetailsReq": {
"type": "object",
"properties": {
"principalName": {
"type": "string"
},
"contactPersonID": {
"type": "string"
},
"contactName": {
"type": "string"
},
"emailAddress": {
"type": "string"
},
"mobileNumber": {
"type": "string"
},
"registrationName": {
"type": "string"
},
"physicalTelephone": {
"type": "string"
},
"physicalFaxNumber": {
"type": "string"
},
"paymentTelephone": {
"type": "string"
}
}
},
"physicalAddressReq": {
"type": "object",
"properties": {
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"address4": {
"type": "string"
},
"address5": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postCode": {
"type": "string"
},
"country": {
"type": "string"
}
}
},
"registeredAddressReq": {
"type": "object",
"properties": {
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"address4": {
"type": "string"
},
"address5": {
"type": "string"
},
"postCode": {
"type": "string"
}
}
},
"paymentSettingsReq": {
"type": "object",
"properties": {
"paymentMode": {
"type": "string"
},
"paymentCurrency": {
"type": "string"
},
"paymentType": {
"type": "string"
},
"paymentFrequency": {
"type": "number"
},
"grossPaymentInd": {
"type": "string"
},
"centralPayIndicator": {
"type": "number"
},
"centralPaymentAcct": {
"type": "string"
},
"statementCode": {
"type": "string"
},
"holdReason": {
"type": "string"
},
"paymentThreshold": {
"type": "number"
}
}
},
"paymentBankReq": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"bankAcctNumber": {
"type": "string"
},
"feeAccount": {
"type": "string"
},
"paymentBank": {
"type": "string"
},
"paymentBranch": {
"type": "string"
},
"paymentName": {
"type": "string"
}
}
},
"paymentAddressReq": {
"type": "object",
"properties": {
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"address4": {
"type": "string"
},
"address5": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"postCode": {
"type": "string"
},
"country": {
"type": "string"
}
}
},
"ratesReq": {
"type": "object",
"properties": {
"discCode": {
"type": "string"
},
"discMarginCode": {
"type": "string"
},
"discChargeIndicator": {
"type": "string"
},
"forexRate": {
"type": "number"
}
}
},
"fixedFeesReq": {
"type": "object",
"properties": {
"fixedFeeFreq1": {
"type": "string"
},
"fixedFeeAmount1": {
"type": "number"
},
"fixedFeeDesc1": {
"type": "string"
},
"fixedFeeFreq2": {
"type": "string"
},
"fixedFeeAmount2": {
"type": "number"
},
"fixedFeeDesc2": {
"type": "string"
},
"fixedFeeFreq3": {
"type": "string"
},
"fixedFeeAmount3": {
"type": "number"
},
"fixedFeeDesc3": {
"type": "string"
},
"fixedFeeFreq4": {
"type": "string"
},
"fixedFeeAmount4": {
"type": "number"
},
"fixedFeeDesc4": {
"type": "string"
},
"fixedFeeFreq5": {
"type": "string"
},
"fixedFeeAmount5": {
"type": "number"
},
"fixedFeeDesc5": {
"type": "string"
}
}
},
"transactionFeesReq": {
"type": "object",
"properties": {
"trxnFeeType1": {
"type": "string"
},
"trxnFeeTier1Amount1": {
"type": "number"
},
"trxnFeeTier1Limit1": {
"type": "number"
},
"trxnFeeTier2Amount1": {
"type": "number"
},
"trxnFeeDesc1": {
"type": "string"
},
"trxnFeeType2": {
"type": "string"
},
"trxnFeeTier1Amount2": {
"type": "number"
},
"trxnFeeTier1Limit2": {
"type": "number"
},
"trxnFeeTier2Amount2": {
"type": "number"
},
"trxnFeeDesc2": {
"type": "string"
},
"trxnFeeType3": {
"type": "string"
},
"trxnFeeTier1Amount3": {
"type": "number"
},
"trxnFeeTier1Limit3": {
"type": "number"
},
"trxnFeeTier2Amount3": {
"type": "number"
},
"trxnFeeDesc3": {
"type": "string"
},
"trxnFeeType4": {
"type": "string"
},
"trxnFeeTier1Amount4": {
"type": "number"
},
"trxnFeeTier1Limit4": {
"type": "number"
},
"trxnFeeTier2Amount4": {
"type": "number"
},
"trxnFeeDesc4": {
"type": "string"
},
"trxnFeeType5": {
"type": "string"
},
"trxnFeeTier1Amount5": {
"type": "number"
},
"trxnFeeTier1Limit5": {
"type": "number"
},
"trxnFeeTier2Amount5": {
"type": "number"
},
"trxnFeeDesc5": {
"type": "string"
}
}
},
"amexDetailsReq": {
"type": "object",
"properties": {
"amexAcctNumber": {
"type": "string"
},
"reasonCode": {
"type": "string"
},
"mcc": {
"type": "number"
},
"bulletin": {
"type": "number"
},
"roleType": {
"type": "string"
},
"mnaIndicator": {
"type": "string"
},
"regularFloorLimit": {
"type": "number"
},
"goldFloorLimit": {
"type": "number"
}
}
},
"dinersClubDetailsReq": {
"type": "object",
"properties": {
"intesCode": {
"type": "string"
},
"mcc": {
"type": "number"
},
"bulletin": {
"type": "number"
},
"dciCommRate": {
"type": "number"
},
"regularFloorLimit": {
"type": "number"
},
"goldFloorLimit": {
"type": "number"
}
}
},
"jcbDetailsReq": {
"type": "object",
"properties": {
"mcc": {
"type": "number"
},
"bulletin": {
"type": "number"
},
"classicFloorLimit": {
"type": "number"
},
"goldFloorLimit": {
"type": "number"
}
}
},
"masterCardDetailsReq": {
"type": "object",
"properties": {
"mcaIdIndicator": {
"type": "string"
},
"electronicIndicator": {
"type": "string"
},
"mcc": {
"type": "number"
},
"bulletin": {
"type": "number"
},
"regularFloorLimit": {
"type": "number"
},
"goldFloorLimit": {
"type": "number"
}
}
},
"unionPayDetailsReq": {
"type": "object",
"properties": {
"mcc": {
"type": "number"
},
"bulletin": {
"type": "number"
},
"regularFloorLimit": {
"type": "number"
},
"goldFloorLimit": {
"type": "number"
}
}
},
"visaDetailsReq": {
"type": "object",
"properties": {
"visaTIRFIndicator": {
"type": "string"
},
"mercVerificationValue": {
"type": "string"
},
"mcc": {
"type": "number"
},
"bulletin": {
"type": "number"
},
"classicFloorLimit": {
"type": "number"
},
"premierFloorLimit": {
"type": "number"
}
}
},
"privateLabelDetailsReq": {
"type": "object",
"properties": {
"mcc": {
"type": "number"
},
"bulletin": {
"type": "number"
},
"floorLimit": {
"type": "number"
}
}
},
"otherInfoDetailsReq": {
"type": "object",
"properties": {
"visaMciPaymentFreq": {
"type": "number"
},
"industryCode": {
"type": "number"
},
"debitCreditInd": {
"type": "string"
},
"motoIndicator": {
"type": "string"
},
"cardAcceptor": {
"type": "string"
},
"acceptCardType": {
"type": "string"
},
"averageTicketSize": {
"type": "number"
},
"averageAuthNumber": {
"type": "number"
},
"posInd": {
"type": "string"
},
"noOfImprinter": {
"type": "number"
},
"noOfPOS": {
"type": "number"
},
"distributionCode": {
"type": "string"
},
"cameraInstalled": {
"type": "string"
},
"remittanceIndicator": {
"type": "string"
},
"contractDate": {
"type": "string"
},
"salesOfficer": {
"type": "string"
},
"serviceCentre": {
"type": "string"
},
"salesAreaCode": {
"type": "string"
},
"setupCode": {
"type": "string"
},
"cancelIndicator": {
"type": "string"
},
"cancelReason": {
"type": "string"
},
"cancelDate": {
"type": "string"
},
"dormantFeeDate": {
"type": "string"
},
"dormantFeeAmt": {
"type": "number"
},
"glIndicator1": {
"type": "string"
},
"glIndicator2": {
"type": "string"
},
"glIndicator3": {
"type": "string"
},
"merchantIAN": {
"type": "string"
},
"qrsMerchantInd": {
"type": "string"
},
"merchantValue": {
"type": "string"
}
}
},
"userFieldsReq": {
"type": "object",
"properties": {
"userCode1": {
"type": "string"
},
"userCode2": {
"type": "string"
},
"userCode3": {
"type": "string"
},
"userCode4": {
"type": "string"
},
"userDate1": {
"type": "string"
},
"userDate2": {
"type": "string"
},
"userAmount1": {
"type": "number"
},
"userAmount2": {
"type": "number"
},
"userField1": {
"type": "string"
},
"userField2": {
"type": "string"
},
"userField3": {
"type": "string"
}
}
}
},
"example": {
"merchantNumber": "333338888833333",
"mainDetailsReq": {
"dbaName": "WEB SERCICE",
"businessName": "WEB SERVICE",
"coBrandID": " ",
"ownershipType": "SOLP",
"groupLoyaltyID": " ",
"microfilmNumber": " ",
"crossRefNumber": "000000000000000",
"merchantLevel": 0,
"chainAcctNumber": "",
"statusCode": " ",
"cautionCode": " ",
"remarks": "INSTANT CREATION THRU WEB SERVICE"
},
"contactDetailsReq": {
"principalName": " ",
"contactPersonID": " ",
"contactName": "MR WASEEM AHMED ",
"emailAddress": " ",
"mobileNumber": " ",
"registrationName": " ",
"physicalTelephone": "6924414 ",
"physicalFaxNumber": " ",
"paymentTelephone": "6924414 "
},
"physicalAddressReq": {
"address1": "SHOP R 5 SECTOR 5 C 4 ",
"address2": "NEAR POWER HOUSE CHOWRANGI ",
"address3": "NORTH KARACHI ",
"address4": " ",
"address5": " ",
"city": "KARACHI ",
"state": " ",
"postCode": " ",
"country": "PK"
},
"registeredAddressReq": {
"address1": " ",
"address2": " ",
"address3": " ",
"address4": " ",
"address5": " ",
"postCode": " "
},
"paymentSettingsReq": {
"paymentMode": "A",
"paymentCurrency": "586",
"paymentType": "D",
"paymentFrequency": 0,
"grossPaymentInd": "N",
"centralPayIndicator": 0,
"centralPaymentAcct": "",
"statementCode": "B",
"holdReason": " ",
"paymentThreshold": 0
},
"paymentBankReq": {
"bankName": "BAL",
"bankAcctNumber": "8401001385",
"feeAccount": " ",
"paymentBank": "8401001385",
"paymentBranch": "BAL",
"paymentName": "WEB SERVICE"
},
"paymentAddressReq": {
"address1": "WEB SERVICE ADDR 1",
"address2": "WEB SERVICE ADDR 2",
"address3": "WEB SERVICE ADDR 3",
"address4": " ",
"address5": " ",
"city": "KARACHI ",
"state": " ",
"postCode": " ",
"country": "PK"
},
"ratesReq": {
"discCode": "0935",
"discMarginCode": " ",
"discChargeIndicator": "3",
"forexRate": 0
},
"fixedFeesReq": {
"fixedFeeFreq1": " ",
"fixedFeeAmount1": 0,
"fixedFeeDesc1": " ",
"fixedFeeFreq2": " ",
"fixedFeeAmount2": 0,
"fixedFeeDesc2": " ",
"fixedFeeFreq3": " ",
"fixedFeeAmount3": 0,
"fixedFeeDesc3": " ",
"fixedFeeFreq4": " ",
"fixedFeeAmount4": 0,
"fixedFeeDesc4": " ",
"fixedFeeFreq5": " ",
"fixedFeeAmount5": 0,
"fixedFeeDesc5": " "
},
"transactionFeesReq": {
"trxnFeeType1": " ",
"trxnFeeTier1Amount1": 0,
"trxnFeeTier1Limit1": 0,
"trxnFeeTier2Amount1": 0,
"trxnFeeDesc1": " ",
"trxnFeeType2": " ",
"trxnFeeTier1Amount2": 0,
"trxnFeeTier1Limit2": 0,
"trxnFeeTier2Amount2": 0,
"trxnFeeDesc2": " ",
"trxnFeeType3": " ",
"trxnFeeTier1Amount3": 0,
"trxnFeeTier1Limit3": 0,
"trxnFeeTier2Amount3": 0,
"trxnFeeDesc3": " ",
"trxnFeeType4": " ",
"trxnFeeTier1Amount4": 0,
"trxnFeeTier1Limit4": 0,
"trxnFeeTier2Amount4": 0,
"trxnFeeDesc4": " ",
"trxnFeeType5": " ",
"trxnFeeTier1Amount5": 0,
"trxnFeeTier1Limit5": 0,
"trxnFeeTier2Amount5": 0,
"trxnFeeDesc5": " "
},
"amexDetailsReq": {
"amexAcctNumber": "",
"reasonCode": " ",
"mcc": 0,
"bulletin": 1,
"roleType": " ",
"mnaIndicator": " ",
"regularFloorLimit": 0,
"goldFloorLimit": 0
},
"dinersClubDetailsReq": {
"intesCode": " ",
"mcc": 5732,
"bulletin": 0,
"dciCommRate": 0,
"regularFloorLimit": 0,
"goldFloorLimit": 0
},
"jcbDetailsReq": {
"mcc": 5732,
"bulletin": 0,
"classicFloorLimit": 0,
"goldFloorLimit": 0
},
"masterCardDetailsReq": {
"mcaIdIndicator": "Y",
"electronicIndicator": " ",
"mcc": 5732,
"bulletin": 1,
"regularFloorLimit": 0,
"goldFloorLimit": 0
},
"unionPayDetailsReq": {
"mcc": 5732,
"bulletin": 0,
"regularFloorLimit": 0,
"goldFloorLimit": 0
},
"visaDetailsReq": {
"visaTIRFIndicator": "Y",
"mercVerificationValue": " ",
"mcc": 5732,
"bulletin": 1,
"classicFloorLimit": 0,
"premierFloorLimit": 0
},
"privateLabelDetailsReq": {
"mcc": 0,
"bulletin": 1,
"floorLimit": 0
},
"otherInfoDetailsReq": {
"visaMciPaymentFreq": 0,
"industryCode": 6,
"debitCreditInd": "C",
"motoIndicator": " ",
"cardAcceptor": " ",
"acceptCardType": "A",
"averageTicketSize": 200000,
"averageAuthNumber": 5,
"posInd": "Y",
"noOfImprinter": 1,
"noOfPOS": 1,
"distributionCode": "W",
"cameraInstalled": "N",
"remittanceIndicator": "N",
"contractDate": "20200223",
"salesOfficer": "K26",
"serviceCentre": "000901",
"salesAreaCode": "116 ",
"setupCode": " ",
"cancelIndicator": " ",
"cancelReason": " ",
"cancelDate": " ",
"dormantFeeDate": " ",
"dormantFeeAmt": 0,
"glIndicator1": "N",
"glIndicator2": "N",
"glIndicator3": "N",
"merchantIAN": " ",
"qrsMerchantInd": "N",
"merchantValue": "1.00"
},
"userFieldsReq": {
"userCode1": " ",
"userCode2": " ",
"userCode3": " ",
"userCode4": " ",
"userDate1": " ",
"userDate2": " ",
"userAmount1": 0,
"userAmount2": 0,
"userField1": " ",
"userField2": " ",
"userField3": " "
}
}
}