Inttegro.Payouts.Payout (inttegro v0.2.0)

An asynchronous transfer from an application balance to configured destinations.

The current status is a processing snapshot, not a bank receipt. Terminal failures include structured error information; successful payouts are reflected in balance transactions.

Summary

Types

t()

The decoded payout value.

Functions

new!(attrs \\ %{})

Builds a Inttegro.Payouts.Payout and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Payouts.Payout{
  amount: Inttegro.Money.Amount.t() | nil,
  balance_transactions: [String.t()] | nil,
  canceled_at: String.t() | nil,
  custom_data: %{optional(String.t()) => String.t()} | nil,
  destination_id: String.t(),
  error: Inttegro.Payouts.Error.t() | nil,
  execute_after: String.t(),
  executed_by: String.t() | nil,
  expected_at: String.t() | nil,
  failed_at: String.t() | nil,
  id: String.t(),
  initiated_at: String.t(),
  initiated_by: String.t() | nil,
  max_amount: Inttegro.Money.Amount.t(),
  reference: String.t() | nil,
  schedule_id: String.t() | nil,
  scheduled_at: String.t() | nil,
  scheduled_by: String.t() | nil,
  sent_at: String.t() | nil,
  source_id: String.t() | nil,
  status: Inttegro.Payouts.Status.t(),
  succeeded_at: String.t() | nil
}

The decoded payout value.

Functions

new!(attrs \\ %{})

@spec new!(map() | keyword()) :: t()

Builds a Inttegro.Payouts.Payout and raises KeyError when a required field is missing.