Post To Batch
Action: POST
Endpoint: /api/CoreCredit/MerchantManagement/PostToBatch
Use this API to batch post transactions.
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 |
BatchID integer Mandatory |
The identifier of the batch, which is assigned by the system. Valid Values:0-9 Example:1234 |
MerchantID integer Conditional |
Unique number of merchant account Valid Values:0-9 Format:XXXXX Example:12345 |
MerchantNumber string Conditional |
Number which is assigned to a Merchant. Valid Values:0-9 Format:XXXXX Example:12345 |
BatchTransactionID int64 Mandatory |
Unique Id for transactions added to Batch. Valid Values: 0-9 Example: 123456 |
AccountNumber string Mandatory |
Account number of cardholder/AccountHolder. Valid Values:0-9 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 Format: xxxxxxxx Example:Purchase/Payment. Allowable Values: 100 |
TransactionAmount decimal Mandatory |
Amount of Transaction Valid Values:0-9 Format: XXX.XX Example: 200.00 |
BatchStatus string Optional |
The Current status of the batch. Valid values: 0- New 1- In Balance 2- Out of Balance 3- Needs Re-posting 4- Posted 5- Batch Flagged for Deletion 6- Summary 7- Batch Flagged for Error(s) 8- Rejected 9- Fraud 10- Processed 11- Non-Monetary Processed 12- Dispute Resolution Batch 16- Rejected: ACH Auto Return 17- Rejected: ACH Manual Return Allowable Values: 50 |
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, "BatchID": 459901, "MerchantID": 11629, "MerchantNumber": null, "BatchTransactionID": 123372036855049848, "AccountNumber": "1234567891000", "TransactionDescription": "8000000000000128", "TransactionAmount": 100.0, "BatchStatus": "0" }
Response fields details
Fields | Description |
---|
Sample response body
{ "Message": "Transaction Posted To Batch.", "Status": true, "ErrorCode": "0000", "ResponseData": null }