VTEX · Schema

UserPaymentInfo

Structure with the order’s payment data. Required only if `invoiceData` is defined.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
paymentMethods	array	List of strings with the payment methods used in the order. Required only if `invoiceData` is defined. The format and some possible values of payment methods accepted in this list can be found in the

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserPaymentInfo",
  "title": "UserPaymentInfo",
  "description": "Structure with the order\u2019s payment data. Required only if `invoiceData` is defined.",
  "required": [
    "paymentMethods"
  ],
  "type": "object",
  "properties": {
    "paymentMethods": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of strings with the payment methods used in the order. Required only if `invoiceData` is defined. The format and some possible values of payment methods accepted in this list can be found in the call [Fetching marketplace information with the Orders API](https://developers.vtex.com/vtex-rest-api/docs/get-marketplace-data-orders-api).",
      "example": [
        "creditCardPaymentGroup"
      ]
    }
  },
  "example": {
    "paymentMethods": [
      "creditCardPaymentGroup"
    ]
  }
}