Retrieve a disbursement by its id | Pier

Request Sandbox Keys See a Demo

Overview
Guides
API Reference

Request Sandbox Keys See a Demo

API Reference Facilities

GET

/facilities/:facility_id/disbursements/:disbursement_id

GET

/api/facilities/:facility_id/disbursements/:disbursement_id

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

Try it

200Retrieved

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 }

Was this page helpful?

List disbursements for a facility

Built with

Retrieve a disbursement by its id

Authentication

AuthorizationBearer

Bearer authentication of the form `Bearer <token>`, where token is your auth token.

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.

idstring

The id of the disbursement

facility_idstring

amountinteger

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

statusenum

The status of the disbursement

created_ondatetime

Timestamp the disbursement object is created on

transfer_typeenum

The type of transfer that the disbursement was (ACH, ledger only, or special cases like refunds)

Allowed values:

failure_reasonstring or null

A reason for the failure if any exists

datestring or null

The date of the disbursement (YYYY-MM-DD)

Errors

Bearer authentication of the form Bearer <token>, where token is your auth token.

The disbursement_id of the disbursement you want to retrieve

The date of the disbursement (YYYY-MM-DD)

The facility_id of the facility you want to retrieve

1	curl 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	}