Adjustments
Adjustment transactions are posted in order to adjust the card account balance against a transaction that might have been charged incorrectly or to correct a transaction that posted with an incorrect amount.
Post Single Transaction
Action: POST
Endpoint: /api/CoreCredit/Transactions/PostSingleTransaction
Use this API to post any transaction by selecting the appropriate transaction code. The API permits posting of all transaction types, including debit, credit, fees, and post-payments, by selecting the invoice ID. Furthermore, the API can be used to reverse any transaction.
Note
You can also add a user-defined description which can be referred to in the future.
Request fields detail
Fields | Description |
---|---|
Source string |
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 |
Place Holder for Future Use. Currency Code Ex. 840 = US Doller. 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 |
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 |
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 |
StoreID integer Optional |
Specific code assigned to a Store. Valid Values:0-9 Example:1234 |
RegisterID string Optional |
Unique ID assigned to a Register. Valid Values:a-z 0-9 Example:123456 Allowable Values: 50 |
AccountNumber string Conditional |
Card Holder's Account Number. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition:At least one of AdminNumber/AccountNumber is required. Allowable Values: 19 |
TransactionCurrencyCode string Mandatory |
Currency code corresponding to the Transaction Amount. Valid Values:840 for US Dollar Example:840 Allowable Values: 3 |
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 |
TransactionCode string Mandatory |
A code to identify type of payment. Valid Values: The valid values of Transaction Code can be fetched from GetTranCodeByUserID API. Example:427248 = Principal Adjustment Allowable Values: 20 |
ProductCode string Optional |
Specific code assigned to the product. Valid Values: Refer Section 5.47 of Appendix Example: 12456 Allowable Values: 50 |
SettlementDate DateTime Optional |
Date of Settlement. Valid Values:0-9 Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
TransactionAmount decimal Mandatory |
Amount of Transaction. Valid Values:0-9 Format:XXX.XX Example:500.00 |
CreditPlanMaster string Optional |
Plan name associated with the card account. Valid Values: 0-9 Example:6051 Allowable Values: 50 |
PaymentReferenceID string Optional |
Refernce ID of the Payment. Valid Values:0-9, A-z Format:XXXXXXXXXXX Example:fy76869878gh Allowable Values: 36 |
TransmissionDateTime DateTime Optional |
Time of transaction. Valid Values:0-9 Format:MM-DD-YYYTHH:mm:ss Example:12-30-2015T13:05:10 |
EffectiveDateTime DateTime Optional |
Effective Date of Transaction Valid Values:01/15/2020 Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
MerchantType string Optional |
Type of Merchant Valid Values:a-z Example: Retail,Hospital Allowable Values: 50 |
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Example:7485122 Condition:At least one of AdminNumber/AccountNumber is required. |
ReversalTargetTranID string Optional |
Transaction number of target transaction which is going to be reversed. Valid Values: 0-9 Example:12345 Allowable Values: 20 |
ReturnTransactionID int64 Optional |
Transaction ID generated for The Return Transaction. Valid Values:0-9 Example:122390308 |
MethodName string Optional |
Method Name uniquely identifies bank accounts in Core card system. Whenever user adds any bank account.This is required If User wants to send transaction in ACH. Valid Values:0-9 Example:4092 Allowable Values: 25 |
MerchantNumber string Optional |
Number which is assigned to a Merchant. Valid Values: 0-9 Example:11642 Allowable Values: 9 |
InvoiceNumber string Optional |
Incoice Number for Transaction. Valid Values: A-Z 0-9 Example: AB987567757 Allowable Values: 50 |
FeeReversalReason string Optional |
Reason for Fee Reversal. Valid Values: 0 - Customers Goodwill , 1- Erroneous charges Example: 0 - Customers Goodwill Allowable Values: 1 |
CheckNumber string Optional |
Number of the Payment Check. Valid Values:0-9 Format:XXXXXXXX Example:89874545 Allowable Values: 15 |
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, "MerchantNumber": "25636", "StoreID": 25637, "RegisterID": null, "TransactionCode": "34292", "EffectiveDateTime": null, "AccountNumber": "9000000900001737", "AdminNumber": 101055, "TransactionAmount": 53.21, "CreditPlanMaster": "21701", "TransactionDescription": null, "TransactionCurrencyCode": "840", "MerchantType": null, "InvoiceNumber": null, "ReversalTargetTranID": "0", "ProductCode": null, "ReturnTransactionID": null, "MethodName": "0", "SettlementDate": null, "FeeReversalReason": null, "PaymentReferenceID": null, "CheckNumber": null, "TransmissionDateTime": null }
Response fields detail
Fields | Description |
---|---|
CreditPlanMaster string |
Plan name associated with the card account. Valid Values: 0-9 Example:6051 Allowable Values: 50 |
PostingReference string |
Posting reference (Like -Transaction Posted Successfully) Allowable Values: 100 |
PostingFlag string |
With certain IDs in response, It confirms the posting of transaction. Example:1 = Success,0 failed Allowable Values: 1 |
TransactionAmount decimal |
Amount of Transaction. Valid Values: 0-9 Example:500.00 |
AccountNumber string |
Card Holder's Account Number. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Allowable Values: 19 |
AdminNumber int64 |
Details can be obtained by admin number (Embossing Acctid). Valid Values:0-9 Example:7485122 |
TransactionID int64 |
Transaction Number for the transaction being posted. Valid Values:0-9 Example:23654789 |
ResponseID string |
This number indicates that API responded. Response ID is unique. This value will be null if no authentication information was passed. Response ID can be used for tracking Valid Values:0-9 Example:478585 Allowable Values: 15 |
StoreID integer |
Specific code assigned to a Store. Valid Values:0-9 Example:1234 |
TransactionCurrencyCode string |
Currency code corresponding to the Transaction Amount. Valid Values:840 for US Dollar Example:840 Allowable Values: 3 |
PostingDateTime datetime |
Date and Time of posting of the transaction. Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
TransactionDescription string |
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 |
TransactionCode string |
A code to identify type of payment. Valid Values: A-Z 0-9 Example:427248 = Principal Adjustment Allowable Values: 20 |
TransmissionDateTime datetime |
Time of transaction. Valid Values:0-9 Format:MM-DD-YYYTHH:mm:ss Example:12-30-2015T13:05:10 |
CurrencySymbol string |
This tag reflects the currency symbol |
Sample response body
{ "application/json": { "Message": "Transaction posted successfully", "Status": true, "ErrorCode": "ERR01058", "ResponseData": { "CreditPlanMaster": "21701", "PostingReference": null, "PostingFlag": null, "TransactionAmount": 53.21, "AccountNumber": "9000000900001737", "AdminNumber": 101055, "TransactionID": null, "ResponseID": "108410544", "StoreID": 25637, "TransactionCurrencyCode": "840", "PostingDateTime": null, "TransactionDescription": "45454 = INITIAL CHARGE OFF REVERSAL", "TransactionCode": "34292", "TransmissionDateTime": null, "CurrencySymbol": null } } }