Retrieve payoff amounts for a facility

GET

/facilities/:facility_id/payoff_amounts

Retrieve a list of payoff amount/date pairs for a facility for the next 10 days

Path parameters

facility_idstringRequired

The facility_id of the facility you want to retrieve payoff amounts for

Response

This endpoint returns a list of objects.

amountinteger

The amount of the payoff, in cents (e.g. 1000 = $10.00)

datestring

The date the payoff is due (YYYY-MM-DD)

Errors

GET

1 curl https://production.pier-finance.com/api/facilities/fac_18e5a3726b3943cda2635f40e1041ba4/payoff_amounts \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 [
2   {
3     "amount": 504889,
4     "date": "2023-12-08"
5   },
6   {
7     "amount": 505112,
8     "date": "2023-12-09"
9   },
10   {
11     "amount": 505334,
12     "date": "2023-12-10"
13   },
14   {
15     "amount": 505556,
16     "date": "2023-12-11"
17   },
18   {
19     "amount": 505778,
20     "date": "2023-12-12"
21   },
22   {
23     "amount": 506001,
24     "date": "2023-12-13"
25   },
26   {
27     "amount": 506223,
28     "date": "2023-12-14"
29   },
30   {
31     "amount": 506445,
32     "date": "2023-12-15"
33   },
34   {
35     "amount": 506667,
36     "date": "2023-12-16"
37   },
38   {
39     "amount": 506866,
40     "date": "2023-12-17"
41   }
42 ]

Built with

1	curl https://production.pier-finance.com/api/facilities/fac_18e5a3726b3943cda2635f40e1041ba4/payoff_amounts \
2	-H "Authorization: Bearer <token>"

1	[
2	{
3	"amount": 504889,
4	"date": "2023-12-08"
5	},
6	{
7	"amount": 505112,
8	"date": "2023-12-09"
9	},
10	{
11	"amount": 505334,
12	"date": "2023-12-10"
13	},
14	{
15	"amount": 505556,
16	"date": "2023-12-11"
17	},
18	{
19	"amount": 505778,
20	"date": "2023-12-12"
21	},
22	{
23	"amount": 506001,
24	"date": "2023-12-13"
25	},
26	{
27	"amount": 506223,
28	"date": "2023-12-14"
29	},
30	{
31	"amount": 506445,
32	"date": "2023-12-15"
33	},
34	{
35	"amount": 506667,
36	"date": "2023-12-16"
37	},
38	{
39	"amount": 506866,
40	"date": "2023-12-17"
41	}
42	]