Get Send Account Letter
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetSendAccountLetter
Use this API to obtain letters generated on the card account in PDF form by account number, account ID, or admin number, as well as mandatory fields such as letter template ID and letter template status.
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 |
|
DecisionFlag integer Mandatory |
Decide if Letter need to view or send. Valid Values: 8 = ViewLetter 0 = Send Letter Example: 8 |
|
AccountNumber string Conditional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one account identifier is required. Allowable Values: 19 |
|
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Example:12345 Condition: At least one account identifier is required. |
|
AccountID integer Conditional |
Account ID represents Unique Identity of Account (CoreCard Bsegment Entitity, i.e., the Account ID of program card account). Format:XXXXX Example:12345 Condition: At least one account identifier is required. |
|
LetterTemplateID integer Mandatory |
ID assigned to a Letter Template Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard. |
|
LetterTemplateVersion integer Mandatory |
Version of the Letter Template Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard. |
|
LetterTemplateStatus integer Mandatory |
Status of the letter template status. Valid Values: 1= Active, 2=Inactive Format: x Example: 1 |
|
LetterTemplateIDDesc string Mandatory |
Description of Letter template ID Valid Values: A-Z, 0-9 Example: L210 = Change of Address Allowable Values: 150 |
|
ApplicantType string Mandatory |
Selects the type of Applicants. Valid Values: Applicant or Co-Applicant Example: Applicant Allowable Values: 15 |
|
TextFieldName1 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue1 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 50 |
|
DateFieldName1 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 8 |
|
DateFieldValue1 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName1 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue1 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName2 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue2 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 50 |
|
DateFieldName2 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 8 |
|
DateFieldValue2 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName2 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue2 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName3 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue3 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName3 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 8 |
|
DateFieldValue3 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName3 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue3 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName4 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue4 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName4 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 8 |
|
DateFieldValue4 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName4 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue4 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName5 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue5 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName5 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 20 |
|
DateFieldValue5 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName5 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue5 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName6 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue6 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName6 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 20 |
|
DateFieldValue6 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName6 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue6 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName7 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue7 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName7 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 20 |
|
DateFieldValue7 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName7 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue7 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName8 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue8 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName8 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 20 |
|
DateFieldValue8 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName8 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue8 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName9 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue9 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName9 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 20 |
|
DateFieldValue9 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName9 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue9 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName10 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue10 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName10 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 20 |
|
DateFieldValue10 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName10 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue10 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
Reason1 string Optional |
Reason 1 involved for rejecting application. Valid Values: A-Z, 0-9 Example: Lack of Credit history Allowable Values: 100 |
|
Reason2 string Optional |
Reason 2 involved for rejecting application. Valid Values: A-Z, 0-9 Example: Over-utilization of available credit Allowable Values: 100 |
|
Reason3 string Optional |
Reason 3 involved for rejecting application. Valid Values: A-Z, 0-9 Example: Late payments Allowable Values: 100 |
|
Reason4 string Optional |
Reason 4 involved for rejecting application. Valid Values: A-Z, 0-9 Example: Delinquency or default Allowable Values: 100 |
|
Factor1 string Optional |
Factor affecting credit bureau (1) Valid Values:0-9, a-z Example:01 Allowable Values: 100 |
|
Factor2 string Optional |
Factor affecting credit bureau (2) Valid Values:0-9, a-z Example:01 Allowable Values: 100 |
|
Factor3 string Optional |
Factor affecting credit bureau (3) Valid Values:0-9, a-z Example:01 Allowable Values: 100 |
|
Factor4 string Optional |
Factor affecting credit bureau (4) Valid Values:0-9, a-z Example:01 Allowable Values: 100 |
|
Factor5 string Optional |
Factor affecting credit bureau (5) Valid Values:0-9, a-z Example:01 Allowable Values: 100 |
|
CreditScore string Optional |
Credit score of card holder. Valid Values: 0-9 Example:700 Allowable Values: 5 |
|
CreditReportDate datetime Optional |
Date of credit report. Valid Values: 0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
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 |
|
DecisionFlag integer Mandatory |
Decide if Letter need to view or send. Valid Values: 8 = View Letter 0 = Send Letter Example: 8 |
|
AccountNumber string Conditional |
Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition: At least one of AccountNumber/AccountID/AdminNumber is required. Allowable Values: 19 |
|
AdminNumber int64 Conditional |
Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Example:12345 Condition: At least one of AccountNumber/AccountID/AdminNumber is required. |
|
AccountID integer Conditional |
Account ID represents Unique Identity of Account (CoreCard Bsegment entity, i.e., the Account ID of program card account). Format:XXXXX Example:12345 Condition: At least one of AccountNumber/AccountID/AdminNumber is required. |
|
LetterTemplateID integer Mandatory |
ID assigned to a Letter Template Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard. |
|
LetterTemplateVersion integer Mandatory |
Version of the Letter Template Valid Values:0-9 Format:XXXX Example:Fixed value provided by CoreCard. |
|
LetterTemplateStatus integer Mandatory |
Status of the letter template status. Valid Values: 1= Active, 2=Inactive Format: x Example: 1 |
|
LetterTemplateIDDesc string Mandatory |
Description of Letter template ID Valid Values: A-Z, 0-9 Example: L210 = Change of Address Allowable Values: 150 |
|
ApplicantType string Mandatory |
Selects the type of Applicants. Valid Values: Applicant or Co-Applicant Example: Applicant Allowable Values: 15 |
|
TextFieldName1 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue1 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 50 |
|
DateFieldName1 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 8 |
|
DateFieldValue1 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName1 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue1 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName2 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue2 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 50 |
|
DateFieldName2 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 8 |
|
DateFieldValue2 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName2 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue2 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName3 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue3 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName3 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 8 |
|
DateFieldValue3 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName3 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue3 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName4 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue4 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName4 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 8 |
|
DateFieldValue4 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName4 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue4 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName5 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue5 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName5 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 20 |
|
DateFieldValue5 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName5 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue5 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName6 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue6 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName6 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 20 |
|
DateFieldValue6 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName6 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue6 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName7 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue7 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName7 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 20 |
|
DateFieldValue7 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName7 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue7 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName8 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue8 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName8 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 20 |
|
DateFieldValue8 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName8 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue8 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName9 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue9 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName9 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 20 |
|
DateFieldValue9 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName9 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue9 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
TextFieldName10 string Optional |
Text Field Name as per configuration on letter template. Valid Values: 0-9, A-Z Example: Reason Allowable Values: 20 |
|
TextFieldValue10 string Optional |
Manual text value for the text field. Valid Values: 0-9, A-Z Allowable Values: 40 |
|
DateFieldName10 string Optional |
Date field name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Date Allowable Values: 20 |
|
DateFieldValue10 datetime Optional |
Manual date for the date field. Valid Values:0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
|
AmountFieldName10 string Optional |
Amount field Name as per configuration on letter template. Valid Value: 0-9, A-Z Example: Due Amount Allowable Values: 20 |
|
AmountFieldValue10 decimal Optional |
Manual amount for the amount field. Valid Values:0-9 Format:XXX.XX Example: 200.00 |
|
Reason1 string Optional |
Reason 1 involved for rejecting application. Valid Values: A-Z, 0-9 Example: Lack of Credit history Allowable Values: 100 |
|
Reason2 string Optional |
Reason 2 involved for rejecting application. Valid Values: A-Z, 0-9 Example: Over-utilization of available credit Allowable Values: 100 |
|
Reason3 string Optional |
Reason 3 involved for rejecting application. Valid Values: A-Z, 0-9 Example: Late payments Allowable Values: 100 |
|
Reason4 string Optional |
Reason 4 involved for rejecting application. Valid Values: A-Z, 0-9 Example: Delinquency or default Allowable Values: 100 |
|
Factor1 string Optional |
Factor affecting credit bureau (1) Valid Values:0-9, a-z Example:01 Allowable Values: 100 |
|
Factor2 string Optional |
Factor affecting credit bureau (2) Valid Values:0-9, a-z Example:01 Allowable Values: 100 |
|
Factor3 string Optional |
Factor affecting credit bureau (3) Valid Values:0-9, a-z Example:01 Allowable Values: 100 |
|
Factor4 string Optional |
Factor affecting credit bureau (4) Valid Values:0-9, a-z Example:01 Allowable Values: 100 |
|
Factor5 string Optional |
Factor affecting credit bureau (5) Valid Values:0-9, a-z Example:01 Allowable Values: 100 |
|
CreditScore string Optional |
Credit score of card holder. Valid Values: 0-9 Example:700 Allowable Values: 5 |
|
CreditReportDate datetime Optional |
Date of credit report. Valid Values: 0-9 Format: MM/DD/YYYY Example: 01/02/2020 |
Sample request body
{
"Source": "Web",
"IPAddress": null,
"DateFormat": null,
"CurrencyCode": null,
"CurrencySymbolType": null,
"Language": null,
"ExternalIP": "10.205.0.56",
"SessionID": null,
"APIVersion": "2.0",
"CallerID": null,
"CalledID": null,
"RequestTime": null,
"DecisionFlag": 8,
"AccountNumber": "8000000000000078",
"AdminNumber": null,
"AccountID": 167499,
"LetterTemplateID": 397,
"LetterTemplateVersion": 1,
"LetterTemplateStatus": 1,
"LetterTemplateIDDesc": "L1214-Payoff_Amount",
"ApplicantType": "Applicant",
"TextFieldName1": null,
"TextFieldValue1": null,
"DateFieldName1": null,
"DateFieldValue1": "03/31/2016 00:00:00",
"AmountFieldName1": null,
"AmountFieldValue1": 10.0,
"TextFieldName2": null,
"TextFieldValue2": null,
"DateFieldName2": null,
"DateFieldValue2": null,
"AmountFieldName2": null,
"AmountFieldValue2": null,
"TextFieldName3": null,
"TextFieldValue3": null,
"DateFieldName3": null,
"DateFieldValue3": null,
"AmountFieldName3": null,
"AmountFieldValue3": null,
"TextFieldName4": null,
"TextFieldValue4": null,
"DateFieldName4": null,
"DateFieldValue4": null,
"AmountFieldName4": null,
"AmountFieldValue4": null,
"TextFieldName5": null,
"TextFieldValue5": null,
"DateFieldName5": null,
"DateFieldValue5": null,
"AmountFieldName5": null,
"AmountFieldValue5": null,
"TextFieldName6": null,
"TextFieldValue6": null,
"DateFieldName6": null,
"DateFieldValue6": null,
"AmountFieldName6": null,
"AmountFieldValue6": null,
"TextFieldName7": null,
"TextFieldValue7": null,
"DateFieldName7": null,
"DateFieldValue7": null,
"AmountFieldName7": null,
"AmountFieldValue7": null,
"TextFieldName8": null,
"TextFieldValue8": null,
"DateFieldName8": null,
"DateFieldValue8": null,
"AmountFieldName8": null,
"AmountFieldValue8": null,
"TextFieldName9": null,
"TextFieldValue9": null,
"DateFieldName9": null,
"DateFieldValue9": null,
"AmountFieldName9": null,
"AmountFieldValue9": null,
"TextFieldName10": null,
"TextFieldValue10": null,
"DateFieldName10": null,
"DateFieldValue10": null,
"AmountFieldName10": null,
"AmountFieldValue10": null,
"Reason1": null,
"Reason2": null,
"Reason3": null,
"Reason4": null,
"Factor1": null,
"Factor2": null,
"Factor3": null,
"Factor4": null,
"Factor5": null,
"CreditScore": null,
"CreditReportDate": null
}
Response fields details
| Fields | Description |
|---|---|
|
LetterID integer |
Unique ID provided by corecard for the generated letter. Valid Values: 0-9 Example: 1234 |
|
LetterFile
|
Group of Letter details. |
|
LetterID integer |
Unique ID provided by corecard for the generated letter. Valid Values: 0-9 Example: 1234 |
|
LetterFile
|
Group of Letter details. |
Sample response body
{
"Message": "Success.",
"Status": true,
"ErrorCode": "Err00017",
"ResponseData": {
"LetterID": 1231,
"LetterFile": {
"LetterFileName": "L1214-Payoff_Amount",
"LetterFileData": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=",
"MIMEType": "application/pdf",
"LetterFileExtension": "pdf"
}
}
}