Inttegro.Payouts.ScheduleRequest (inttegro v0.2.0)

Parameters for Schedule Request in the Payouts API.

Build this struct with new!/1 and pass it to the corresponding function on Inttegro.Payouts. Required keys are enforced immediately; optional values left as nil are omitted from the request sent to Inttegro.

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 validated schedule request request.

Functions

new!(attrs \\ %{})

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

Types

t()

@type t() :: %Inttegro.Payouts.ScheduleRequest{
  destination_id: String.t(),
  execute_after: String.t() | nil,
  max_amount: integer() | nil,
  reference: String.t()
}

A validated schedule request request.

Functions

new!(attrs \\ %{})

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

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