Record a served garnishment, levy or child-support order once (Idempotency-Key; an issuer's reference is served once) and freeze what it reaches after the federal benefits found in the lookback

POST/accounts/{id}/garnishments

Path parameters

idstringRequired

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

amountintegerRequired

irs_levybooleanOptional

A levy served by the Internal Revenue Service: 21-day hold before surrender

issuerstringRequired

kindstringRequired

Garnishment, levy or child_support

notesstringOptional

protected_amountintegerRequired

State exemptions the operator established; federal benefit deposits in the lookback are found and added by the bank

received_atstring · dateRequired

A business date, YYYY-MM-DD

referencestringRequired

Returns

200 OK

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

benefit_credits_amountintegerRequired

Federal benefit payments found in the lookback

created_atstring · date-timeRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

held_amountintegerRequired

The legal hold: the order's amount, capped at what was available after the protected funds

hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

hold_untilstring · date or nullOptional

IRS levy: no remittance before the 21st day after service

idstringRequired

irs_levybooleanRequired

issuerstringRequired

kindstringRequired

lookback_fromstring · dateRequired

A business date, YYYY-MM-DD

lookback_tostring · dateRequired

A business date, YYYY-MM-DD

notesstringRequired

notice_channelstringOptional

notice_due_bystring · date or nullOptional

212.7: three business days after the account review

notice_referencestringOptional

notice_sent_onstring · date or nullOptional

A business date, YYYY-MM-DD

protected_amountintegerRequired

received_atstring · dateRequired

A business date, YYYY-MM-DD

referencestringRequired

remit_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

remitted_amountintegerRequired

reviewed_onstring · dateRequired

A business date, YYYY-MM-DD

statusstringRequired

Open, payable, released; remitted is a legacy internal-transfer status

updated_atstring · date-timeRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503