PayPal · Schema
Vaulted Venmo Wallet Common Attributes
Resource consolidating common request and response attirbutes for vaulting Venmo Wallet.
BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/vault_venmo_wallet_base",
"title": "Vaulted Venmo Wallet Common Attributes",
"type": "object",
"description": "Resource consolidating common request and response attirbutes for vaulting Venmo Wallet.",
"allOf": [
{
"$ref": "#/components/schemas/v3_vault_instruction_base"
},
{
"properties": {
"description": {
"type": "string",
"description": "The description displayed to Venmo consumer on the approval flow for Venmo, as well as on the Venmo payment token management experience on Venmo.com.",
"minLength": 1,
"maxLength": 128,
"pattern": "^[a-zA-Z0-9_'\\-., :;\\!?\"]*$"
},
"usage_pattern": {
"type": "string",
"description": "Expected business/pricing model for the billing agreement.",
"minLength": 1,
"maxLength": 30,
"pattern": "^[0-9A-Z_]+$",
"enum": [
"IMMEDIATE",
"DEFERRED",
"RECURRING_PREPAID",
"RECURRING_POSTPAID",
"THRESHOLD_PREPAID",
"THRESHOLD_POSTPAID"
]
},
"usage_type": {
"type": "string",
"description": "The usage type associated with the Venmo payment token.",
"minLength": 1,
"maxLength": 255,
"pattern": "^[0-9A-Z_]+$",
"enum": [
"MERCHANT",
"PLATFORM"
]
},
"customer_type": {
"type": "string",
"description": "The customer type associated with the Venmo 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 Venmo account.",
"default": false
}
}
}
],
"required": [
"usage_type"
]
}