Category links

API Links

CustomerInquiry

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/CustomerInquiry

The purpose of this API is to display account information to external merchants.

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

AccountNumber

string

Mandatory

Account number whose information is required. Valid Values: 0-9 Format:XXXXXXXXXX Example:7314145404

Allowable Values:

19

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": "8000000000000128"
}
Response fields details
Fields Description

MerchantName

string

Name of the Merchant where account is opened. Valid Values: A-Z, 0-9 Format: XXXXXX Example:Merchant 1

Allowable Values:

40

MerchantID

integer

Specific ID Assigned to a Merchant. Valid Values: 0-9 Format: XXXX Example:11111111

ApplicationID

int64

This tag reflects the Application ID. Valid Values:0-9 Format:XXXXXXXXXX Example:133973

LastName

string

Card holder's last name. Valid Values:A-Z Example:John

Allowable Values:

50

FirstName

string

Card holder's first name. Valid Values:A-Z Example:Smith

Allowable Values:

50

ProductName

string

Reflects the name of product for the account. Valid Values: a-z Format:xxxxxx Example:Abc revolving

Allowable Values:

50

OpenToBuy

decimal

Remaining Credit Limit which can be used for further posting. Valid Values: 0-9 Format: XXXXXXX.XX Example:200.00

CreditLimit

decimal

Credit Limit of account. Valid Values: 0-9 Format: XXX.XX Example:500.00

ApplicationDate

datetime

Date when the Application was Submitted. Valid Values:0-9 Format:MM/DD/YYYY Example:02/01/2020

BlockedPosting

integer

Based on the higher priority status of the account if posting is allowed or not. Valid Values:as per “Posting of Transactions” field Format:X Example: 0 – No – Posting is allowed 1 – Yes - Posting is not allowed.

EmailID

string

Primary Account Holder Email address. Valid Values: 0-9, A-Z Format:XX@XX.Com Example:ABC@gmail.com

Allowable Values:

100

MobilePhoneNumber

string

Primary Account Holder Mobile phone. Valid Values: 0-9 Format:XXXXXXXXXX Example:987567757

Allowable Values:

15

HomePhoneNumber

string

Primary Account Holder Home phone. Valid Values: 0-9 Format:XXXXXXXXXX Example:7895463214

Allowable Values:

15

CoApplicantFirstName

string

Co- Applicant’s First Name. Valid Values:A-Z,0-9 Example:Bob

Allowable Values:

50

CoApplicantLastName

string

Co- Applicant’s Last Name. Valid Values:A-Z,0-9 Example:Dylan

Allowable Values:

50

AddressLine1

string

Debtor Address Line 1. Valid Values: A-Z, 0-9 Example:123 HWY

Allowable Values:

50

City

string

Debtor City. Valid Values:Alphabets, numbers, symbol Format: XXXXXXX Example:Los Angeles

Allowable Values:

25

State

string

Address State of the Card Holder. Valid Values: a-z Format: XXX Example:MO

Allowable Values:

3

PostalCode

string

Postal code of the applicant’s address. Valid Values: 0-9 Format: XXXXX Example:46206

Allowable Values:

9

ArrayOfAllTransactions

array

Array of all purchase and refund transactions including the following transaction fields.

Sample response body

{
  "Message": "Success.",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": {
    "MerchantName": "Merchant 1",
    "MerchantID": 11111111,
    "MSRNumber": "1234567890",
    "MSREmail": "Test1234@corecard.com",
    "MerchantAddressLine1": "One Meca Way",
    "MerchantAddressLine2": null,
    "MerchantCity": "Norcross",
    "MerchantState": null,
    "MerchantPostalCode": "12345",
    "StoreID": 11698,
    "ApplicationID": 133973,
    "LastName": null,
    "FirstName": null,
    "ProductName": "abc",
    "OpenToBuy": 4999.0,
    "CreditLimit": 6999.0,
    "ApplicationDate": "01/15/2017 00:00:00",
    "BlockedPosting": 0,
    "EmailID": "dd3232srwe4343@sds.com",
    "MobilePhoneNumber": "7896541236",
    "HomePhoneNumber": "7896541236",
    "CoApplicantFirstName": "JUDY",
    "CoApplicantLastName": "STEPIEN",
    "AddressLine1": "267 CHANDLER ST",
    "City": "WASHINGTON",
    "State": "NC",
    "PostalCode": "190183429",
    "AccountActivationStatus": "1",
    "ActivationResponseDateTime": "04/06/2017 09:04:53",
    "ActivationResponseChannel": "2",
    "EmailIdOfActivationRequest": "Ankesh.Kirar@corecard.com",
    "EmailDeliveryStatus": "1",
    "EmailDeliveryDateTime": "11/01/2021 16:11:19",
    "MobileNumberOfActivationRequest": "9898987445",
    "SMSDeliveryStatus": "2",
    "SMSDeliveryDateTime": null,
    "ValidEmailAddress": "True",
    "ValidMobilePhone": "False",
    "MobilePhoneLineType": "Fixed VOIP",
    "ActivationMTAConsolidationFlag": null,
    "ArrayOfAllTransactions": [
      {
        "TransactionDate": "01/16/2017 00:00:00",
        "CreditPlanNumber": "6053",
        "CreditPlanDescription": "12 Months No Interest if Paid in Full",
        "TransactionType": "Settled",
        "TransactionAmount": 2000.0,
        "TransactionStatus": "Success",
        "TransactionID": "123372036854802129",
        "TransactionDescription": "3020 = DOMESTIC SALE (THIRD PARTY)",
        "APR": 29.99,
        "RefundFlag": 2,
        "PartialRefundAmount": 500.0,
        "OriginalPurchaseTransactionID": "123372036855074781",
        "PrintReceiptPromotionText": "Interest will be charged on this promotional purchase at a reduced 4.99% APR for 36 months after the transaction date shown above (the promotional period).  36-fixed monthly payments are required on this promotional purchase. Any promotional purchase balance when the promotional period ends is subject to 29.99% APR and to the other terms in your Cardholder Agreement.  Minimum interest charge is $2.00."
      }
    ],
    "ArrayOfAllAuthorizations": [
      {
        "AuthTranTime": "01/16/2017 00:00:00",
        "AuthorizationStatus": "Outstanding",
        "TransactionAmount": 2000.0,
        "RejectReason": "Wrong Plan",
        "TransactionID": "23654789",
        "CreditPlanDescription": "Fixed APR of 3.99%-28.99% for 24 Months",
        "ADCResponse": 54,
        "AuthorizationResponseDateTime": "03/30/2017 00:00:58",
        "AuthorizationChannel": null,
        "EmailIdOfAuthorizationRequest": "Ankesh.Kirar@corecard.com",
        "EmailDeliveryStatus": "1",
        "EmailDeliveryDateTime": "11/10/2021 14:14:40",
        "MobileNumberOfAuthorizationRequest": "9898987445",
        "SMSDeliveryStatus": "0",
        "SMSDeliveryDateTime": "07/13/2021 23:00:02",
        "ValidEmailAddress": "True",
        "ValidMobilePhone": "False",
        "MobilePhoneLineType": null
      }
    ],
    "PendingActivationAuth": {
      "DateTimeOfPendingActivationAuth": "04/08/2017 14:14:24",
      "PendingActivationAuthStatus": "0",
      "PendingActivationAuthID": "123372036855159790",
      "TransactionAmount": "500.0000",
      "PlanDescription": "Fixed APR of 3.99%-28.99% for 24 Months"
    }
  }
}