/participants/{participant_id}/disbursements/{disbursement_id}/

put

https://sandbox.401go.com/api/participants/{participant_id}/disbursements/{disbursement_id}/

Update a specific disbursement request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

disbursement_id

string

required

participant_id

string

required

Body Params

Convert chosen empty strings into None during serialization. Specify with the empty_to_null_fields Meta attribute.

reason

string

enum

required

The reason for the disbursement request.

pretax_amount

string

^-?\d{0,8}(?:\.\d{0,2})?$

Pre-tax amount to disburse.

posttax_amount

string

^-?\d{0,8}(?:\.\d{0,2})?$

Post-tax amount to disburse.

pretax_memo

string

length ≤ 20

Payment memo for pre-tax disbursement (max 20 characters). Required when pretax_amount is provided.

posttax_memo

string

length ≤ 20

Payment memo for post-tax disbursement (max 20 characters). Required when posttax_amount is provided.

posttax_payment_method

string

enum

Payment method for post-tax portion (if different from pre-tax). Only used in split disbursements when different from payment_method.

Allowed:

posttax_bank_name

string

Bank name for post-tax portion. Only used in split disbursements when different from payment_method.

posttax_bank_routing_aba_number

string

Routing number for post-tax portion. Only used in split disbursements when different from payment_method. Not necessary for Check Payments.

posttax_bank_account_number

string

Account number for post-tax portion. Only used in split disbursements when different from payment_method. Not necessary for Check Payments.

posttax_name_on_bank_account

string

Account holder for post-tax portion. Only used in split disbursements when different from payment_method. Not necessary for Check Payments.

payment_method

string

enum

required

The payment method to use (e.g., Check, ACH, Wire). For single disbursements, use this field regardless of tax type. For split disbursements, this applies to the pre-tax portion.

Allowed:

hardship_proof_document

string

Base64-encoded proof document required for hardship disbursements and death disbursements.

hardship_signature

string

Base64-encoded signature image for hardship disbursements. Recommended dimensions: 500px width x 150px height (10:3 aspect ratio) to match the final document format.

is_rollover

boolean

Defaults to false

Set to true if this is a rollover to a new provider.

payment_address

object

A participant's Address

posttax_payment_address

object

A participant's Address

bank_name

string

Name of the bank for ACH/Wire payments (used for pre-tax portion in splits). For single disbursements, use this field regardless of tax type. For split disbursements, this applies to the pre-tax portion

bank_routing_aba_number

string

Routing (ABA) number for the bank account. For single disbursements, use this field regardless of tax type. For split disbursements, this applies to the pre-tax portion. Not necessary for Check Payments.

bank_account_number

string

Bank account number for payment. For single disbursements, use this field regardless of tax type. For split disbursements, this applies to the pre-tax portion. Not necessary for Check Payments.

name_on_bank_account

string

Name of the account holder for the bank account. For single disbursements, use this field regardless of tax type. For split disbursements, this applies to the pre-tax portion. Not necessary for Check Payments.

federal_withholding_percent

string

^-?\d{0,3}(?:\.\d{0,2})?$

Federal tax withholding percent (required for Hardship and RMD disbursements). Enter as percentage (e.g., 10.0 for 10%)

hardship

string

enum

Specific hardship reason (required for hardship disbursements).

Allowed:

name

string

required

length ≥ 1

The participant's name

dob

date

required

The participant's date of birth

married

boolean

required

The participant's marital status

phone

string

required

length ≥ 1

The participant's phone number

address

object

required

A participant's Address

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad Request: Invalid disbursement data

401

Unauthorized: Missing or invalid authentication

403

Forbidden: Insufficient permissions or scopes

200