Unit.API.CheckDeposits (Unit v1.0.0)

API module for Unit Check Deposits (Remote Deposit Capture).

Flow

Create a check deposit — status: AwaitingImages
Upload front image → status: AwaitingBackImage
Upload back image → status: Pending → Clearing → Sent

Images must be submitted as JPEG (preferred) or TIFF files.

Summary

Functions

create(params, opts \\ [])

Create a check deposit.

get(id, opts \\ [])

Get a check deposit by ID.

list(opts \\ [])

List check deposits.

update(id, params, opts \\ [])

Update a check deposit's tags.

upload_back(id, image_binary, mime_type \\ "image/jpeg", opts \\ [])

Upload the back image of a check.

upload_front(id, image_binary, mime_type \\ "image/jpeg", opts \\ [])

Upload the front image of a check (JPEG or TIFF binary).

Functions

create(params, opts \\ [])

@spec create(
  map(),
  keyword()
) :: {:ok, Unit.Resource.CheckDeposit.t()} | {:error, term()}

Create a check deposit.

Required params

:account_id
:amount — in cents
:description

get(id, opts \\ [])

@spec get(
  String.t(),
  keyword()
) :: {:ok, Unit.Resource.CheckDeposit.t()} | {:error, term()}

Get a check deposit by ID.

list(opts \\ [])

@spec list(keyword()) ::
  {:ok, [Unit.Resource.CheckDeposit.t()], map()} | {:error, term()}

List check deposits.

:account_id, :customer_id, :status
:since, :until

update(id, params, opts \\ [])

@spec update(String.t(), map(), keyword()) ::
  {:ok, Unit.Resource.CheckDeposit.t()} | {:error, term()}

Update a check deposit's tags.

upload_back(id, image_binary, mime_type \\ "image/jpeg", opts \\ [])

@spec upload_back(String.t(), binary(), String.t(), keyword()) ::
  {:ok, Unit.Resource.CheckDeposit.t()} | {:error, term()}

Upload the back image of a check.

upload_front(id, image_binary, mime_type \\ "image/jpeg", opts \\ [])

@spec upload_front(String.t(), binary(), String.t(), keyword()) ::
  {:ok, Unit.Resource.CheckDeposit.t()} | {:error, term()}

Upload the front image of a check (JPEG or TIFF binary).