Synctera.ACH (Synctera v1.0.0)

Copy Markdown View Source

Synctera 'ACH' 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

Send an ACH — Send an ACH

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

Get a sent ACH transaction — Get a single sent ACH transaction

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

List sent ACH transactions — List sent ACH transactions

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

Update a sent ACH transaction — Update a sent ACH transaction (either status or funds availability)

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

Functions

add_transaction_out(client, opts \\ [])

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

Send an ACH — Send an ACH

Options

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

add_transaction_out!(client, opts)

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

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

get_transaction_out(client, transaction_id, opts \\ [])

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

Get a sent ACH transaction — Get a single sent ACH transaction

Options

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

get_transaction_out!(client, transaction_id, opts)

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

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

list_transactions_out(client, opts \\ [])

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

List sent ACH transactions — List sent ACH transactions

Options

Query options: :limit, :page_token

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

list_transactions_out!(client, opts)

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

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

patch_transaction_out(client, transaction_id, opts \\ [])

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

Update a sent ACH transaction — Update a sent ACH transaction (either status or funds availability)

Options

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

patch_transaction_out!(client, transaction_id, opts)

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

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