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

Payment Methods

List of payment methods.

paypalobject<paypal>Optional

Response for PayPal.

paypal properties

6 properties

can_be_vaultedbooleanOptional

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.

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.

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.

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.

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.

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.

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.

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.

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"

Back to top

Payment Methods

List of payment methods.

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.

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.

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.

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.

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.

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.

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.

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.

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 Methods

paypal properties

venmo properties

payment_method_common properties

payment_method_common properties

Back to top

On this page

On this page

Payment Methods

paypal properties

venmo properties

payment_method_common properties

payment_method_common properties

Back to top

On this page

Payment Methods

paypal properties

venmo properties

payment_method_common properties

payment_method_common 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

Payment Methods

paypal properties

venmo properties

payment_method_common properties

payment_method_common properties

Back to top

On this page