Inttegro.Refunds.CreateRequest (inttegro v0.2.0)

Parameters for Create Request in the Refunds API.

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

Returns funds from a paid order to its original payment method.

Refunds are asynchronous financial records. Creating a refund validates the requested line items and amount, while the returned status describes processing progress. Look up the refund until it reaches a terminal state and reconcile it through balance transactions.

Summary

Types

t()

A validated create request request.

Functions

new!(attrs \\ %{})

Builds a Inttegro.Refunds.CreateRequest and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Refunds.CreateRequest{
  custom_data: %{optional(String.t()) => String.t()} | nil,
  line_items: [Inttegro.Refunds.CreateLineItemInput.t()],
  order_id: String.t(),
  reason: Inttegro.Refunds.Reason.t(),
  reason_details: String.t() | nil,
  reference: String.t() | nil,
  request_meta: Inttegro.Refunds.RequestMetaInput.t() | nil
}

A validated create request request.

Functions

new!(attrs \\ %{})

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

Builds a Inttegro.Refunds.CreateRequest and raises KeyError when a required field is missing.