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

paypal_wallet_attributes_response

Additional attributes associated with the use of a PayPal Wallet.

vaultobject<paypal_wallet_vault_response>Optional

The details about a saved PayPal Wallet payment source.

paypal_wallet_vault_response properties

4 properties

idstringOptional

The PayPal-generated ID for the saved payment source.

Match^[\S\s]*$Length1 <= length <= 255

statusenumOptional

The vault status.

Allowed values

"VAULTED"
"CREATED"
"APPROVED"

customerobject<paypal_wallet_customer>Optional

The details about a customer in PayPal's system of record.

paypal_wallet_customer properties

5 properties

idstring<merchant_partner_customer_id>Optional

The unique ID for a customer generated by PayPal.

Match^[0-9a-zA-Z_-]+$Length1 <= length <= 22

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

phoneobject<phone_with_type>Optional

The phone information.

phone_with_type properties

2 properties

phone_typeenum<phone_type>Optional

The phone type.

Allowed values

"FAX"
"HOME"
"MOBILE"
"OTHER"
"PAGER"

phone_numberobject<phone>Required

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

phone properties

3 properties

country_codestring<country_calling_code>Required

The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).

Match^[0-9]{1,3}?$Length1 <= length <= 3

national_numberstringRequired

The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). 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).

Match^[0-9]{1,14}?$Length1 <= length <= 14

extension_numberstringOptional

The extension number.

Match^[0-9]{1,15}?$Length1 <= length <= 15

nameobject<name>Optional

The name of the party.

name properties

6 properties

prefixstringOptional

The prefix, or title, to the party's name.

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

given_namestringOptional

When the party is a person, the party's given, or first, name.

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

surnamestringOptional

When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.

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

middle_namestringOptional

When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

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

suffixstringOptional

The suffix for the party's name.

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

full_namestringOptional

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

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

merchant_customer_idstringOptional

Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.

Match^[0-9a-zA-Z-_.^*$@#]+$Length1 <= length <= 64

linksobject<link_description>[]Optional

An array of request-related HATEOAS links.

Items1 <= length <= 10

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.

Allowed values

"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

cobranded_cardsobject<cobranded_card>[]Optional

An array of merchant cobranded cards used by buyer to complete an order. This array will be present if a merchant has onboarded their cobranded card with PayPal and provided corresponding label(s).

Items0 <= length <= 25

cobranded_card properties

3 properties

labelsarray<label>Optional

Array of labels for the cobranded card.

Items1 <= length <= 25

payeeobject<payee_base>Optional

The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.

payee_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.

merchant_idstring<account_id>Optional

The account identifier for a PayPal account.

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

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

Back to top

paypal_wallet_attributes_response

Additional attributes associated with the use of a PayPal Wallet.

vaultobject<paypal_wallet_vault_response>Optional

The details about a saved PayPal Wallet payment source.

paypal_wallet_vault_response properties

4 properties

idstringOptional

The PayPal-generated ID for the saved payment source.

Match^[\S\s]*$Length1 <= length <= 255

statusenumOptional

The vault status.

Allowed values

"VAULTED"
"CREATED"
"APPROVED"

customerobject<paypal_wallet_customer>Optional

The details about a customer in PayPal's system of record.

paypal_wallet_customer properties

5 properties

idstring<merchant_partner_customer_id>Optional

The unique ID for a customer generated by PayPal.

Match^[0-9a-zA-Z_-]+$Length1 <= length <= 22

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.

phoneobject<phone_with_type>Optional

The phone information.

phone_with_type properties

2 properties

phone_typeenum<phone_type>Optional

The phone type.

Allowed values

"FAX"
"HOME"
"MOBILE"
"OTHER"
"PAGER"

phone_numberobject<phone>Required

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

phone properties

3 properties

country_codestring<country_calling_code>Required

Match^[0-9]{1,3}?$Length1 <= length <= 3

national_numberstringRequired

Match^[0-9]{1,14}?$Length1 <= length <= 14

extension_numberstringOptional

The extension number.

Match^[0-9]{1,15}?$Length1 <= length <= 15

nameobject<name>Optional

The name of the party.

name properties

6 properties

prefixstringOptional

The prefix, or title, to the party's name.

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

given_namestringOptional

When the party is a person, the party's given, or first, name.

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

surnamestringOptional

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

middle_namestringOptional

When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.

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

suffixstringOptional

The suffix for the party's name.

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

full_namestringOptional

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

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

merchant_customer_idstringOptional

Match^[0-9a-zA-Z-_.^*$@#]+$Length1 <= length <= 64

linksobject<link_description>[]Optional

An array of request-related HATEOAS links.

Items1 <= length <= 10

link_description properties

8 properties

hrefstringRequired

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

relstringRequired

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

methodenumOptional

The HTTP method required to make the related call.

Allowed values

"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

cobranded_cardsobject<cobranded_card>[]Optional

An array of merchant cobranded cards used by buyer to complete an order. This array will be present if a merchant has onboarded their cobranded card with PayPal and provided corresponding label(s).

Items0 <= length <= 25

cobranded_card properties

3 properties

labelsarray<label>Optional

Array of labels for the cobranded card.

Items1 <= length <= 25

payeeobject<payee_base>Optional

The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.

payee_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.

merchant_idstring<account_id>Optional

The account identifier for a PayPal account.

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

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Match^[\S\s]*$Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

paypal_wallet_attributes_response

paypal_wallet_vault_response properties

paypal_wallet_customer properties

phone_with_type properties

phone properties

name properties

link_description properties

link_schema properties

Media properties

link_schema properties

Media properties

cobranded_card properties

payee_base properties

money properties

Back to top

On this page

On this page

paypal_wallet_attributes_response

paypal_wallet_vault_response properties

paypal_wallet_customer properties

phone_with_type properties

phone properties

name properties

link_description properties

link_schema properties

Media properties

link_schema properties

Media properties

cobranded_card properties

payee_base properties

money properties

Back to top

On this page

paypal_wallet_attributes_response

paypal_wallet_vault_response properties

paypal_wallet_customer properties

phone_with_type properties

phone properties

name properties

link_description properties

link_schema properties

Media properties

link_schema properties

Media properties

cobranded_card properties

payee_base properties

money 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

paypal_wallet_attributes_response

paypal_wallet_vault_response properties

paypal_wallet_customer properties

phone_with_type properties

phone properties

name properties

link_description properties

link_schema properties

Media properties

link_schema properties

Media properties

cobranded_card properties

payee_base properties

money properties

Back to top

On this page