Skip to main content

GET MAPPED BANKS LIST

This API returns the payment gateway and mapped bank details for a selected product and bank. It is typically used during the Add Funds workflow to identify the appropriate payment gateway configuration.

🔗 Path Parameters

ParameterTypeRequiredDescriptionExample
productIdintegerYesProduct ID into which funds will be added1
bankIdstringYesBank ID from which funds will be added"HDFC"

🔍 Query Parameters

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringRequest payload formatapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize request{{x-api-key}}

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringSuccess message"Mapped bank details fetched successfully"
dataarrayList of mapped bank and gateway detailsRefer Data Object Fields

📦 Data Object Fields

FieldTypeDescriptionExample
sProductIdintegerProduct ID1
sMerchantIdstringMerchant ID"MID001"
sMerchantNamestringMerchant Name"SynapseWave"
sMasterBankIdstringMaster Bank ID"HDFC"
sBankIdstringBank ID"HDFC"
sAggregatorBankIdstringAggregator Bank ID"AGG001"
sBankNamestringBank Name"HDFC Bank"
sMappedBankNamestringMapped Bank Name"HDFC Payment Gateway"
nGroupIdintegerGroup ID associated with the user1001
sMemberLoginIdstringMember Login ID"LOGIN001"
sMemberPasswordstringMember Password / Configuration Reference"******"
sMemberIdstringMember ID"MEM001"
nBlockThirdPartyintegerThird-Party Transaction Restriction Flag0
nBankActiveintegerBank Active Status1
nIndexNointegerIndex Number1