forked from LiveCarta/PayPal-PHP-Server-SDK
Automated commit message
This commit is contained in:
@@ -1,11 +1,11 @@
|
||||
|
||||
# AVS Code
|
||||
# Avs Code
|
||||
|
||||
The address verification code for Visa, Discover, Mastercard, or American Express transactions.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`AVSCode`
|
||||
`AvsCode`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# BLIK Experience Context
|
||||
# Blik Experience Context
|
||||
|
||||
Customizes the payer experience during the approval process for the BLIK payment.
|
||||
|
||||
## Structure
|
||||
|
||||
`BLIKExperienceContext`
|
||||
`BlikExperienceContext`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# BLIK Level 0 Payment Object
|
||||
# Blik Level 0 Payment Object
|
||||
|
||||
Information used to pay using BLIK level_0 flow.
|
||||
|
||||
## Structure
|
||||
|
||||
`BLIKLevel0PaymentObject`
|
||||
`BlikLevel0PaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# BLIK One Click Payment Object
|
||||
# Blik One Click Payment Object
|
||||
|
||||
Information used to pay using BLIK one-click flow.
|
||||
|
||||
## Structure
|
||||
|
||||
`BLIKOneClickPaymentObject`
|
||||
`BlikOneClickPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# BLIK One Click Payment Request
|
||||
# Blik One Click Payment Request
|
||||
|
||||
Information used to pay using BLIK one-click flow.
|
||||
|
||||
## Structure
|
||||
|
||||
`BLIKOneClickPaymentRequest`
|
||||
`BlikOneClickPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# BLIK Payment Object
|
||||
# Blik Payment Object
|
||||
|
||||
Information used to pay using BLIK.
|
||||
|
||||
## Structure
|
||||
|
||||
`BLIKPaymentObject`
|
||||
`BlikPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -14,7 +14,7 @@ Information used to pay using BLIK.
|
||||
| `name` | `?string` | Optional | The full name representation like Mr J Smith.<br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void |
|
||||
| `countryCode` | `?string` | Optional | The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> 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.</blockquote><br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): ?string | setCountryCode(?string countryCode): void |
|
||||
| `email` | `?string` | Optional | The internationalized email address.<blockquote><strong>Note:</strong> Up to 64 characters are allowed before and 255 characters are allowed after the <code>@</code> sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted <code>@</code> sign exists.</blockquote><br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: ``^(?:[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])?\|\[(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-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])+)\])$`` | getEmail(): ?string | setEmail(?string email): void |
|
||||
| `oneClick` | [`?BLIKOneClickPaymentObject`](../../doc/models/blik-one-click-payment-object.md) | Optional | Information used to pay using BLIK one-click flow. | getOneClick(): ?BLIKOneClickPaymentObject | setOneClick(?BLIKOneClickPaymentObject oneClick): void |
|
||||
| `oneClick` | [`?BlikOneClickPaymentObject`](../../doc/models/blik-one-click-payment-object.md) | Optional | Information used to pay using BLIK one-click flow. | getOneClick(): ?BlikOneClickPaymentObject | setOneClick(?BlikOneClickPaymentObject oneClick): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# BLIK Payment Request
|
||||
# Blik Payment Request
|
||||
|
||||
Information needed to pay using BLIK.
|
||||
|
||||
## Structure
|
||||
|
||||
`BLIKPaymentRequest`
|
||||
`BlikPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -14,9 +14,9 @@ Information needed to pay using BLIK.
|
||||
| `name` | `string` | Required | The full name representation like Mr J Smith.<br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): string | setName(string name): void |
|
||||
| `countryCode` | `string` | Required | The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> 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.</blockquote><br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void |
|
||||
| `email` | `?string` | Optional | The internationalized email address.<blockquote><strong>Note:</strong> Up to 64 characters are allowed before and 255 characters are allowed after the <code>@</code> sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted <code>@</code> sign exists.</blockquote><br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: ``^(?:[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])?\|\[(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-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])+)\])$`` | getEmail(): ?string | setEmail(?string email): void |
|
||||
| `experienceContext` | [`?BLIKExperienceContext`](../../doc/models/blik-experience-context.md) | Optional | Customizes the payer experience during the approval process for the BLIK payment. | getExperienceContext(): ?BLIKExperienceContext | setExperienceContext(?BLIKExperienceContext experienceContext): void |
|
||||
| `level0` | [`?BLIKLevel0PaymentObject`](../../doc/models/blik-level-0-payment-object.md) | Optional | Information used to pay using BLIK level_0 flow. | getLevel0(): ?BLIKLevel0PaymentObject | setLevel0(?BLIKLevel0PaymentObject level0): void |
|
||||
| `oneClick` | [`?BLIKOneClickPaymentRequest`](../../doc/models/blik-one-click-payment-request.md) | Optional | Information used to pay using BLIK one-click flow. | getOneClick(): ?BLIKOneClickPaymentRequest | setOneClick(?BLIKOneClickPaymentRequest oneClick): void |
|
||||
| `experienceContext` | [`?BlikExperienceContext`](../../doc/models/blik-experience-context.md) | Optional | Customizes the payer experience during the approval process for the BLIK payment. | getExperienceContext(): ?BlikExperienceContext | setExperienceContext(?BlikExperienceContext experienceContext): void |
|
||||
| `level0` | [`?BlikLevel0PaymentObject`](../../doc/models/blik-level-0-payment-object.md) | Optional | Information used to pay using BLIK level_0 flow. | getLevel0(): ?BlikLevel0PaymentObject | setLevel0(?BlikLevel0PaymentObject level0): void |
|
||||
| `oneClick` | [`?BlikOneClickPaymentRequest`](../../doc/models/blik-one-click-payment-request.md) | Optional | Information used to pay using BLIK one-click flow. | getOneClick(): ?BlikOneClickPaymentRequest | setOneClick(?BlikOneClickPaymentRequest oneClick): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
|
||||
@@ -11,8 +11,8 @@ The processor response information for payment requests, such as direct credit c
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `avsCode` | [`?string(AVSCode)`](../../doc/models/avs-code.md) | Optional | The address verification code for Visa, Discover, Mastercard, or American Express transactions. | getAvsCode(): ?string | setAvsCode(?string avsCode): void |
|
||||
| `cvvCode` | [`?string(CVVCode)`](../../doc/models/cvv-code.md) | Optional | The card verification value code for for Visa, Discover, Mastercard, or American Express. | getCvvCode(): ?string | setCvvCode(?string cvvCode): void |
|
||||
| `avsCode` | [`?string(AvsCode)`](../../doc/models/avs-code.md) | Optional | The address verification code for Visa, Discover, Mastercard, or American Express transactions. | getAvsCode(): ?string | setAvsCode(?string avsCode): void |
|
||||
| `cvvCode` | [`?string(CvvCode)`](../../doc/models/cvv-code.md) | Optional | The card verification value code for for Visa, Discover, Mastercard, or American Express. | getCvvCode(): ?string | setCvvCode(?string cvvCode): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# CVV Code
|
||||
# Cvv Code
|
||||
|
||||
The card verification value code for for Visa, Discover, Mastercard, or American Express.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`CVVCode`
|
||||
`CvvCode`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# ECI Flag
|
||||
# Eci Flag
|
||||
|
||||
Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`ECIFlag`
|
||||
`EciFlag`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# EPS Payment Object
|
||||
# Eps Payment Object
|
||||
|
||||
Information used to pay using eps.
|
||||
|
||||
## Structure
|
||||
|
||||
`EPSPaymentObject`
|
||||
`EpsPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# EPS Payment Request
|
||||
# Eps Payment Request
|
||||
|
||||
Information needed to pay using eps.
|
||||
|
||||
## Structure
|
||||
|
||||
`EPSPaymentRequest`
|
||||
`EpsPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# IDEAL Payment Object
|
||||
# Ideal Payment Object
|
||||
|
||||
Information used to pay using iDEAL.
|
||||
|
||||
## Structure
|
||||
|
||||
`IDEALPaymentObject`
|
||||
`IdealPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# IDEAL Payment Request
|
||||
# Ideal Payment Request
|
||||
|
||||
Information needed to pay using iDEAL.
|
||||
|
||||
## Structure
|
||||
|
||||
`IDEALPaymentRequest`
|
||||
`IdealPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ The request-related [HATEOAS link](/api/rest/responses/#hateoas-links) informati
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `href` | `string` | Required | 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. | getHref(): string | setHref(string href): void |
|
||||
| `rel` | `string` | Required | 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). | getRel(): string | setRel(string rel): void |
|
||||
| `method` | [`?string(LinkHTTPMethod)`](../../doc/models/link-http-method.md) | Optional | The HTTP method required to make the related call. | getMethod(): ?string | setMethod(?string method): void |
|
||||
| `method` | [`?string(LinkHttpMethod)`](../../doc/models/link-http-method.md) | Optional | The HTTP method required to make the related call. | getMethod(): ?string | setMethod(?string method): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Link HTTP Method
|
||||
# Link Http Method
|
||||
|
||||
The HTTP method required to make the related call.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`LinkHTTPMethod`
|
||||
`LinkHttpMethod`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# My Bank Payment Object
|
||||
# Mybank Payment Object
|
||||
|
||||
Information used to pay using MyBank.
|
||||
|
||||
## Structure
|
||||
|
||||
`MyBankPaymentObject`
|
||||
`MybankPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# My Bank Payment Request
|
||||
# Mybank Payment Request
|
||||
|
||||
Information needed to pay using MyBank.
|
||||
|
||||
## Structure
|
||||
|
||||
`MyBankPaymentRequest`
|
||||
`MybankPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -14,7 +14,7 @@ The Third Party Network token used to fund a payment.
|
||||
| `number` | `string` | Required | Third party network token number.<br>**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `19`, *Pattern*: `^[0-9]{13,19}$` | getNumber(): string | setNumber(string number): void |
|
||||
| `expiry` | `string` | Required | The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).<br>**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): string | setExpiry(string expiry): void |
|
||||
| `cryptogram` | `?string` | Optional | An Encrypted one-time use value that's sent along with Network Token. This field is not required to be present for recurring transactions.<br>**Constraints**: *Minimum Length*: `28`, *Maximum Length*: `32`, *Pattern*: `^.*$` | getCryptogram(): ?string | setCryptogram(?string cryptogram): void |
|
||||
| `eciFlag` | [`?string(ECIFlag)`](../../doc/models/eci-flag.md) | Optional | Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getEciFlag(): ?string | setEciFlag(?string eciFlag): void |
|
||||
| `eciFlag` | [`?string(EciFlag)`](../../doc/models/eci-flag.md) | Optional | Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getEciFlag(): ?string | setEciFlag(?string eciFlag): void |
|
||||
| `tokenRequestorId` | `?string` | Optional | A TRID, or a Token Requestor ID, is an identifier used by merchants to request network tokens from card networks. A TRID is a precursor to obtaining a network token for a credit card primary account number (PAN), and will aid in enabling secure card on file (COF) payments and reducing fraud.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `11`, *Pattern*: `^[0-9A-Z_]+$` | getTokenRequestorId(): ?string | setTokenRequestorId(?string tokenRequestorId): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -13,7 +13,7 @@ The payment source definition.
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardRequest`](../../doc/models/card-request.md) | Optional | The payment card to use to fund a payment. Can be a credit or debit card.<blockquote><strong>Note:</strong> Passing card number, cvv and expiry directly via the API requires <a href="https://www.pcisecuritystandards.org/pci_security/completing_self_assessment"> PCI SAQ D compliance</a>. <br>*PayPal offers a mechanism by which you do not have to take on the <strong>PCI SAQ D</strong> burden by using hosted fields - refer to <a href="https://developer.paypal.com/docs/checkout/advanced/integrate/">this Integration Guide</a>*.</blockquote> | getCard(): ?CardRequest | setCard(?CardRequest card): void |
|
||||
| `token` | [`?Token`](../../doc/models/token.md) | Optional | The tokenized payment source to fund a payment. | getToken(): ?Token | setToken(?Token token): void |
|
||||
| `paypal` | [`?PayPalWallet`](../../doc/models/pay-pal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PayPalWallet | setPaypal(?PayPalWallet paypal): void |
|
||||
| `paypal` | [`?PaypalWallet`](../../doc/models/paypal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PaypalWallet | setPaypal(?PaypalWallet paypal): void |
|
||||
| `applePay` | [`?ApplePayRequest`](../../doc/models/apple-pay-request.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayRequest | setApplePay(?ApplePayRequest applePay): void |
|
||||
| `googlePay` | [`?GooglePayRequest`](../../doc/models/google-pay-request.md) | Optional | Information needed to pay using Google Pay. | getGooglePay(): ?GooglePayRequest | setGooglePay(?GooglePayRequest googlePay): void |
|
||||
| `venmo` | [`?VenmoWalletRequest`](../../doc/models/venmo-wallet-request.md) | Optional | Information needed to pay using Venmo. | getVenmo(): ?VenmoWalletRequest | setVenmo(?VenmoWalletRequest venmo): void |
|
||||
|
||||
@@ -12,7 +12,7 @@ The payment source used to fund the payment.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardResponse`](../../doc/models/card-response.md) | Optional | The payment card to use to fund a payment. Card can be a credit or debit card. | getCard(): ?CardResponse | setCard(?CardResponse card): void |
|
||||
| `paypal` | [`?PayPalWalletResponse`](../../doc/models/pay-pal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PayPalWalletResponse | setPaypal(?PayPalWalletResponse paypal): void |
|
||||
| `paypal` | [`?PaypalWalletResponse`](../../doc/models/paypal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PaypalWalletResponse | setPaypal(?PaypalWalletResponse paypal): void |
|
||||
| `applePay` | [`?ApplePayPaymentObject`](../../doc/models/apple-pay-payment-object.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayPaymentObject | setApplePay(?ApplePayPaymentObject applePay): void |
|
||||
| `googlePay` | [`?GooglePayWalletResponse`](../../doc/models/google-pay-wallet-response.md) | Optional | Google Pay Wallet payment data. | getGooglePay(): ?GooglePayWalletResponse | setGooglePay(?GooglePayWalletResponse googlePay): void |
|
||||
| `venmo` | [`?VenmoWalletResponse`](../../doc/models/venmo-wallet-response.md) | Optional | Venmo wallet response. | getVenmo(): ?VenmoWalletResponse | setVenmo(?VenmoWalletResponse venmo): void |
|
||||
|
||||
@@ -13,7 +13,7 @@ The payment source definition.
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardRequest`](../../doc/models/card-request.md) | Optional | The payment card to use to fund a payment. Can be a credit or debit card.<blockquote><strong>Note:</strong> Passing card number, cvv and expiry directly via the API requires <a href="https://www.pcisecuritystandards.org/pci_security/completing_self_assessment"> PCI SAQ D compliance</a>. <br>*PayPal offers a mechanism by which you do not have to take on the <strong>PCI SAQ D</strong> burden by using hosted fields - refer to <a href="https://developer.paypal.com/docs/checkout/advanced/integrate/">this Integration Guide</a>*.</blockquote> | getCard(): ?CardRequest | setCard(?CardRequest card): void |
|
||||
| `token` | [`?Token`](../../doc/models/token.md) | Optional | The tokenized payment source to fund a payment. | getToken(): ?Token | setToken(?Token token): void |
|
||||
| `paypal` | [`?PayPalWallet`](../../doc/models/pay-pal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PayPalWallet | setPaypal(?PayPalWallet paypal): void |
|
||||
| `paypal` | [`?PaypalWallet`](../../doc/models/paypal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PaypalWallet | setPaypal(?PaypalWallet paypal): void |
|
||||
| `applePay` | [`?ApplePayRequest`](../../doc/models/apple-pay-request.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayRequest | setApplePay(?ApplePayRequest applePay): void |
|
||||
| `googlePay` | [`?GooglePayRequest`](../../doc/models/google-pay-request.md) | Optional | Information needed to pay using Google Pay. | getGooglePay(): ?GooglePayRequest | setGooglePay(?GooglePayRequest googlePay): void |
|
||||
| `venmo` | [`?VenmoWalletRequest`](../../doc/models/venmo-wallet-request.md) | Optional | Information needed to pay using Venmo. | getVenmo(): ?VenmoWalletRequest | setVenmo(?VenmoWalletRequest venmo): void |
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# PA Res Status
|
||||
# Pa Res Status
|
||||
|
||||
Transactions status result identifier. The outcome of the issuer's authentication.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PAResStatus`
|
||||
`PaResStatus`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -12,13 +12,13 @@ The payment source used to fund the payment.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardResponse`](../../doc/models/card-response.md) | Optional | The payment card to use to fund a payment. Card can be a credit or debit card. | getCard(): ?CardResponse | setCard(?CardResponse card): void |
|
||||
| `paypal` | [`?PayPalWalletResponse`](../../doc/models/pay-pal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PayPalWalletResponse | setPaypal(?PayPalWalletResponse paypal): void |
|
||||
| `paypal` | [`?PaypalWalletResponse`](../../doc/models/paypal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PaypalWalletResponse | setPaypal(?PaypalWalletResponse paypal): void |
|
||||
| `bancontact` | [`?BancontactPaymentObject`](../../doc/models/bancontact-payment-object.md) | Optional | Information used to pay Bancontact. | getBancontact(): ?BancontactPaymentObject | setBancontact(?BancontactPaymentObject bancontact): void |
|
||||
| `blik` | [`?BLIKPaymentObject`](../../doc/models/blik-payment-object.md) | Optional | Information used to pay using BLIK. | getBlik(): ?BLIKPaymentObject | setBlik(?BLIKPaymentObject blik): void |
|
||||
| `eps` | [`?EPSPaymentObject`](../../doc/models/eps-payment-object.md) | Optional | Information used to pay using eps. | getEps(): ?EPSPaymentObject | setEps(?EPSPaymentObject eps): void |
|
||||
| `blik` | [`?BlikPaymentObject`](../../doc/models/blik-payment-object.md) | Optional | Information used to pay using BLIK. | getBlik(): ?BlikPaymentObject | setBlik(?BlikPaymentObject blik): void |
|
||||
| `eps` | [`?EpsPaymentObject`](../../doc/models/eps-payment-object.md) | Optional | Information used to pay using eps. | getEps(): ?EpsPaymentObject | setEps(?EpsPaymentObject eps): void |
|
||||
| `giropay` | [`?GiropayPaymentObject`](../../doc/models/giropay-payment-object.md) | Optional | Information needed to pay using giropay. | getGiropay(): ?GiropayPaymentObject | setGiropay(?GiropayPaymentObject giropay): void |
|
||||
| `ideal` | [`?IDEALPaymentObject`](../../doc/models/ideal-payment-object.md) | Optional | Information used to pay using iDEAL. | getIdeal(): ?IDEALPaymentObject | setIdeal(?IDEALPaymentObject ideal): void |
|
||||
| `mybank` | [`?MyBankPaymentObject`](../../doc/models/my-bank-payment-object.md) | Optional | Information used to pay using MyBank. | getMybank(): ?MyBankPaymentObject | setMybank(?MyBankPaymentObject mybank): void |
|
||||
| `ideal` | [`?IdealPaymentObject`](../../doc/models/ideal-payment-object.md) | Optional | Information used to pay using iDEAL. | getIdeal(): ?IdealPaymentObject | setIdeal(?IdealPaymentObject ideal): void |
|
||||
| `mybank` | [`?MybankPaymentObject`](../../doc/models/mybank-payment-object.md) | Optional | Information used to pay using MyBank. | getMybank(): ?MybankPaymentObject | setMybank(?MybankPaymentObject mybank): void |
|
||||
| `p24` | [`?P24PaymentObject`](../../doc/models/p24-payment-object.md) | Optional | Information used to pay using P24(Przelewy24). | getP24(): ?P24PaymentObject | setP24(?P24PaymentObject p24): void |
|
||||
| `sofort` | [`?SofortPaymentObject`](../../doc/models/sofort-payment-object.md) | Optional | Information used to pay using Sofort. | getSofort(): ?SofortPaymentObject | setSofort(?SofortPaymentObject sofort): void |
|
||||
| `trustly` | [`?TrustlyPaymentObject`](../../doc/models/trustly-payment-object.md) | Optional | Information needed to pay using Trustly. | getTrustly(): ?TrustlyPaymentObject | setTrustly(?TrustlyPaymentObject trustly): void |
|
||||
|
||||
@@ -13,13 +13,13 @@ The payment source definition.
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardRequest`](../../doc/models/card-request.md) | Optional | The payment card to use to fund a payment. Can be a credit or debit card.<blockquote><strong>Note:</strong> Passing card number, cvv and expiry directly via the API requires <a href="https://www.pcisecuritystandards.org/pci_security/completing_self_assessment"> PCI SAQ D compliance</a>. <br>*PayPal offers a mechanism by which you do not have to take on the <strong>PCI SAQ D</strong> burden by using hosted fields - refer to <a href="https://developer.paypal.com/docs/checkout/advanced/integrate/">this Integration Guide</a>*.</blockquote> | getCard(): ?CardRequest | setCard(?CardRequest card): void |
|
||||
| `token` | [`?Token`](../../doc/models/token.md) | Optional | The tokenized payment source to fund a payment. | getToken(): ?Token | setToken(?Token token): void |
|
||||
| `paypal` | [`?PayPalWallet`](../../doc/models/pay-pal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PayPalWallet | setPaypal(?PayPalWallet paypal): void |
|
||||
| `paypal` | [`?PaypalWallet`](../../doc/models/paypal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PaypalWallet | setPaypal(?PaypalWallet paypal): void |
|
||||
| `bancontact` | [`?BancontactPaymentRequest`](../../doc/models/bancontact-payment-request.md) | Optional | Information needed to pay using Bancontact. | getBancontact(): ?BancontactPaymentRequest | setBancontact(?BancontactPaymentRequest bancontact): void |
|
||||
| `blik` | [`?BLIKPaymentRequest`](../../doc/models/blik-payment-request.md) | Optional | Information needed to pay using BLIK. | getBlik(): ?BLIKPaymentRequest | setBlik(?BLIKPaymentRequest blik): void |
|
||||
| `eps` | [`?EPSPaymentRequest`](../../doc/models/eps-payment-request.md) | Optional | Information needed to pay using eps. | getEps(): ?EPSPaymentRequest | setEps(?EPSPaymentRequest eps): void |
|
||||
| `blik` | [`?BlikPaymentRequest`](../../doc/models/blik-payment-request.md) | Optional | Information needed to pay using BLIK. | getBlik(): ?BlikPaymentRequest | setBlik(?BlikPaymentRequest blik): void |
|
||||
| `eps` | [`?EpsPaymentRequest`](../../doc/models/eps-payment-request.md) | Optional | Information needed to pay using eps. | getEps(): ?EpsPaymentRequest | setEps(?EpsPaymentRequest eps): void |
|
||||
| `giropay` | [`?GiropayPaymentRequest`](../../doc/models/giropay-payment-request.md) | Optional | Information needed to pay using giropay. | getGiropay(): ?GiropayPaymentRequest | setGiropay(?GiropayPaymentRequest giropay): void |
|
||||
| `ideal` | [`?IDEALPaymentRequest`](../../doc/models/ideal-payment-request.md) | Optional | Information needed to pay using iDEAL. | getIdeal(): ?IDEALPaymentRequest | setIdeal(?IDEALPaymentRequest ideal): void |
|
||||
| `mybank` | [`?MyBankPaymentRequest`](../../doc/models/my-bank-payment-request.md) | Optional | Information needed to pay using MyBank. | getMybank(): ?MyBankPaymentRequest | setMybank(?MyBankPaymentRequest mybank): void |
|
||||
| `ideal` | [`?IdealPaymentRequest`](../../doc/models/ideal-payment-request.md) | Optional | Information needed to pay using iDEAL. | getIdeal(): ?IdealPaymentRequest | setIdeal(?IdealPaymentRequest ideal): void |
|
||||
| `mybank` | [`?MybankPaymentRequest`](../../doc/models/mybank-payment-request.md) | Optional | Information needed to pay using MyBank. | getMybank(): ?MybankPaymentRequest | setMybank(?MybankPaymentRequest mybank): void |
|
||||
| `p24` | [`?P24PaymentRequest`](../../doc/models/p24-payment-request.md) | Optional | Information needed to pay using P24 (Przelewy24). | getP24(): ?P24PaymentRequest | setP24(?P24PaymentRequest p24): void |
|
||||
| `sofort` | [`?SofortPaymentRequest`](../../doc/models/sofort-payment-request.md) | Optional | Information needed to pay using Sofort. | getSofort(): ?SofortPaymentRequest | setSofort(?SofortPaymentRequest sofort): void |
|
||||
| `trustly` | [`?TrustlyPaymentRequest`](../../doc/models/trustly-payment-request.md) | Optional | Information needed to pay using Trustly. | getTrustly(): ?TrustlyPaymentRequest | setTrustly(?TrustlyPaymentRequest trustly): void |
|
||||
|
||||
@@ -12,7 +12,7 @@ The vaulted payment method details.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardPaymentToken`](../../doc/models/card-payment-token.md) | Optional | Full representation of a Card Payment Token including network token. | getCard(): ?CardPaymentToken | setCard(?CardPaymentToken card): void |
|
||||
| `paypal` | [`?PayPalPaymentToken`](../../doc/models/pay-pal-payment-token.md) | Optional | - | getPaypal(): ?PayPalPaymentToken | setPaypal(?PayPalPaymentToken paypal): void |
|
||||
| `paypal` | [`?PaypalPaymentToken`](../../doc/models/paypal-payment-token.md) | Optional | - | getPaypal(): ?PaypalPaymentToken | setPaypal(?PaypalPaymentToken paypal): void |
|
||||
| `venmo` | [`?VenmoPaymentToken`](../../doc/models/venmo-payment-token.md) | Optional | - | getVenmo(): ?VenmoPaymentToken | setVenmo(?VenmoPaymentToken venmo): void |
|
||||
| `applePay` | [`?ApplePayPaymentToken`](../../doc/models/apple-pay-payment-token.md) | Optional | A resource representing a response for Apple Pay. | getApplePay(): ?ApplePayPaymentToken | setApplePay(?ApplePayPaymentToken applePay): void |
|
||||
| `bank` | `mixed` | Optional | Full representation of a Bank Payment Token. | getBank(): | setBank( bank): void |
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Experience Landing Page
|
||||
# Paypal Experience Landing Page
|
||||
|
||||
The type of landing page to show on the PayPal site for customer checkout.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PayPalExperienceLandingPage`
|
||||
`PaypalExperienceLandingPage`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Experience User Action
|
||||
# Paypal Experience User Action
|
||||
|
||||
Configures a <strong>Continue</strong> or <strong>Pay Now</strong> checkout flow.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PayPalExperienceUserAction`
|
||||
`PaypalExperienceUserAction`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Payment Token Customer Type
|
||||
# Paypal Payment Token Customer Type
|
||||
|
||||
The customer type associated with the PayPal payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PayPalPaymentTokenCustomerType`
|
||||
`PaypalPaymentTokenCustomerType`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Payment Token Usage Pattern
|
||||
# Paypal Payment Token Usage Pattern
|
||||
|
||||
Expected business/pricing model for the billing agreement.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PayPalPaymentTokenUsagePattern`
|
||||
`PaypalPaymentTokenUsagePattern`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Payment Token Usage Type
|
||||
# Paypal Payment Token Usage Type
|
||||
|
||||
The usage type associated with the PayPal payment token.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PayPalPaymentTokenUsageType`
|
||||
`PaypalPaymentTokenUsageType`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
# Pay Pal Payment Token
|
||||
# Paypal Payment Token
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalPaymentToken`
|
||||
`PaypalPaymentToken`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Wallet Account Verification Status
|
||||
# Paypal Wallet Account Verification Status
|
||||
|
||||
The account status indicates whether the buyer has verified the financial details associated with their PayPal account.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PayPalWalletAccountVerificationStatus`
|
||||
`PaypalWalletAccountVerificationStatus`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
|
||||
# Pay Pal Wallet Attributes Response
|
||||
# Paypal Wallet Attributes Response
|
||||
|
||||
Additional attributes associated with the use of a PayPal Wallet.
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletAttributesResponse`
|
||||
`PaypalWalletAttributesResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `vault` | [`?PayPalWalletVaultResponse`](../../doc/models/pay-pal-wallet-vault-response.md) | Optional | The details about a saved PayPal Wallet payment source. | getVault(): ?PayPalWalletVaultResponse | setVault(?PayPalWalletVaultResponse vault): void |
|
||||
| `vault` | [`?PaypalWalletVaultResponse`](../../doc/models/paypal-wallet-vault-response.md) | Optional | The details about a saved PayPal Wallet payment source. | getVault(): ?PaypalWalletVaultResponse | setVault(?PaypalWalletVaultResponse vault): void |
|
||||
| `cobrandedCards` | [`?(CobrandedCard[])`](../../doc/models/cobranded-card.md) | Optional | An array of merchant cobranded cards used by buyer to complete an order. This array will be present if a merchant has onboarded their cobranded card with PayPal and provided corresponding label(s).<br>**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `25` | getCobrandedCards(): ?array | setCobrandedCards(?array cobrandedCards): void |
|
||||
|
||||
## Example (as JSON)
|
||||
@@ -1,18 +1,18 @@
|
||||
|
||||
# Pay Pal Wallet Attributes
|
||||
# Paypal Wallet Attributes
|
||||
|
||||
Additional attributes associated with the use of this PayPal Wallet.
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletAttributes`
|
||||
`PaypalWalletAttributes`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `customer` | [`?PayPalWalletCustomerRequest`](../../doc/models/pay-pal-wallet-customer-request.md) | Optional | - | getCustomer(): ?PayPalWalletCustomerRequest | setCustomer(?PayPalWalletCustomerRequest customer): void |
|
||||
| `vault` | [`?PayPalWalletVaultInstruction`](../../doc/models/pay-pal-wallet-vault-instruction.md) | Optional | - | getVault(): ?PayPalWalletVaultInstruction | setVault(?PayPalWalletVaultInstruction vault): void |
|
||||
| `customer` | [`?PaypalWalletCustomerRequest`](../../doc/models/paypal-wallet-customer-request.md) | Optional | - | getCustomer(): ?PaypalWalletCustomerRequest | setCustomer(?PaypalWalletCustomerRequest customer): void |
|
||||
| `vault` | [`?PaypalWalletVaultInstruction`](../../doc/models/paypal-wallet-vault-instruction.md) | Optional | - | getVault(): ?PaypalWalletVaultInstruction | setVault(?PaypalWalletVaultInstruction vault): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
# Pay Pal Wallet Customer Request
|
||||
# Paypal Wallet Customer Request
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletCustomerRequest`
|
||||
`PaypalWalletCustomerRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Wallet Customer
|
||||
# Paypal Wallet Customer
|
||||
|
||||
The details about a customer in PayPal's system of record.
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletCustomer`
|
||||
`PaypalWalletCustomer`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Wallet Experience Context
|
||||
# Paypal Wallet Experience Context
|
||||
|
||||
Customizes the payer experience during the approval process for payment with PayPal.<blockquote><strong>Note:</strong> Partners and Marketplaces might configure <code>brand_name</code> and <code>shipping_preference</code> during partner account setup, which overrides the request values.</blockquote>
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletExperienceContext`
|
||||
`PaypalWalletExperienceContext`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -16,8 +16,8 @@ Customizes the payer experience during the approval process for payment with Pay
|
||||
| `shippingPreference` | [`?string(ShippingPreference)`](../../doc/models/shipping-preference.md) | Optional | The location from which the shipping address is derived.<br>**Default**: `ShippingPreference::GET_FROM_FILE`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getShippingPreference(): ?string | setShippingPreference(?string shippingPreference): void |
|
||||
| `returnUrl` | `?string` | Optional | Describes the URL. | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void |
|
||||
| `cancelUrl` | `?string` | Optional | Describes the URL. | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void |
|
||||
| `landingPage` | [`?string(PayPalExperienceLandingPage)`](../../doc/models/pay-pal-experience-landing-page.md) | Optional | The type of landing page to show on the PayPal site for customer checkout.<br>**Default**: `PayPalExperienceLandingPage::NO_PREFERENCE`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `13`, *Pattern*: `^[0-9A-Z_]+$` | getLandingPage(): ?string | setLandingPage(?string landingPage): void |
|
||||
| `userAction` | [`?string(PayPalExperienceUserAction)`](../../doc/models/pay-pal-experience-user-action.md) | Optional | Configures a <strong>Continue</strong> or <strong>Pay Now</strong> checkout flow.<br>**Default**: `PayPalExperienceUserAction::CONTINUE_`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `8`, *Pattern*: `^[0-9A-Z_]+$` | getUserAction(): ?string | setUserAction(?string userAction): void |
|
||||
| `landingPage` | [`?string(PaypalExperienceLandingPage)`](../../doc/models/paypal-experience-landing-page.md) | Optional | The type of landing page to show on the PayPal site for customer checkout.<br>**Default**: `PaypalExperienceLandingPage::NO_PREFERENCE`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `13`, *Pattern*: `^[0-9A-Z_]+$` | getLandingPage(): ?string | setLandingPage(?string landingPage): void |
|
||||
| `userAction` | [`?string(PaypalExperienceUserAction)`](../../doc/models/paypal-experience-user-action.md) | Optional | Configures a <strong>Continue</strong> or <strong>Pay Now</strong> checkout flow.<br>**Default**: `PaypalExperienceUserAction::CONTINUE_`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `8`, *Pattern*: `^[0-9A-Z_]+$` | getUserAction(): ?string | setUserAction(?string userAction): void |
|
||||
| `paymentMethodPreference` | [`?string(PayeePaymentMethodPreference)`](../../doc/models/payee-payment-method-preference.md) | Optional | The merchant-preferred payment methods.<br>**Default**: `PayeePaymentMethodPreference::UNRESTRICTED`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getPaymentMethodPreference(): ?string | setPaymentMethodPreference(?string paymentMethodPreference): void |
|
||||
|
||||
## Example (as JSON)
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Wallet Response
|
||||
# Paypal Wallet Response
|
||||
|
||||
The PayPal Wallet response.
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletResponse`
|
||||
`PaypalWalletResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -13,7 +13,7 @@ The PayPal Wallet response.
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `emailAddress` | `?string` | Optional | The internationalized email address.<blockquote><strong>Note:</strong> Up to 64 characters are allowed before and 255 characters are allowed after the <code>@</code> sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted <code>@</code> sign exists.</blockquote><br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: ``(?:[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])+)\])`` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void |
|
||||
| `accountId` | `?string` | Optional | The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is used to encode the result.<br>**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `13`, *Pattern*: `^[2-9A-HJ-NP-Z]{13}$` | getAccountId(): ?string | setAccountId(?string accountId): void |
|
||||
| `accountStatus` | [`?string(PayPalWalletAccountVerificationStatus)`](../../doc/models/pay-pal-wallet-account-verification-status.md) | Optional | The account status indicates whether the buyer has verified the financial details associated with their PayPal account.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getAccountStatus(): ?string | setAccountStatus(?string accountStatus): void |
|
||||
| `accountStatus` | [`?string(PaypalWalletAccountVerificationStatus)`](../../doc/models/paypal-wallet-account-verification-status.md) | Optional | The account status indicates whether the buyer has verified the financial details associated with their PayPal account.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getAccountStatus(): ?string | setAccountStatus(?string accountStatus): void |
|
||||
| `name` | [`?Name`](../../doc/models/name.md) | Optional | The name of the party. | getName(): ?Name | setName(?Name name): void |
|
||||
| `phoneType` | [`?string(PhoneType)`](../../doc/models/phone-type.md) | Optional | The phone type. | getPhoneType(): ?string | setPhoneType(?string phoneType): void |
|
||||
| `phoneNumber` | [`?PhoneNumber`](../../doc/models/phone-number.md) | Optional | The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): ?PhoneNumber | setPhoneNumber(?PhoneNumber phoneNumber): void |
|
||||
@@ -21,7 +21,7 @@ The PayPal Wallet response.
|
||||
| `businessName` | `?string` | Optional | The business name of the PayPal account holder (populated for business accounts only)<br>**Constraints**: *Minimum Length*: `0`, *Maximum Length*: `300`, *Pattern*: `^.*$` | getBusinessName(): ?string | setBusinessName(?string businessName): void |
|
||||
| `taxInfo` | [`?TaxInfo`](../../doc/models/tax-info.md) | Optional | The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` are required. | getTaxInfo(): ?TaxInfo | setTaxInfo(?TaxInfo taxInfo): void |
|
||||
| `address` | [`?Address`](../../doc/models/address.md) | Optional | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getAddress(): ?Address | setAddress(?Address address): void |
|
||||
| `attributes` | [`?PayPalWalletAttributesResponse`](../../doc/models/pay-pal-wallet-attributes-response.md) | Optional | Additional attributes associated with the use of a PayPal Wallet. | getAttributes(): ?PayPalWalletAttributesResponse | setAttributes(?PayPalWalletAttributesResponse attributes): void |
|
||||
| `attributes` | [`?PaypalWalletAttributesResponse`](../../doc/models/paypal-wallet-attributes-response.md) | Optional | Additional attributes associated with the use of a PayPal Wallet. | getAttributes(): ?PaypalWalletAttributesResponse | setAttributes(?PaypalWalletAttributesResponse attributes): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
# Pay Pal Wallet Vault Instruction
|
||||
# Paypal Wallet Vault Instruction
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletVaultInstruction`
|
||||
`PaypalWalletVaultInstruction`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -11,9 +11,9 @@
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `storeInVault` | [`?string(StoreInVaultInstruction)`](../../doc/models/store-in-vault-instruction.md) | Optional | Defines how and when the payment source gets vaulted.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStoreInVault(): ?string | setStoreInVault(?string storeInVault): void |
|
||||
| `description` | `?string` | Optional | The description displayed to PayPal consumer on the approval flow for PayPal, as well as on the PayPal payment token management experience on PayPal.com.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | getDescription(): ?string | setDescription(?string description): void |
|
||||
| `usagePattern` | [`?string(PayPalPaymentTokenUsagePattern)`](../../doc/models/pay-pal-payment-token-usage-pattern.md) | Optional | Expected business/pricing model for the billing agreement.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `30` | getUsagePattern(): ?string | setUsagePattern(?string usagePattern): void |
|
||||
| `usageType` | [`string(PayPalPaymentTokenUsageType)`](../../doc/models/pay-pal-payment-token-usage-type.md) | Required | The usage type associated with the PayPal payment token.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getUsageType(): string | setUsageType(string usageType): void |
|
||||
| `customerType` | [`?string(PayPalPaymentTokenCustomerType)`](../../doc/models/pay-pal-payment-token-customer-type.md) | Optional | The customer type associated with the PayPal payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.<br>**Default**: `PayPalPaymentTokenCustomerType::CONSUMER`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getCustomerType(): ?string | setCustomerType(?string customerType): void |
|
||||
| `usagePattern` | [`?string(PaypalPaymentTokenUsagePattern)`](../../doc/models/paypal-payment-token-usage-pattern.md) | Optional | Expected business/pricing model for the billing agreement.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `30` | getUsagePattern(): ?string | setUsagePattern(?string usagePattern): void |
|
||||
| `usageType` | [`string(PaypalPaymentTokenUsageType)`](../../doc/models/paypal-payment-token-usage-type.md) | Required | The usage type associated with the PayPal payment token.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getUsageType(): string | setUsageType(string usageType): void |
|
||||
| `customerType` | [`?string(PaypalPaymentTokenCustomerType)`](../../doc/models/paypal-payment-token-customer-type.md) | Optional | The customer type associated with the PayPal payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.<br>**Default**: `PaypalPaymentTokenCustomerType::CONSUMER`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getCustomerType(): ?string | setCustomerType(?string customerType): void |
|
||||
| `permitMultiplePaymentTokens` | `?bool` | Optional | Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.<br>**Default**: `false` | getPermitMultiplePaymentTokens(): ?bool | setPermitMultiplePaymentTokens(?bool permitMultiplePaymentTokens): void |
|
||||
|
||||
## Example (as JSON)
|
||||
@@ -1,20 +1,20 @@
|
||||
|
||||
# Pay Pal Wallet Vault Response
|
||||
# Paypal Wallet Vault Response
|
||||
|
||||
The details about a saved PayPal Wallet payment source.
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletVaultResponse`
|
||||
`PaypalWalletVaultResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `id` | `?string` | Optional | The PayPal-generated ID for the saved payment source.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getId(): ?string | setId(?string id): void |
|
||||
| `status` | [`?string(PayPalWalletVaultStatus)`](../../doc/models/pay-pal-wallet-vault-status.md) | Optional | The vault status.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void |
|
||||
| `status` | [`?string(PaypalWalletVaultStatus)`](../../doc/models/paypal-wallet-vault-status.md) | Optional | The vault status.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related HATEOAS links.<br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getLinks(): ?array | setLinks(?array links): void |
|
||||
| `customer` | [`?PayPalWalletCustomer`](../../doc/models/pay-pal-wallet-customer.md) | Optional | The details about a customer in PayPal's system of record. | getCustomer(): ?PayPalWalletCustomer | setCustomer(?PayPalWalletCustomer customer): void |
|
||||
| `customer` | [`?PaypalWalletCustomer`](../../doc/models/paypal-wallet-customer.md) | Optional | The details about a customer in PayPal's system of record. | getCustomer(): ?PaypalWalletCustomer | setCustomer(?PaypalWalletCustomer customer): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Wallet Vault Status
|
||||
# Paypal Wallet Vault Status
|
||||
|
||||
The vault status.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PayPalWalletVaultStatus`
|
||||
`PaypalWalletVaultStatus`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Wallet
|
||||
# Paypal Wallet
|
||||
|
||||
A resource that identifies a PayPal Wallet is used for payment.
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWallet`
|
||||
`PaypalWallet`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -18,8 +18,8 @@ A resource that identifies a PayPal Wallet is used for payment.
|
||||
| `birthDate` | `?string` | Optional | The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard `date_time` type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.<br>**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `10`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])$` | getBirthDate(): ?string | setBirthDate(?string birthDate): void |
|
||||
| `taxInfo` | [`?TaxInfo`](../../doc/models/tax-info.md) | Optional | The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` are required. | getTaxInfo(): ?TaxInfo | setTaxInfo(?TaxInfo taxInfo): void |
|
||||
| `address` | [`?Address`](../../doc/models/address.md) | Optional | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getAddress(): ?Address | setAddress(?Address address): void |
|
||||
| `attributes` | [`?PayPalWalletAttributes`](../../doc/models/pay-pal-wallet-attributes.md) | Optional | Additional attributes associated with the use of this PayPal Wallet. | getAttributes(): ?PayPalWalletAttributes | setAttributes(?PayPalWalletAttributes attributes): void |
|
||||
| `experienceContext` | [`?PayPalWalletExperienceContext`](../../doc/models/pay-pal-wallet-experience-context.md) | Optional | Customizes the payer experience during the approval process for payment with PayPal.<blockquote><strong>Note:</strong> Partners and Marketplaces might configure <code>brand_name</code> and <code>shipping_preference</code> during partner account setup, which overrides the request values.</blockquote> | getExperienceContext(): ?PayPalWalletExperienceContext | setExperienceContext(?PayPalWalletExperienceContext experienceContext): void |
|
||||
| `attributes` | [`?PaypalWalletAttributes`](../../doc/models/paypal-wallet-attributes.md) | Optional | Additional attributes associated with the use of this PayPal Wallet. | getAttributes(): ?PaypalWalletAttributes | setAttributes(?PaypalWalletAttributes attributes): void |
|
||||
| `experienceContext` | [`?PaypalWalletExperienceContext`](../../doc/models/paypal-wallet-experience-context.md) | Optional | Customizes the payer experience during the approval process for payment with PayPal.<blockquote><strong>Note:</strong> Partners and Marketplaces might configure <code>brand_name</code> and <code>shipping_preference</code> during partner account setup, which overrides the request values.</blockquote> | getExperienceContext(): ?PaypalWalletExperienceContext | setExperienceContext(?PaypalWalletExperienceContext experienceContext): void |
|
||||
| `billingAgreementId` | `?string` | Optional | The PayPal billing agreement ID. References an approved recurring payment for goods or services.<br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `128`, *Pattern*: `^[a-zA-Z0-9-]+$` | getBillingAgreementId(): ?string | setBillingAgreementId(?string billingAgreementId): void |
|
||||
|
||||
## Example (as JSON)
|
||||
@@ -11,8 +11,8 @@ The processor response information for payment requests, such as direct credit c
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `avsCode` | [`?string(AVSCode)`](../../doc/models/avs-code.md) | Optional | The address verification code for Visa, Discover, Mastercard, or American Express transactions. | getAvsCode(): ?string | setAvsCode(?string avsCode): void |
|
||||
| `cvvCode` | [`?string(CVVCode)`](../../doc/models/cvv-code.md) | Optional | The card verification value code for for Visa, Discover, Mastercard, or American Express. | getCvvCode(): ?string | setCvvCode(?string cvvCode): void |
|
||||
| `avsCode` | [`?string(AvsCode)`](../../doc/models/avs-code.md) | Optional | The address verification code for Visa, Discover, Mastercard, or American Express transactions. | getAvsCode(): ?string | setAvsCode(?string avsCode): void |
|
||||
| `cvvCode` | [`?string(CvvCode)`](../../doc/models/cvv-code.md) | Optional | The card verification value code for for Visa, Discover, Mastercard, or American Express. | getCvvCode(): ?string | setCvvCode(?string cvvCode): void |
|
||||
| `responseCode` | [`?string(ProcessorResponseCode)`](../../doc/models/processor-response-code.md) | Optional | Processor response code for the non-PayPal payment processor errors. | getResponseCode(): ?string | setResponseCode(?string responseCode): void |
|
||||
| `paymentAdviceCode` | [`?string(PaymentAdviceCode)`](../../doc/models/payment-advice-code.md) | Optional | The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes. | getPaymentAdviceCode(): ?string | setPaymentAdviceCode(?string paymentAdviceCode): void |
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ The payment method to vault with the instrument details.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?SetupTokenRequestCard`](../../doc/models/setup-token-request-card.md) | Optional | A Resource representing a request to vault a Card. | getCard(): ?SetupTokenRequestCard | setCard(?SetupTokenRequestCard card): void |
|
||||
| `paypal` | [`?VaultPayPalWalletRequest`](../../doc/models/vault-pay-pal-wallet-request.md) | Optional | A resource representing a request to vault PayPal Wallet. | getPaypal(): ?VaultPayPalWalletRequest | setPaypal(?VaultPayPalWalletRequest paypal): void |
|
||||
| `paypal` | [`?VaultPaypalWalletRequest`](../../doc/models/vault-paypal-wallet-request.md) | Optional | A resource representing a request to vault PayPal Wallet. | getPaypal(): ?VaultPaypalWalletRequest | setPaypal(?VaultPaypalWalletRequest paypal): void |
|
||||
| `venmo` | [`?VaultVenmoRequest`](../../doc/models/vault-venmo-request.md) | Optional | - | getVenmo(): ?VaultVenmoRequest | setVenmo(?VaultVenmoRequest venmo): void |
|
||||
| `token` | [`?VaultTokenRequest`](../../doc/models/vault-token-request.md) | Optional | The Tokenized Payment Source representing a Request to Vault a Token. | getToken(): ?VaultTokenRequest | setToken(?VaultTokenRequest token): void |
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ The setup payment method details.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?SetupTokenResponseCard`](../../doc/models/setup-token-response-card.md) | Optional | - | getCard(): ?SetupTokenResponseCard | setCard(?SetupTokenResponseCard card): void |
|
||||
| `paypal` | [`?PayPalPaymentToken`](../../doc/models/pay-pal-payment-token.md) | Optional | - | getPaypal(): ?PayPalPaymentToken | setPaypal(?PayPalPaymentToken paypal): void |
|
||||
| `paypal` | [`?PaypalPaymentToken`](../../doc/models/paypal-payment-token.md) | Optional | - | getPaypal(): ?PaypalPaymentToken | setPaypal(?PaypalPaymentToken paypal): void |
|
||||
| `venmo` | [`?VenmoPaymentToken`](../../doc/models/venmo-payment-token.md) | Optional | - | getVenmo(): ?VenmoPaymentToken | setVenmo(?VenmoPaymentToken venmo): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -11,7 +11,7 @@ Results of 3D Secure Authentication.
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `authenticationStatus` | [`?string(PAResStatus)`](../../doc/models/pa-res-status.md) | Optional | Transactions status result identifier. The outcome of the issuer's authentication.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getAuthenticationStatus(): ?string | setAuthenticationStatus(?string authenticationStatus): void |
|
||||
| `authenticationStatus` | [`?string(PaResStatus)`](../../doc/models/pa-res-status.md) | Optional | Transactions status result identifier. The outcome of the issuer's authentication.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getAuthenticationStatus(): ?string | setAuthenticationStatus(?string authenticationStatus): void |
|
||||
| `enrollmentStatus` | [`?string(EnrollmentStatus)`](../../doc/models/enrollment-status.md) | Optional | Status of Authentication eligibility.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getEnrollmentStatus(): ?string | setEnrollmentStatus(?string enrollmentStatus): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -11,7 +11,7 @@ The Universal Product Code of the item.
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `type` | [`string(UPCType)`](../../doc/models/upc-type.md) | Required | The Universal Product Code type.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `5`, *Pattern*: `^[0-9A-Z_-]+$` | getType(): string | setType(string type): void |
|
||||
| `type` | [`string(UpcType)`](../../doc/models/upc-type.md) | Required | The Universal Product Code type.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `5`, *Pattern*: `^[0-9A-Z_-]+$` | getType(): string | setType(string type): void |
|
||||
| `code` | `string` | Required | The UPC product code of the item.<br>**Constraints**: *Minimum Length*: `6`, *Maximum Length*: `17`, *Pattern*: `^[0-9]{0,17}$` | getCode(): string | setCode(string code): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# UPC Type
|
||||
# Upc Type
|
||||
|
||||
The Universal Product Code type.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`UPCType`
|
||||
`UpcType`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Vault Pay Pal Wallet Request
|
||||
# Vault Paypal Wallet Request
|
||||
|
||||
A resource representing a request to vault PayPal Wallet.
|
||||
|
||||
## Structure
|
||||
|
||||
`VaultPayPalWalletRequest`
|
||||
`VaultPaypalWalletRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
Reference in New Issue
Block a user