Synctera.SandboxWipeAlpha (Synctera v1.0.0)

Copy Markdown View Source

Synctera 'Sandbox Wipe (alpha)' 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

wipe_workspace(client, opts \\ [])

Delete data — Delete the customer and account related data, leaving other configuration data intact. This enables use cases such as bulk data deletion between tests. Data associated with below resources will be deleted: - Accounts - Account applications - ACH - Businesses

wipe_workspace!(client, opts)

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

Functions

wipe_workspace(client, opts \\ [])

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

Delete data — Delete the customer and account related data, leaving other configuration data intact. This enables use cases such as bulk data deletion between tests. Data associated with below resources will be deleted: - Accounts - Account applications - ACH - Businesses

  • Cards - Card images - Cases - Customers - Disclosures - External Accounts - Internal Accounts - Payment schedules and history - Persons - RDC - Relationships - Transactions (including for Internal Accounts) - Verifications Data associated with below resources will be retained: - Account Templates - API Keys - Bank/Partner data - Card product - Disclosure document records - Egress config - Groups - PII contract with vault
  • Roles - Users - Webhooks

Options

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

wipe_workspace!(client, opts)

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

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