forked from LiveCarta/PayPal-PHP-Server-SDK
1.9 KiB
1.9 KiB
Ideal Payment Request
Information needed to pay using iDEAL.
Structure
IdealPaymentRequest
Fields
| Name | Type | Tags | Description | Getter | Setter |
|---|---|---|---|---|---|
name |
string |
Required | The full name representation like Mr J Smith. Constraints: Minimum Length: 3, Maximum Length: 300 |
getName(): string | setName(string name): void |
countryCode |
string |
Required | 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.Constraints: Minimum Length: 2, Maximum Length: 2, Pattern: ^([A-Z]{2}|C2)$ |
getCountryCode(): string | setCountryCode(string countryCode): void |
bic |
?string |
Optional | The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank. Constraints: Minimum Length: 8, Maximum Length: 11, Pattern: ^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$ |
getBic(): ?string | setBic(?string bic): void |
experienceContext |
?ExperienceContext |
Optional | Customizes the payer experience during the approval process for the payment. | getExperienceContext(): ?ExperienceContext | setExperienceContext(?ExperienceContext experienceContext): void |
Example (as JSON)
{
"name": "name6",
"country_code": "country_code4",
"bic": "bic8",
"experience_context": {
"brand_name": "brand_name2",
"locale": "locale6",
"shipping_preference": "NO_SHIPPING",
"return_url": "return_url4",
"cancel_url": "cancel_url6"
}
}