GetMerchantAuthorizations
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/GetMerchantAuthorizations
This API is used to get all the available Merchant Authorizations details.
Request fields details
Fields | Description |
---|---|
Source string Mandatory |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840 Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string Mandatory |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string Mandatory |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
InstitutionID integer Mandatory |
Unique identification number for Institution Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard. |
MerchantNumber string Conditional |
Merchant Number which is assigned to a Merchant. Valid Values: 0-9 Format: XXXXXX Example: 205136549 Condition:Mandatory If Merchant ID not Inputted in API Request or Other Conditional Input Parameters are not Inputted. Allowable Values: 9 |
MerchantID integer Conditional |
Specific ID Assigned to a Merchant. Valid Values: 0-9 Format: XXXXXX Example: 562489 Condition:Mandatory If Merchant Number Not Inputted in API Request or Other Conditional Input Parameters are not Inputted |
AuthPostFromDate datetime Mandatory |
From Date of Auth Posted. Valid Values: 0-9 Format: MM/DD/YYYY Example: 12/11/2020 |
AuthPostToDate datetime Mandatory |
From Date of Auth Posted. Valid Values: 0-9 Format: MM/DD/YYYY Example: 12/11/2020 |
AccountNumber string Conditional |
Account number of Card holder/Account Holder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:Mandatory If other Conditional Input Parameters are not Inputted. Allowable Values: 19 |
ApplicationNumber string Conditional |
Unique Number generated for the Account creation Application. Valid Values:0-9 Format:XXXXXXXXXX Example:8002201421 Condition:Mandatory If other Conditional Input Parameters are not Inputted. Allowable Values: 19 |
FirstName string Conditional |
First name of account holder. Valid Values:a-z Format:XXXXXXXXXX Example:John Condition:Mandatory If other Conditional Input Parameters are not Inputted. Allowable Values: 50 |
LastName string Conditional |
Last name of account holder. Valid Values:a-z Format:XXXXXXXXXX Example:John Condition:Mandatory If other Conditional Input Parameters are not Inputted. Allowable Values: 50 |
BatchSize integer Optional |
Number of Transaction which can be view in one Batch. Default Value would be 100 Valid Values: 0-9 Format: XX Example: 20 |
PageIndex integer Optional |
Number of page. Valid Values: 0 - 9 Format: XX Example: 12 |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.0", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "InstitutionID": 3235, "MerchantNumber": null, "MerchantID": 11631, "AuthPostFromDate": "01/14/2017 00:00:00", "AuthPostToDate": "01/21/2017 00:00:00", "AccountNumber": null, "ApplicationNumber": null, "FirstName": null, "LastName": null, "BatchSize": 100, "PageIndex": 0 }
Response fields details
Fields | Description |
---|---|
TotalRecordCount integer |
TotalRecordCount |
TransactionRecords array |
Get or set TransactionRecords |
Sample response body
{ "Message": "Request processed successfully", "Status": true, "ErrorCode": "ERR01155", "ResponseData": { "TotalRecordCount": 1, "TransactionRecords": [ { "TransactionID": "123372036854851808", "MerchantName": "Merchant 2", "MerchantNumber": "22222222", "AccountNumber": "8000000000000037", "ApplicationNumber": "8002200230", "FirstName": "FRANK", "LastName": "HU", "AuthorizedSource": "0", "AuthorizationStatus": "Aged Off", "RejectReason": "0", "EmailSMSVerificationServiceCallDateTime": "03/31/2016 00:00:00", "EmailSMSVerificationServiceStatus": "1", "ProcedureCompletedorScheduled": "1", "EmailVerificationStatus": "1", "MobilePhoneVerificationStatus": "1", "EmailAddressValid": "1", "EmailAddressUsed": "senki.baderiya@corecard.com", "EmailDeliveryStatus": "1", "EmailDeliveryDateTime": "03/31/2016 00:00:00", "MobilePhoneValid": "1", "SMSDeliveryStatus": null, "SMSDeliveryDateTime": null, "Amount": 300.0, "HoldAmount": 300.0, "TransactionDateTime": "03/31/2016 00:00:00", "TransactionDescription": null, "CreditPlanMaster": "6 Months No Interest if Paid in Full" } ] } }