Corgi BankDocumentation
OpenAPI

Read a cash letter

GET/rails/check/cash-letters/{id}

Path parameters

idstringRequired

Returns

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

Errors

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

400401403404409412413422424429500503

to move to open esc to close