Indicates if the payment method can be vaulted or not. A true value indicates the payment method can be vaulted using our vaults product. If false, vaulting is not currently supported for this payment method.

Default"false"

country_codestring<country_code-2>Optional

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

product_codeenum<credit_product_button_code>Optional

The button code corresponding to a particular product or set of products. The values followed are defined by the SDK team.

Value in"CREDIT" | "PAYLATER" | "PAY_IN_3" | "PAY_IN_4"

eligible_in_paypal_networkboolean<payment_method_eligible_in_paypal_network>Optional

Flag that indicates if the customer is in the PayPal network. This value will be included in the response if the include_account_details flag is set to "true" in the API request.

recommendedbooleanOptional

Indicates if the payment method is recommended or not. A true value indicates the customer is payment ready and this payment method may be presented upfront.

Default"false"

recommended_priorityintegerOptional

This value is included in the response when recommended is true for a payment method. It indicates the priority of recommendation for payment readiness of eligible payment methods with lowest number taking the highest precedence.

Range1 <= value <= 3

venmoobject<venmo>Optional

Response for Venmo.

venmo properties

6 properties

can_be_vaultedbooleanOptional

Default"false"

country_codestring<country_code-2>Optional

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

product_codeenum<credit_product_button_code>Optional

The button code corresponding to a particular product or set of products. The values followed are defined by the SDK team.

Value in"CREDIT" | "PAYLATER" | "PAY_IN_3" | "PAY_IN_4"

eligible_in_paypal_networkboolean<payment_method_eligible_in_paypal_network>Optional

Flag that indicates if the customer is in the PayPal network. This value will be included in the response if the include_account_details flag is set to "true" in the API request.

recommendedbooleanOptional

Indicates if the payment method is recommended or not. A true value indicates the customer is payment ready and this payment method may be presented upfront.

Default"false"

recommended_priorityintegerOptional

Range1 <= value <= 3

paypal_creditobject<payment_method_common>Optional

Common response fields for all payment methods.

payment_method_common properties

3 properties

can_be_vaultedbooleanOptional

Default"false"

country_codestring<country_code-2>Optional

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

product_codeenum<credit_product_button_code>Optional

The button code corresponding to a particular product or set of products. The values followed are defined by the SDK team.

Value in"CREDIT" | "PAYLATER" | "PAY_IN_3" | "PAY_IN_4"

paypal_pay_laterobject<payment_method_common>Optional

Common response fields for all payment methods.

payment_method_common properties

3 properties

can_be_vaultedbooleanOptional

Default"false"

country_codestring<country_code-2>Optional

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

product_codeenum<credit_product_button_code>Optional

The button code corresponding to a particular product or set of products. The values followed are defined by the SDK team.

Value in"CREDIT" | "PAYLATER" | "PAY_IN_3" | "PAY_IN_4"

payment_tokensobject<payment_token>[]Optional

Payment tokens for vaulted instruments, if available. This object will be included only if include_vault_tokens is set to true in the request.

Items1 <= length <= 64

payment_token properties

3 properties

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.

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.

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

paypal_response

Eligible payment methods along with applicable vault tokens, if requested.

eligible_methodsobject<payment_methods>Optional

List of payment methods.

payment_methods properties

4 properties

paypalobject<paypal>Optional

Response for PayPal.

paypal properties

6 properties

can_be_vaultedbooleanOptional

Default"false"

country_codestring<country_code-2>Optional

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

product_codeenum<credit_product_button_code>Optional

The button code corresponding to a particular product or set of products. The values followed are defined by the SDK team.

Value in"CREDIT" | "PAYLATER" | "PAY_IN_3" | "PAY_IN_4"

eligible_in_paypal_networkboolean<payment_method_eligible_in_paypal_network>Optional

Flag that indicates if the customer is in the PayPal network. This value will be included in the response if the include_account_details flag is set to "true" in the API request.

recommendedbooleanOptional

Indicates if the payment method is recommended or not. A true value indicates the customer is payment ready and this payment method may be presented upfront.

Default"false"

recommended_priorityintegerOptional

Range1 <= value <= 3

venmoobject<venmo>Optional

Response for Venmo.

venmo properties

6 properties

can_be_vaultedbooleanOptional

Default"false"

country_codestring<country_code-2>Optional

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

product_codeenum<credit_product_button_code>Optional

The button code corresponding to a particular product or set of products. The values followed are defined by the SDK team.

Value in"CREDIT" | "PAYLATER" | "PAY_IN_3" | "PAY_IN_4"

eligible_in_paypal_networkboolean<payment_method_eligible_in_paypal_network>Optional

Flag that indicates if the customer is in the PayPal network. This value will be included in the response if the include_account_details flag is set to "true" in the API request.

recommendedbooleanOptional

Indicates if the payment method is recommended or not. A true value indicates the customer is payment ready and this payment method may be presented upfront.

Default"false"

recommended_priorityintegerOptional

Range1 <= value <= 3

paypal_creditobject<payment_method_common>Optional

Common response fields for all payment methods.

payment_method_common properties

3 properties

can_be_vaultedbooleanOptional

Default"false"

country_codestring<country_code-2>Optional

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

product_codeenum<credit_product_button_code>Optional

The button code corresponding to a particular product or set of products. The values followed are defined by the SDK team.

Value in"CREDIT" | "PAYLATER" | "PAY_IN_3" | "PAY_IN_4"

paypal_pay_laterobject<payment_method_common>Optional

Common response fields for all payment methods.

payment_method_common properties

3 properties

can_be_vaultedbooleanOptional

Default"false"

country_codestring<country_code-2>Optional

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

product_codeenum<credit_product_button_code>Optional

The button code corresponding to a particular product or set of products. The values followed are defined by the SDK team.

Value in"CREDIT" | "PAYLATER" | "PAY_IN_3" | "PAY_IN_4"

payment_tokensobject<payment_token>[]Optional

Payment tokens for vaulted instruments, if available. This object will be included only if include_vault_tokens is set to true in the request.

Items1 <= length <= 64

payment_token properties

3 properties

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.

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

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

relstringRequired

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

methodenumOptional

The HTTP method required to make the related call.

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

paypal_response

payment_methods properties

paypal properties

venmo properties

payment_method_common properties

payment_method_common properties

payment_token properties

The vaulted payment method details properties

payer_base properties

venmo_payment_token_info properties

link_description properties

link_schema properties

Media properties

link_schema properties

Media properties

Back to top

On this page

On this page

paypal_response

payment_methods properties

paypal properties

venmo properties

payment_method_common properties

payment_method_common properties

payment_token properties

The vaulted payment method details properties

payer_base properties

venmo_payment_token_info properties

link_description properties

link_schema properties

Media properties

link_schema properties

Media properties

Back to top

On this page

paypal_response

payment_methods properties

paypal properties

venmo properties

payment_method_common properties

payment_method_common properties

payment_token properties

The vaulted payment method details properties

payer_base properties

venmo_payment_token_info properties

link_description properties

link_schema properties

Media properties

link_schema properties

Media properties

Back to top

On this page

On this page

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

paypal_response

payment_methods properties

paypal properties

venmo properties

payment_method_common properties

payment_method_common properties

payment_token properties

The vaulted payment method details properties

payer_base properties

venmo_payment_token_info properties

link_description properties

link_schema properties

Media properties

link_schema properties

Media properties

Back to top

On this page