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
@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— seeSynctera.Idempotency.:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@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.
@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.
@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.
@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.
@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.
@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.
@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.
@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.
@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.