Synctera.Transactions (Synctera v1.0.0)

Copy Markdown View Source

Synctera 'Transactions' 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 an internal transfer — Create an internal transfer

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

Get a pending transaction — Get a pending transaction by its uuid

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

Get a posted transaction — Get a posted transaction by its uuid

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

List pending transactions — Get paginated list of pending transactions matching the provided filters

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

List posted transactions — Get paginated list of posted transactions matching the provided filters

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

Functions

create_internal_transfer(client, opts \\ [])

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

Create an internal transfer — Create an internal transfer

Options

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

create_internal_transfer!(client, opts)

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

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

get_pending_transaction_by_id(client, id, opts \\ [])

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

Get a pending transaction — Get a pending transaction by its uuid

Options

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

get_pending_transaction_by_id!(client, id, opts)

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

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

get_posted_transaction_by_id(client, id, opts \\ [])

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

Get a posted transaction — Get a posted transaction by its uuid

Options

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

get_posted_transaction_by_id!(client, id, opts)

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

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

list_pending_transactions(client, opts \\ [])

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

List pending transactions — Get paginated list of pending transactions matching the provided filters

Options

Query options: :account_no, :account_id, :from_date, :to_date, :status, :transaction_id, :type, :subtype, :limit, :page_token

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

list_pending_transactions!(client, opts)

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

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

list_posted_transactions(client, opts \\ [])

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

List posted transactions — Get paginated list of posted transactions matching the provided filters

Options

Query options: :account_no, :account_id, :from_date, :to_date, :type, :subtype, :limit, :page_token

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

list_posted_transactions!(client, opts)

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

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