Venmo Request

A resource representing a request to vault Venmo.

Schema Information

Type:object

Properties

description

Type: string

Pattern: ^.*$

Min length: 1

Max length: 128

The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com.

usage_pattern

Type: string

Enum:

"IMMEDIATE", "DEFERRED", "RECURRING_PREPAID", "RECURRING_POSTPAID", "THRESHOLD_PREPAID", "THRESHOLD_POSTPAID", "UNSCHEDULED_POSTPAID", "UNSCHEDULED_PREPAID", "SUBSCRIPTION_PREPAID", "SUBSCRIPTION_POSTPAID", "INSTALLMENT_POSTPAID", "INSTALLMENT_PREPAID"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 30

Expected business/charge model for the billing agreement.

shipping

Type: object

The shipping details.

name

Type: object

The name of the party.

full_name

Type: string

Max length: 300

When the party is a person, the party's full name.

email_address

Type: string

Format: ppaas_common_email_address_v2

Pattern:

^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$

Min length: 3

Max length: 254

The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery.

phone_number

Type: object

The phone number, in its canonical international E.164 numbering plan format.

country_coderequired

Type: string

Pattern: ^[0-9]{1,3}?$

Min length: 1

Max length: 3

The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

national_numberrequired

Type: string

Pattern: ^[0-9]{1,14}?$

Min length: 1

Max length: 14

The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).

type

Type: string

Enum: "SHIPPING", "PICKUP_IN_PERSON", "PICKUP_IN_STORE", "PICKUP_FROM_PERSON"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either type or options may be present, but not both.

address

Type: object

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

address_line_1

Type: string

Max length: 300

The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.

address_line_2

Type: string

Max length: 300

The second line of the address, for example, a suite or apartment number.

admin_area_2

Type: string

Max length: 120

A city, town, or village. Smaller than admin_area_level_1.

admin_area_1

Type: string

Max length: 300

The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, CA and not California. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

postal_code

Type: string

Max length: 60

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

country_coderequired

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The 2-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

permit_multiple_payment_tokens

Type: boolean

Default: false

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.

usage_type

Type: string

Enum: "MERCHANT", "PLATFORM"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

The usage type associated with a digital wallet payment token.

customer_type

Type: string

Enum: "CONSUMER", "BUSINESS"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

The customer type associated with a digital wallet payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.

experience_context

Type: object

A resource representing an experience context of vault a venmo account.

brand_name

Type: string

Pattern: ^.*$

Min length: 1

Max length: 127

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.

shipping_preference

Type: string

Enum: "GET_FROM_FILE", "NO_SHIPPING", "SET_PROVIDED_ADDRESS"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Default: "GET_FROM_FILE"

The shipping preference. This only applies to PayPal payment source.

vault_instruction

Type: string

Enum: "ON_CREATE_PAYMENT_TOKENS", "ON_PAYER_APPROVAL"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

Default: "ON_CREATE_PAYMENT_TOKENS"

DEPRECATED. Vault Instruction on action to be performed after a successful payer approval.

user_action

Type: string

Enum: "SETUP_NOW", "CONTINUE"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

Default: "CONTINUE"

User Action on action to be performed after a successful payer approval.

Properties

description

Type: string

Pattern: ^.*$

Min length: 1

Max length: 128

The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com.

usage_pattern

Type: string

Enum:

"IMMEDIATE", "DEFERRED", "RECURRING_PREPAID", "RECURRING_POSTPAID", "THRESHOLD_PREPAID", "THRESHOLD_POSTPAID", "UNSCHEDULED_POSTPAID", "UNSCHEDULED_PREPAID", "SUBSCRIPTION_PREPAID", "SUBSCRIPTION_POSTPAID", "INSTALLMENT_POSTPAID", "INSTALLMENT_PREPAID"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 30

Expected business/charge model for the billing agreement.

shipping

Type: object

The shipping details.

name

Type: object

The name of the party.

full_name

Type: string

Max length: 300

When the party is a person, the party's full name.

email_address

Type: string

Format: ppaas_common_email_address_v2

Pattern:

^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$

Min length: 3

Max length: 254

The email address of the recipient of the shipped items, which may belong to either the payer, or an alternate contact, for delivery.

phone_number

Type: object

The phone number, in its canonical international E.164 numbering plan format.

country_coderequired

Type: string

Pattern: ^[0-9]{1,3}?$

Min length: 1

Max length: 3

national_numberrequired

Type: string

Pattern: ^[0-9]{1,14}?$

Min length: 1

Max length: 14

type

Type: string

Enum: "SHIPPING", "PICKUP_IN_PERSON", "PICKUP_IN_STORE", "PICKUP_FROM_PERSON"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either type or options may be present, but not both.

address

Type: object

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

address_line_1

Type: string

Max length: 300

The first line of the address, such as number and street, for example, 173 Drury Lane. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.

address_line_2

Type: string

Max length: 300

The second line of the address, for example, a suite or apartment number.

admin_area_2

Type: string

Max length: 120

A city, town, or village. Smaller than admin_area_level_1.

admin_area_1

Type: string

Max length: 300

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

postal_code

Type: string

Max length: 60

The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

country_coderequired

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The 2-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

permit_multiple_payment_tokens

Type: boolean

Default: false

usage_type

Type: string

Enum: "MERCHANT", "PLATFORM"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

The usage type associated with a digital wallet payment token.

customer_type

Type: string

Enum: "CONSUMER", "BUSINESS"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

The customer type associated with a digital wallet payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.

experience_context

Type: object

A resource representing an experience context of vault a venmo account.

brand_name

Type: string

Pattern: ^.*$

Min length: 1

Max length: 127

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.

shipping_preference

Type: string

Enum: "GET_FROM_FILE", "NO_SHIPPING", "SET_PROVIDED_ADDRESS"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 255

Default: "GET_FROM_FILE"

The shipping preference. This only applies to PayPal payment source.

vault_instruction

Type: string

Enum: "ON_CREATE_PAYMENT_TOKENS", "ON_PAYER_APPROVAL"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

Default: "ON_CREATE_PAYMENT_TOKENS"

DEPRECATED. Vault Instruction on action to be performed after a successful payer approval.

user_action

Type: string

Enum: "SETUP_NOW", "CONTINUE"

Pattern: ^[A-Z_]+$

Min length: 1

Max length: 255

Default: "CONTINUE"

User Action on action to be performed after a successful payer approval.

Venmo Request

Schema Information

Properties

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Venmo Request

Schema Information

Properties