Synctera 'Wires (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
Cancel an outgoing wire — Cancel an outgoing tranfer
Like cancel_wire/3 but returns the value directly and raises on error.
Send a wire — Create an outgoing wire transfer
Like create_wire/2 but returns the value directly and raises on error.
Get a wire by id — Get a wire by id
Like get_wire/3 but returns the value directly and raises on error.
List wires — Get paginated list of wires
Like list_wires/2 but returns the value directly and raises on error.
Functions
@spec cancel_wire(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Cancel an outgoing wire — Cancel an outgoing tranfer
Options
:body— request body (map), required.:idempotency_key— seeSynctera.Idempotency.:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec cancel_wire!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like cancel_wire/3 but returns the value directly and raises on error.
@spec create_wire( Synctera.Client.t(), keyword() ) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Send a wire — Create an outgoing wire transfer
Options
:body— request body (map), required.:idempotency_key— seeSynctera.Idempotency.:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec create_wire!( Synctera.Client.t(), keyword() ) :: Synctera.JSON.json()
Like create_wire/2 but returns the value directly and raises on error.
@spec get_wire(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Get a wire by id — Get a wire by id
Options
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec get_wire!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like get_wire/3 but returns the value directly and raises on error.
@spec list_wires( Synctera.Client.t(), keyword() ) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
List wires — Get paginated list of wires
Options
Query options: :limit, :page_token, :status, :customer_id, :originating_account_id,
:receiving_account_id
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec list_wires!( Synctera.Client.t(), keyword() ) :: Synctera.JSON.json()
Like list_wires/2 but returns the value directly and raises on error.