Sumup.Checkout (Sumup v1.0.0)

A SumUp Checkout: the core online-payment primitive. Created with an amount/currency/reference, then processed with a payment method (card, token, or an alternative payment method such as iDEAL/Bancontact/Blik).

Summary

Types

next_step()

status()

t()

Types

next_step()

@type next_step() :: %{
  optional(:url) => String.t(),
  optional(:method) => String.t(),
  optional(:redirect_url) => String.t(),
  optional(:mechanism) => String.t(),
  optional(:payload) => map()
}

status()

@type status() :: :pending | :paid | :failed | :expired | :unknown

t()

@type t() :: %Sumup.Checkout{
  amount: Sumup.Money.Float.t(),
  checkout_reference: String.t(),
  customer_id: String.t() | nil,
  date: DateTime.t() | nil,
  description: String.t() | nil,
  hosted_checkout_url: String.t() | nil,
  id: String.t(),
  mandate: map() | nil,
  merchant_code: String.t() | nil,
  merchant_name: String.t() | nil,
  next_step: next_step() | nil,
  payment_instrument_token: String.t() | nil,
  raw: map(),
  redirect_url: String.t() | nil,
  return_url: String.t() | nil,
  status: status(),
  transaction_code: String.t() | nil,
  transaction_id: String.t() | nil,
  transactions: [map()],
  valid_until: DateTime.t() | nil
}