Get a summary of loans

GET /LoanSummary

Use this call to retrieve a summary of loans in their current state.

Request URL

https:// ... /LoanSummary

For detailed reference information on the loan attributes, see Loan attributes and parameters.

Sample request in cURL - GET /LoanSummary

curl --location --request GET 'https://arixapisandbox.crbnj.net/LoanSummary?id=e33cc34e-8a5c-4dca-bd64-ad2300cc85f6' \
--header 'Accept: application/json' \
--header 'Authorization: <BearerToken>' \
--header 'Cookie: ss-opt=temp; ss-id=w66BENtcwDwQh80eCrER; ss-pid=j6Ygbx4QpeDBVyUyLFrX'

Sample response in JSON - GET /LoanSummary

After you call a loan summary the Results that show are a list of the current loan statuses.

{
    "Offset": 0,
    "Total": 0,
    "Results": [
        {
            "Status": "Received",
            "TimeStamp": "/Date(1601468209417-0000)/",
            "Id": "16ae6e4a-d96e-4151-8cbc-ac4600ca5fed",
            "MPLId": "TST",
            "Date": "/Date(1601468209427-0000)/",
            "LoanNumber": "AW-a68f1f7ec92440c",
            "IssuingBankId": "CRB",
            "Platform": "string",
            "LoanType": "HFS",
            "NoteDate": "/Date(1577768400000-0000)/",
            "BorrowerLastName": "Dach",
            "BorrowerFirstName": "Myles",
            "BorrowerDOB": "/Date(536389200000-0000)/",
            "BorrowerSSN": "952953656",
            "BorrowerAddress": "963_Marco_Fords",
            "BorrowerCity": "Labadieton",
            "BorrowerState": "SU",
            "BorrowerZip": "84720",
            "LoanAmount": 1500.000000,
            "NetFunding": 1300.000000,
            "Rate": 0.200000,
            "APR": 10.000000,
            "BatchId": "string",
            "BorrowerPhone": "933-392-5495",
            "BorrowerEmail": "[email protected]",
            "Amortization": 0,
            "Term": 36,
            "RateType": 0,
            "PriorLoanFlag": "string",
            "FICO": 10,
            "FICODate": "/Date(1514696400000-0000)/",
            "CreditGrade": "string",
            "AssetClass": 0,
            "LoanPurpose": "string",
            "Investor": "string",
            "Servicer": "string",
            "ApplicationDate": "/Date(1601468209400-0000)/",
            "RegBDecisionDate": "/Date(1601468209400-0000)/",
            "PurchaseDate": "/Date(1601697600000-0000)/",
            "PaymentDueDate": "/Date(1606712400000-0000)/",
            "ApprovedLoanAmount": 0.000000,
            "PeriodicPayment": 0.000000,
            "OriginationFee": 100.000000,
            "HomeownerFlag": "string",
            "OpenCreditLines": 0,
            "AnnualIncome": 0,
            "CreditInquiries12months": 0,
            "DQPast24months": 0,
            "PublicRecordsOnFile": 0,
            "EmploymentLength": 0,
            "DebtUtilization": 0.000000,
            "TotalRevolvingDebt": 0.000000,
            "AccountsOpenedPast24months": 0,
            "CollectionsExcludingMedical": 0,
            "MonthsSinceLastRecord": 0,
            "Employer": "string",
            "DTI": 0.000000,
            "MLAFLAG": "string",
            "MAPR": "string",
            "ReceiverName": "string",
            "SameDayFlag": 0,
            "AddendaRecord": "string",
            "CoBorrowerFirstName": "string",
            "CoBorrowerLastName": "string",
            "CoBorrowerDOB": "/Date(536389200000-0000)/",
            "CoBorrowerSSN": "string",
            "CoBorrowerAddress": "string",
            "CoBorrowerCity": "string",
            "CoBorrowerState": "string",
            "CoBorrowerZip": "string",
            "CoBorrowerPhone": "string",
            "CoBorrowerEmail": "string",
            "CoBorrowerFICO": 0,
            "MerchantName": "string",
            "MerchantFee": 0.000000,
            "RefundAmount": 0.000000,
            "AdjustedLoanAmount": 0.000000,
            "AdjustedNetFunding": 0.000000,
            "AdjustedOriginationFee": 0.000000,
            "AdjustedCurrentMonthlyPayment": 0.000000,
            "RefundDate": "/Date(1514696400000-0000)/",
            "AdjustedMerchantFee": 0.000000,
            "FinalPaymentDate": "/Date(1617076800000-0000)/",
            "FinalPayment": 0.000000,
            "FinanceCharge": 0.000000,
            "TotalPayments": 0.000000,
            "PPY": 0,
            "PaymentFrequency": 0,
            "StandardEntryTypeCode": "string",
            "InterestAccrualMethodDays": 0,
            "SubpoolId": "Moe83",
            "Program": "DTM",
            "Field1": "string",
            "Field2": "string",
            "Field3": "string",
            "Field4": "string",
            "Field5": "string",
            "Field6": "string",
            "Field7": "string",
            "Field8": "string",
            "Field9": "string",
            "Field10": "string",
            "Field11": "string",
            "Field12": "string",
            "Field13": "string",
            "Field14": "string",
            "Field15": "string",
            "Field16": "string",
            "Field17": "string",
            "Field18": "string",
            "Field19": "string",
            "Field20": "string",
            "Rails": [
                {
                    "ACHFields": {
                        "StandardEntryClassCode": "PPD",
                        "TransactionType": "push",
                        "ToRoutingNumber": "021214891",
                        "ToAccountType": "GL",
                        "ToAccountName": "Test",
                        "ToAccountNumber": "9999999999",
                        "Description": "Test"
                    },
                    "Id": "da240b55-9a2b-40ae-91fb-ac4600ca5fed",
                    "RailType": "COSACH",
                    "Priority": 1,
                    "Amount": 300.0,
                    "LoanId": "16ae6e4a-d96e-4151-8cbc-ac4600ca5fed",
                    "MPLId": "TST",
                    "IssuingBankId": "CRB",
                    "IsFailed": false,
                    "LoanType": "Undefined"
                }
            ]
        }
    ],
    "Meta": {}
}

Configuration

  • You can customize the result set with the jsconfig parameter.
  • DateTime values are returned in the Unix format.
?jsconfig=dh:ut

Query parameters

Use these parameters to design and filter a query to narrow down and present the most precise results possible.

Skip
integer or null

Enter a number of responses to skip.

Take
integer or null

Enter a number of responses to return.

OrderBy
string

The field by which to sort.

OrderByDesc
string

The field by which to sort descending.

Include
string

Aggregate queries to include.

Meta
Dictionary

A meta object.


Did this page help you?