GuidesAPI Reference
Log In
API Reference

/participants/{participant_id}/disbursements-info/

Get information about available disbursement options before creating one.

Query parameters can be used to get accurate available amounts for different disbursement types:

  • is_hardship: Calculate amounts for hardship disbursements
  • is_emergency: Calculate amounts for emergency expense disbursements
  • is_move_rollover: Calculate amounts for move rollover disbursements

All parameters default to false if not specified.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
boolean
Defaults to false

Whether to calculate available amounts for emergency expense disbursements.

boolean
Defaults to false

Whether to calculate available amounts for hardship disbursements.

boolean
Defaults to false

Whether to calculate available amounts for move rollover disbursements.

Responses

400

Bad Request: Unable to get participant info or invalid query parameters

401

Unauthorized: Missing or invalid authentication

403

Forbidden: Insufficient permissions or scopes

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json