Loan Tape Types

Allows configuration for which fields should be included for loans or payments tapes.

Create loan tape type

Creates a new loan tape type.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Request Body schema: application/json
tapeName
required
string

A friendly name for the tape.

shouldReportDrawsSeparately
boolean
Default: false

Indicates whether LOC Draws should be reported as separate rows in loan tape. LOC will always be reported on an aggregated level.

tapeOutputFormat
string
Default: "CSV"

The tape output format.

Value: "CSV"
moneyUnit
string
Default: "subUnit100"

If subUnit100, the amount fields in loan tapes will be in pennies. For example: 100 means $1.00 (one dollar).

If fullUnit, the amount fields in loan tapes will be in decimal format with 2 places after the decimal point. For example: 32.45 is thirty two dollars and forty five cents.

Enum: "fullUnit" "subUnit100"
fieldNameMappings
object

Mapping of fields from fields to field names used in the bank/investor's system.

For example: {"investorId": "investor_id", "isChargedOff": "loan_charged_off"}

reportDaysWhenChargedOff
number <integer> >= 10
Default: 180

Number of days to report a loan after it was changed to chargedOff.

reportDaysWhenPaidOff
number <integer> >= 10
Default: 10

Number of days to report a loan after it was changed to paidOff.

compressionType
string
Default: "gzip"

Compression type used for result file.

Enum: "noCompression" "gzip" "zip"
loanMetaDataFields
Array of strings
Default: []

A list of loan's metaData keys/values to be included in a specific tape. Loan's metaData attribute is comprised of key/value pairs in the form of a JSON dictionary. The loanMetaDataFields value must be provided if loanMetaData is included in the fields list. If the key cannot be found in the loan's metaData attribute, the tape will populate the column name (aka key) but will not populate the value (aka the value will be empty). If found, each column name will be the "key" + "LoanMetaData" and the value will be the "value". The search/look up of the loanMetaDataFields key in the loan's metaData attribute is case sensitive. Peach doesn't know what data is provided in the loan's metaData attribute and we don't check validity of the key/value pairs. It's lender/caller responsibility to make sure that the loan's metaData attribute has valid and formatted values.

required
Array of Loan Tape Fields (strings) or Array of Payment Tape Fields (strings)

A list of fields to be included in a specific tape. There are two tapeType available - loans and payments. When you choose a list of fields, make sure to include only the values corresponding to tapeType. For example: tapeType=loans cannot have an attribute paymentMethodType because that field is only relevant to tapeType=payments.

loanMetaData - is a special field. If included, the caller must provide the loanMetaDataFields attribute.

mainBorrowerIdentityValue - is the borrower's identity number such as SSN, ITIN, tax ID, FEIN, etc. This value is encrypted in Peach system. If you want to export that value in loan tapes, you must have encryptionMethod and publicKey set when you call "Create loan tape". In other words, loan tape must be encrypted in order to populate mainBorrowerIdentityValue.

tapeType
required
string

The loan tape type.

loans - the tape includes information about accounts (e.g. loans).

payments - the tape includes information about payments made by borrowers.

Enum: "loans" "payments"
Responses
200

Success

post/companies/{companyId}/loan-tape-types
Request samples
application/json
{
  • "tapeName": "string",
  • "shouldReportDrawsSeparately": false,
  • "tapeOutputFormat": "CSV",
  • "moneyUnit": "fullUnit",
  • "fieldNameMappings": { },
  • "reportDaysWhenChargedOff": 180,
  • "reportDaysWhenPaidOff": 10,
  • "compressionType": "noCompression",
  • "loanMetaDataFields": [ ],
  • "fields": [
    ],
  • "tapeType": "loans"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get loan tape types

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

query Parameters
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-tape-types
Response samples
application/json
{
  • "count": 0,
  • "data": [
    ]
}

Get loan tape type by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanTapeTypeId
required
string

The ID of the loan tape type

Responses
200

Success

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

Update loan tape type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanTapeTypeId
required
string

The ID of the loan tape type

Request Body schema: application/json
tapeName
string

A friendly name for the tape.

shouldReportDrawsSeparately
boolean
Default: false

Indicates whether LOC Draws should be reported as separate rows in loan tape. LOC will always be reported on an aggregated level.

tapeOutputFormat
string
Default: "CSV"

The tape output format.

Value: "CSV"
moneyUnit
string
Default: "subUnit100"

If subUnit100, the amount fields in loan tapes will be in pennies. For example: 100 means $1.00 (one dollar).

If fullUnit, the amount fields in loan tapes will be in decimal format with 2 places after the decimal point. For example: 32.45 is thirty two dollars and forty five cents.

Enum: "fullUnit" "subUnit100"
fieldNameMappings
object

Mapping of fields from fields to field names used in the bank/investor's system.

For example: {"investorId": "investor_id", "isChargedOff": "loan_charged_off"}

reportDaysWhenChargedOff
number <integer> >= 10
Default: 180

Number of days to report a loan after it was changed to chargedOff.

reportDaysWhenPaidOff
number <integer> >= 10
Default: 10

Number of days to report a loan after it was changed to paidOff.

compressionType
string
Default: "gzip"

Compression type used for result file.

Enum: "noCompression" "gzip" "zip"
loanMetaDataFields
Array of strings
Default: []

A list of loan's metaData keys/values to be included in a specific tape. Loan's metaData attribute is comprised of key/value pairs in the form of a JSON dictionary. The loanMetaDataFields value must be provided if loanMetaData is included in the fields list. If the key cannot be found in the loan's metaData attribute, the tape will populate the column name (aka key) but will not populate the value (aka the value will be empty). If found, each column name will be the "key" + "LoanMetaData" and the value will be the "value". The search/look up of the loanMetaDataFields key in the loan's metaData attribute is case sensitive. Peach doesn't know what data is provided in the loan's metaData attribute and we don't check validity of the key/value pairs. It's lender/caller responsibility to make sure that the loan's metaData attribute has valid and formatted values.

Array of Loan Tape Fields (strings) or Array of Payment Tape Fields (strings)

A list of fields to be included in a specific tape. There are two tapeType available - loans and payments. When you choose a list of fields, make sure to include only the values corresponding to tapeType. For example: tapeType=loans cannot have an attribute paymentMethodType because that field is only relevant to tapeType=payments.

loanMetaData - is a special field. If included, the caller must provide the loanMetaDataFields attribute.

mainBorrowerIdentityValue - is the borrower's identity number such as SSN, ITIN, tax ID, FEIN, etc. This value is encrypted in Peach system. If you want to export that value in loan tapes, you must have encryptionMethod and publicKey set when you call "Create loan tape". In other words, loan tape must be encrypted in order to populate mainBorrowerIdentityValue.

Responses
200

Success

put/companies/{companyId}/loan-tape-types/{loanTapeTypeId}
Request samples
application/json
{
  • "tapeName": "string",
  • "shouldReportDrawsSeparately": false,
  • "tapeOutputFormat": "CSV",
  • "moneyUnit": "fullUnit",
  • "fieldNameMappings": { },
  • "reportDaysWhenChargedOff": 180,
  • "reportDaysWhenPaidOff": 10,
  • "compressionType": "noCompression",
  • "loanMetaDataFields": [ ],
  • "fields": [
    ]
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete loan tape type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanTapeTypeId
required
string

The ID of the loan tape type

Responses
204

Success

delete/companies/{companyId}/loan-tape-types/{loanTapeTypeId}