VTEX · Schema

PaymentMethodRequest

Object containing information about the payment method.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
paymentAccountId string Data about shoppers' profiles and documents. For example, their credit card number. To obtain that information, use the endpoint [Get client profile by email](https://developers.vtex.com/docs/api-refe
paymentSystem string Payment system's ID.
installments integer Number of payment installments.
View JSON Schema on GitHub

JSON Schema

vtex-paymentmethodthinrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentMethodThinRequest",
  "title": "PaymentMethodRequest",
  "description": "Object containing information about the payment method.",
  "required": [
    "paymentSystem"
  ],
  "type": "object",
  "properties": {
    "paymentAccountId": {
      "type": "string",
      "nullable": true,
      "description": "Data about shoppers' profiles and documents. For example, their credit card number. To obtain that information, use the endpoint [Get client profile by email](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pub/profiles).",
      "example": "340357032569595"
    },
    "paymentSystem": {
      "type": "string",
      "description": "Payment system's ID.",
      "nullable": true,
      "example": "4"
    },
    "installments": {
      "type": "integer",
      "format": "int32",
      "description": "Number of payment installments.",
      "nullable": true,
      "example": 3
    }
  },
  "additionalProperties": false
}