Web Profile

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/web_profile",
  "title": "Web Profile",
  "type": "object",
  "description": "A payment web experience profile.",
  "required": [
    "name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true,
      "minLength": 22,
      "maxLength": 22,
      "description": "The ID of the web experience profile."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 50,
      "description": "The web experience profile name. Must be unique for a set of profiles for a merchant."
    },
    "temporary": {
      "type": "boolean",
      "description": "Indicates whether the profile persists for three hours or permanently. To persist the profile permanently, set to `false`. To persist the profile for three hours, set to `true`."
    },
    "flow_config": {
      "type": "object",
      "title": "Flow Configuration",
      "description": "The flow configuration parameters.",
      "properties": {
        "landing_page_type": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255,
          "description": "The type of landing page to display on the PayPal site for user checkout. To use the non-PayPal account landing page, set to `Billing`. To use the PayPal account login landing page, set to `Login`.",
          "enum": [
            "login",
            "billing"
          ]
        },
        "bank_txn_pending_url": {
          "type": "string",
          "format": "uri",
          "minLength": 1,
          "maxLength": 127,
          "description": "The merchant site URL to display after a bank transfer payment. In Germany, valid only for the Giropay payment method or bank transfer payment method."
        },
        "user_action": {
          "type": "string",
          "description": "Presents either the **Continue** or **Pay Now** checkout flow to the customer.<br/><br/>Default is **Continue**, or `user_action=continue`. When you do not know the final payment amount, accept this default flow, which redirects the customer to the PayPal payment page with the **Continue** button. When the customer clicks **Continue**, the customer can change the payment amount.<br/><br/> When you know the final payment amount, set `user_action=commit` to choose the **Pay Now** flow, which redirects the customer to the PayPal payment page with the **Pay Now** button. When the customer clicks **Pay Now**, the payment is processed immediately.",
          "minLength": 1,
          "maxLength": 255,
          "enum": [
            "COMMIT"
          ]
        },
        "return_uri_http_method": {
          "type": "string",
          "description": "The HTTP method to use to redirect the customer to a return URL. Value is `GET` or `POST`.",
          "minLength": 1,
          "maxLength": 255,
          "enum": [
            "GET",
            "POST"
          ]
        }
      }
    },
    "input_fields": {
      "type": "object",
      "title": "Input Field Customization",
      "description": "The input field customization parameters.",
      "properties": {
        "no_shipping": {
          "type": "integer",
          "minimum": 0,
          "maximum": 2,
          "description": "Indicates whether PayPal displays shipping address fields on the experience pages. Value is:<ul><li><code>0</code>. Displays the shipping address on the PayPal pages.</li><li><code>1</code>. Redacts shipping address fields from the PayPal pages. For digital goods, this field is required and must be <code>1</code>.</li><li><code>2</code>. Gets the shipping address from the customer's account profile.</li></ul>"
        },
        "address_override": {
          "type": "integer",
          "minimum": 0,
          "maximum": 1,
          "description": "Indicates whether to display the shipping address that is passed to this call rather than the one on file for this buyer on the PayPal experience pages. Value is:<ul><li><code>0</code>. Displays the shipping address on file.</li><li><code>1</code>. Displays the shipping address specified in this call. the customer cannot edit this shipping address.</li></ul>"
        }
      }
    },
    "presentation": {
      "type": "object",
      "title": "Style and Presentation",
      "description": "The style and presentation parameters.",
      "properties": {
        "brand_name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 127,
          "description": "A label that overrides the business name in the PayPal account on the PayPal pages. Character length and limitations: 127 single-byte alphanumeric characters."
        },
        "logo_image": {
          "type": "string",
          "minLength": 1,
          "maxLength": 127,
          "description": "A URL to the logo image. A valid media type is `.gif`, `.jpg`, or `.png`. The image's maximum width is 190 pixels and maximum height is 60 pixels. PayPal crops images that are larger. PayPal places your logo image at the top of the cart review area. PayPal recommends that you store the image on a secure (HTTPS) server. Otherwise, web browsers display a message that checkout pages contain non-secure items. Character length and limitations: 127 single-byte alphanumeric characters."
        },
        "locale_code": {
          "type": "string",
          "minLength": 2,
          "maxLength": 5,
          "description": "The locale of pages that the PayPal payment experience displays. A valid value is `AU`, `AT`, `BE`, `BR`, `CA`, `CH`, `CN`, `DE`, `ES`, `GB`, `FR`, `IT`, `NL`, `PL`, `PT`, `RU`, or `US`. A 5-character code is also valid for languages in these countries: `da_DK`, `he_IL`, `id_ID`, `ja_JP`, `no_NO`, `pt_BR`, `ru_RU`, `sv_SE`, `th_TH`, `zh_CN`, `zh_HK`, or `zh_TW`."
        }
      }
    }
  }
}