Post the operator's settlement of a cash letter the bank sent

POST/rails/check/cash-letters/{id}/settle

Path parameters

idstringRequired

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.

200 OK

business_datestring · dateRequired

A business date, YYYY-MM-DD

created_atstring · date-timeRequired

directionstringRequired

Outbound or inbound

idstringRequired

item_countintegerRequired

kindstringRequired

Forward or return

rail_refstringOptional

settlement_datestring · dateOptional

A business date, YYYY-MM-DD

statusstringRequired

Built, sent, send_failed, settled, received

total_amountintegerRequired

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

400401403404409412413422424429500503