Facilities

Retrieve a disbursement by its id

GET
Retrieve a disbursement by its id

Path parameters

facility_idstringRequired

The facility_id of the facility you want to retrieve

disbursement_idstringRequired

The disbursement_id of the disbursement you want to retrieve

Response

This endpoint returns an object
id
string
The id of the disbursement
facility_id
string
amount
integer
The amount of the disbursement, in cents (e.g. 1000 = $10.00)
status
enum
The status of the disbursement
Allowed values: pendingprocessingsettledfailedcancelled
created_on
datetime
Timestamp the disbursement object is created on
transfer_type
enum
The type of transfer to use for the disbursement
Allowed values: standardnext_daysame_daynone
failure_reason
stringOptional
A reason for the failure if any exists
date
stringOptional
The date of the disbursement (YYYY-MM-DD)

Errors

GET
1curl https://production.pier-finance.com/api/facilities/fac_18e5a3726b3943cda2635f40e1041ba4/disbursements/dsb_18e5a3726b3943cda2635f40e1041ba4 \
2 -H "Authorization: Bearer <token>"
1{
2 "id": "dsb_18e5a3726b3943cda2635f40e1041ba4",
3 "facility_id": "fac_18e5a3726b3943cda2635f40e1041ba4",
4 "amount": 100000,
5 "status": "pending",
6 "created_on": "2023-02-27T00:00:00Z",
7 "transfer_type": "standard",
8 "failure_reason": null,
9 "date": "2023-02-27"
10}