PayPal · Schema

Vaulted PayPal Wallet Common Attributes

Resource consolidating common request and response attributes for vaulting PayPal Wallet.

PayPalBillingCommerceDisputesInvoicesOrderPaymentsPayoutsSubscriptionTokensWebhookAgentic CommercePayment Processing

Properties

Name Type Description
description string The description displayed to PayPal consumer on the approval flow for PayPal, as well as on the PayPal payment token management experience on PayPal.com.
usage_pattern string Expected business/pricing model for the billing agreement.
shipping object The shipping address for the Payer.
usage_type string The usage type associated with the PayPal payment token.
owner_id object
customer_type string The customer type associated with the PayPal payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.
permit_multiple_payment_tokens boolean Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be
View JSON Schema on GitHub

JSON Schema

paypal-vault-paypal-wallet-base-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/vault_paypal_wallet_base",
  "title": "Vaulted PayPal Wallet Common Attributes",
  "type": "object",
  "description": "Resource consolidating common request and response attributes for vaulting PayPal Wallet.",
  "allOf": [
    {
      "$ref": "#/components/schemas/vault_instruction_base"
    },
    {
      "properties": {
        "description": {
          "type": "string",
          "description": "The description displayed to PayPal consumer on the approval flow for PayPal, as well as on the PayPal payment token management experience on PayPal.com.",
          "minLength": 1,
          "maxLength": 128
        },
        "usage_pattern": {
          "type": "string",
          "description": "Expected business/pricing model for the billing agreement.",
          "minLength": 1,
          "maxLength": 30,
          "enum": [
            "IMMEDIATE",
            "DEFERRED",
            "RECURRING_PREPAID",
            "RECURRING_POSTPAID",
            "THRESHOLD_PREPAID",
            "THRESHOLD_POSTPAID"
          ]
        },
        "shipping": {
          "description": "The shipping address for the Payer.",
          "$ref": "#/components/schemas/shipping_detail"
        },
        "usage_type": {
          "type": "string",
          "description": "The usage type associated with the PayPal payment token.",
          "minLength": 1,
          "maxLength": 255,
          "pattern": "^[0-9A-Z_]+$",
          "enum": [
            "MERCHANT",
            "PLATFORM"
          ]
        },
        "owner_id": {
          "$ref": "#/components/schemas/vault_owner_id"
        },
        "customer_type": {
          "type": "string",
          "description": "The customer type associated with the PayPal payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.",
          "minLength": 1,
          "maxLength": 255,
          "pattern": "^[0-9A-Z_]+$",
          "default": "CONSUMER",
          "enum": [
            "CONSUMER",
            "BUSINESS"
          ]
        },
        "permit_multiple_payment_tokens": {
          "type": "boolean",
          "description": "Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.",
          "default": false
        }
      }
    }
  ],
  "required": [
    "usage_type"
  ]
}

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-vault-paypal-wallet-base"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.