PaymentMethod

A Schema.org Type

Thing > Intangible > PaymentMethod

[more...]

Canonical URL: https://schema.org/PaymentMethod
Check for open issues.

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:

http://purl.org/goodrelations/v1#ByBankTransferInAdvance
http://purl.org/goodrelations/v1#ByInvoice
http://purl.org/goodrelations/v1#Cash
http://purl.org/goodrelations/v1#CheckInAdvance
http://purl.org/goodrelations/v1#COD
http://purl.org/goodrelations/v1#DirectDebit
http://purl.org/goodrelations/v1#GoogleCheckout
http://purl.org/goodrelations/v1#PayPal
http://purl.org/goodrelations/v1#PaySwarm

Structured values are recommended for newer payment methods.

Property	Expected Type	Description
Properties from PaymentMethod
`paymentMethodType`	PaymentMethodType	The type of a payment method.
Properties from Thing
`additionalType`	Text or URL	An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide.
`alternateName`	Text	An alias for the item.
`description`	Text or TextObject	A description of the item.
`disambiguatingDescription`	Text	A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
`identifier`	PropertyValue or Text or URL	The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.
`image`	ImageObject or URL	An image of the item. This can be a URL or a fully described ImageObject.
`mainEntityOfPage`	CreativeWork or URL	Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. Inverse property: mainEntity
`name`	Text	The name of the item.
`potentialAction`	Action	Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
`sameAs`	URL	URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
`subjectOf`	CreativeWork or Event	A CreativeWork or Event about this Thing. Inverse property: about
`url`	URL	URL of the item.

Instances of PaymentMethod may appear as a value for the following properties

Property	On Types	Description
acceptedPaymentMethod	Demand or Offer or Organization	The payment method(s) that are accepted in general by an organization, or for some specific demand or offer.
appliesToPaymentMethod	PaymentChargeSpecification	The payment method(s) to which the payment charge specification applies.
paymentMethod	Invoice or Order	The name of the credit card or other method of payment for the order.

More specific Types

Acknowledgements

GoodRelations Vocabulary Classes

This class is derived from the GoodRelations Vocabulary for E-Commerce, created by Martin Hepp. GoodRelations is a data model for sharing e-commerce data on the Web that can be expressed in a variety of syntaxes, including RDFa and HTML5 Microdata. More information about GoodRelations can be found at http://purl.org/goodrelations/.

Source

https://github.com/schemaorg/schemaorg/issues/3537

Examples

Example 1

No Markup JSON-LD Structure

Example notes or example HTML without markup.

Possible Payment: Cash On Delivery, SplashPay 🌊, SEPA bank transfer and prepayment in all Splash stores 🌊.

Example encoded as JSON-LD in a HTML script tag.

<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "OnlineStore",
  "name": "Example Online Store",
  "acceptedPaymentMethod": [
  {
    "@type": "PaymentMethod",
    "paymentMethodType": "https://schema.org/COD",
    "name": "Cash on Delivery"
  }, {
    "@type": "PaymentService",
    "name": "SplashPay",
    "description": "Pay using the SplashPay app."
  }, {
    "@type": "PaymentMethod",
    "paymentMethodType": "https://schema.org/ByBankTransferInAdvance",
    "name": "SEPA bank transfer",
    "description": "Bank transfer within the Single Euro Payments Area (SEPA)."
  }, {
    "@type": "PaymentService",
    "paymentMethodType": "https://schema.org/InStorePrepay",
    "provider": {
      "@type": "Organization",
      "name": "Splash Store",
      "description": "Pay your online purchases conveniently in any Splash Store."
    }
  }
  ]
}
</script>

Structured representation of the JSON-LD example.