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

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition:At least one of AdminNumber/AccountNumber is required.

AccountNumber

string

Conditional

Account number of cardholder. Valid Values: 0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896325874 Condition:At least one of AdminNumber/AccountNumber is required.

Allowable Values:

19

Action

integer

Optional

Valid Values: 1 = Add 2 = Update 3 = Get Loan Account details

Status

integer

Optional

Valid Values: 0 = Inactive, 1 = Active Status should be active for adding LoanAccountNumber and if not provided then default value is active

PayeeName1

string

Conditional

Payee first name Condition: PayeeName1 is required if action is 1. Example: Alex Valid Value: A-Z

Allowable Values:

50

PayeeName2

string

Optional

Payee last name Example: Telles Valid Value: A-Z

Allowable Values:

50

PayeeAddress1

string

Conditional

PayeeAddress1 Condition: PayeeAddress1 is required if action is 1. Example: 123 HWY Valid Values: A-Z, 0-9

Allowable Values:

50

PayeeAddress2

string

Optional

Payee's Address2 Example: 123 HWY Valid Values: A-Z, 0-9

Allowable Values:

50

PayeeAddress3

string

Optional

Payee's Address3 Example: 123 HWY Valid Values: A-Z, 0-9

Allowable Values:

50

PayeeCity

string

Conditional

PayeeCity Condition: PayeeCity is required if action is 1. Example: New York Valid Values: A-Z

Allowable Values:

25

PayeeState

string

Conditional

PayeeState Example: NY Valid Values: A-Z Condition: PayeeState is required if action is 1 (it can be statecode or state name).

Allowable Values:

50

PayeeZipCode

string

Conditional

PayeeZipCode Condition: PayeeZipCode is required if action is 1. Example: 178365 Valid Value: 0-9

Allowable Values:

10

PayeeCountry

string

Conditional

PayeeCountry Condition: PayeeCountry is required if action is 1 (it can be country code or country name). Example: India Valid Value: A-Z

Allowable Values:

50

LoanAccountNumber

string

Conditional

LoanAccountNumber which is to be added or updated. Valid Values: 19 digit number Example : 654789512301450039 Condition : Required in case of add and update.

Allowable Values:

19

AccountUUID

string

Conditional

Basesegment's Universal Unique Id. Condition:At least one of AdminNumber/AccountNumber/AccountUniversalUniqueID/AdminUniversalUniqueID is required. Valid Values:0-9 Example 985241915761

Allowable Values:

64

AdminUUID

string

Conditional

EmbossingAccount's Universal Unique Id. Condition:At least one of AdminNumber/AccountNumber/AccountUniversalUniqueID/AdminUniversalUniqueID is required. Valid Values:0-9 Example:1234

Allowable Values:

64

CustomerNameOnLoan

string

Optional

CustomerNameOnLoan Borrower name on loan account. Condition : Required in case of add and update.

Allowable Values:

50

PayeeAddress4

string

Optional

PayeeAddress4 Fetched from Biller Directory Example: 123 HWY Valid Values: A-Z, 0-9

Allowable Values:

50

PayeeID

string

Optional

Biller iD

Allowable Values:

50

MethodName

string

Optional

Loan ID

Allowable Values:

50

LoanAccountDetailsList

array

LoanAccountDetailsList

MethodName

string

MethodName. Example:0782

Allowable Values:

4

LAcctNumLast4digit

string

Last 4 Digits of LoanAccountNumber. Example:0782

Allowable Values:

4

AccountUUID

string

AccountUUID. Example:0782

Allowable Values:

4

AdminUUID

string

AdminUUID. Example:0782

Allowable Values:

4

ResponseID

string

ResponseID. Example:0782

Allowable Values:

4

ErrorMessage

string

ErrorMessage. Example:0782

Allowable Values:

4

ErrorNumber

string

ErrorNumber. Example:0782

Allowable Values:

4

ErrorFound

string

ErrorFound. Example:0782

Allowable Values:

4