SCRA

Operations

Delete line of credit loan terms SCRA

Request

Removes a single SCRA interest rate (interestType=AbsoluteScra) on a line of credit loan.

The specified rateId must refer to an active SCRA interest rate on the loan.

Security

oauth2(Required scopes: loan:paymentplan.scra.delete) or bearerAuth or apiKeyHeader

Path

personIdstring(AnyId)^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+$write-onlyrequired

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

loanIdstring(AnyId)^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+$write-onlyrequired

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

Query

rateIdstring(AnyId)^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+$write-onlyrequired

Unique identifier of the SCRA interest rate to update or delete.

sendNoticebooleandeprecated

Deprecated. This parameter is accepted for backwards compatibility but has no effect. Notices are always sent.

Default:true

caseIdstring(AnyId)^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+$write-only

The case object unique identifier.

DELETE

/people/{personId}/loans/{loanId}/loc-payment-plan-scra

curl -i -X DELETE \
  'https://sandboxapi.peach.finance/api/people/{personId}/loans/{loanId}/loc-payment-plan-scra?rateId=string&sendNotice=true&caseId=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses