Add Batch Transaction
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/AddBatchTransaction
Use this API to add transactions to a merchant payment batch in progress. The merchant creates batches containing payments for multiple accounts instead of posting independent payments to each of the accounts.
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 |
MerchantID integer Conditional |
Specific ID assigned to a Merchant Valid Values:0-9 Format:XXXXX Example:12345 Condition: Atleast one of MerchantID or MerchantNumber is required. |
MerchantNumber string Conditional |
Merchant Number which is assigned to a Merchant Valid Values:0-9 Format:XXXXX Example:12345 Condition: Atleast one of MerchantID or MerchantNumber is required. Allowable Values: 10 |
EffectiveDateAndTime datetime Optional |
Date and time of adding transaction to merchant payment batch. Default value should be the system date and time. Valid Values: 0-9 Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05 |
AccountNumber string Optional |
Account number of cardholder/AccountHolder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Allowable Values: 19 |
TransactionDescription string Optional |
User defined description of transaction if entered by user explicitly. If not entered by the user, then system will generate it. Valid Values:A-Z,0-9 Example:Purchase/Payment. Allowable Values: 100 |
TransactionAmount decimal Mandatory |
Amount of Transaction Valid Values:0-9 Format: XXX.XX Example: 200.00 |
BatchID integer Optional |
The identifier of the batch, which is assigned by the system. Valid Values: 0-9 Example: 1234 |
Sample request body
{ "Source": "WEB", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "MerchantID": 7031, "MerchantNumber": null, "EffectiveDateAndTime": "02/16/2017 17:06:36", "AccountNumber": "5000000000012848", "TransactionDescription": "Batch txn description", "TransactionAmount": 2.5, "BatchID": 459901 }
Response fields details
Fields | Description |
---|
Sample response body
{ "Message": "Transaction posted successfully", "Status": true, "ErrorCode": "ERR01058", "ResponseData": null }