Inttegro.Payouts.SettingsMutation (inttegro v0.2.0)

Represents Settings Mutation data in the Payouts API.

Inttegro decodes API responses into this struct. Required fields are always present; optional fields are nil when they do not apply or were not returned. Follow the linked types in t/0 for nested domain values.

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()

The decoded settings mutation value.

Functions

new!(attrs \\ %{})

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

Types

t()

@type t() :: %Inttegro.Payouts.SettingsMutation{
  destinations: %{optional(String.t()) => String.t()} | nil,
  id: String.t() | nil,
  schedule: Inttegro.Payouts.SettingsMutationSchedule.t() | nil
}

The decoded settings mutation value.

Functions

new!(attrs \\ %{})

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

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