Category links

API Links

Get Monetary Transaction Control

Action: POST

Endpoint: /api/CoreCredit/ControlParameters/GetMonetaryTransactionControl

Use this API is to obtain details of the logic modules and transaction codes, such as transaction type, short transactions description, and transaction type.

Request fields details
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 ---- es: means Spanish

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

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

LogicModule

string

Mandatory

Logic module Valid Values:o-9 Format:XX Example:40

Allowable Values:

5

TransactionCode

string

Optional

Payment Transaction Code Valid Values:0-9 Format:XXXXX Example: 86221 = AUTO ACH PAYMENT

Allowable Values:

20

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

LogicModule

string

Mandatory

Logic module Valid Values:o-9 Format:XX Example:40

Allowable Values:

5

TransactionCode

string

Optional

The unique, user-defined number assigned to the transaction Valid Values: 0-9,A-z Example: 1360 = Bad Debit settlement

Allowable Values:

20

BatchSize

integer

Optional

Number of Transaction which can be view in one Batch Default Value would be 50. Valid Values:0-9 Format:XX Example:20

PageIndex

integer

Optional

Number of page Default value would be 0 Valid Values:0-9 Format:XX Example:12

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,
  "LogicModule": "02",
  "TransactionCode": null,
  "BatchSize": null,
  "PageIndex": null
}
Response fields details
Fields Description

TranCodesList

array

get or set TranCodes

TranCodesList

array

get or set TranCodes

Sample response body 

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": {
    "TranCodesList": [
      {
        "LogicModule": "02 = Billed Interest",
        "TransactionCode": "36112 = INTEREST CHARGES",
        "TransactionType": "Debit",
        "TransactionDescription": "INTEREST CHARGES",
        "ShortDescription": null,
        "SendToLedger": "No",
        "Commission": "No",
        "AccountReceivableDebitLedger": null,
        "AccountReceivableCreditLedger": null,
        "ProfitLossDebitLedger": null,
        "ProfitLossCreditLedger": null,
        "BackdatedMethod": null,
        "BackdatedDays": null,
        "FuturedatedMethod": null,
        "FuturedatedDays": null,
        "MTCStatus": "Active",
        "TransactionCodeType": "INT",
        "IncludeInStatementTotals": "Both YTD and CTD Totals",
        "AchPushOption": null
      }
    ]
  }
}
POST /api/CoreCredit/ControlParameters/GetMonetaryTransactionControl