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 Tapes

Allows investors to get different loan tapes delivered to different SFTP servers.

Create loan tape

Creates a new loan tape.

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>
investorId
string or null

The investor ID.

loanTapeTypeId
required
string

The loan tape type ID.

sftpAccessMethod
string
Default: "usernamePassword"

If usernamePassword, then sftpUsername and sftpPassword must be provided.

If keys, then sftpSSHPeachPrivateKey and sftpSSHPeachPublicKey will be created by peach.

Enum: "usernamePassword" "keys"
sftpHostname
required
string

The hostname for SFTP. Host name should not contain a scheme, so don't put sftp:// on the front. You may optionally specify a port like so: example.com:222. If no port is supplied a default of 22 will be used.

sftpUsername
string

The username for SFTP.

sftpPassword
string

The password for SFTP.

sftpCdDir
string or null

Change directory into this folder before performing the upload.

encryptionMethod
string or null

The encryption method that Peach system with use to encrypt the files.

Value: "GPG"
publicKey
string or null

The lender's public key to use to encrypt the files. A value must be passed if encryptionMethod is set.

customFileName
string or null

If provided, will override the default file name for new loan tape files created. Date and time placeholders may be used, along with the following placeholders:

  • {{loanTapeId}} the loan tape ID.
  • {{loanTapeTypeId}} the loan tape type ID.

For example, a value of loan_tape_{{loanTapeId}}_%m_%d_%Y.csv might look like loan_tape_TA-DJEK-CVDE_02_12_2022.csv when generated.

dateForCustomFileName
string or null
Default: "dateOfGeneration"

Controls the date value for the customFileName field. Options:

  • reportDate: Uses the reportDate of the loan tape record
  • dateOfGeneration: Uses the date when the loan tape record was generated
Enum: "reportDate" "dateOfGeneration"
Responses
200

Success

post/companies/{companyId}/loan-tapes
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "investorId": "string",
  • "loanTapeTypeId": "string",
  • "sftpAccessMethod": "usernamePassword",
  • "sftpHostname": "string",
  • "sftpUsername": "string",
  • "sftpPassword": "string",
  • "sftpCdDir": "string",
  • "encryptionMethod": "GPG",
  • "publicKey": "string",
  • "customFileName": "string",
  • "dateForCustomFileName": "reportDate"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get loan tapes

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

query Parameters
untokenize
boolean
Default: false

Untokenize any tokenized fields if the calling user has the applicable permission.

limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

startingAfter
string

Return results starting after the provided object identifier.

endingBefore
string

Return results ending before the provided object identifier.

Responses
200

Success

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

Get loan tape by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanTapeId
required
string

The ID of the loan tape

query Parameters
untokenize
boolean
Default: false

Untokenize any tokenized fields if the calling user has the applicable permission.

Responses
200

Success

get/companies/{companyId}/loan-tapes/{loanTapeId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update loan tape

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanTapeId
required
string

The ID of the loan tape

Request Body schema: application/json
required
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
investorId
string or null

The investor ID.

loanTapeTypeId
string

The loan tape type ID.

sftpAccessMethod
string
Default: "usernamePassword"

If usernamePassword, then sftpUsername and sftpPassword must be provided.

If keys, then sftpSSHPeachPrivateKey and sftpSSHPeachPublicKey will be created by peach.

Enum: "usernamePassword" "keys"
sftpHostname
string

The hostname for SFTP. Host name should not contain a scheme, so don't put sftp:// on the front. You may optionally specify a port like so: example.com:222. If no port is supplied a default of 22 will be used.

sftpUsername
string

The username for SFTP.

sftpPassword
string

The password for SFTP.

sftpCdDir
string or null

Change directory into this folder before performing the upload.

encryptionMethod
string or null

The encryption method that Peach system with use to encrypt the files.

Value: "GPG"
publicKey
string or null

The lender's public key to use to encrypt the files. A value must be passed if encryptionMethod is set.

customFileName
string or null

If provided, will override the default file name for new loan tape files created. Date and time placeholders may be used, along with the following placeholders:

  • {{loanTapeId}} the loan tape ID.
  • {{loanTapeTypeId}} the loan tape type ID.

For example, a value of loan_tape_{{loanTapeId}}_%m_%d_%Y.csv might look like loan_tape_TA-DJEK-CVDE_02_12_2022.csv when generated.

dateForCustomFileName
string or null
Default: "dateOfGeneration"

Controls the date value for the customFileName field. Options:

  • reportDate: Uses the reportDate of the loan tape record
  • dateOfGeneration: Uses the date when the loan tape record was generated
Enum: "reportDate" "dateOfGeneration"
Responses
200

Success

put/companies/{companyId}/loan-tapes/{loanTapeId}
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "investorId": "string",
  • "loanTapeTypeId": "string",
  • "sftpAccessMethod": "usernamePassword",
  • "sftpHostname": "string",
  • "sftpUsername": "string",
  • "sftpPassword": "string",
  • "sftpCdDir": "string",
  • "encryptionMethod": "GPG",
  • "publicKey": "string",
  • "customFileName": "string",
  • "dateForCustomFileName": "reportDate"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete loan tape

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanTapeId
required
string

The ID of the loan tape

Responses
204

Success

delete/companies/{companyId}/loan-tapes/{loanTapeId}
➔ Next to Merchants

Request sandbox access