Line of Credit Purchases

A lender's identifier for a resource.

After the resource is successfully created, a lender can use the Peach assigned ID OR the externalId identifiers to fetch the resource.

Fetching with externalId:

To fetch a resource using an externalId, you MUST use the prefix ext- in the URL.

For example, a loan with an external identifier of ABCDE would be referenced like /api/people/BO-FAKE-IDNT/loans/ext-ABCDE.

Creating with externalId:

To create a resource with an external identifer, you MUST NOT use the prefix ext-.

For example, if the external identifier should be ABCDE, then pass { externalId: "ACBCE", ... } in the request body.

The unique identifier of the draw that the purchase belongs to.

The unique identifier of the line of credit that the purchase belongs to.

Peach’s unique (or lender’s external identifier) for the authorization purchase. This attribute is used to reference an initial authorization, so lenders know which captures (purchase object(s) in Peach) are related to the original authorization.

• regular - a regular purchase made by the borrower. Increases draw's balance.
• refund - a refund of the purchase made in the past. Decreases draw's balance.
• cashBack - cash back given to the borrower by the issuing institution.

• authorized - the purchase is authorized and not yet settled. Authorized purchases are included in openToBuy, utilizationAmount, and availableCredit calculations; however, authorizations are not written to the ledger and are not included in total outstanding loan balances.
• settled - the purchase was settled.
• pending - the purchase is pending. pending purchases increases the draw balance similar to settled. Pending status is used mainly for visuals and normally shown in Borrower Portal and on statements.
• canceled - the purchase was canceled. canceled purchases reduce the draw balance. A new purchase cannot be created in canceled status.
• declined - the purchase was declined. declined purchases reduce the draw balance if the status changes from pending to declined. A new purchase can be created in declinedstatus for record purposes (it will not impact the draw balance).
• disputed - The purchase was disputed for full or partial amount. disputed status is a terminal state and once set cannot be changed to another status. This status can not be set manually. Submitting a purchase dispute will set the purchase's status to disputed.

The amount of the purchase. The amount can be updated only if the purchase status is pending or authorized. The amount and status of a purchase may be changed on the same call.

This value is equal to the date part of the authorizedAt converted to the product timezone (e.g. Eastern or Pacific). If authorizedAt is null, this value is equal to the date part of the purchase's createdAt converted to the product timezone.

This attribute is deprecated on purchase creation and will not be used by the system.

The details of purchase.

The details of how a refund was applied:

• The system will first deplete any non-due principal. This amount will be stored as refundNonDuePrincipalAmount.
• If any refund amount is left to apply, the system will create a transaction of type serviceCredit and serviceCreditType=refund. This transaction will be applied on the Draw level first and any leftover amount will be applied on the LOC level (based on the loan type waterfall configuration for payments). This amount will be stored as refundTransactionAmount.
• Any unapplied refund amount will be recorded as credit to the borrower (also called reimbursementAmount.)

Peach's unique or lender's external identifier.

The reason the purchase was declined

Store any type of key/value pairs in the form of a JSON dictionary.

The amount of the purchase.

The effective timestamp when the purchase was applied in the ledger. When a new purchase is created, the effectiveAt is equal to createdAt. Changing the effectiveAt will trigger a replay of the line of credit. Keep in mind that an existing statement might've included the purchase based on the existing effectiveAt value and the interest was accrued based on the existing effectiveAt. You might want/need to regenerate the statement. effectiveAt can be updated only if the purchase is in settled or pending status.

The timezone is UTC for this timestamp and the format is ISO. For example, in order to set a purchase effectiveAt to July 28th 2022, 10:44 am PDT, send 2022-07-28T17:44:00Z

The lender's identifier for the purchase.

Peach's unique or lender's external identifier. Typically used for purchases of type refund which allows the lender to reference the original purchase being refunded. For authorizations, please see authorizationPurchaseId attribute.

Peach’s unique or lender’s external identifier for the authorization purchase. This attribute is used to reference an initial authorization, so lenders know which captures (purchase object(s) in Peach) are related to the original authorization.

The details of purchase.

The reason the purchase was declined

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.

Peach identifier of the case. The case object contains more details about the dispute, e.g. evidence information such as supporting documents.

The status of the dispute. unsubmitted is the only valid status for a new purchase dispute.

unsubmitted - The dispute is pending submission to a processor/network.

submitted - The dispute has been submitted to a processor/network.

expired - The dispute has expired.

won - The dispute is won.

lost - The dispute is lost.

canceled - The dispute was canceled. Only unsubmitted disputes can be canceled.

The disputed amount. Can be less than the original purchase amount. Sum of disputed amounts cannot exceed the original purchase amounts (regardless of disputes outcomes).

The identifier of the reposted purchase. When a borrower loses a dispute, the lender normally creates a new purchase in the amount of the dispute.

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.

Peach identifier of the case. The case object contains more details about the dispute, e.g. evidence information such as supporting documents.

The status of the dispute. unsubmitted is the only valid status for a new purchase dispute.

unsubmitted - The dispute is pending submission to a processor/network.

submitted - The dispute has been submitted to a processor/network.

expired - The dispute has expired.

won - The dispute is won.

lost - The dispute is lost.

canceled - The dispute was canceled. Only unsubmitted disputes can be canceled.

The disputed amount. Can be less than the original purchase amount. Sum of disputed amounts cannot exceed the original purchase amounts (regardless of disputes outcomes).