PayPal · Schema

PayPal Wallet Experience Context

Customizes the payer experience during the approval process for payment with PayPal.

Note: Partners and Marketplaces might configure brand_name and shipping_preference during partner account setup, which overrides the request values.

BillingCommerceDisputesInvoicesOrderPaymentsPayoutsSubscriptionTokensWebhook

Properties

Name Type Description
brand_name string The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.
locale object The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, `da-DK`, `he-IL`, `id-ID`, `ja-JP`, `no-NO`, `pt-BR`, `ru-RU`, `sv-SE
shipping_preference string The location from which the shipping address is derived.
return_url object The URL where the customer will be redirected upon approving a payment.
cancel_url object The URL where the customer will be redirected upon cancelling the payment approval.
landing_page string The type of landing page to show on the PayPal site for customer checkout.
user_action string Configures a Continue or Pay Now checkout flow.
payment_method_preference string The merchant-preferred payment methods.
View JSON Schema on GitHub

JSON Schema

paypal-paypal-wallet-experience-context-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/paypal_wallet_experience_context",
  "title": "PayPal Wallet Experience Context",
  "type": "object",
  "description": "Customizes the payer experience during the approval process for payment with PayPal.<blockquote><strong>Note:</strong> Partners and Marketplaces might configure <code>brand_name</code> and <code>shipping_preference</code> during partner account setup, which overrides the request values.</blockquote>",
  "properties": {
    "brand_name": {
      "type": "string",
      "description": "The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.",
      "minLength": 1,
      "maxLength": 127,
      "pattern": "^.*$"
    },
    "locale": {
      "description": "The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, `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`.",
      "$ref": "#/components/schemas/language"
    },
    "shipping_preference": {
      "type": "string",
      "description": "The location from which the shipping address is derived.",
      "minLength": 1,
      "maxLength": 24,
      "pattern": "^[A-Z_]+$",
      "default": "GET_FROM_FILE",
      "enum": [
        "GET_FROM_FILE",
        "NO_SHIPPING",
        "SET_PROVIDED_ADDRESS"
      ]
    },
    "return_url": {
      "description": "The URL where the customer will be redirected upon approving a payment.",
      "format": "uri",
      "$ref": "#/components/schemas/url"
    },
    "cancel_url": {
      "description": "The URL where the customer will be redirected upon cancelling the payment approval.",
      "format": "uri",
      "$ref": "#/components/schemas/url"
    },
    "landing_page": {
      "type": "string",
      "description": "The type of landing page to show on the PayPal site for customer checkout.",
      "default": "NO_PREFERENCE",
      "minLength": 1,
      "maxLength": 13,
      "pattern": "^[0-9A-Z_]+$",
      "enum": [
        "LOGIN",
        "GUEST_CHECKOUT",
        "NO_PREFERENCE"
      ]
    },
    "user_action": {
      "type": "string",
      "description": "Configures a <strong>Continue</strong> or <strong>Pay Now</strong> checkout flow.",
      "default": "CONTINUE",
      "minLength": 1,
      "maxLength": 8,
      "pattern": "^[0-9A-Z_]+$",
      "enum": [
        "CONTINUE",
        "PAY_NOW"
      ]
    },
    "payment_method_preference": {
      "type": "string",
      "description": "The merchant-preferred payment methods.",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[0-9A-Z_]+$",
      "default": "UNRESTRICTED",
      "enum": [
        "UNRESTRICTED",
        "IMMEDIATE_PAYMENT_REQUIRED"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/paypal-paypal-wallet-experience-context"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.