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

Create an account — Create a shadow mode or lead mode account. You need to determine the mode according to integrator configuration, and specify the required fields accordingly. Shadow mode required fields: - account_number - status Lead mode required fields: - account_template_id - relationships

Options

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

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

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

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

Create account relationship — Add a customer to an account

Options

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

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

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

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

Create an account product — Create an account product. Rates cannot be nil or empty.

Options

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

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

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

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

Create an account template — Create an account template. An account template is need when create an account in a lead mode

Options

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

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

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

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

Delete account relationship — Delete account relationship

Options

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

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

Like delete_account_relationship/4 but returns the value directly and raises on error.

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

Delete account template — Delete account template

Options

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

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

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

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

Get account — Get an account

Options

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

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

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

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

Get account relationship — Get account relationship by ID

Options

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

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

Like get_account_relationship/4 but returns the value directly and raises on error.

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

Get account template — Get an account template

Options

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

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

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

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

List account relationships — List all customers of an account

Options

Query options: :limit, :page_token

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

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

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

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

List account products — List account Products

Options

Query options: :limit, :page_token, :start_date, :end_date, :product_type

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

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

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

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

List account templates — List account templates

Options

Query options: :limit, :page_token

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

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

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

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

List accounts — Get paginated list of Accounts associated

Options

Query options: :id, :linked_account_id, :overdraft_account_id, :overflow_account_id, :account_number, :status, :interest_product_id, :customer_type, :customer_id, :business_id, :person_id, :first_name, :last_name, :limit, :page_token, :sort_by

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

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

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

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

Patch account — Patch account. Immutable fields: - account_number - account_type - account_template_id - customer_type Please note: - Other fields cannot be modified when access_status is FROZEN. - access_status has to be patched individually without other fields.

Options

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

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

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

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

Patch account product — Patch account product. Rates requires at minimum 1 entry if specified.

Options

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

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

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

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

Update account — Update account Shadow mode required fields: - account_number - status Lead mode required fields: - All fields are required. Please note: - access_status needs to be in ACTIVE. - PUT request cannot change access_status.

Options

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

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

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

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

Update account relationship — Update account relationship. Only relationship_type can be updated. customer_id should not be modified.

Options

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

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

Like update_account_relationship/4 but returns the value directly and raises on error.

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

Update account template — Update account template

Options

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

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

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