Inttegro.Payouts.Status (inttegro v0.2.0)

Copy Markdown View Source

Values accepted for Status in the Payouts 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.

Schedules and manages transfers from an application balance.

Payout creation is asynchronous. The returned payout records its current state but does not by itself prove that the destination received funds. Use lookup and balance transactions for reconciliation, and reuse an idempotency key when retrying the same logical payout.

Summary

Types

t()

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

Functions

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

Types

t()

@type t() ::
  :initialized
  | :scheduled
  | :processing
  | :executing
  | :succeeded
  | :invalid
  | :canceled
  | String.t()

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

Functions

values()

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

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