Cheque deposit via the Image Cheque Clearing System (ICS).
ClearBank supports inbound cheque deposits by submitting a cheque image. The image must meet ICS quality standards.
Settlement
ICS cheques settle on Day 2 (next business day) for most cheques.
Summary
Functions
Submits a cheque image deposit.
Functions
@spec submit_deposit(ClearBank.Client.t(), map()) :: ClearBank.HTTP.result()
Submits a cheque image deposit.
Required params
:account_id- destination account UUID:amount- decimal string amount on the cheque:currency-"GBP":cheque_image_front- Base64-encoded front image (TIFF or PNG):cheque_image_back- Base64-encoded back image:micr_line- MICR line string from the bottom of the cheque
Optional params
:payee_name- name of the payee on the cheque:cheque_number- cheque serial number
Examples
{:ok, result} = ClearBank.Payments.Cheques.submit_deposit(client, %{
account_id: "acct-uuid",
amount: "500.00",
currency: "GBP",
cheque_image_front: Base.encode64(front_tiff),
cheque_image_back: Base.encode64(back_tiff),
micr_line: "000123|040004|12345678|"
})