GetListofPartneridMID
Action: POST
Endpoint: /api/GetListofPartneridMID
API Version 1.3
Request fields details
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
AccountNumber string Conditional |
Account Number of the cardholder. Valid values: 0-9 Example: 2000000000000396893 Condition:At least one of Card Number/Proxy Number/Account Number is required. Allowable Values: 19 |
CardNumber string Conditional |
Clear Card Number of the cardholder Valid values: 0-9 Example: 123456******0001 Condition:At least one of Card Number/Proxy Number/Account Number is required. Allowable Values: 16 |
ProxyNumber string Conditional |
Proxy Number of the cardholder Valid values:0-9 Example:1005 Condition:At least one of Card Number/Proxy Number/Account Number is required. Allowable Values: 19 |
Sample request body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "AccountNumber": "60000000031747", "CardNumber": "", "ProxyNumber": "" }
Response fields details
Fields | Description |
---|---|
Message string |
Returns Error Message in case of Error. |
Status boolean |
Returns result of API processing. If any error is found then value will be 'false' else 'true'. |
ErrorCode string |
Returns Error Code in case of Error. |
ResponseData
|
This is group of below data elements. |
PartnerIDManage array |
|
PartnerID string |
Partner ID to be created. Multiple PartnerIDs can be requested for creation or status change Valid Values :A-Z, a-z, 0-9 Example : 1589 , PIDA001 |
Status string |
Status of the partner ID Valid values : 1 - Active(default) 2 - Inactive Example: Active |
IncludeExcludeFlag string |
Tag to include or exclude the partner ID or Merchant ID for POS Transactions for the account number/Card Number Valid Values : 1 = Include PartnerID 2 = Exclude PartnerID Condition : If 1 is passed, then only the passed partner id will be allowed for POS transactions and remaining all partnerID will be restricted. If 2 is passed, then only the passed partner id will be restricted for POS transactions and remaining all partnerID will be allowed |
MerchantIDManage array |
|
MerchantID string |
Merchant ID Valid Values:A-Z, a-z, 0-9 Example :PIDA001 |
IncludeExcludeFlag string |
Tag to Include or exclude the partner ID or Merchant ID for POS Transactions for the account number/Card Number Valid Values : 1 = Include Merchant ID 2 = Exclude Merchant ID Condition : If 1 is passed, then only the passed Merchant ID will be allowed for POS transactions and remaining all Merchant ID will be restricted. If 2 is passed, then only the passed Merchant ID will be restricted for POS transactions and remaining all Merchant ID will be allowed |
Sample response body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "PartnerIDManage": [ { "PartnerID": "PIDB1001", "Status": "Active", "IncludeExcludeFlag": "Exclude" } ], "MerchantIDManage": [ { "MerchantID": "MerchantIDA00011", "IncludeExcludeFlag": "Exclude" } ] } }