Verifone · Schema

Model17

Model17 from PayPal eComm API

PaymentsPOSTerminal ManagementeCommerceFinTechPayment ProcessingOmnichannel

Properties

Name	Type	Description
tokenId	string	The state of the agreement.
status	string	The description of the agreement.
description	string	The description of the agreement.
collectShippingAddress	boolean	Indicates whether to skip the collection of the shipping address from the customer during the agreement sign-up phase.
enableAddressChange	boolean	Indicates whether to show the shipping address but prevent the customer from editing it.
payerInfo	object
redirectUrls	object
experienceId	string	The ID of the experience profile to apply during the agreement approval UI flow.
externalSelectedFundingInstrumentType	string	The type of financial instrument (FI) that the merchant wants to promote.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/json-schema/paypal-ecommerce-api-model17.json",
  "title": "Model17",
  "description": "Model17 from PayPal eComm API",
  "required": [
    "tokenId"
  ],
  "type": "object",
  "properties": {
    "tokenId": {
      "type": "string",
      "description": "The state of the agreement."
    },
    "status": {
      "type": "string",
      "description": "The description of the agreement."
    },
    "description": {
      "type": "string",
      "description": "The description of the agreement."
    },
    "collectShippingAddress": {
      "type": "boolean",
      "description": "Indicates whether to skip the collection of the shipping address from the customer during the agreement sign-up phase."
    },
    "enableAddressChange": {
      "type": "boolean",
      "description": "Indicates whether to show the shipping address but prevent the customer from editing it."
    },
    "payerInfo": {
      "$ref": "#/components/schemas/payerInfo"
    },
    "redirectUrls": {
      "$ref": "#/components/schemas/redirectUrls"
    },
    "experienceId": {
      "type": "string",
      "description": "The ID of the experience profile to apply during the agreement approval UI flow."
    },
    "externalSelectedFundingInstrumentType": {
      "type": "string",
      "description": "The type of financial instrument (FI) that the merchant wants to promote.",
      "enum": [
        "CREDIT",
        "PAY_UPON_INVOICE"
      ]
    }
  }
}