Core Card Api Quick Start

Get CBR Account Details

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetCBRAccountDetails

CoreCARD allows the card issuer to obtain credit bureau reporting details based on the reporting month. The API retrieves details, as per Metro2 acceptable format, with the segments shown below:
> Base Segment: Provides basic account details, like the account holder's PII (personal identification information), demographic details, contact information, and account details.
> J1 Segment: Provides details about co-applicants who have the same address as the main applicant.
> J2 Segment: Provides details about co-applicants who have different addresses from the main applicant.
> K1 Segment: Original creditor name.
> K2 Segment: Purchased portfolio/sold to.
> K3 Segment: Mortgage information.
> K4 Segment: Specialized payment information.
> L1 Segment: Account number/identification number change details.
> N1 Segment: Employment.

The credit bureau reporting details for the current and prior months can be retrieved, as required.

Request fields details

Fields	Description
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
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 of AccountNumber / AdminNumber / AccountID is required.
CreditBureauReportDate datetime Mandatory	Date of Credit Bureau Reporting Format: MM/DD/YYYY HH:MM:SS Example: 11/30/2019 23:59:57
AccountNumber string Conditional	Account number of cardholder Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition: At least one of AccountNumber / AdminNumber / AccountID is required. Allowable Values: 19
AdminNumber int64 Conditional	Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345 Condition: At least one of AccountNumber / AdminNumber / AccountID is required.

Fields

Description

Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

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:

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:

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

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:

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:

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:

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

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 of AccountNumber / AdminNumber / AccountID is required.

CreditBureauReportDate

datetime

Mandatory

Date of Credit Bureau Reporting Format: MM/DD/YYYY HH:MM:SS Example: 11/30/2019 23:59:57

AccountNumber

string

Conditional

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

Allowable Values:

AdminNumber

int64

Conditional

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

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,
  "AccountNumber": null,
  "AdminNumber": null,
  "AccountID": 6106,
  "CreditBureauReportDate": "04/30/2016 23:59:57"
}

Response fields details

Fields	Description
BaseSegment array	Borrower's details are displayed in the base segment.
J1Segment array	Information for J1 Segment
J2Segment array	Information for J2 Segment
K1Segment array	Information for K1 Segment
K2Segment array	Information for K2 Segment
K3Segment array	Information for K3 Segment
K4Segment array	Information for K4 Segment
L1Segment array	Information for L1 Segment
N1Segment array	Information for N1 Segment
J1Segments array	List if J1 Segments
J2Segments array	List if J2 Segments

Sample response body

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": null
}