Worldpay.Partner.TerminalLease (Worldpay v1.0.0)

Worldpay Terminal Lease Notification API — equipment lease alerts.

Worldpay notifies partners when merchants request terminal equipment leases. Parse the incoming notification to action lease requests.

Summary

Types

lease_notification()

Functions

parse(body)

Parse a terminal lease notification.

Types

lease_notification()

@type lease_notification() :: %{
  merchant_id: String.t() | nil,
  terminal_model: String.t() | nil,
  quantity: non_neg_integer() | nil,
  lease_term: String.t() | nil,
  status: atom(),
  raw: map()
}

Functions

parse(body)

@spec parse(String.t() | %{required(String.t()) => term()}) ::
  {:ok, lease_notification()}

Parse a terminal lease notification.