PayPal · Schema

Venmo Wallet Response Object

Venmo wallet response.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
email_address object The email address of the payer.
account_id object This is an immutable system-generated id for a user's Venmo account.
user_name string The Venmo user name chosen by the user, also know as a Venmo handle.
name object The name associated with the Venmo account. Supports only the `given_name` and `surname` properties.
phone_number object The phone number associated with the Venmo account, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). Supports only the `national_number` property.
address object The address of the payer. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties. Also referred to as the billing address of
attributes object
View JSON Schema on GitHub

JSON Schema

paypal-venmo-wallet-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/venmo_wallet_response",
  "title": "Venmo Wallet Response Object",
  "type": "object",
  "description": "Venmo wallet response.",
  "properties": {
    "email_address": {
      "description": "The email address of the payer.",
      "$ref": "#/components/schemas/email"
    },
    "account_id": {
      "description": "This is an immutable system-generated id for a user's Venmo account.",
      "readOnly": true,
      "$ref": "#/components/schemas/account_id-2"
    },
    "user_name": {
      "description": "The Venmo user name chosen by the user, also know as a Venmo handle.",
      "type": "string",
      "pattern": "^[-a-zA-Z0-9_]*$",
      "minLength": 1,
      "maxLength": 50
    },
    "name": {
      "description": "The name associated with the Venmo account. Supports only the `given_name` and `surname` properties.",
      "$ref": "#/components/schemas/name-2"
    },
    "phone_number": {
      "description": "The phone number associated with the Venmo account, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). Supports only the `national_number` property.",
      "$ref": "#/components/schemas/phone-2"
    },
    "address": {
      "description": "The address of the payer. Supports only the `address_line_1`, `address_line_2`, `admin_area_1`, `admin_area_2`, `postal_code`, and `country_code` properties. Also referred to as the billing address of the customer.",
      "$ref": "#/components/schemas/address_portable-2"
    },
    "attributes": {
      "$ref": "#/components/schemas/venmo_wallet_attributes_response"
    }
  }
}