ideal_request

Information needed to pay using iDEAL.

Schema Information

Type:object

Properties

namerequired

Type: object

Pattern: ^[\S\s]*$

Min length: 3

Max length: 300

The full name representation like Mr J Smith.

The name of the account holder associated with this payment method.

country_coderequired

Type: object

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The two-character ISO 3166-1 code 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.

The two-character ISO 3166-1 country code.

bic

Type: object

Pattern: ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$

Min length: 8

Max length: 11

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

The bank identification code (BIC).

experience_context

Type: object

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

brand_name

Type: string

Pattern: ^.*$

Min length: 1

Max length: 127

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.

locale

Type: object

Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$

Min length: 2

Max length: 10

The language tag 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, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.

The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW.

shipping_preference

Type: string

Enum: "GET_FROM_FILE", "NO_SHIPPING", "SET_PROVIDED_ADDRESS"

Default: "GET_FROM_FILE"

The location from which the shipping address is derived.

return_url

Type: object

Format: uri

Min length: 0

Max length: 2147483647

Describes the URL.

The URL where the customer is redirected after the customer approves the payment.

cancel_url

Type: object

Format: uri

Min length: 0

Max length: 2147483647

Describes the URL.

The URL where the customer is redirected after the customer cancels the payment.

Properties

namerequired

Type: object

Pattern: ^[\S\s]*$

Min length: 3

Max length: 300

The full name representation like Mr J Smith.

The name of the account holder associated with this payment method.

country_coderequired

Type: object

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The two-character ISO 3166-1 code 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.

The two-character ISO 3166-1 country code.

bic

Type: object

Pattern: ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$

Min length: 8

Max length: 11

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

The bank identification code (BIC).

experience_context

Type: object

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

brand_name

Type: string

Pattern: ^.*$

Min length: 1

Max length: 127

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.

locale

Type: object

Pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$

Min length: 2

Max length: 10

shipping_preference

Type: string

Enum: "GET_FROM_FILE", "NO_SHIPPING", "SET_PROVIDED_ADDRESS"

Default: "GET_FROM_FILE"

The location from which the shipping address is derived.

return_url

Type: object

Format: uri

Min length: 0

Max length: 2147483647

Describes the URL.

The URL where the customer is redirected after the customer approves the payment.

cancel_url

Type: object

Format: uri

Min length: 0

Max length: 2147483647

Describes the URL.

The URL where the customer is redirected after the customer cancels the payment.

ideal_request

Schema Information

Properties

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

Schema Information

Properties