SEO.JSONLD.PaymentMethod (SEO v0.3.0-rc.0)

A payment method is a standardized procedure for transferring the monetary amount for a purchase. Payment methods are characterized by the legal and technical structures used, and by the organization or group carrying out the transaction. The following legacy values should be accepted:

Structured values, or UNCE payment means are recommended or for newer annotations.

Helper for building a Schema.org PaymentMethod JSON-LD structure.

Summary

Types

attrs()

t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "PaymentMethod", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

Build a PaymentMethod JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    optional(:payment_method_type) =>
      :by_bank_transfer_in_advance
      | :by_invoice
      | :cash
      | :check_in_advance
      | :cod
      | :direct_debit
      | :in_store_prepay
      | :phone_carrier_payment,
    optional(:additional_type) => String.t() | URI.t(),
    optional(:alternate_name) => String.t(),
    optional(:description) => SEO.JSONLD.TextObject.t() | map() | String.t(),
    optional(:disambiguating_description) => String.t(),
    optional(:identifier) =>
      String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
    optional(:image) =>
      URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
    optional(:main_entity_of_page) =>
      SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
    optional(:name) => String.t(),
    optional(:owner) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:potential_action) => SEO.JSONLD.Action.t() | map(),
    optional(:same_as) => URI.t() | String.t(),
    optional(:subject_of) =>
      SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
    optional(:url) => URI.t() | String.t()
  }
  | [
      payment_method_type:
        :by_bank_transfer_in_advance
        | :by_invoice
        | :cash
        | :check_in_advance
        | :cod
        | :direct_debit
        | :in_store_prepay
        | :phone_carrier_payment,
      additional_type: String.t() | URI.t(),
      alternate_name: String.t(),
      description: SEO.JSONLD.TextObject.t() | map() | String.t(),
      disambiguating_description: String.t(),
      identifier: String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
      image: URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
      main_entity_of_page:
        SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
      name: String.t(),
      owner: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      potential_action: SEO.JSONLD.Action.t() | map(),
      same_as: URI.t() | String.t(),
      subject_of: SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
      url: URI.t() | String.t()
    ]

t()

@type t() :: %{required(String.t()) => term()}

Functions

build(attrs)

@spec build(attrs()) :: t()

Build a PaymentMethod JSON-LD map.

Fields

:payment_method_type - The type of a payment method. One of: :by_bank_transfer_in_advance, :by_invoice, :cash, :check_in_advance, :cod, :direct_debit, :in_store_prepay, :phone_carrier_payment.

Inherited properties

Additional properties are available through the inheritance chain. See each ancestor's docs for its properties:

SEO.JSONLD.Thing