ideal_request

Information needed to pay using iDEAL.

namestring<full_name>Required

The full name representation like Mr J Smith.

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

country_codestring<country_code-2>Required

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

bicstring<bic>Optional

The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.

Match^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$Length8 <= length <= 11

experience_contextobject<experience_context_base>Optional

Customizes the payer experience during the approval process for the payment.

experience_context_base properties

5 properties

brand_namestringOptional

The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.

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

localestring<language>Optional

The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).

Match^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$Length2 <= length <= 10

shipping_preferenceenumOptional

The location from which the shipping address is derived.

Default"GET_FROM_FILE"Value in"GET_FROM_FILE" | "NO_SHIPPING" | "SET_PROVIDED_ADDRESS"

return_urlstring<url>Optional

Describes the URL.

FormaturiLength0 <= length <= 2147483647

cancel_urlstring<url>Optional

Describes the URL.

FormaturiLength0 <= length <= 2147483647

Information needed to pay using iDEAL.

namestring<full_name>Required

The full name representation like Mr J Smith.

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

country_codestring<country_code-2>Required

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

bicstring<bic>Optional

The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.

Match^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$Length8 <= length <= 11

experience_contextobject<experience_context_base>Optional

Customizes the payer experience during the approval process for the payment.

experience_context_base properties

5 properties

brand_namestringOptional

The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.

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

localestring<language>Optional

Match^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$Length2 <= length <= 10

shipping_preferenceenumOptional

The location from which the shipping address is derived.

Default"GET_FROM_FILE"Value in"GET_FROM_FILE" | "NO_SHIPPING" | "SET_PROVIDED_ADDRESS"

return_urlstring<url>Optional

Describes the URL.

FormaturiLength0 <= length <= 2147483647

cancel_urlstring<url>Optional

Describes the URL.

FormaturiLength0 <= length <= 2147483647

ideal_request

experience_context_base properties

Back to top

On this page

On this page

ideal_request

experience_context_base properties

Back to top

On this page

ideal_request

experience_context_base 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

ideal_request

experience_context_base properties

Back to top

On this page