Synctera.RemoteCheckDepositBeta (Synctera v1.0.0)

Copy Markdown View Source

Synctera 'Remote Check Deposit (beta)' endpoints.

Code generated by scripts/generate.py from the Synctera OpenAPI spec. Do not edit by hand — re-run mix generate (or python3 scripts/generate.py) to regenerate.

Summary

Functions

Create a Remote Check Deposit — Create a new deposit using remote deposit capture to an account

Like create_rdc_deposit/2 but returns the value directly and raises on error.

Get Remote Check Deposit — Retrieves one deposit made using remote deposit capture associated with an account

Like get_rdc_deposit/3 but returns the value directly and raises on error.

List Remote Check Deposits — Retrieves a paginated list of the deposits made using remote deposit capture associated with an account

Like list_rdc_deposits/2 but returns the value directly and raises on error.

Functions

create_rdc_deposit(client, opts \\ [])

@spec create_rdc_deposit(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Create a Remote Check Deposit — Create a new deposit using remote deposit capture to an account

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

create_rdc_deposit!(client, opts)

@spec create_rdc_deposit!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like create_rdc_deposit/2 but returns the value directly and raises on error.

get_rdc_deposit(client, deposit_id, opts \\ [])

@spec get_rdc_deposit(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Get Remote Check Deposit — Retrieves one deposit made using remote deposit capture associated with an account

Options

  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

get_rdc_deposit!(client, deposit_id, opts)

@spec get_rdc_deposit!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like get_rdc_deposit/3 but returns the value directly and raises on error.

list_rdc_deposits(client, opts \\ [])

@spec list_rdc_deposits(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

List Remote Check Deposits — Retrieves a paginated list of the deposits made using remote deposit capture associated with an account

Options

Query options: :limit, :page_token

  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

list_rdc_deposits!(client, opts)

@spec list_rdc_deposits!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like list_rdc_deposits/2 but returns the value directly and raises on error.