Inttegro.Refunds.Reason (inttegro v0.2.0)

Copy Markdown View Source

Values accepted for Reason in the Refunds 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.

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 reason atom or an unknown wire value preserved as a string.

Functions

Returns the documented Inttegro.Refunds.Reason atoms known by this SDK version.

Types

t()

@type t() ::
  :requested_by_customer
  | :duplicate
  | :fraudulent
  | :order_canceled
  | :item_returned
  | :item_damaged
  | :item_not_received
  | :item_not_as_described
  | :custom
  | String.t()

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

Functions

values()

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

Returns the documented Inttegro.Refunds.Reason atoms known by this SDK version.