Digital lending
Get loan details by ID

Loan detail collections

8min

Collections

A loan collection contains a specific set of results, in response to a query that you add to your call.

When you want to access information (any details) about a loan, use the GET/LoanDetail/{Id} API. You can add 1 or more of the loan collections available in Arix (which are shown in the table below), which customizes the API response.

The API response always returns the OriginalLoanInfo (original details that were entered when the loan was created), and can also return other information. Therefore, if you made changes to a loan, it's easy to view and compare any of the changes you made to the loan.

To check the collections you've called, look at the Fields in the path parameter that show after the equal (=) sign.

Example

In the response below, only results for FundingAttempts and ProcessedRails are returned, which in this case doesn't return any responses.

GET /LoanDetail/{Id}?Fields=FundingAttempts,ProcessedRails

Document image


IMPORTANT When you send a PUT call to these endpoints, only unprocessed rails are overwritten.

Already processed rails and rails that are in the process of being funded aren't affected.

Loan collections

Description

LoanInfoUpdates

array

View all updates made to the loan.

To view a full list of the parameters returned, see LoanInfoUpdates below.

FundingInfoUpdates

array

View all funding updates made to the loan.

To view a full list of the parameters returned, see FundingInfoUpdates below.

FailedLoanInfoUpdate

array

View information about a loan that failed.To view a full list of the parameters returned, see FailedloanInfoUpdate below.

FailedFundingInfoUpdate

array

View information about the failed loan funding. To view a full list of the parameters returned, see "FailedFundingInfoUpdate** below.

ProcessedRails

array

View the rails that were processed for a loan.To view a full list of the parameters returned, go to Payment rails

FundingAttempts

array

View the number of times funding was attempted. To view a full list of the parameters returned, see FundingAttempts below.

ReturnedRails

array



View the rails that were returned. To view a full list of the parameters returned, go to Payment rails

StatusUpdates

array

View the status of the loan.

To view a full list of the parameters returned, go to Status updates .

Attachments

array

View the attachments that were submitted, or those that are missing.

To view a full list of the parameters returned, go to Document reference.

RequiredDocs

array

View the documents that are required for the loan. To view a full list of the parameters returned, go to Document reference.

ComplianceLoanResult

array

View the compliance status of the loan. To view a full list of the parameters returned, go to Compliance results.

AdjustmentActions

array

View updates made to the loan after funding. To view a full list of the parameters returned, go to Adjustment Action parameters.

LoanInfoUpdate collection parameters

This collection returns information about any updates made to a loan.

Attribute

Description

LoanInfoUpdates

Unique identifier for the loan update

UpdatedBy

string

Clerk who updated the loan

UpdatedOn

DateTime

The date the loan was updated

FundingInfoUpdate collection parameters

This collection returns information about any funding updates made to a loan.

Attribute

Description

LoanId

string

Unique identifier for the loan

MPLId

string

ID of the MPL

UpdatedBy

string

Clerk who updated the loan

UpdatedOn

DateTime

The date the loan was updated

Rails

List{RailTransaction}

Click Payment rails for a list of all rail types

Attribute

Description

LoanId

Unique identifier of the loan

Time

Time

Time the funding attempt was made

TransactionGroupId

string

Group ID for the transaction

FundingResult



List of possible funding results.

- Success

- PartialFailure

- FundingFailed

See Enums for more information.

AmountFunded

decimal

Dollar amount funded

FailedLoanInfoUpdate collection parameters

This collection returns information about loan funding that failed.

Attribute

Description

FailedLoanInfoUpdateId

Unique identifier of information about the failed loan

UpdatedBy

string

Clerk who updated the loan

UpdatedOn

DateTime or null

The date the loan was updated

ErrorMessages

string

Error message

FailedFundingInfoUpdate collection parameters

This collection returns information about loan funding that failed.

Attribute

Description

ErrorMessages

string

Error message

RequiredDocs collection parameters

This collection returns information about Required Documents and their received status for this loan.

Attribute

Description

DocumentType

One of the documents required for loan processing

Received

Confirms if a particular document was received

ReceivedDate

Date the document was received



🤔
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.