venmo_response

descriptionstringOptional

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.

Match^.*$Length1 <= length <= 128

usage_patternenum<usage_pattern>Optional

Expected business/charge model for the billing agreement.

Match^[0-9A-Z_]+$Length1 <= length <= 30

Allowed values

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

shippingobject<Shipping Details>Optional

The shipping details.

Shipping Details properties

5 properties

email_addressstring<email_address>Optional

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

Match^(?:[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])+)\])$Formatppaas_common_email_address_v2Length3 <= length <= 254

phone_numberobject<Phone>Optional

The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).

typeenumOptional

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.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"SHIPPING"
"PICKUP_IN_PERSON"
"PICKUP_IN_STORE"
"PICKUP_FROM_PERSON"

addressobject<Portable Postal Address (Medium-Grained)>Optional

The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).

permit_multiple_payment_tokensbooleanOptional

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.

Defaultfalse

email_addressstring<email>Optional

The email address of the payer.

Match(?:[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])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-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])+)\])Formatmerchant_common_email_address_v2Length3 <= length <= 254

phoneobject<phone_with_type>Optional

The phone number of the customer. Available only when you enable the **Contact Telephone Number** option in the **Profile & Settings** for the merchant's PayPal account. The `phone.phone_number` supports only `national_number`.

addressobject<Portable Postal Address (Medium-Grained)>Optional

descriptionstringOptional

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.

Match^.*$Length1 <= length <= 128

usage_patternenum<usage_pattern>Optional

Expected business/charge model for the billing agreement.

Match^[0-9A-Z_]+$Length1 <= length <= 30

Allowed values

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

shippingobject<Shipping Details>Optional

The shipping details.

Shipping Details properties

5 properties

email_addressstring<email_address>Optional

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

phone_numberobject<Phone>Optional

The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).

typeenumOptional

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.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"SHIPPING"
"PICKUP_IN_PERSON"
"PICKUP_IN_STORE"
"PICKUP_FROM_PERSON"

addressobject<Portable Postal Address (Medium-Grained)>Optional

permit_multiple_payment_tokensbooleanOptional

Defaultfalse

email_addressstring<email>Optional

The email address of the payer.

phoneobject<phone_with_type>Optional

addressobject<Portable Postal Address (Medium-Grained)>Optional

venmo_response

Shipping Details properties

Name properties

Phone properties

Portable Postal Address (Medium-Grained) properties

Name properties

phone_with_type properties

Phone properties

Portable Postal Address (Medium-Grained) properties

Back to top

On this page

On this page

venmo_response

Shipping Details properties

Name properties

Phone properties

Portable Postal Address (Medium-Grained) properties

Name properties

phone_with_type properties

Phone properties

Portable Postal Address (Medium-Grained) properties

Back to top

On this page

venmo_response

Shipping Details properties

Name properties

Phone properties

Portable Postal Address (Medium-Grained) properties

Name properties

phone_with_type properties

Phone properties

Portable Postal Address (Medium-Grained) properties

Back to top

On this page

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_response

Shipping Details properties

Name properties

Phone properties

Portable Postal Address (Medium-Grained) properties

Name properties

phone_with_type properties

Phone properties

Portable Postal Address (Medium-Grained) properties

Back to top

On this page