Inttegro.Payments.Status (inttegro v0.2.0)

Copy Markdown View Source

Values accepted for Status in the Payments API.

Prefer the documented atoms returned by values/0. The type also accepts strings so a newer server value can be preserved by an older SDK instead of failing during decoding.

Payment state, attempts, confirmations, and next actions attached to orders.

Summary

Types

t()

A status atom or an unknown wire value preserved as a string.

Functions

Returns the documented Inttegro.Payments.Status atoms known by this SDK version.

Types

t()

@type t() ::
  :initiated
  | :requires_action
  | :overdue
  | :executed
  | :paid
  | :canceled
  | :expired
  | :failed
  | :unknown
  | String.t()

A status atom or an unknown wire value preserved as a string.

Functions

values()

@spec values() :: [t()]

Returns the documented Inttegro.Payments.Status atoms known by this SDK version.