Create a limit reduction notice

POST

/facilities/:facility_id/create_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.

Path parameters

facility_idstringRequired

Request

This endpoint expects an object.

new_limit_amountintegerRequired

Amount of the new credit limit, in cents

reasonslist of enumsRequired

The reasons for the limit reduction

Response

This endpoint returns an object.

document_urlstring

The URL where the document can be accessed.

idstring

The unique identifier for the document.

Errors

Built with

1	curl -X POST https://production.pier-finance.com/api/facilities/fac_18e5a3726b3943cda2635f40e1041ba4/create_limit_reduction_notice \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"new_limit_amount": 100000,
6	"reasons": [
7	"fraud_prevention"
8	]
9	}'

1	{
2	"document_url": "https://example.com/document.pdf",
3	"id": "doc_1234567890abcdef"
4	}