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

AccountNumber

string

Conditional

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

Allowable Values:

19

AdminNumber

int64

Conditional

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

Frequency

integer

Conditional

Frequency set with which payment will be made Possible values 0 = Monthly Specific Day 1 = Payment Due Date 2 = One Time 3 = Weekly 4 = Instant Pay 5 = Daily 6 = Bi-Weekly 7 = Semi-Monthly Condition:Mandatory When Request type = 0 NOTE: If 'Instant Pay' option is used for Payment then the balances will be updated at the same time but it can have different status based on the transaction processing through ACH.

PaymentDate

datetime

Conditional

Date when payment is scheduled. Format: MM/DD/YYYY Example: 01/01/2020 Condition: If request type = 0 and frequency = 2 then this is mandatory.

PaymentType

integer

Conditional

Type of Payment as below enumerations: 0 = Minimum Payment Due 1 = Statement Balance 2 = Current Balance 3 = Fixed Amount 4 = Adjusted Statement Balance Condition: Mandatory When Request type = 0

MethodName

integer

Conditional

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. Condition: Mandatory When Request type = 0 and PaymentMode is 0(ACH).

SpecificDay

string

Conditional

Specific day when scheduled payment should occur. If frequency = 0 Or frequency = 3 Or frequency = 6 then this is mandatory. Possible values: If (frequency = 0) 1-31 EOM If (frequency = 3 Or frequency = 6) MON, TUE, WED, THU, FRI, SAT, SUN Condition : If frequency = 0 Or frequency = 3 Or frequency = 6 then this is mandatory if PaymentDate is not provided.

Allowable Values:

10

EnterMemo

string

Conditional

Memo text entered by Customer service representative. Possible values: a-z,0-9 Example:abc Condition: Memo text required when deleting a schedule, if request type = 1

Allowable Values:

150

ScheduleID

integer

Conditional

Unique identifier for Schedule Payment. Condition:Mandatory When Request type = 1.

RequestType

integer

Optional

Denotes type of action being attempted. Possible values: 0 = Add/Create Schedule 1 = Delete Schedule 2 = Update Example: 0

Priority

integer

Conditional

Denotes memo priority while deleting scheduled payment. Possible values: 0 = No, 1 = Yes Example:1 Condition: If request type = 1 then priority can be set.

FixedAmount

decimal

Conditional

This is fixed value of payment to be used to schedule a payment. Condition: If payment type = 3 then this is mandatory

PaymentMode

integer

Optional

If not provided then Default value - 0 (ACH) Possible values: 0 = ACH 1 = Debit Card With Token 2 = Debit Card With Card Number 3 = APC Payment

Token

string

Optional

Debit Card Token (Cardholder Authentication Verification Value(CAVV))

Allowable Values:

100

CreateMethodForNextPayment

string

Optional

If User wants to generate Method of Debit Card Token or Debit Card Number information for further Payments Possible values: 0 = No, 1 = Yes Example: 0

Allowable Values:

2

XDaysBeforePaymentDueDate

integer

Optional

XdaysBeforePaymentDueDate will be enable, if Frequency is Payment Due Date. Possible Values: 0 - 28. If not provided then default values is 0 which means payment date will be Payment due Date.

ApplicantType

integer

Optional

Selects the type of Applicant. Valid Values: 1,2,3 Example: 1 = Applicant, 2 = Co-Applicant, 3 = Cosigner

UniqueId

string

Optional

Unique ID is a transaction specific unique ID. This ID is unique for every transaction. If multiple calls are made by client for a specific transaction, the value of this tag will always be the same for a specific transaction. (GUID and UUID datatypes are supported for this tag). Valid Values: A-Z, 0-9 Example: F965C56F-C58F-EC11-B80E-A4BF010A357E Condition:For API user, if API Idempotency Applicable is set as Yes on CoreCredit, field is mandatory. The UniqueId is valid for 7 days from first submission of the request. Same request can be retried for 7 days without performing the same action twice.Idempotency will be checked at the belongingOwning Partner and Merchant Level.

Allowable Values:

40

ScheduleID

integer

Unique identifier for Schedule Payment.

TransactionStatus

string

Shows status of transaction.

Allowable Values:

20

TransactionAmount

decimal

Amount of Transaction.

ExternalErrorMessage

string

Error message, if any.

Allowable Values:

50

DateOfPayment

datetime

Date when payment transaction will happen. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05