ExBankID.Cancel.Payload (ex_bank_id v0.2.2) View Source

Provides the struct used when requesting to cancel a pending authentication or signing

Link to this section Summary

Functions

Returns a Cancel Payload given a orderRef, Auth response struct or Sign response struct

Link to this section Functions

Specs

new(
  binary()
  | %ExBankID.Auth.Response{
      autoStartToken: term(),
      orderRef: term(),
      qrStartSecret: term(),
      qrStartToken: term()
    }
  | %ExBankID.Sign.Response{
      autoStartToken: term(),
      orderRef: term(),
      qrStartSecret: term(),
      qrStartToken: term()
    }
) :: {:error, String.t()} | %ExBankID.Cancel.Payload{orderRef: String.t()}

Returns a Cancel Payload given a orderRef, Auth response struct or Sign response struct

Examples

iex> ExBankID.Cancel.Payload.new("131daac9-16c6-4618-beb0-365768f37288")
%ExBankID.Cancel.Payload{orderRef: "131daac9-16c6-4618-beb0-365768f37288"}

iex> ExBankID.Cancel.Payload.new("Not-a-valid-UUID")
{:error, "OrderRef is not a valid UUID"}

iex> %ExBankID.Auth.Response{orderRef: "131daac9-16c6-4618-beb0-365768f37288"} |> ExBankID.Cancel.Payload.new()
%ExBankID.Cancel.Payload{orderRef: "131daac9-16c6-4618-beb0-365768f37288"}

iex> %ExBankID.Sign.Response{orderRef: "131daac9-16c6-4618-beb0-365768f37288"} |> ExBankID.Cancel.Payload.new()
%ExBankID.Cancel.Payload{orderRef: "131daac9-16c6-4618-beb0-365768f37288"}