Skip to content

Latest commit

 

History

History
144 lines (86 loc) · 2.98 KB

paymentitem.schema.md

File metadata and controls

144 lines (86 loc) · 2.98 KB
Raw

Payment Item Schema

https://ns.adobe.com/xdm/data/paymentitem

A payment associated with an order that defines the type of payment, the amount and the associated currency.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental No Forbidden Permitted data/paymentitem.schema.json

Payment Item Example

{
  "xdm:transactionID": "transactid-a12345",
  "xdm:paymentAmount": 333.99,
  "xdm:paymentType": "credit_card",
  "xdm:currencyCode": "USD"
}

Payment Item Properties

Property Type Required Defined by
xdm:currencyCode string Optional Payment Item (this schema)
xdm:paymentAmount number Optional Payment Item (this schema)
xdm:paymentType string Optional Payment Item (this schema)
xdm:transactionID string Optional Payment Item (this schema)
* any Additional this schema allows additional properties

xdm:currencyCode

Currency Code

The ISO 4217 currency code used for this payment item.

xdm:currencyCode

  • is optional
  • type: string
  • defined in this schema

xdm:currencyCode Type

string

All instances must conform to this regular expression

^[A-Z]{3}$
  • test example: USD
  • test example: EUR

xdm:currencyCode Examples

"USD"
"EUR"

xdm:paymentAmount

Payment Amount

The value of the payment.

xdm:paymentAmount

  • is optional
  • type: number
  • defined in this schema

xdm:paymentAmount Type

number

xdm:paymentType

Payment Type

The method of payment for this order. Enumerated, custom values allowed.

xdm:paymentType

  • is optional
  • type: string
  • defined in this schema

xdm:paymentType Type

string

xdm:paymentType Known Values

Value Description
cash Cash
credit_card Credit Card
debit_card Debit Card
gift_card Gift Card
check Check
paypal PayPal
wire_transfer Wire Transfer
credit_card_reference Credit Card Reference Transaction
other Other

xdm:transactionID

Transaction ID

The unique transaction identifier for this payment item.

xdm:transactionID

  • is optional
  • type: string
  • defined in this schema

xdm:transactionID Type

string