Peach Finance

Collection Agencies

Allows lenders to keep track of different collection agencies that charged-off loans may be assigned to. This is useful when a lender assigns charged off loans to a third party debt collection agency. The Peach Borrower Portal will display the collection agency information to the borrower. The lender can continue to use Peach as the system of record / ledger for charged off loans. The lender can post any payments collected by the collection agency as isExternal=true transactions. The Peach system will waterfall the payments and update loan balances.

Create collection agency

Creates a new collection agency. This is useful when a lender assigns a charged off loan to a third party debt collection agency. The Peach Borrower Portal will display the collection agency information to the borrower. The lender can continue to use Peach as the system of record / ledger for charged off loans. The lender can post any payments collected by the collection agency as isExternal=true transaction. The Peach system will waterfall the payments and update loan balances.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Request Body schema: application/json
required
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
externalId
string or null [ 1 .. 50 ] characters

A lender's identifier for an object.

After the object is successfully created, a lender can use ID or externalId identifiers to fetch the object.

To fetch the object using externalId you need to add ext- to the URL.

Note: Don't add ext- to the identifier value. For example: if the external identifier is ABCDE, then pass externalId=ACBCE and NOT ext-ABCDE when creating the object.

legalName
required
string

The third party debt collection agency name that the charged-off loan was assigned to.

contactPhone
required
string

The third party debt collection agency primary phone that the charged-off loan was assigned to. Should be provided in E.164 format.

required
object

The mailing address.

contactEmail
string

The third party debt collection agency email address that the charged-off loan was assigned to.

Responses
200

Success

post/companies/{companyId}/collection-agencies
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "legalName": "string",
  • "contactPhone": "string",
  • "mailingAddress": {
    },
  • "contactEmail": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get collection agencies

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

query Parameters
includeArchived
boolean
Default: false

If set to true, includes archived objects

Responses
200

Success

get/companies/{companyId}/collection-agencies
Response samples
application/json
{
  • "status": 0,
  • "count": 0,
  • "data": [
    ]
}

Get collection agency by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

collectionAgencyId
required
string

The ID of the collection agency

Responses
200

Success

get/companies/{companyId}/collection-agencies/{collectionAgencyId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update collection agency

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

collectionAgencyId
required
string

The ID of the collection agency

Request Body schema: application/json
required
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
externalId
string or null [ 1 .. 50 ] characters

A lender's identifier for an object.

After the object is successfully created, a lender can use ID or externalId identifiers to fetch the object.

To fetch the object using externalId you need to add ext- to the URL.

Note: Don't add ext- to the identifier value. For example: if the external identifier is ABCDE, then pass externalId=ACBCE and NOT ext-ABCDE when creating the object.

legalName
string

The third party debt collection agency name that the charged-off loan was assigned to.

contactPhone
string

The third party debt collection agency primary phone that the charged-off loan was assigned to. Should be provided in E.164 format.

object (AddressBase)

The mailing address.

contactEmail
string

The third party debt collection agency email address that the charged-off loan was assigned to.

isArchived
boolean

Set to true if the debt collection agency no longer active. Loans that were assigned to that agency will keep the reference, but new loans cannot be assigned.

Responses
200

Success

put/companies/{companyId}/collection-agencies/{collectionAgencyId}
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "legalName": "string",
  • "contactPhone": "string",
  • "mailingAddress": {
    },
  • "contactEmail": "string",
  • "isArchived": true
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete collection agency

Sets isArchived = true on the agency

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

collectionAgencyId
required
string

The ID of the collection agency

Responses
204

Success no content

delete/companies/{companyId}/collection-agencies/{collectionAgencyId}
➔ Next to Errors