Balances

This object represents current loan balances.

Get loan balances

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
loanId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

query Parameters

isRounded	boolean If true, balances will be rounded to the closes 1 cent.
skipYtd	boolean If true, skip year-to-date calculations.
fast	boolean Default: false Perform a faster query that returns a pre-defined subset of attributes. When this query parameter is used, the `toEffectiveAt` parameter is ignored and only real-time balances are returned. To configure the subset of attributes, please contact the Peach team.
toEffectiveDate	string <date> Last day for which to fetch balances

Responses

200

Success

get/people/{personId}/loans/{loanId}/balances

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"isLocked": true,
"outstandingBalances": {"outstandingTotalAmount": 0,
"outstandingPrincipalAmount": 0,
"outstandingInterestAmount": 0,
"outstandingFeesAmount": 0,
"outstandingOriginationFeesAmount": 0,
"outstandingDrawFeesAmount": 0,
"outstandingLateFeesAmount": 0,
"outstandingModificationFeesAmount": 0
},
"outstandingBalancesWithPromo": {"outstandingTotalAmount": 0
},
"nonDueBalances": {"nonDueTotalAmount": 0,
"nonDuePrincipalAmount": 0,
"nonDueInterestAmount": 0,
"nonDueFeesAmount": 0,
"nonDueOriginationFeesAmount": 0,
"nonDueDrawFeesAmount": 0,
"nonDueLateFeesAmount": 0,
"nonDueModificationFeesAmount": 0
},
"dueBalances": {"dueTotalAmount": 0,
"duePrincipalAmount": 0,
"dueInterestAmount": 0,
"dueFeesAmount": 0,
"dueOriginationFeesAmount": 0,
"dueDrawFeesAmount": 0,
"dueLateFeesAmount": 0,
"dueModificationFeesAmount": 0
},
"overdueBalances": {"overdueTotalAmount": 0,
"overduePrincipalAmount": 0,
"overdueInterestAmount": 0,
"overdueFeesAmount": 0,
"overdueOriginationFeesAmount": 0,
"overdueDrawFeesAmount": 0,
"overdueLateFeesAmount": 0,
"overdueModificationFeesAmount": 0
},
"nonAccrualBalances": {"nonAccrualTotalAmount": 0,
"nonAccrualPrincipalAmount": 0,
"nonAccrualInterestAmount": 0,
"nonAccrualFeesAmount": 0
},
"chargedOffBalances": {"chargedOffTotalAmount": 0,
"chargedOffPrincipalAmount": 0,
"chargedOffInterestAmount": 0,
"chargedOffFeesAmount": 0
},
"paidBalances": {"paidTotalAmount": 0,
"paidPaymentsAmount": 0,
"paidCreditsAmount": 0,
"paidReimbursementsAmount": 0,
"paidPrincipalAmount": 0,
"paidInterestAmount": 0,
"paidFeesAmount": 0,
"paidOverAmount": 0
},
"interestAndFeesAmounts": {"interestAccruedTotalAmount": 0,
"interestDiscountTotalAmount": 0,
"forgoneInterestCapAmount": 0,
"forgoneInterestRoundingAmount": 0,
"interestAccruedYearToDateAmount": 0,
"interestAccruedYearToDateForStatementAmount": 0,
"feesChargedYearToDateAmount": 0,
"deferredInterestAccruedTotalAmount": 0,
"deferredInterestDiscountTotalAmount": 0,
"forgoneInterestDeferredAmount": 0
},
"overdueNumberDays": 0,
"reimbursementAmount": 0,
"creditLimitAmount": 0,
"availableCreditAmount": 0,
"openToBuyAmount": 0,
"utilizationAmount": 0,
"overLimitAmount": 0,
"loanStatus": "pending",
"calculatedAt": "2019-08-24T14:15:22Z"
}
}

Get loan interest

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
loanId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

query Parameters

drawId	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The draw identifier, if getting interest for a specific draw.
fromEffectiveDate	string <date> Last day for which to fetch balances
toEffectiveDate	string <date> Last day for which to fetch balances

Responses

200

Success

get/people/{personId}/loans/{loanId}/interest

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"interestAccruedAmount": 0,
"interestDiscountAmount": 0,
"foregoneInterestCapAmount": 0,
"netInterestAccruedAmount": 0,
"deferredInterestAccruedAmount": 0
}
}

Get loan future balances

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
loanId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

query Parameters

isRounded

boolean

If true, balances will be rounded to the closes 1 cent.

Responses

200

Success

get/people/{personId}/loans/{loanId}/future-balances

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"isLocked": true,
"expectedTotalAmount": 0,
"projectedPayoffDate": "2019-08-24",
"projectedTotalDueBalanceTenDays": 0
}
}

Get draw balances

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
loanId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.
drawId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The draw identifier.

query Parameters

isRounded	boolean If true, balances will be rounded to the closes 1 cent.
skipYtd	boolean If true, skip year-to-date calculations.
fast	boolean Default: false Perform a faster query that returns a pre-defined subset of attributes. When this query parameter is used, the `toEffectiveAt` parameter is ignored and only real-time balances are returned. To configure the subset of attributes, please contact the Peach team.
toEffectiveDate	string <date> Last day for which to fetch balances
skipInterestAccrual	boolean If true, skip automatic interest accrual to catch up if it is missing.

Responses

200

Success

get/people/{personId}/loans/{loanId}/draws/{drawId}/balances

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"isLocked": true,
"outstandingBalances": {"outstandingTotalAmount": 0,
"outstandingPrincipalAmount": 0,
"outstandingInterestAmount": 0,
"outstandingFeesAmount": 0,
"outstandingOriginationFeesAmount": 0,
"outstandingDrawFeesAmount": 0,
"outstandingLateFeesAmount": 0,
"outstandingModificationFeesAmount": 0
},
"outstandingBalancesWithPromo": {"outstandingTotalAmount": 0
},
"nonDueBalances": {"nonDueTotalAmount": 0,
"nonDuePrincipalAmount": 0,
"nonDueInterestAmount": 0,
"nonDueFeesAmount": 0,
"nonDueOriginationFeesAmount": 0,
"nonDueDrawFeesAmount": 0,
"nonDueLateFeesAmount": 0,
"nonDueModificationFeesAmount": 0
},
"dueBalances": {"dueTotalAmount": 0,
"duePrincipalAmount": 0,
"dueInterestAmount": 0,
"dueFeesAmount": 0,
"dueOriginationFeesAmount": 0,
"dueDrawFeesAmount": 0,
"dueLateFeesAmount": 0,
"dueModificationFeesAmount": 0
},
"overdueBalances": {"overdueTotalAmount": 0,
"overduePrincipalAmount": 0,
"overdueInterestAmount": 0,
"overdueFeesAmount": 0,
"overdueOriginationFeesAmount": 0,
"overdueDrawFeesAmount": 0,
"overdueLateFeesAmount": 0,
"overdueModificationFeesAmount": 0
},
"nonAccrualBalances": {"nonAccrualTotalAmount": 0,
"nonAccrualPrincipalAmount": 0,
"nonAccrualInterestAmount": 0,
"nonAccrualFeesAmount": 0
},
"chargedOffBalances": {"chargedOffTotalAmount": 0,
"chargedOffPrincipalAmount": 0,
"chargedOffInterestAmount": 0,
"chargedOffFeesAmount": 0
},
"paidBalances": {"paidTotalAmount": 0,
"paidPaymentsAmount": 0,
"paidCreditsAmount": 0,
"paidReimbursementsAmount": 0,
"paidPrincipalAmount": 0,
"paidInterestAmount": 0,
"paidFeesAmount": 0,
"paidOverAmount": 0
},
"interestAndFeesAmounts": {"interestAccruedTotalAmount": 0,
"interestDiscountTotalAmount": 0,
"forgoneInterestCapAmount": 0,
"forgoneInterestRoundingAmount": 0,
"interestAccruedYearToDateAmount": 0,
"interestAccruedYearToDateForStatementAmount": 0,
"feesChargedYearToDateAmount": 0,
"deferredInterestAccruedTotalAmount": 0,
"deferredInterestDiscountTotalAmount": 0,
"forgoneInterestDeferredAmount": 0
},
"overdueNumberDays": 0,
"reimbursementAmount": 0,
"creditLimitAmount": 0,
"availableCreditAmount": 0,
"openToBuyAmount": 0,
"utilizationAmount": 0,
"overLimitAmount": 0,
"loanStatus": "pending",
"calculatedAt": "2019-08-24T14:15:22Z"
}
}

Get draw future balances

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
loanId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.
drawId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The draw identifier.

query Parameters

isRounded

boolean

If true, balances will be rounded to the closes 1 cent.

Responses

200

Success

get/people/{personId}/loans/{loanId}/draws/{drawId}/future-balances

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"isLocked": true,
"expectedTotalAmount": 0,
"projectedPayoffDate": "2019-08-24",
"projectedTotalDueBalanceTenDays": 0
}
}

➔ Next to Credit Reporting

Request sandbox access