You are viewing the latest API docs through the legacy docs viewer. The modern viewer can be found here: https://docs.peachfinance.com/api-docs.
Peach Finance

Loan Collection Agency

Allows a loan to be assigned to a collection agency

Update loan collection agency

This end point allows lenders to assign a loan to a debt collection agency. When a loan is assigned to a debt collection agency, the system will set servicedBy=debtCollectionAgency. Once the loan is assigned, Peach system can only accept "external" transactions to update the loan balance (isExternal=true).

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.

Request Body schema: application/json
required
agencyId
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

Peach's unique or lender's external identifier.

assignedOnDate
string or null <date>

The date when the loan was assigned to a debt collection agency. If a date is not passed, the system will set the date to today.

status
string

pendingAssignment - the loan is in the process of being assigned to an agency. It might take a few days for the agency to be ready to start collecting debt. Peach cannot collect payments.

assigned - the loan was successfully assigned to an agency. The borrower should contact the agency for details. Peach cannot collect payments and loan balances might not be accurate.

Enum: "unassigned" "pendingAssignment" "assigned"
assignmentType
string

The type of loan assignment to a debt collection agency.

wholeSale - The loan was sold to a third party debt collections agency. The loan is no longer managed by Peach as the system of record.

contingency - Collection efforts are performed by a third party debt collections agency. The loan is still managed by Peach as the system of record.

Enum: "wholeSale" "contingency"
object
Responses
200

Success

post/people/{personId}/loans/{loanId}/collection-agency
Request samples
application/json
{
  • "agencyId": "string",
  • "assignedOnDate": "2019-08-24",
  • "status": "unassigned",
  • "assignmentType": "wholeSale",
  • "metro2": {
    }
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get loan collection agency

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.

Responses
200

Success

get/people/{personId}/loans/{loanId}/collection-agency
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Unassign loan collection agency

This endpoint is used to "unassign" a loan from a collection agency. To keep the servicedBy value on the loan to debtCollectionAgency, just pass that value to this endpoint and the servicedBy will remain the same, while still clearing the collection agency assignment fields for the loan.

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
servicedBy
required
string (LoanServicer)

The entity type that services the loan.

creditor, thirdPartyServicer - means that the loan is serviced on the Peach platform.

debtCollectionAgency - means that the loan is no longer serviced on the Peach platform. The loan can be still visible in Borrower Portal. To clarify, the loan is not deleted from the Peach platform.

Enum: "creditor" "thirdPartyServicer" "debtCollectionAgency"
Responses
200

Success

delete/people/{personId}/loans/{loanId}/collection-agency
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}
➔ Next to Errors