List cash letters sent and received

GET/rails/check/cash-letters

Query parameters

limitintegerOptional

Page size

Default 10. Maximum 100.

starting_afterstringOptional

The id of the last item seen; returns the page after it

ending_beforestringOptional

The id of the first item seen; returns the page before it

directionstringOptional

kindstringOptional

statusstringOptional

200 OK

dataarray of objectsRequired

10 child attributes

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

has_morebooleanRequired

Whether another page follows

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

400401403404409412413422424429500503