PIpier-finance
Facilities

Create a limit reduction notice

Create a limit reduction notice, which should be presented to the user when their credit limit is reduced. This endpoint must be called before reducing the credit limit. The document_id returned should be stored and used in the PATCH /facilities/{facility_id}/update_limit endpoint.

post/facilities/{facility_id}/create_limit_reduction_notice

Request

  • Base URL
    https://production.pier-finance.com/api
  • Auth
    HTTP bearer

Path parameters

facility_idstring required

Request body

new_limit_amountinteger required

Amount of the new credit limit, in cents

reasonsLimitReductionReasons[] required

The reasons for the limit reduction

Example request

{
  "new_limit_amount": 100000
}

Response

document_urlstring required

The URL where the document can be accessed.

idstring required

The unique identifier for the document.

Example response

{
  "document_url": "https://example.com/document.pdf",
  "id": "doc_1234567890abcdef"
}

Changes

No recorded changes to this operation across all 1 revision of this API.