Business Platforms and marketplacesPlatforms Enterprise

Business Platforms and marketplaces Enterprise

Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

On this page

Resources

GitHub repo

Postman repo

PayPal.com

llms.txt

Where to find us

Developer blog

Community

Help Center

Sign up for updates

Where to hear from us

X

YouTube

LinkedIn

Discord

Legal

Privacy Policy

Terms of Service

Developer Agreement

© 2026 PayPal. All rights reserved.

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

payment_token

Vaulted instrument for a payment-method.

idstring<id>Optional

The PayPal-generated ID for the vault token.

Match^[0-9a-zA-Z_-]+$Length7 <= length <= 36

payment_sourceobject<The vaulted payment method details>Optional

The vaulted payment method details.

The vaulted payment method details properties

2 properties

paypalobject<payer_base>Optional

The customer who approves and pays for the order. The customer is also known as the payer.

payer_base properties

2 properties

email_addressstring<email>Optional

The internationalized email address.

Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

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])+)\]).*$Length3 <= length <= 254

payer_idstring<account_id-2>Optional

The account identifier for a PayPal account.

Match^[2-9A-HJ-NP-Z]{13}$Length13 <= length <= 13

venmoobject<venmo_payment_token_info>Optional

Payment Token info for Venmo payment source.

venmo_payment_token_info properties

1 property

user_namestringOptional

The Venmo username, as chosen by the user.

Match^[-a-zA-Z0-9_]*$Length1 <= length <= 50

linksobject<link_description>[]Optional

An array of related [HATEOAS links](/api/rest/responses/#hateoas).

Items1 <= length <= 32

link_description properties

8 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

Match^[\S\s]*$Length0 <= length <= 2147483647

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

Match^[\S\s]*$Length0 <= length <= 2147483647

methodenumOptional

The HTTP method required to make the related call.

Value in"GET" | "POST" | "PUT" | "DELETE" | "HEAD" | "CONNECT" | "OPTIONS" | "PATCH"

titlestringOptional

The link title.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaTypestring<media_type>Optional

The media type, as defined by [RFC 2046](https://www.ietf.org/rfc/rfc2046.txt). Describes the link target.

Match^[\S\s]*$Length0 <= length <= 2147483647

encTypestring<enc_type>Optional

The media type in which to submit the request data.

Default"application/json"Match^[\S\s]*$Length0 <= length <= 2147483647

schemaobject<link_schema>Optional

The request data or link target.

link_schema properties

14 properties

additionalItemsobject<additional_items>Optional

Any additional items.

dependenciesobject<Dependencies>Optional

The dependencies.

itemsobject<Items>Optional

An item.

definitionsobject<Definitions>Optional

Definitions.

patternPropertiesobject<pattern_properties>Optional

The pattern properties.

propertiesobject<Properties>Optional

The properties.

allOfarray<all_of_item>Optional

An array of sub-schemas. The data must validate against all sub-schemas.

Items0 <= length <= 32767

anyOfarray<any_of_item>Optional

An array of sub-schemas. The data must validate against one or more sub-schemas.

Items0 <= length <= 32767

oneOfarray<one_of_item>Optional

An array of sub-schemas. The data must validate against one sub-schema.

Items0 <= length <= 32767

notobject<Not>Optional

Not.

linksarray<link>Optional

An array of links.

Items0 <= length <= 32767

fragmentResolutionstring<fragment_resolution>Optional

The fragment resolution.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaobject<Media>Optional

The media type and context-encoding scheme.

Media properties

2 properties

typestringOptional

The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).

Match^[\S\s]*$Length0 <= length <= 2147483647

binaryEncodingstring<binary_encoding>Optional

The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).

Match^[\S\s]*$Length0 <= length <= 2147483647

pathStartstring<path_start>Optional

To apply this schema to the instances' URIs, start the URIs with this value.

FormaturiLength0 <= length <= 2147483647

targetSchemaobject<link_schema>Optional

The request data or link target.

link_schema properties

14 properties

additionalItemsobject<additional_items>Optional

Any additional items.

dependenciesobject<Dependencies>Optional

The dependencies.

itemsobject<Items>Optional

An item.

definitionsobject<Definitions>Optional

Definitions.

patternPropertiesobject<pattern_properties>Optional

The pattern properties.

propertiesobject<Properties>Optional

The properties.

allOfarray<all_of_item>Optional

An array of sub-schemas. The data must validate against all sub-schemas.

Items0 <= length <= 32767

anyOfarray<any_of_item>Optional

An array of sub-schemas. The data must validate against one or more sub-schemas.

Items0 <= length <= 32767

oneOfarray<one_of_item>Optional

An array of sub-schemas. The data must validate against one sub-schema.

Items0 <= length <= 32767

notobject<Not>Optional

Not.

linksarray<link>Optional

An array of links.

Items0 <= length <= 32767

fragmentResolutionstring<fragment_resolution>Optional

The fragment resolution.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaobject<Media>Optional

The media type and context-encoding scheme.

Media properties

2 properties

typestringOptional

The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).

Match^[\S\s]*$Length0 <= length <= 2147483647

binaryEncodingstring<binary_encoding>Optional

The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).

Match^[\S\s]*$Length0 <= length <= 2147483647

pathStartstring<path_start>Optional

To apply this schema to the instances' URIs, start the URIs with this value.

FormaturiLength0 <= length <= 2147483647

Back to top

On this page

No Headings