Skip to main content

Mapped Banks List

This API endpoint retrieves the payment gateway details associated with a selected product and bank. It returns detailed information about the merchant, bank, and associated payment gateway details, including the bank's activation status, third-party blocking, and other related data.

🛣️Path Parameters

ParameterTypeDescriptionExample/ENUM
productIDintegerThe unique identifier for the product.100
bankIDstringThe unique identifier for the bank.HDFC

🔑Header Parameters

HeaderTypeDescriptionExample/ENUM
AuthorizationstringBearer token for user authentication.{{access_token}}
x-api-keystringAPI key to authenticate the request.{{x-api-key}}
Content-TypestringSpecifies the type of the request payload.application/json

🟢Success Response - 200 Ok

FieldTypeDescriptionExample/ENUM
statusstringStatus of the API call.success
codestringResponse code indicating the outcome of the request.200
messagestringA message indicating the success of the request.Mapped banks fetched successfully
dataarray of objectArray containing the mapped bank details.See details belows

🏦Mapped Bank Details (Array of Objects)

FieldTypeDescriptionExample/ENUM
sProductIdintegerUnique identifier for the product.100
sMerchantIdstringUnique identifier for the merchant.M12345
sMerchantNamestringName of the merchant.XYZ Merchants
sMasterBankIdstringMaster bank ID associated with the merchant.MBID6789
sBankIdstringBank ID associated with the merchant.HDFC
sAggregatorBankIdstringBank ID for the aggregator.AGID1122
sBankNamestringName of the bank.HDFC Bank
sMappedBankNamestringName of the mapped bank.Mapped HDFC Bank
nGroupIdintegerID of the group to which the merchant belongs.1
sMemberLoginIdstringLogin ID of the member associated with the merchant.MLogin9876
sMemberPasswordstringPassword associated with the member login.Password123!
sMemberIdstringUnique identifier for the member.MID54321
nBlockThirdPartyintegerFlag indicating if third-party payments are blocked.0 (Not blocked)
nBankActiveintegerIndicates whether the bank is active.1 (Active)
nIndexNointegerIndex number for the mapped bank.1
get/transactional/v1/getMappedBanksList/{productID}/{bankID}