forked from LiveCarta/PayPal-PHP-Server-SDK
Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
7d69e11899 | ||
|
|
4bc534dfec | ||
|
|
09148245f7 | ||
|
|
6b43a4225b |
22
LICENSE
22
LICENSE
@@ -1,35 +1,35 @@
|
||||
The PayPal Server SDK is released under the following license:
|
||||
|
||||
Copyright (c) 2024 PAYPAL, INC.
|
||||
Copyright (c) 2024 PAYPAL, INC.
|
||||
|
||||
SDK LICENSE
|
||||
SDK LICENSE
|
||||
|
||||
NOTICE TO USER: PayPal, Inc. is providing the Software and Documentation for use under the terms of this Agreement. Any use, reproduction, modification or distribution of the Software or Documentation, or any derivatives or portions hereof, constitutes your acceptance of this Agreement.
|
||||
As used in this Agreement, "PayPal" means PayPal, Inc. "Software" means the software code accompanying this agreement. "Documentation" means the documents, specifications and all other items accompanying this Agreement other than the Software.
|
||||
As used in this Agreement, "PayPal" means PayPal, Inc. "Software" means the software code accompanying this agreement. "Documentation" means the documents, specifications and all other items accompanying this Agreement other than the Software.
|
||||
|
||||
1. LICENSE GRANT
|
||||
1. LICENSE GRANT
|
||||
Subject to the terms of this Agreement, PayPal hereby grants you a non-exclusive, worldwide, royalty free license to use, reproduce, prepare derivative works from, publicly display, publicly perform, distribute and sublicense the Software for any purpose, other than perpetration of any fraud or violation of any law, statute, ordinance, or regulation (for example, those governing financial services, consumer protections, unfair competition, anti-discrimination or false advertising), provided the copyright notice below appears in a conspicuous location within the source code of the distributed Software and this license is distributed in the supporting documentation of the Software you distribute. Furthermore, you must comply with all third party licenses in order to use the third party software contained in the Software.
|
||||
Subject to the terms of this Agreement, PayPal hereby grants you a non-exclusive, worldwide, royalty free license to use, reproduce, publicly display, publicly perform, distribute and sublicense the Documentation for any purpose, other than perpetration of any fraud or violation of any law, statute, ordinance, or regulation (for example, those governing financial services, consumer protections, unfair competition, anti-discrimination or false advertising). You may not modify the Documentation.
|
||||
No title to the intellectual property in the Software or Documentation is transferred to you under the terms of this Agreement. You do not acquire any rights to the Software or the Documentation except as expressly set forth in this Agreement.
|
||||
Nothing in this Agreement provides you with any right, title, or license to use PayPal’s or any third party’s copyright, patent, trademark, trade secret, or other intellectual property rights, or rights of publicity or privacy, beyond the rights specifically granted herein. You may not infringe PayPal’s or any third party’s copyright, patent, trademark, trade secret, or other intellectual property rights, or rights of publicity or privacy.
|
||||
Nothing in this Agreement provides you with any right, title, or license to use PayPal’s or any third party’s copyright, patent, trademark, trade secret, or other intellectual property rights, or rights of publicity or privacy, beyond the rights specifically granted herein. You may not infringe PayPal’s or any third party’s copyright, patent, trademark, trade secret, or other intellectual property rights, or rights of publicity or privacy.
|
||||
If you choose to distribute the Software in a commercial product, you do so with the understanding that you agree to defend, indemnify and hold harmless PayPal and its suppliers against any losses, damages and costs arising from the claims, lawsuits or other legal actions arising out of such distribution. You may distribute the Software in object code form under your own license, provided that your license agreement:
|
||||
(a) complies with the terms and conditions of this license agreement;
|
||||
(a) complies with the terms and conditions of this license agreement;
|
||||
(b) effectively disclaims all warranties and conditions, express or implied, on behalf of PayPal;
|
||||
(c) effectively excludes all liability for damages on behalf of PayPal;
|
||||
(d) states that any provisions that differ from this Agreement are offered by you alone and not PayPal; and
|
||||
(e) states that the Software is available from you or PayPal and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
|
||||
(e) states that the Software is available from you or PayPal and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
|
||||
|
||||
2. DISCLAIMER OF WARRANTY
|
||||
PAYPAL LICENSES THE SOFTWARE AND DOCUMENTATION TO YOU ONLY ON AN "AS IS" BASIS WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. PAYPAL MAKES NO WARRANTY THAT THE SOFTWARE OR DOCUMENTATION WILL BE ERROR-FREE. Each user of the Software or Documentation is solely responsible for determining the appropriateness of using and distributing the Software and Documentation and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs, or equipment, and unavailability or interruption of operations. Use of the Software and Documentation is made with the understanding that PayPal will not provide you with any technical or customer support or maintenance. Some states or jurisdictions do not allow the exclusion of implied warranties or limitations on how long an implied warranty may last, so the above limitations may not apply to you. To the extent permissible, any implied warranties are limited to ninety (90) days.
|
||||
|
||||
3. LIMITATION OF LIABILITY
|
||||
PAYPAL AND ITS SUPPLIERS SHALL NOT BE LIABLE FOR LOSS OR DAMAGE ARISING OUT OF THIS AGREEMENT OR FROM THE USE OF THE SOFTWARE OR DOCUMENTATION. IN NO EVENT WILL PAYPAL OR ITS SUPPLIERS BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, INCIDENTAL, OR SPECIAL DAMAGES INCLUDING LOST PROFITS, LOST SAVINGS, COSTS, FEES, OR EXPENSES OF ANY KIND ARISING OUT OF ANY PROVISION OF THIS AGREEMENT OR THE USE OR THE INABILITY TO USE THE SOFTWARE OR DOCUMENTATION, HOWEVER CAUSED AND UNDER ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR TORT INCLUDING NEGLIGENCE (OR OTHERWISE), EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. PAYPAL'S AGGREGATE LIABILITY AND THAT OF ITS SUPPLIERS UNDER OR IN CONNECTION WITH THIS AGREEMENT SHALL BE LIMITED TO THE AMOUNT PAID BY YOU FOR THE SOFTWARE AND DOCUMENTATION.
|
||||
PAYPAL AND ITS SUPPLIERS SHALL NOT BE LIABLE FOR LOSS OR DAMAGE ARISING OUT OF THIS AGREEMENT OR FROM THE USE OF THE SOFTWARE OR DOCUMENTATION. IN NO EVENT WILL PAYPAL OR ITS SUPPLIERS BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, INCIDENTAL, OR SPECIAL DAMAGES INCLUDING LOST PROFITS, LOST SAVINGS, COSTS, FEES, OR EXPENSES OF ANY KIND ARISING OUT OF ANY PROVISION OF THIS AGREEMENT OR THE USE OR THE INABILITY TO USE THE SOFTWARE OR DOCUMENTATION, HOWEVER CAUSED AND UNDER ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR TORT INCLUDING NEGLIGENCE (OR OTHERWISE), EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. PAYPAL'S AGGREGATE LIABILITY AND THAT OF ITS SUPPLIERS UNDER OR IN CONNECTION WITH THIS AGREEMENT SHALL BE LIMITED TO THE AMOUNT PAID BY YOU FOR THE SOFTWARE AND DOCUMENTATION.
|
||||
|
||||
4. TRADEMARK USAGE
|
||||
PayPal is a trademark PayPal, Inc. in the United States and other countries. Such trademarks may not be used to endorse or promote any product unless expressly permitted under separate agreement with PayPal.
|
||||
PayPal is a trademark PayPal, Inc. in the United States and other countries. Such trademarks may not be used to endorse or promote any product unless expressly permitted under separate agreement with PayPal.
|
||||
|
||||
5. TERM
|
||||
Your rights under this Agreement shall terminate if you fail to comply with any of the material terms or conditions of this Agreement and do not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all your rights under this Agreement terminate, you agree to cease use and distribution of the Software and Documentation as soon as reasonably practicable.
|
||||
Your rights under this Agreement shall terminate if you fail to comply with any of the material terms or conditions of this Agreement and do not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all your rights under this Agreement terminate, you agree to cease use and distribution of the Software and Documentation as soon as reasonably practicable.
|
||||
|
||||
6. GOVERNING LAW AND JURISDICTION.
|
||||
6. GOVERNING LAW AND JURISDICTION.
|
||||
This Agreement is governed by the statutes and laws of the State of California, without regard to the conflicts of law principles thereof. If any part of this Agreement is found void and unenforceable, it will not affect the validity of the balance of the Agreement, which shall remain valid and enforceable according to its terms. Any dispute arising out of or related to this Agreement shall be brought in the courts of Santa Clara County, California, USA.
|
||||
51
README.md
51
README.md
@@ -1,9 +1,24 @@
|
||||
|
||||
# Getting Started with paypal server sdk
|
||||
# Getting Started with PayPal Server SDK
|
||||
|
||||
## Introduction
|
||||
|
||||
An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders., Call the Payments API to authorize payments, capture authorized payments, refund payments that have already been captured, and show payment information. Use the Payments API in conjunction with the <a href="/docs/api/orders/v2/">Orders API</a>. For more information, see the <a href="/docs/checkout/">PayPal Checkout Overview</a>., The Payment Method Tokens API saves payment methods so payers don't have to enter details for future transactions. Payers can check out faster or pay without being present after they agree to save a payment method.<br><br>The API associates a payment method with a temporary setup token. Pass the setup token to the API to exchange the setup token for a permanent token.<br><br>The permanent token represents a payment method that's saved to the vault. This token can be used repeatedly for checkout or recurring transactions such as subscriptions.<br><br>The Payment Method Tokens API is available in the US only.
|
||||
### ⚠️ Beta Release Notice
|
||||
|
||||
This version is considered a **beta release**. While we have done our best to ensure stability and functionality, there may still be bugs, incomplete features, or breaking changes in future updates.
|
||||
|
||||
#### Important Notes
|
||||
|
||||
- **Available Features:** This SDK currently contains only 3 of PayPal's API endpoints. Additional endpoints and functionality will be added in the future.
|
||||
- **API Changes:** Expect potential changes in APIs and features as we finalize the product.
|
||||
|
||||
### Information
|
||||
|
||||
The PayPal Server SDK provides integration access to the PayPal REST APIs. The API endpoints are divided into distinct controllers:
|
||||
|
||||
- Orders Controller: <a href="https://developer.paypal.com/docs/api/orders/v2/">Orders API v2</a>
|
||||
- Payments Controller: <a href="https://developer.paypal.com/docs/api/payments/v2/">Payments API v2</a>
|
||||
- Vault Controller: <a href="https://developer.paypal.com/docs/api/payment-tokens/v3/">Payment Method Tokens API v3</a> *Available in the US only.*
|
||||
|
||||
Find out more here: [https://developer.paypal.com/docs/api/orders/v2/](https://developer.paypal.com/docs/api/orders/v2/)
|
||||
|
||||
@@ -12,23 +27,23 @@ Find out more here: [https://developer.paypal.com/docs/api/orders/v2/](https://d
|
||||
Run the following command to install the package and automatically add the dependency to your composer.json file:
|
||||
|
||||
```php
|
||||
composer require "paypal/paypal-server-sdk:0.5.0"
|
||||
composer require "paypal/paypal-server-sdk:0.6.0"
|
||||
```
|
||||
|
||||
Or add it to the composer.json file manually as given below:
|
||||
|
||||
```php
|
||||
"require": {
|
||||
"paypal/paypal-server-sdk": "0.5.0"
|
||||
"paypal/paypal-server-sdk": "0.6.0"
|
||||
}
|
||||
```
|
||||
|
||||
You can also view the package at:
|
||||
https://packagist.org/packages/paypal/paypal-server-sdk#0.5.0
|
||||
https://packagist.org/packages/paypal/paypal-server-sdk#0.6.0
|
||||
|
||||
## Initialize the API Client
|
||||
|
||||
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.0/doc/client.md)
|
||||
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/client.md)
|
||||
|
||||
The following parameters are configurable for the API Client:
|
||||
|
||||
@@ -44,8 +59,8 @@ The following parameters are configurable for the API Client:
|
||||
| `retryOnTimeout` | `bool` | Whether to retry on request timeout.<br>*Default*: `true` |
|
||||
| `httpStatusCodesToRetry` | `array` | Http status codes to retry against.<br>*Default*: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524` |
|
||||
| `httpMethodsToRetry` | `array` | Http methods to retry against.<br>*Default*: `'GET', 'PUT'` |
|
||||
| `loggingConfiguration` | [`LoggingConfigurationBuilder`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.0/doc/logging-configuration-builder.md) | Represents the logging configurations for API calls |
|
||||
| `clientCredentialsAuth` | [`ClientCredentialsAuth`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.0/doc/auth/oauth-2-client-credentials-grant.md) | The Credentials Setter for OAuth 2 Client Credentials Grant |
|
||||
| `loggingConfiguration` | [`LoggingConfigurationBuilder`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/logging-configuration-builder.md) | Represents the logging configurations for API calls |
|
||||
| `clientCredentialsAuth` | [`ClientCredentialsAuth`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/auth/oauth-2-client-credentials-grant.md) | The Credentials Setter for OAuth 2 Client Credentials Grant |
|
||||
|
||||
The API client can be initialized as follows:
|
||||
|
||||
@@ -90,20 +105,20 @@ The SDK can be configured to use a different environment for making API calls. A
|
||||
|
||||
This API uses the following authentication schemes.
|
||||
|
||||
* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.0/doc/auth/oauth-2-client-credentials-grant.md)
|
||||
* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/auth/oauth-2-client-credentials-grant.md)
|
||||
|
||||
## List of APIs
|
||||
|
||||
* [Orders](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.0/doc/controllers/orders.md)
|
||||
* [Payments](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.0/doc/controllers/payments.md)
|
||||
* [Vault](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.0/doc/controllers/vault.md)
|
||||
* [Orders](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/controllers/orders.md)
|
||||
* [Payments](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/controllers/payments.md)
|
||||
* [Vault](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/controllers/vault.md)
|
||||
|
||||
## Classes Documentation
|
||||
|
||||
* [ApiException](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.0/doc/api-exception.md)
|
||||
* [HttpRequest](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.0/doc/http-request.md)
|
||||
* [HttpResponse](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.0/doc/http-response.md)
|
||||
* [LoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.0/doc/logging-configuration-builder.md)
|
||||
* [RequestLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.0/doc/request-logging-configuration-builder.md)
|
||||
* [ResponseLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.0/doc/response-logging-configuration-builder.md)
|
||||
* [ApiException](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/api-exception.md)
|
||||
* [HttpRequest](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/http-request.md)
|
||||
* [HttpResponse](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/http-response.md)
|
||||
* [LoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/logging-configuration-builder.md)
|
||||
* [RequestLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/request-logging-configuration-builder.md)
|
||||
* [ResponseLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/response-logging-configuration-builder.md)
|
||||
|
||||
|
||||
@@ -46,7 +46,7 @@ API calls return an `ApiResponse` object that includes the following fields:
|
||||
| `getHeaders` | Headers of the HTTP response as a Hash |
|
||||
| `getResult` | The deserialized body of the HTTP response as a String |
|
||||
|
||||
## paypal server sdk Client
|
||||
## PayPal Server SDK Client
|
||||
|
||||
The gateway for the SDK. This class acts as a factory for the Controllers and also holds the configuration of the SDK.
|
||||
|
||||
|
||||
@@ -12,16 +12,110 @@ $ordersController = $client->getOrdersController();
|
||||
|
||||
## Methods
|
||||
|
||||
* [Orders Create](../../doc/controllers/orders.md#orders-create)
|
||||
* [Orders Get](../../doc/controllers/orders.md#orders-get)
|
||||
* [Orders Patch](../../doc/controllers/orders.md#orders-patch)
|
||||
* [Orders Confirm](../../doc/controllers/orders.md#orders-confirm)
|
||||
* [Orders Authorize](../../doc/controllers/orders.md#orders-authorize)
|
||||
* [Orders Capture](../../doc/controllers/orders.md#orders-capture)
|
||||
* [Orders Track Create](../../doc/controllers/orders.md#orders-track-create)
|
||||
* [Orders Create](../../doc/controllers/orders.md#orders-create)
|
||||
* [Orders Patch](../../doc/controllers/orders.md#orders-patch)
|
||||
* [Orders Capture](../../doc/controllers/orders.md#orders-capture)
|
||||
* [Orders Get](../../doc/controllers/orders.md#orders-get)
|
||||
* [Orders Confirm](../../doc/controllers/orders.md#orders-confirm)
|
||||
* [Orders Trackers Patch](../../doc/controllers/orders.md#orders-trackers-patch)
|
||||
|
||||
|
||||
# Orders Authorize
|
||||
|
||||
Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#authorize-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersAuthorize(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which to authorize.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=,-]*$` |
|
||||
| `paypalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
| `body` | [`?OrderAuthorizeRequest`](../../doc/models/order-authorize-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`OrderAuthorizeResponse`](../../doc/models/order-authorize-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersAuthorize($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The authorized payment failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Track Create
|
||||
|
||||
Adds tracking information for an Order.
|
||||
|
||||
```php
|
||||
function ordersTrackCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order that the tracking information is associated with.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `body` | [`OrderTrackerRequest`](../../doc/models/order-tracker-request.md) | Body, Required | - |
|
||||
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'body' => OrderTrackerRequestBuilder::init(
|
||||
'capture_id8'
|
||||
)
|
||||
->notifyPayer(false)
|
||||
->build()
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersTrackCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Create
|
||||
|
||||
Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see <a href="https://developer.paypal.com/docs/checkout/advanced/processing/">checkout</a> or <a href="https://developer.paypal.com/docs/multiparty/checkout/advanced/processing/">multiparty checkout</a>.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#create-order">Orders v2 errors</a>.</blockquote>
|
||||
@@ -35,9 +129,9 @@ function ordersCreate(array $options): ApiResponse
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `body` | [`OrderRequest`](../../doc/models/order-request.md) | Body, Required | - |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` |
|
||||
| `payPalPartnerAttributionId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `payPalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` |
|
||||
| `paypalPartnerAttributionId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `paypalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=,-]*$` |
|
||||
|
||||
## Response Type
|
||||
@@ -75,44 +169,6 @@ $apiResponse = $ordersController->ordersCreate($collect);
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Get
|
||||
|
||||
Shows details for an order, by ID.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#get-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersGet(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which to show details.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `fields` | `?string` | Query, Optional | A comma-separated list of fields that should be returned for the order. Valid filter field is `payment_source`.<br>**Constraints**: *Pattern*: `^[a-z_]*$` |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersGet($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Patch
|
||||
|
||||
Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the `COMPLETED` status.<br/><br/>To make an update, you must provide a `reference_id`. If you omit this value with an order that contains only one purchase unit, PayPal sets the value to `default` which enables you to use the path: <code>\"/purchase_units/@reference_id=='default'/{attribute-or-object}\"</code>. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see <a href="https://developer.paypal.com/docs/checkout/advanced/processing/">checkout</a> or <a href="https://developer.paypal.com/docs/multiparty/checkout/advanced/processing/">multiparty checkout</a>.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#patch-order">Orders v2 errors</a>.</blockquote>Patchable attributes or objects:<br/><br/><table><thead><th>Attribute</th><th>Op</th><th>Notes</th></thead><tbody><tr><td><code>intent</code></td><td>replace</td><td></td></tr><tr><td><code>payer</code></td><td>replace, add</td><td>Using replace op for <code>payer</code> will replace the whole <code>payer</code> object with the value sent in request.</td></tr><tr><td><code>purchase_units</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].custom_id</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].description</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].payee.email</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].shipping.name</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.email_address</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.phone_number</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.options</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.address</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.type</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].soft_descriptor</code></td><td>replace, remove</td><td></td></tr><tr><td><code>purchase_units[].amount</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].items</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].invoice_id</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].payment_instruction</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].payment_instruction.disbursement_mode</code></td><td>replace</td><td>By default, <code>disbursement_mode</code> is <code>INSTANT</code>.</td></tr><tr><td><code>purchase_units[].payment_instruction.payee_receivable_fx_rate_id</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].payment_instruction.platform_fees</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].supplementary_data.airline</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].supplementary_data.card</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>application_context.client_configuration</code></td><td>replace, add</td><td></td></tr></tbody></table>
|
||||
@@ -158,101 +214,6 @@ $apiResponse = $ordersController->ordersPatch($collect);
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Confirm
|
||||
|
||||
Payer confirms their intent to pay for the the Order with the given payment source.
|
||||
|
||||
```php
|
||||
function ordersConfirm(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which the payer confirms their intent to pay.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `payPalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=]*$` |
|
||||
| `body` | [`?ConfirmOrderRequest`](../../doc/models/confirm-order-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'prefer' => 'return=minimal',
|
||||
'body' => ConfirmOrderRequestBuilder::init(
|
||||
PaymentSourceBuilder::init()->build()
|
||||
)
|
||||
->processingInstruction(ProcessingInstruction::NO_INSTRUCTION)
|
||||
->build()
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersConfirm($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Authorize
|
||||
|
||||
Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#authorize-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersAuthorize(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which to authorize.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=,-]*$` |
|
||||
| `payPalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
| `body` | [`?OrderAuthorizeRequest`](../../doc/models/order-authorize-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`OrderAuthorizeResponse`](../../doc/models/order-authorize-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersAuthorize($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The authorized payment failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Capture
|
||||
|
||||
Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#capture-order">Orders v2 errors</a>.</blockquote>
|
||||
@@ -266,10 +227,10 @@ function ordersCapture(array $options): ApiResponse
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which to capture a payment.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` |
|
||||
| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=,-]*$` |
|
||||
| `payPalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
| `paypalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
| `body` | [`?OrderCaptureRequest`](../../doc/models/order-capture-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
@@ -300,21 +261,60 @@ $apiResponse = $ordersController->ordersCapture($collect);
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Track Create
|
||||
# Orders Get
|
||||
|
||||
Adds tracking information for an Order.
|
||||
Shows details for an order, by ID.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#get-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersTrackCreate(array $options): ApiResponse
|
||||
function ordersGet(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order that the tracking information is associated with.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `body` | [`OrderTrackerRequest`](../../doc/models/order-tracker-request.md) | Body, Required | - |
|
||||
| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which to show details.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `fields` | `?string` | Query, Optional | A comma-separated list of fields that should be returned for the order. Valid filter field is `payment_source`.<br>**Constraints**: *Pattern*: `^[a-z_]*$` |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersGet($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Confirm
|
||||
|
||||
Payer confirms their intent to pay for the the Order with the given payment source.
|
||||
|
||||
```php
|
||||
function ordersConfirm(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which the payer confirms their intent to pay.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `paypalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=]*$` |
|
||||
| `body` | [`?ConfirmOrderRequest`](../../doc/models/confirm-order-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
@@ -325,14 +325,15 @@ This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getR
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'body' => OrderTrackerRequestBuilder::init(
|
||||
'capture_id8'
|
||||
'prefer' => 'return=minimal',
|
||||
'body' => ConfirmOrderRequestBuilder::init(
|
||||
PaymentSourceBuilder::init()->build()
|
||||
)
|
||||
->notifyPayer(false)
|
||||
->processingInstruction(ProcessingInstruction::NO_INSTRUCTION)
|
||||
->build()
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersTrackCreate($collect);
|
||||
$apiResponse = $ordersController->ordersConfirm($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
@@ -341,7 +342,6 @@ $apiResponse = $ordersController->ordersTrackCreate($collect);
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
@@ -14,8 +14,8 @@ $paymentsController = $client->getPaymentsController();
|
||||
|
||||
* [Authorizations Get](../../doc/controllers/payments.md#authorizations-get)
|
||||
* [Authorizations Capture](../../doc/controllers/payments.md#authorizations-capture)
|
||||
* [Authorizations Reauthorize](../../doc/controllers/payments.md#authorizations-reauthorize)
|
||||
* [Authorizations Void](../../doc/controllers/payments.md#authorizations-void)
|
||||
* [Authorizations Reauthorize](../../doc/controllers/payments.md#authorizations-reauthorize)
|
||||
* [Captures Get](../../doc/controllers/payments.md#captures-get)
|
||||
* [Captures Refund](../../doc/controllers/payments.md#captures-refund)
|
||||
* [Refunds Get](../../doc/controllers/payments.md#refunds-get)
|
||||
@@ -71,7 +71,7 @@ function authorizationsCapture(array $options): ApiResponse
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to capture. |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
|
||||
| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
|
||||
| `body` | [`?CaptureRequest`](../../doc/models/capture-request.md) | Body, Optional | - |
|
||||
|
||||
@@ -107,51 +107,6 @@ $apiResponse = $paymentsController->authorizationsCapture($collect);
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Authorizations Reauthorize
|
||||
|
||||
Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires.<br/><br/>If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment.<br/><br/>A reauthorized payment itself has a new honor period of three days.<br/><br/>You can reauthorize an authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on context and geography, for example in US it is up to 115% of the original authorized amount, not to exceed an increase of $75 USD.<br/><br/>Supports only the `amount` request parameter.<blockquote><strong>Note:</strong> This request is currently not supported for Partner use cases.</blockquote>
|
||||
|
||||
```php
|
||||
function authorizationsReauthorize(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to reauthorize. |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
|
||||
| `body` | [`?ReauthorizeRequest`](../../doc/models/reauthorize-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentAuthorization`](../../doc/models/payment-authorization.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'authorizationId' => 'authorization_id8',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $paymentsController->authorizationsReauthorize($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The request failed because it either is semantically incorrect or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | The request failed because an internal server error occurred. | `ApiException` |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Authorizations Void
|
||||
|
||||
Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured.
|
||||
@@ -165,7 +120,7 @@ function authorizationsVoid(array $options): ApiResponse
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to void. |
|
||||
| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion).<blockquote><strong>Note:</strong>For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.</blockquote> |
|
||||
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion).<blockquote><strong>Note:</strong>For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.</blockquote> |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
|
||||
|
||||
## Response Type
|
||||
@@ -197,6 +152,51 @@ $apiResponse = $paymentsController->authorizationsVoid($collect);
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Authorizations Reauthorize
|
||||
|
||||
Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires.<br/><br/>If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment.<br/><br/>A reauthorized payment itself has a new honor period of three days.<br/><br/>You can reauthorize an authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on context and geography, for example in US it is up to 115% of the original authorized amount, not to exceed an increase of $75 USD.<br/><br/>Supports only the `amount` request parameter.<blockquote><strong>Note:</strong> This request is currently not supported for Partner use cases.</blockquote>
|
||||
|
||||
```php
|
||||
function authorizationsReauthorize(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to reauthorize. |
|
||||
| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
|
||||
| `body` | [`?ReauthorizeRequest`](../../doc/models/reauthorize-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentAuthorization`](../../doc/models/payment-authorization.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'authorizationId' => 'authorization_id8',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $paymentsController->authorizationsReauthorize($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The request failed because it either is semantically incorrect or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | The request failed because an internal server error occurred. | `ApiException` |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Captures Get
|
||||
|
||||
Shows details for a captured payment, by ID.
|
||||
@@ -247,9 +247,9 @@ function capturesRefund(array $options): ApiResponse
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `captureId` | `string` | Template, Required | The PayPal-generated ID for the captured payment to refund. |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
|
||||
| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
|
||||
| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion).<blockquote><strong>Note:</strong>For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.</blockquote> |
|
||||
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion).<blockquote><strong>Note:</strong>For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.</blockquote> |
|
||||
| `body` | [`?RefundRequest`](../../doc/models/refund-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
@@ -12,57 +12,14 @@ $vaultController = $client->getVaultController();
|
||||
|
||||
## Methods
|
||||
|
||||
* [Payment-Tokens Create](../../doc/controllers/vault.md#payment-tokens-create)
|
||||
* [Customer Payment-Tokens Get](../../doc/controllers/vault.md#customer-payment-tokens-get)
|
||||
* [Payment-Tokens Get](../../doc/controllers/vault.md#payment-tokens-get)
|
||||
* [Payment-Tokens Delete](../../doc/controllers/vault.md#payment-tokens-delete)
|
||||
* [Payment-Tokens Create](../../doc/controllers/vault.md#payment-tokens-create)
|
||||
* [Setup-Tokens Create](../../doc/controllers/vault.md#setup-tokens-create)
|
||||
* [Payment-Tokens Delete](../../doc/controllers/vault.md#payment-tokens-delete)
|
||||
* [Setup-Tokens Get](../../doc/controllers/vault.md#setup-tokens-get)
|
||||
|
||||
|
||||
# Payment-Tokens Create
|
||||
|
||||
Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.
|
||||
|
||||
```php
|
||||
function paymentTokensCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `payPalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
|
||||
| `body` | [`PaymentTokenRequest`](../../doc/models/payment-token-request.md) | Body, Required | Payment Token creation with a financial instrument and an optional customer_id. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentTokenResponse`](../../doc/models/payment-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'payPalRequestId' => 'PayPal-Request-Id6',
|
||||
'body' => PaymentTokenRequestBuilder::init(
|
||||
PaymentTokenRequestPaymentSourceBuilder::init()->build()
|
||||
)->build()
|
||||
];
|
||||
|
||||
$apiResponse = $vaultController->paymentTokensCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | Request contains reference to resources that do not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Customer Payment-Tokens Get
|
||||
|
||||
Returns all payment tokens for a customer.
|
||||
@@ -142,6 +99,91 @@ $apiResponse = $vaultController->paymentTokensGet($id);
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Payment-Tokens Create
|
||||
|
||||
Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.
|
||||
|
||||
```php
|
||||
function paymentTokensCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `paypalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
|
||||
| `body` | [`PaymentTokenRequest`](../../doc/models/payment-token-request.md) | Body, Required | Payment Token creation with a financial instrument and an optional customer_id. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentTokenResponse`](../../doc/models/payment-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'paypalRequestId' => 'PayPal-Request-Id6',
|
||||
'body' => PaymentTokenRequestBuilder::init(
|
||||
PaymentTokenRequestPaymentSourceBuilder::init()->build()
|
||||
)->build()
|
||||
];
|
||||
|
||||
$apiResponse = $vaultController->paymentTokensCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | Request contains reference to resources that do not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Setup-Tokens Create
|
||||
|
||||
Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer.
|
||||
|
||||
```php
|
||||
function setupTokensCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `paypalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
|
||||
| `body` | [`SetupTokenRequest`](../../doc/models/setup-token-request.md) | Body, Required | Setup Token creation with a instrument type optional financial instrument details and customer_id. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`SetupTokenResponse`](../../doc/models/setup-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'paypalRequestId' => 'PayPal-Request-Id6',
|
||||
'body' => SetupTokenRequestBuilder::init(
|
||||
SetupTokenRequestPaymentSourceBuilder::init()->build()
|
||||
)->build()
|
||||
];
|
||||
|
||||
$apiResponse = $vaultController->setupTokensCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Payment-Tokens Delete
|
||||
|
||||
Delete the payment token associated with the payment token id.
|
||||
@@ -177,48 +219,6 @@ $apiResponse = $vaultController->paymentTokensDelete($id);
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Setup-Tokens Create
|
||||
|
||||
Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer.
|
||||
|
||||
```php
|
||||
function setupTokensCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `payPalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
|
||||
| `body` | [`SetupTokenRequest`](../../doc/models/setup-token-request.md) | Body, Required | Setup Token creation with a instrument type optional financial instrument details and customer_id. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`SetupTokenResponse`](../../doc/models/setup-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'payPalRequestId' => 'PayPal-Request-Id6',
|
||||
'body' => SetupTokenRequestBuilder::init(
|
||||
SetupTokenRequestPaymentSourceBuilder::init()->build()
|
||||
)->build()
|
||||
];
|
||||
|
||||
$apiResponse = $vaultController->setupTokensCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Setup-Tokens Get
|
||||
|
||||
Returns a readable representation of temporarily vaulted payment source associated with the setup token id.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -23,6 +23,119 @@ use PaypalServerSdkLib\Models\OrderAuthorizeResponse;
|
||||
|
||||
class OrdersController extends BaseController
|
||||
{
|
||||
/**
|
||||
* Authorizes payment for an order. To successfully authorize payment for an order, the buyer must
|
||||
* first approve the order or a valid payment_source must be provided in the request. A buyer can
|
||||
* approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS
|
||||
* links in the create order response.<blockquote><strong>Note:</strong> For error handling and
|
||||
* troubleshooting, see <a href="https://developer.paypal.
|
||||
* com/api/rest/reference/orders/v2/errors/#authorize-order">Orders v2 errors</a>.</blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersAuthorize(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/authorize')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init(
|
||||
'The authorized payment failed due to insufficient permissions.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The requested action could not be performed, semantically incorrect, or fa' .
|
||||
'iled business validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(OrderAuthorizeResponse::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds tracking information for an Order.
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersTrackCreate(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/track')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
BodyParam::init($options)->extract('body'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The requested action could not be performed, semantically incorrect, or fa' .
|
||||
'iled business validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(Order::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and
|
||||
* payment processing costs. For more information about processing payments, see <a href="https:
|
||||
@@ -43,9 +156,9 @@ class OrdersController extends BaseController
|
||||
->parameters(
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
BodyParam::init($options)->extract('body'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('PayPal-Partner-Attribution-Id', $options)->extract('payPalPartnerAttributionId'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('PayPal-Partner-Attribution-Id', $options)->extract('paypalPartnerAttributionId'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal')
|
||||
);
|
||||
|
||||
@@ -80,41 +193,6 @@ class OrdersController extends BaseController
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Shows details for an order, by ID.<blockquote><strong>Note:</strong> For error handling and
|
||||
* troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#get-
|
||||
* order">Orders v2 errors</a>.</blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersGet(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/checkout/orders/{id}')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
QueryParam::init('fields', $options)->extract('fields')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(Order::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the
|
||||
* `COMPLETED` status.<br/><br/>To make an update, you must provide a `reference_id`. If you omit this
|
||||
@@ -201,122 +279,6 @@ class OrdersController extends BaseController
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Payer confirms their intent to pay for the the Order with the given payment source.
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersConfirm(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(
|
||||
RequestMethod::POST,
|
||||
'/v2/checkout/orders/{id}/confirm-payment-source'
|
||||
)
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The requested action could not be performed, semantically incorrect, or fa' .
|
||||
'iled business validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(Order::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Authorizes payment for an order. To successfully authorize payment for an order, the buyer must
|
||||
* first approve the order or a valid payment_source must be provided in the request. A buyer can
|
||||
* approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS
|
||||
* links in the create order response.<blockquote><strong>Note:</strong> For error handling and
|
||||
* troubleshooting, see <a href="https://developer.paypal.
|
||||
* com/api/rest/reference/orders/v2/errors/#authorize-order">Orders v2 errors</a>.</blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersAuthorize(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/authorize')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init(
|
||||
'The authorized payment failed due to insufficient permissions.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The requested action could not be performed, semantically incorrect, or fa' .
|
||||
'iled business validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(OrderAuthorizeResponse::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Captures payment for an order. To successfully capture payment for an order, the buyer must first
|
||||
* approve the order or a valid payment_source must be provided in the request. A buyer can approve the
|
||||
@@ -336,10 +298,10 @@ class OrdersController extends BaseController
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
@@ -384,21 +346,60 @@ class OrdersController extends BaseController
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds tracking information for an Order.
|
||||
* Shows details for an order, by ID.<blockquote><strong>Note:</strong> For error handling and
|
||||
* troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#get-
|
||||
* order">Orders v2 errors</a>.</blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersTrackCreate(array $options): ApiResponse
|
||||
public function ordersGet(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/track')
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/checkout/orders/{id}')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
QueryParam::init('fields', $options)->extract('fields')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(Order::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Payer confirms their intent to pay for the the Order with the given payment source.
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersConfirm(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(
|
||||
RequestMethod::POST,
|
||||
'/v2/checkout/orders/{id}/confirm-payment-source'
|
||||
)
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
BodyParam::init($options)->extract('body'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion')
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
@@ -413,7 +414,6 @@ class OrdersController extends BaseController
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
|
||||
@@ -81,7 +81,7 @@ class PaymentsController extends BaseController
|
||||
->parameters(
|
||||
TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
@@ -136,82 +136,6 @@ class PaymentsController extends BaseController
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available,
|
||||
* reauthorize a payment after its initial three-day honor period expires. Within the 29-day
|
||||
* authorization period, you can issue multiple re-authorizations after the honor period expires.
|
||||
* <br/><br/>If 30 days have transpired since the date of the original authorization, you must create
|
||||
* an authorized payment instead of reauthorizing the original authorized payment.<br/><br/>A
|
||||
* reauthorized payment itself has a new honor period of three days.<br/><br/>You can reauthorize an
|
||||
* authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on
|
||||
* context and geography, for example in US it is up to 115% of the original authorized amount, not to
|
||||
* exceed an increase of $75 USD.<br/><br/>Supports only the `amount` request parameter.
|
||||
* <blockquote><strong>Note:</strong> This request is currently not supported for Partner use cases.
|
||||
* </blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function authorizationsReauthorize(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(
|
||||
RequestMethod::POST,
|
||||
'/v2/payments/authorizations/{authorization_id}/reauthorize'
|
||||
)
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'The request failed because it is not well-formed or is syntactically incor' .
|
||||
'rect or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init(
|
||||
'The request failed because the caller has insufficient permissions.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'404',
|
||||
ErrorType::init('The request failed because the resource does not exist.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The request failed because it either is semantically incorrect or failed b' .
|
||||
'usiness validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('The request failed because an internal server error occurred.'))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(PaymentAuthorization::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been
|
||||
* fully captured.
|
||||
@@ -229,7 +153,7 @@ class PaymentsController extends BaseController
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal')
|
||||
);
|
||||
|
||||
@@ -285,6 +209,82 @@ class PaymentsController extends BaseController
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available,
|
||||
* reauthorize a payment after its initial three-day honor period expires. Within the 29-day
|
||||
* authorization period, you can issue multiple re-authorizations after the honor period expires.
|
||||
* <br/><br/>If 30 days have transpired since the date of the original authorization, you must create
|
||||
* an authorized payment instead of reauthorizing the original authorized payment.<br/><br/>A
|
||||
* reauthorized payment itself has a new honor period of three days.<br/><br/>You can reauthorize an
|
||||
* authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on
|
||||
* context and geography, for example in US it is up to 115% of the original authorized amount, not to
|
||||
* exceed an increase of $75 USD.<br/><br/>Supports only the `amount` request parameter.
|
||||
* <blockquote><strong>Note:</strong> This request is currently not supported for Partner use cases.
|
||||
* </blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function authorizationsReauthorize(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(
|
||||
RequestMethod::POST,
|
||||
'/v2/payments/authorizations/{authorization_id}/reauthorize'
|
||||
)
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'The request failed because it is not well-formed or is syntactically incor' .
|
||||
'rect or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init(
|
||||
'The request failed because the caller has insufficient permissions.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'404',
|
||||
ErrorType::init('The request failed because the resource does not exist.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The request failed because it either is semantically incorrect or failed b' .
|
||||
'usiness validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('The request failed because an internal server error occurred.'))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(PaymentAuthorization::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Shows details for a captured payment, by ID.
|
||||
*
|
||||
@@ -342,9 +342,9 @@ class PaymentsController extends BaseController
|
||||
->parameters(
|
||||
TemplateParam::init('capture_id', $options)->extract('captureId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
|
||||
@@ -24,58 +24,6 @@ use PaypalServerSdkLib\Models\SetupTokenResponse;
|
||||
|
||||
class VaultController extends BaseController
|
||||
{
|
||||
/**
|
||||
* Creates a Payment Token from the given payment source and adds it to the Vault of the associated
|
||||
* customer.
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function paymentTokensCreate(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/payment-tokens')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'404',
|
||||
ErrorType::init(
|
||||
'Request contains reference to resources that do not exist.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The requested action could not be performed, semantically incorrect, or fa' .
|
||||
'iled business validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->type(PaymentTokenResponse::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns all payment tokens for a customer.
|
||||
*
|
||||
@@ -148,17 +96,22 @@ class VaultController extends BaseController
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the payment token associated with the payment token id.
|
||||
* Creates a Payment Token from the given payment source and adds it to the Vault of the associated
|
||||
* customer.
|
||||
*
|
||||
* @param string $id ID of the payment token.
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function paymentTokensDelete(string $id): ApiResponse
|
||||
public function paymentTokensCreate(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v3/vault/payment-tokens/{id}')
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/payment-tokens')
|
||||
->auth('Oauth2')
|
||||
->parameters(TemplateParam::init('id', $id));
|
||||
->parameters(
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
@@ -172,7 +125,23 @@ class VaultController extends BaseController
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'404',
|
||||
ErrorType::init(
|
||||
'Request contains reference to resources that do not exist.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The requested action could not be performed, semantically incorrect, or fa' .
|
||||
'iled business validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->type(PaymentTokenResponse::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
@@ -191,7 +160,7 @@ class VaultController extends BaseController
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/setup-tokens')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
@@ -223,6 +192,37 @@ class VaultController extends BaseController
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the payment token associated with the payment token id.
|
||||
*
|
||||
* @param string $id ID of the payment token.
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function paymentTokensDelete(string $id): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v3/vault/payment-tokens/{id}')
|
||||
->auth('Oauth2')
|
||||
->parameters(TemplateParam::init('id', $id));
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a readable representation of temporarily vaulted payment source associated with the setup
|
||||
* token id.
|
||||
|
||||
@@ -17,7 +17,7 @@ use stdClass;
|
||||
/**
|
||||
* The address verification code for Visa, Discover, Mastercard, or American Express transactions.
|
||||
*/
|
||||
class AVSCode
|
||||
class AvsCode
|
||||
{
|
||||
public const A = 'A';
|
||||
|
||||
@@ -109,6 +109,6 @@ class AVSCode
|
||||
if (CoreHelper::checkValueOrValuesInList($value, self::_ALL_VALUES)) {
|
||||
return $value;
|
||||
}
|
||||
throw new Exception("$value is invalid for AVSCode.");
|
||||
throw new Exception("$value is invalid for AvsCode.");
|
||||
}
|
||||
}
|
||||
@@ -15,7 +15,7 @@ use stdClass;
|
||||
/**
|
||||
* Customizes the payer experience during the approval process for the BLIK payment.
|
||||
*/
|
||||
class BLIKExperienceContext implements \JsonSerializable
|
||||
class BlikExperienceContext implements \JsonSerializable
|
||||
{
|
||||
/**
|
||||
* @var string|null
|
||||
@@ -15,7 +15,7 @@ use stdClass;
|
||||
/**
|
||||
* Information used to pay using BLIK level_0 flow.
|
||||
*/
|
||||
class BLIKLevel0PaymentObject implements \JsonSerializable
|
||||
class BlikLevel0PaymentObject implements \JsonSerializable
|
||||
{
|
||||
/**
|
||||
* @var string
|
||||
@@ -15,7 +15,7 @@ use stdClass;
|
||||
/**
|
||||
* Information used to pay using BLIK one-click flow.
|
||||
*/
|
||||
class BLIKOneClickPaymentObject implements \JsonSerializable
|
||||
class BlikOneClickPaymentObject implements \JsonSerializable
|
||||
{
|
||||
/**
|
||||
* @var string|null
|
||||
@@ -15,7 +15,7 @@ use stdClass;
|
||||
/**
|
||||
* Information used to pay using BLIK one-click flow.
|
||||
*/
|
||||
class BLIKOneClickPaymentRequest implements \JsonSerializable
|
||||
class BlikOneClickPaymentRequest implements \JsonSerializable
|
||||
{
|
||||
/**
|
||||
* @var string|null
|
||||
@@ -15,7 +15,7 @@ use stdClass;
|
||||
/**
|
||||
* Information used to pay using BLIK.
|
||||
*/
|
||||
class BLIKPaymentObject implements \JsonSerializable
|
||||
class BlikPaymentObject implements \JsonSerializable
|
||||
{
|
||||
/**
|
||||
* @var string|null
|
||||
@@ -33,7 +33,7 @@ class BLIKPaymentObject implements \JsonSerializable
|
||||
private $email;
|
||||
|
||||
/**
|
||||
* @var BLIKOneClickPaymentObject|null
|
||||
* @var BlikOneClickPaymentObject|null
|
||||
*/
|
||||
private $oneClick;
|
||||
|
||||
@@ -115,7 +115,7 @@ class BLIKPaymentObject implements \JsonSerializable
|
||||
* Returns One Click.
|
||||
* Information used to pay using BLIK one-click flow.
|
||||
*/
|
||||
public function getOneClick(): ?BLIKOneClickPaymentObject
|
||||
public function getOneClick(): ?BlikOneClickPaymentObject
|
||||
{
|
||||
return $this->oneClick;
|
||||
}
|
||||
@@ -126,7 +126,7 @@ class BLIKPaymentObject implements \JsonSerializable
|
||||
*
|
||||
* @maps one_click
|
||||
*/
|
||||
public function setOneClick(?BLIKOneClickPaymentObject $oneClick): void
|
||||
public function setOneClick(?BlikOneClickPaymentObject $oneClick): void
|
||||
{
|
||||
$this->oneClick = $oneClick;
|
||||
}
|
||||
@@ -15,7 +15,7 @@ use stdClass;
|
||||
/**
|
||||
* Information needed to pay using BLIK.
|
||||
*/
|
||||
class BLIKPaymentRequest implements \JsonSerializable
|
||||
class BlikPaymentRequest implements \JsonSerializable
|
||||
{
|
||||
/**
|
||||
* @var string
|
||||
@@ -33,17 +33,17 @@ class BLIKPaymentRequest implements \JsonSerializable
|
||||
private $email;
|
||||
|
||||
/**
|
||||
* @var BLIKExperienceContext|null
|
||||
* @var BlikExperienceContext|null
|
||||
*/
|
||||
private $experienceContext;
|
||||
|
||||
/**
|
||||
* @var BLIKLevel0PaymentObject|null
|
||||
* @var BlikLevel0PaymentObject|null
|
||||
*/
|
||||
private $level0;
|
||||
|
||||
/**
|
||||
* @var BLIKOneClickPaymentRequest|null
|
||||
* @var BlikOneClickPaymentRequest|null
|
||||
*/
|
||||
private $oneClick;
|
||||
|
||||
@@ -137,7 +137,7 @@ class BLIKPaymentRequest implements \JsonSerializable
|
||||
* Returns Experience Context.
|
||||
* Customizes the payer experience during the approval process for the BLIK payment.
|
||||
*/
|
||||
public function getExperienceContext(): ?BLIKExperienceContext
|
||||
public function getExperienceContext(): ?BlikExperienceContext
|
||||
{
|
||||
return $this->experienceContext;
|
||||
}
|
||||
@@ -148,7 +148,7 @@ class BLIKPaymentRequest implements \JsonSerializable
|
||||
*
|
||||
* @maps experience_context
|
||||
*/
|
||||
public function setExperienceContext(?BLIKExperienceContext $experienceContext): void
|
||||
public function setExperienceContext(?BlikExperienceContext $experienceContext): void
|
||||
{
|
||||
$this->experienceContext = $experienceContext;
|
||||
}
|
||||
@@ -157,7 +157,7 @@ class BLIKPaymentRequest implements \JsonSerializable
|
||||
* Returns Level 0.
|
||||
* Information used to pay using BLIK level_0 flow.
|
||||
*/
|
||||
public function getLevel0(): ?BLIKLevel0PaymentObject
|
||||
public function getLevel0(): ?BlikLevel0PaymentObject
|
||||
{
|
||||
return $this->level0;
|
||||
}
|
||||
@@ -168,7 +168,7 @@ class BLIKPaymentRequest implements \JsonSerializable
|
||||
*
|
||||
* @maps level_0
|
||||
*/
|
||||
public function setLevel0(?BLIKLevel0PaymentObject $level0): void
|
||||
public function setLevel0(?BlikLevel0PaymentObject $level0): void
|
||||
{
|
||||
$this->level0 = $level0;
|
||||
}
|
||||
@@ -177,7 +177,7 @@ class BLIKPaymentRequest implements \JsonSerializable
|
||||
* Returns One Click.
|
||||
* Information used to pay using BLIK one-click flow.
|
||||
*/
|
||||
public function getOneClick(): ?BLIKOneClickPaymentRequest
|
||||
public function getOneClick(): ?BlikOneClickPaymentRequest
|
||||
{
|
||||
return $this->oneClick;
|
||||
}
|
||||
@@ -188,7 +188,7 @@ class BLIKPaymentRequest implements \JsonSerializable
|
||||
*
|
||||
* @maps one_click
|
||||
*/
|
||||
public function setOneClick(?BLIKOneClickPaymentRequest $oneClick): void
|
||||
public function setOneClick(?BlikOneClickPaymentRequest $oneClick): void
|
||||
{
|
||||
$this->oneClick = $oneClick;
|
||||
}
|
||||
@@ -1,48 +0,0 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\BLIKLevel0PaymentObject;
|
||||
|
||||
/**
|
||||
* Builder for model BLIKLevel0PaymentObject
|
||||
*
|
||||
* @see BLIKLevel0PaymentObject
|
||||
*/
|
||||
class BLIKLevel0PaymentObjectBuilder
|
||||
{
|
||||
/**
|
||||
* @var BLIKLevel0PaymentObject
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(BLIKLevel0PaymentObject $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new bliklevel 0 payment object Builder object.
|
||||
*/
|
||||
public static function init(string $authCode): self
|
||||
{
|
||||
return new self(new BLIKLevel0PaymentObject($authCode));
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new bliklevel 0 payment object object.
|
||||
*/
|
||||
public function build(): BLIKLevel0PaymentObject
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
}
|
||||
@@ -11,31 +11,31 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\BLIKExperienceContext;
|
||||
use PaypalServerSdkLib\Models\BlikExperienceContext;
|
||||
|
||||
/**
|
||||
* Builder for model BLIKExperienceContext
|
||||
* Builder for model BlikExperienceContext
|
||||
*
|
||||
* @see BLIKExperienceContext
|
||||
* @see BlikExperienceContext
|
||||
*/
|
||||
class BLIKExperienceContextBuilder
|
||||
class BlikExperienceContextBuilder
|
||||
{
|
||||
/**
|
||||
* @var BLIKExperienceContext
|
||||
* @var BlikExperienceContext
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(BLIKExperienceContext $instance)
|
||||
private function __construct(BlikExperienceContext $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new blikexperience context Builder object.
|
||||
* Initializes a new blik experience context Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new BLIKExperienceContext());
|
||||
return new self(new BlikExperienceContext());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -102,9 +102,9 @@ class BLIKExperienceContextBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new blikexperience context object.
|
||||
* Initializes a new blik experience context object.
|
||||
*/
|
||||
public function build(): BLIKExperienceContext
|
||||
public function build(): BlikExperienceContext
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
48
src/Models/Builders/BlikLevel0PaymentObjectBuilder.php
Normal file
48
src/Models/Builders/BlikLevel0PaymentObjectBuilder.php
Normal file
@@ -0,0 +1,48 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\BlikLevel0PaymentObject;
|
||||
|
||||
/**
|
||||
* Builder for model BlikLevel0PaymentObject
|
||||
*
|
||||
* @see BlikLevel0PaymentObject
|
||||
*/
|
||||
class BlikLevel0PaymentObjectBuilder
|
||||
{
|
||||
/**
|
||||
* @var BlikLevel0PaymentObject
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(BlikLevel0PaymentObject $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new blik level 0 payment object Builder object.
|
||||
*/
|
||||
public static function init(string $authCode): self
|
||||
{
|
||||
return new self(new BlikLevel0PaymentObject($authCode));
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new blik level 0 payment object object.
|
||||
*/
|
||||
public function build(): BlikLevel0PaymentObject
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
}
|
||||
@@ -11,31 +11,31 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\BLIKOneClickPaymentObject;
|
||||
use PaypalServerSdkLib\Models\BlikOneClickPaymentObject;
|
||||
|
||||
/**
|
||||
* Builder for model BLIKOneClickPaymentObject
|
||||
* Builder for model BlikOneClickPaymentObject
|
||||
*
|
||||
* @see BLIKOneClickPaymentObject
|
||||
* @see BlikOneClickPaymentObject
|
||||
*/
|
||||
class BLIKOneClickPaymentObjectBuilder
|
||||
class BlikOneClickPaymentObjectBuilder
|
||||
{
|
||||
/**
|
||||
* @var BLIKOneClickPaymentObject
|
||||
* @var BlikOneClickPaymentObject
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(BLIKOneClickPaymentObject $instance)
|
||||
private function __construct(BlikOneClickPaymentObject $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new blikone click payment object Builder object.
|
||||
* Initializes a new blik one click payment object Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new BLIKOneClickPaymentObject());
|
||||
return new self(new BlikOneClickPaymentObject());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -48,9 +48,9 @@ class BLIKOneClickPaymentObjectBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new blikone click payment object object.
|
||||
* Initializes a new blik one click payment object object.
|
||||
*/
|
||||
public function build(): BLIKOneClickPaymentObject
|
||||
public function build(): BlikOneClickPaymentObject
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -11,31 +11,31 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\BLIKOneClickPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\BlikOneClickPaymentRequest;
|
||||
|
||||
/**
|
||||
* Builder for model BLIKOneClickPaymentRequest
|
||||
* Builder for model BlikOneClickPaymentRequest
|
||||
*
|
||||
* @see BLIKOneClickPaymentRequest
|
||||
* @see BlikOneClickPaymentRequest
|
||||
*/
|
||||
class BLIKOneClickPaymentRequestBuilder
|
||||
class BlikOneClickPaymentRequestBuilder
|
||||
{
|
||||
/**
|
||||
* @var BLIKOneClickPaymentRequest
|
||||
* @var BlikOneClickPaymentRequest
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(BLIKOneClickPaymentRequest $instance)
|
||||
private function __construct(BlikOneClickPaymentRequest $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new blikone click payment request Builder object.
|
||||
* Initializes a new blik one click payment request Builder object.
|
||||
*/
|
||||
public static function init(string $consumerReference): self
|
||||
{
|
||||
return new self(new BLIKOneClickPaymentRequest($consumerReference));
|
||||
return new self(new BlikOneClickPaymentRequest($consumerReference));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -66,9 +66,9 @@ class BLIKOneClickPaymentRequestBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new blikone click payment request object.
|
||||
* Initializes a new blik one click payment request object.
|
||||
*/
|
||||
public function build(): BLIKOneClickPaymentRequest
|
||||
public function build(): BlikOneClickPaymentRequest
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -11,32 +11,32 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\BLIKOneClickPaymentObject;
|
||||
use PaypalServerSdkLib\Models\BLIKPaymentObject;
|
||||
use PaypalServerSdkLib\Models\BlikOneClickPaymentObject;
|
||||
use PaypalServerSdkLib\Models\BlikPaymentObject;
|
||||
|
||||
/**
|
||||
* Builder for model BLIKPaymentObject
|
||||
* Builder for model BlikPaymentObject
|
||||
*
|
||||
* @see BLIKPaymentObject
|
||||
* @see BlikPaymentObject
|
||||
*/
|
||||
class BLIKPaymentObjectBuilder
|
||||
class BlikPaymentObjectBuilder
|
||||
{
|
||||
/**
|
||||
* @var BLIKPaymentObject
|
||||
* @var BlikPaymentObject
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(BLIKPaymentObject $instance)
|
||||
private function __construct(BlikPaymentObject $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new blikpayment object Builder object.
|
||||
* Initializes a new blik payment object Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new BLIKPaymentObject());
|
||||
return new self(new BlikPaymentObject());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -69,16 +69,16 @@ class BLIKPaymentObjectBuilder
|
||||
/**
|
||||
* Sets one click field.
|
||||
*/
|
||||
public function oneClick(?BLIKOneClickPaymentObject $value): self
|
||||
public function oneClick(?BlikOneClickPaymentObject $value): self
|
||||
{
|
||||
$this->instance->setOneClick($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new blikpayment object object.
|
||||
* Initializes a new blik payment object object.
|
||||
*/
|
||||
public function build(): BLIKPaymentObject
|
||||
public function build(): BlikPaymentObject
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -11,34 +11,34 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\BLIKExperienceContext;
|
||||
use PaypalServerSdkLib\Models\BLIKLevel0PaymentObject;
|
||||
use PaypalServerSdkLib\Models\BLIKOneClickPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\BLIKPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\BlikExperienceContext;
|
||||
use PaypalServerSdkLib\Models\BlikLevel0PaymentObject;
|
||||
use PaypalServerSdkLib\Models\BlikOneClickPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\BlikPaymentRequest;
|
||||
|
||||
/**
|
||||
* Builder for model BLIKPaymentRequest
|
||||
* Builder for model BlikPaymentRequest
|
||||
*
|
||||
* @see BLIKPaymentRequest
|
||||
* @see BlikPaymentRequest
|
||||
*/
|
||||
class BLIKPaymentRequestBuilder
|
||||
class BlikPaymentRequestBuilder
|
||||
{
|
||||
/**
|
||||
* @var BLIKPaymentRequest
|
||||
* @var BlikPaymentRequest
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(BLIKPaymentRequest $instance)
|
||||
private function __construct(BlikPaymentRequest $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new blikpayment request Builder object.
|
||||
* Initializes a new blik payment request Builder object.
|
||||
*/
|
||||
public static function init(string $name, string $countryCode): self
|
||||
{
|
||||
return new self(new BLIKPaymentRequest($name, $countryCode));
|
||||
return new self(new BlikPaymentRequest($name, $countryCode));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -53,7 +53,7 @@ class BLIKPaymentRequestBuilder
|
||||
/**
|
||||
* Sets experience context field.
|
||||
*/
|
||||
public function experienceContext(?BLIKExperienceContext $value): self
|
||||
public function experienceContext(?BlikExperienceContext $value): self
|
||||
{
|
||||
$this->instance->setExperienceContext($value);
|
||||
return $this;
|
||||
@@ -62,7 +62,7 @@ class BLIKPaymentRequestBuilder
|
||||
/**
|
||||
* Sets level 0 field.
|
||||
*/
|
||||
public function level0(?BLIKLevel0PaymentObject $value): self
|
||||
public function level0(?BlikLevel0PaymentObject $value): self
|
||||
{
|
||||
$this->instance->setLevel0($value);
|
||||
return $this;
|
||||
@@ -71,16 +71,16 @@ class BLIKPaymentRequestBuilder
|
||||
/**
|
||||
* Sets one click field.
|
||||
*/
|
||||
public function oneClick(?BLIKOneClickPaymentRequest $value): self
|
||||
public function oneClick(?BlikOneClickPaymentRequest $value): self
|
||||
{
|
||||
$this->instance->setOneClick($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new blikpayment request object.
|
||||
* Initializes a new blik payment request object.
|
||||
*/
|
||||
public function build(): BLIKPaymentRequest
|
||||
public function build(): BlikPaymentRequest
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -11,31 +11,31 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\EPSPaymentObject;
|
||||
use PaypalServerSdkLib\Models\EpsPaymentObject;
|
||||
|
||||
/**
|
||||
* Builder for model EPSPaymentObject
|
||||
* Builder for model EpsPaymentObject
|
||||
*
|
||||
* @see EPSPaymentObject
|
||||
* @see EpsPaymentObject
|
||||
*/
|
||||
class EPSPaymentObjectBuilder
|
||||
class EpsPaymentObjectBuilder
|
||||
{
|
||||
/**
|
||||
* @var EPSPaymentObject
|
||||
* @var EpsPaymentObject
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(EPSPaymentObject $instance)
|
||||
private function __construct(EpsPaymentObject $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new epspayment object Builder object.
|
||||
* Initializes a new eps payment object Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new EPSPaymentObject());
|
||||
return new self(new EpsPaymentObject());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -66,9 +66,9 @@ class EPSPaymentObjectBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new epspayment object object.
|
||||
* Initializes a new eps payment object object.
|
||||
*/
|
||||
public function build(): EPSPaymentObject
|
||||
public function build(): EpsPaymentObject
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -11,32 +11,32 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\EPSPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\EpsPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\ExperienceContext;
|
||||
|
||||
/**
|
||||
* Builder for model EPSPaymentRequest
|
||||
* Builder for model EpsPaymentRequest
|
||||
*
|
||||
* @see EPSPaymentRequest
|
||||
* @see EpsPaymentRequest
|
||||
*/
|
||||
class EPSPaymentRequestBuilder
|
||||
class EpsPaymentRequestBuilder
|
||||
{
|
||||
/**
|
||||
* @var EPSPaymentRequest
|
||||
* @var EpsPaymentRequest
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(EPSPaymentRequest $instance)
|
||||
private function __construct(EpsPaymentRequest $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new epspayment request Builder object.
|
||||
* Initializes a new eps payment request Builder object.
|
||||
*/
|
||||
public static function init(string $name, string $countryCode): self
|
||||
{
|
||||
return new self(new EPSPaymentRequest($name, $countryCode));
|
||||
return new self(new EpsPaymentRequest($name, $countryCode));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -49,9 +49,9 @@ class EPSPaymentRequestBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new epspayment request object.
|
||||
* Initializes a new eps payment request object.
|
||||
*/
|
||||
public function build(): EPSPaymentRequest
|
||||
public function build(): EpsPaymentRequest
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -11,31 +11,31 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\IDEALPaymentObject;
|
||||
use PaypalServerSdkLib\Models\IdealPaymentObject;
|
||||
|
||||
/**
|
||||
* Builder for model IDEALPaymentObject
|
||||
* Builder for model IdealPaymentObject
|
||||
*
|
||||
* @see IDEALPaymentObject
|
||||
* @see IdealPaymentObject
|
||||
*/
|
||||
class IDEALPaymentObjectBuilder
|
||||
class IdealPaymentObjectBuilder
|
||||
{
|
||||
/**
|
||||
* @var IDEALPaymentObject
|
||||
* @var IdealPaymentObject
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(IDEALPaymentObject $instance)
|
||||
private function __construct(IdealPaymentObject $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new idealpayment object Builder object.
|
||||
* Initializes a new ideal payment object Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new IDEALPaymentObject());
|
||||
return new self(new IdealPaymentObject());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -75,9 +75,9 @@ class IDEALPaymentObjectBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new idealpayment object object.
|
||||
* Initializes a new ideal payment object object.
|
||||
*/
|
||||
public function build(): IDEALPaymentObject
|
||||
public function build(): IdealPaymentObject
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -12,31 +12,31 @@ namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\ExperienceContext;
|
||||
use PaypalServerSdkLib\Models\IDEALPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\IdealPaymentRequest;
|
||||
|
||||
/**
|
||||
* Builder for model IDEALPaymentRequest
|
||||
* Builder for model IdealPaymentRequest
|
||||
*
|
||||
* @see IDEALPaymentRequest
|
||||
* @see IdealPaymentRequest
|
||||
*/
|
||||
class IDEALPaymentRequestBuilder
|
||||
class IdealPaymentRequestBuilder
|
||||
{
|
||||
/**
|
||||
* @var IDEALPaymentRequest
|
||||
* @var IdealPaymentRequest
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(IDEALPaymentRequest $instance)
|
||||
private function __construct(IdealPaymentRequest $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new idealpayment request Builder object.
|
||||
* Initializes a new ideal payment request Builder object.
|
||||
*/
|
||||
public static function init(string $name, string $countryCode): self
|
||||
{
|
||||
return new self(new IDEALPaymentRequest($name, $countryCode));
|
||||
return new self(new IdealPaymentRequest($name, $countryCode));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -58,9 +58,9 @@ class IDEALPaymentRequestBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new idealpayment request object.
|
||||
* Initializes a new ideal payment request object.
|
||||
*/
|
||||
public function build(): IDEALPaymentRequest
|
||||
public function build(): IdealPaymentRequest
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -11,31 +11,31 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\MyBankPaymentObject;
|
||||
use PaypalServerSdkLib\Models\MybankPaymentObject;
|
||||
|
||||
/**
|
||||
* Builder for model MyBankPaymentObject
|
||||
* Builder for model MybankPaymentObject
|
||||
*
|
||||
* @see MyBankPaymentObject
|
||||
* @see MybankPaymentObject
|
||||
*/
|
||||
class MyBankPaymentObjectBuilder
|
||||
class MybankPaymentObjectBuilder
|
||||
{
|
||||
/**
|
||||
* @var MyBankPaymentObject
|
||||
* @var MybankPaymentObject
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(MyBankPaymentObject $instance)
|
||||
private function __construct(MybankPaymentObject $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new my bank payment object Builder object.
|
||||
* Initializes a new mybank payment object Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new MyBankPaymentObject());
|
||||
return new self(new MybankPaymentObject());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -75,9 +75,9 @@ class MyBankPaymentObjectBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new my bank payment object object.
|
||||
* Initializes a new mybank payment object object.
|
||||
*/
|
||||
public function build(): MyBankPaymentObject
|
||||
public function build(): MybankPaymentObject
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -12,31 +12,31 @@ namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\ExperienceContext;
|
||||
use PaypalServerSdkLib\Models\MyBankPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\MybankPaymentRequest;
|
||||
|
||||
/**
|
||||
* Builder for model MyBankPaymentRequest
|
||||
* Builder for model MybankPaymentRequest
|
||||
*
|
||||
* @see MyBankPaymentRequest
|
||||
* @see MybankPaymentRequest
|
||||
*/
|
||||
class MyBankPaymentRequestBuilder
|
||||
class MybankPaymentRequestBuilder
|
||||
{
|
||||
/**
|
||||
* @var MyBankPaymentRequest
|
||||
* @var MybankPaymentRequest
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(MyBankPaymentRequest $instance)
|
||||
private function __construct(MybankPaymentRequest $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new my bank payment request Builder object.
|
||||
* Initializes a new mybank payment request Builder object.
|
||||
*/
|
||||
public static function init(string $name, string $countryCode): self
|
||||
{
|
||||
return new self(new MyBankPaymentRequest($name, $countryCode));
|
||||
return new self(new MybankPaymentRequest($name, $countryCode));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -49,9 +49,9 @@ class MyBankPaymentRequestBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new my bank payment request object.
|
||||
* Initializes a new mybank payment request object.
|
||||
*/
|
||||
public function build(): MyBankPaymentRequest
|
||||
public function build(): MybankPaymentRequest
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -15,7 +15,7 @@ use PaypalServerSdkLib\Models\ApplePayRequest;
|
||||
use PaypalServerSdkLib\Models\CardRequest;
|
||||
use PaypalServerSdkLib\Models\GooglePayRequest;
|
||||
use PaypalServerSdkLib\Models\OrderAuthorizeRequestPaymentSource;
|
||||
use PaypalServerSdkLib\Models\PayPalWallet;
|
||||
use PaypalServerSdkLib\Models\PaypalWallet;
|
||||
use PaypalServerSdkLib\Models\Token;
|
||||
use PaypalServerSdkLib\Models\VenmoWalletRequest;
|
||||
|
||||
@@ -65,7 +65,7 @@ class OrderAuthorizeRequestPaymentSourceBuilder
|
||||
/**
|
||||
* Sets paypal field.
|
||||
*/
|
||||
public function paypal(?PayPalWallet $value): self
|
||||
public function paypal(?PaypalWallet $value): self
|
||||
{
|
||||
$this->instance->setPaypal($value);
|
||||
return $this;
|
||||
|
||||
@@ -15,7 +15,7 @@ use PaypalServerSdkLib\Models\ApplePayPaymentObject;
|
||||
use PaypalServerSdkLib\Models\CardResponse;
|
||||
use PaypalServerSdkLib\Models\GooglePayWalletResponse;
|
||||
use PaypalServerSdkLib\Models\OrderAuthorizeResponsePaymentSource;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletResponse;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletResponse;
|
||||
use PaypalServerSdkLib\Models\VenmoWalletResponse;
|
||||
|
||||
/**
|
||||
@@ -55,7 +55,7 @@ class OrderAuthorizeResponsePaymentSourceBuilder
|
||||
/**
|
||||
* Sets paypal field.
|
||||
*/
|
||||
public function paypal(?PayPalWalletResponse $value): self
|
||||
public function paypal(?PaypalWalletResponse $value): self
|
||||
{
|
||||
$this->instance->setPaypal($value);
|
||||
return $this;
|
||||
|
||||
@@ -15,7 +15,7 @@ use PaypalServerSdkLib\Models\ApplePayRequest;
|
||||
use PaypalServerSdkLib\Models\CardRequest;
|
||||
use PaypalServerSdkLib\Models\GooglePayRequest;
|
||||
use PaypalServerSdkLib\Models\OrderCaptureRequestPaymentSource;
|
||||
use PaypalServerSdkLib\Models\PayPalWallet;
|
||||
use PaypalServerSdkLib\Models\PaypalWallet;
|
||||
use PaypalServerSdkLib\Models\Token;
|
||||
use PaypalServerSdkLib\Models\VenmoWalletRequest;
|
||||
|
||||
@@ -65,7 +65,7 @@ class OrderCaptureRequestPaymentSourceBuilder
|
||||
/**
|
||||
* Sets paypal field.
|
||||
*/
|
||||
public function paypal(?PayPalWallet $value): self
|
||||
public function paypal(?PaypalWallet $value): self
|
||||
{
|
||||
$this->instance->setPaypal($value);
|
||||
return $this;
|
||||
|
||||
@@ -1,68 +0,0 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletAttributes;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletCustomerRequest;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletVaultInstruction;
|
||||
|
||||
/**
|
||||
* Builder for model PayPalWalletAttributes
|
||||
*
|
||||
* @see PayPalWalletAttributes
|
||||
*/
|
||||
class PayPalWalletAttributesBuilder
|
||||
{
|
||||
/**
|
||||
* @var PayPalWalletAttributes
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(PayPalWalletAttributes $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet attributes Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new PayPalWalletAttributes());
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets customer field.
|
||||
*/
|
||||
public function customer(?PayPalWalletCustomerRequest $value): self
|
||||
{
|
||||
$this->instance->setCustomer($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets vault field.
|
||||
*/
|
||||
public function vault(?PayPalWalletVaultInstruction $value): self
|
||||
{
|
||||
$this->instance->setVault($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet attributes object.
|
||||
*/
|
||||
public function build(): PayPalWalletAttributes
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
}
|
||||
@@ -13,16 +13,16 @@ namespace PaypalServerSdkLib\Models\Builders;
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\ApplePayRequest;
|
||||
use PaypalServerSdkLib\Models\BancontactPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\BLIKPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\BlikPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\CardRequest;
|
||||
use PaypalServerSdkLib\Models\EPSPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\EpsPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\GiropayPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\GooglePayRequest;
|
||||
use PaypalServerSdkLib\Models\IDEALPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\MyBankPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\IdealPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\MybankPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\P24PaymentRequest;
|
||||
use PaypalServerSdkLib\Models\PaymentSource;
|
||||
use PaypalServerSdkLib\Models\PayPalWallet;
|
||||
use PaypalServerSdkLib\Models\PaypalWallet;
|
||||
use PaypalServerSdkLib\Models\SofortPaymentRequest;
|
||||
use PaypalServerSdkLib\Models\Token;
|
||||
use PaypalServerSdkLib\Models\TrustlyPaymentRequest;
|
||||
@@ -74,7 +74,7 @@ class PaymentSourceBuilder
|
||||
/**
|
||||
* Sets paypal field.
|
||||
*/
|
||||
public function paypal(?PayPalWallet $value): self
|
||||
public function paypal(?PaypalWallet $value): self
|
||||
{
|
||||
$this->instance->setPaypal($value);
|
||||
return $this;
|
||||
@@ -92,7 +92,7 @@ class PaymentSourceBuilder
|
||||
/**
|
||||
* Sets blik field.
|
||||
*/
|
||||
public function blik(?BLIKPaymentRequest $value): self
|
||||
public function blik(?BlikPaymentRequest $value): self
|
||||
{
|
||||
$this->instance->setBlik($value);
|
||||
return $this;
|
||||
@@ -101,7 +101,7 @@ class PaymentSourceBuilder
|
||||
/**
|
||||
* Sets eps field.
|
||||
*/
|
||||
public function eps(?EPSPaymentRequest $value): self
|
||||
public function eps(?EpsPaymentRequest $value): self
|
||||
{
|
||||
$this->instance->setEps($value);
|
||||
return $this;
|
||||
@@ -119,7 +119,7 @@ class PaymentSourceBuilder
|
||||
/**
|
||||
* Sets ideal field.
|
||||
*/
|
||||
public function ideal(?IDEALPaymentRequest $value): self
|
||||
public function ideal(?IdealPaymentRequest $value): self
|
||||
{
|
||||
$this->instance->setIdeal($value);
|
||||
return $this;
|
||||
@@ -128,7 +128,7 @@ class PaymentSourceBuilder
|
||||
/**
|
||||
* Sets mybank field.
|
||||
*/
|
||||
public function mybank(?MyBankPaymentRequest $value): self
|
||||
public function mybank(?MybankPaymentRequest $value): self
|
||||
{
|
||||
$this->instance->setMybank($value);
|
||||
return $this;
|
||||
|
||||
@@ -13,16 +13,16 @@ namespace PaypalServerSdkLib\Models\Builders;
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\ApplePayPaymentObject;
|
||||
use PaypalServerSdkLib\Models\BancontactPaymentObject;
|
||||
use PaypalServerSdkLib\Models\BLIKPaymentObject;
|
||||
use PaypalServerSdkLib\Models\BlikPaymentObject;
|
||||
use PaypalServerSdkLib\Models\CardResponse;
|
||||
use PaypalServerSdkLib\Models\EPSPaymentObject;
|
||||
use PaypalServerSdkLib\Models\EpsPaymentObject;
|
||||
use PaypalServerSdkLib\Models\GiropayPaymentObject;
|
||||
use PaypalServerSdkLib\Models\GooglePayWalletResponse;
|
||||
use PaypalServerSdkLib\Models\IDEALPaymentObject;
|
||||
use PaypalServerSdkLib\Models\MyBankPaymentObject;
|
||||
use PaypalServerSdkLib\Models\IdealPaymentObject;
|
||||
use PaypalServerSdkLib\Models\MybankPaymentObject;
|
||||
use PaypalServerSdkLib\Models\P24PaymentObject;
|
||||
use PaypalServerSdkLib\Models\PaymentSourceResponse;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletResponse;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletResponse;
|
||||
use PaypalServerSdkLib\Models\SofortPaymentObject;
|
||||
use PaypalServerSdkLib\Models\TrustlyPaymentObject;
|
||||
use PaypalServerSdkLib\Models\VenmoWalletResponse;
|
||||
@@ -64,7 +64,7 @@ class PaymentSourceResponseBuilder
|
||||
/**
|
||||
* Sets paypal field.
|
||||
*/
|
||||
public function paypal(?PayPalWalletResponse $value): self
|
||||
public function paypal(?PaypalWalletResponse $value): self
|
||||
{
|
||||
$this->instance->setPaypal($value);
|
||||
return $this;
|
||||
@@ -82,7 +82,7 @@ class PaymentSourceResponseBuilder
|
||||
/**
|
||||
* Sets blik field.
|
||||
*/
|
||||
public function blik(?BLIKPaymentObject $value): self
|
||||
public function blik(?BlikPaymentObject $value): self
|
||||
{
|
||||
$this->instance->setBlik($value);
|
||||
return $this;
|
||||
@@ -91,7 +91,7 @@ class PaymentSourceResponseBuilder
|
||||
/**
|
||||
* Sets eps field.
|
||||
*/
|
||||
public function eps(?EPSPaymentObject $value): self
|
||||
public function eps(?EpsPaymentObject $value): self
|
||||
{
|
||||
$this->instance->setEps($value);
|
||||
return $this;
|
||||
@@ -109,7 +109,7 @@ class PaymentSourceResponseBuilder
|
||||
/**
|
||||
* Sets ideal field.
|
||||
*/
|
||||
public function ideal(?IDEALPaymentObject $value): self
|
||||
public function ideal(?IdealPaymentObject $value): self
|
||||
{
|
||||
$this->instance->setIdeal($value);
|
||||
return $this;
|
||||
@@ -118,7 +118,7 @@ class PaymentSourceResponseBuilder
|
||||
/**
|
||||
* Sets mybank field.
|
||||
*/
|
||||
public function mybank(?MyBankPaymentObject $value): self
|
||||
public function mybank(?MybankPaymentObject $value): self
|
||||
{
|
||||
$this->instance->setMybank($value);
|
||||
return $this;
|
||||
|
||||
@@ -14,7 +14,7 @@ use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\ApplePayPaymentToken;
|
||||
use PaypalServerSdkLib\Models\CardPaymentToken;
|
||||
use PaypalServerSdkLib\Models\PaymentTokenResponsePaymentSource;
|
||||
use PaypalServerSdkLib\Models\PayPalPaymentToken;
|
||||
use PaypalServerSdkLib\Models\PaypalPaymentToken;
|
||||
use PaypalServerSdkLib\Models\VenmoPaymentToken;
|
||||
|
||||
/**
|
||||
@@ -54,7 +54,7 @@ class PaymentTokenResponsePaymentSourceBuilder
|
||||
/**
|
||||
* Sets paypal field.
|
||||
*/
|
||||
public function paypal(?PayPalPaymentToken $value): self
|
||||
public function paypal(?PaypalPaymentToken $value): self
|
||||
{
|
||||
$this->instance->setPaypal($value);
|
||||
return $this;
|
||||
|
||||
@@ -13,34 +13,34 @@ namespace PaypalServerSdkLib\Models\Builders;
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\Address;
|
||||
use PaypalServerSdkLib\Models\Name;
|
||||
use PaypalServerSdkLib\Models\PayPalPaymentToken;
|
||||
use PaypalServerSdkLib\Models\PaypalPaymentToken;
|
||||
use PaypalServerSdkLib\Models\Phone;
|
||||
use PaypalServerSdkLib\Models\PhoneWithType;
|
||||
use PaypalServerSdkLib\Models\VaultedDigitalWalletShippingDetails;
|
||||
|
||||
/**
|
||||
* Builder for model PayPalPaymentToken
|
||||
* Builder for model PaypalPaymentToken
|
||||
*
|
||||
* @see PayPalPaymentToken
|
||||
* @see PaypalPaymentToken
|
||||
*/
|
||||
class PayPalPaymentTokenBuilder
|
||||
class PaypalPaymentTokenBuilder
|
||||
{
|
||||
/**
|
||||
* @var PayPalPaymentToken
|
||||
* @var PaypalPaymentToken
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(PayPalPaymentToken $instance)
|
||||
private function __construct(PaypalPaymentToken $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal payment token Builder object.
|
||||
* Initializes a new paypal payment token Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new PayPalPaymentToken());
|
||||
return new self(new PaypalPaymentToken());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -152,9 +152,9 @@ class PayPalPaymentTokenBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal payment token object.
|
||||
* Initializes a new paypal payment token object.
|
||||
*/
|
||||
public function build(): PayPalPaymentToken
|
||||
public function build(): PaypalPaymentToken
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
68
src/Models/Builders/PaypalWalletAttributesBuilder.php
Normal file
68
src/Models/Builders/PaypalWalletAttributesBuilder.php
Normal file
@@ -0,0 +1,68 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletAttributes;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletCustomerRequest;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletVaultInstruction;
|
||||
|
||||
/**
|
||||
* Builder for model PaypalWalletAttributes
|
||||
*
|
||||
* @see PaypalWalletAttributes
|
||||
*/
|
||||
class PaypalWalletAttributesBuilder
|
||||
{
|
||||
/**
|
||||
* @var PaypalWalletAttributes
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(PaypalWalletAttributes $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new paypal wallet attributes Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new PaypalWalletAttributes());
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets customer field.
|
||||
*/
|
||||
public function customer(?PaypalWalletCustomerRequest $value): self
|
||||
{
|
||||
$this->instance->setCustomer($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets vault field.
|
||||
*/
|
||||
public function vault(?PaypalWalletVaultInstruction $value): self
|
||||
{
|
||||
$this->instance->setVault($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new paypal wallet attributes object.
|
||||
*/
|
||||
public function build(): PaypalWalletAttributes
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
}
|
||||
@@ -11,38 +11,38 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletAttributesResponse;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletVaultResponse;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletAttributesResponse;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletVaultResponse;
|
||||
|
||||
/**
|
||||
* Builder for model PayPalWalletAttributesResponse
|
||||
* Builder for model PaypalWalletAttributesResponse
|
||||
*
|
||||
* @see PayPalWalletAttributesResponse
|
||||
* @see PaypalWalletAttributesResponse
|
||||
*/
|
||||
class PayPalWalletAttributesResponseBuilder
|
||||
class PaypalWalletAttributesResponseBuilder
|
||||
{
|
||||
/**
|
||||
* @var PayPalWalletAttributesResponse
|
||||
* @var PaypalWalletAttributesResponse
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(PayPalWalletAttributesResponse $instance)
|
||||
private function __construct(PaypalWalletAttributesResponse $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet attributes response Builder object.
|
||||
* Initializes a new paypal wallet attributes response Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new PayPalWalletAttributesResponse());
|
||||
return new self(new PaypalWalletAttributesResponse());
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets vault field.
|
||||
*/
|
||||
public function vault(?PayPalWalletVaultResponse $value): self
|
||||
public function vault(?PaypalWalletVaultResponse $value): self
|
||||
{
|
||||
$this->instance->setVault($value);
|
||||
return $this;
|
||||
@@ -58,9 +58,9 @@ class PayPalWalletAttributesResponseBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet attributes response object.
|
||||
* Initializes a new paypal wallet attributes response object.
|
||||
*/
|
||||
public function build(): PayPalWalletAttributesResponse
|
||||
public function build(): PaypalWalletAttributesResponse
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -13,35 +13,35 @@ namespace PaypalServerSdkLib\Models\Builders;
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\Address;
|
||||
use PaypalServerSdkLib\Models\Name;
|
||||
use PaypalServerSdkLib\Models\PayPalWallet;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletAttributes;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletExperienceContext;
|
||||
use PaypalServerSdkLib\Models\PaypalWallet;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletAttributes;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletExperienceContext;
|
||||
use PaypalServerSdkLib\Models\PhoneWithType;
|
||||
use PaypalServerSdkLib\Models\TaxInfo;
|
||||
|
||||
/**
|
||||
* Builder for model PayPalWallet
|
||||
* Builder for model PaypalWallet
|
||||
*
|
||||
* @see PayPalWallet
|
||||
* @see PaypalWallet
|
||||
*/
|
||||
class PayPalWalletBuilder
|
||||
class PaypalWalletBuilder
|
||||
{
|
||||
/**
|
||||
* @var PayPalWallet
|
||||
* @var PaypalWallet
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(PayPalWallet $instance)
|
||||
private function __construct(PaypalWallet $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet Builder object.
|
||||
* Initializes a new paypal wallet Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new PayPalWallet());
|
||||
return new self(new PaypalWallet());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -110,7 +110,7 @@ class PayPalWalletBuilder
|
||||
/**
|
||||
* Sets attributes field.
|
||||
*/
|
||||
public function attributes(?PayPalWalletAttributes $value): self
|
||||
public function attributes(?PaypalWalletAttributes $value): self
|
||||
{
|
||||
$this->instance->setAttributes($value);
|
||||
return $this;
|
||||
@@ -119,7 +119,7 @@ class PayPalWalletBuilder
|
||||
/**
|
||||
* Sets experience context field.
|
||||
*/
|
||||
public function experienceContext(?PayPalWalletExperienceContext $value): self
|
||||
public function experienceContext(?PaypalWalletExperienceContext $value): self
|
||||
{
|
||||
$this->instance->setExperienceContext($value);
|
||||
return $this;
|
||||
@@ -135,9 +135,9 @@ class PayPalWalletBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet object.
|
||||
* Initializes a new paypal wallet object.
|
||||
*/
|
||||
public function build(): PayPalWallet
|
||||
public function build(): PaypalWallet
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -11,32 +11,32 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletCustomer;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletCustomer;
|
||||
use PaypalServerSdkLib\Models\PhoneWithType;
|
||||
|
||||
/**
|
||||
* Builder for model PayPalWalletCustomer
|
||||
* Builder for model PaypalWalletCustomer
|
||||
*
|
||||
* @see PayPalWalletCustomer
|
||||
* @see PaypalWalletCustomer
|
||||
*/
|
||||
class PayPalWalletCustomerBuilder
|
||||
class PaypalWalletCustomerBuilder
|
||||
{
|
||||
/**
|
||||
* @var PayPalWalletCustomer
|
||||
* @var PaypalWalletCustomer
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(PayPalWalletCustomer $instance)
|
||||
private function __construct(PaypalWalletCustomer $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet customer Builder object.
|
||||
* Initializes a new paypal wallet customer Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new PayPalWalletCustomer());
|
||||
return new self(new PaypalWalletCustomer());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -76,9 +76,9 @@ class PayPalWalletCustomerBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet customer object.
|
||||
* Initializes a new paypal wallet customer object.
|
||||
*/
|
||||
public function build(): PayPalWalletCustomer
|
||||
public function build(): PaypalWalletCustomer
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -11,32 +11,32 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletCustomerRequest;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletCustomerRequest;
|
||||
use PaypalServerSdkLib\Models\PhoneWithType;
|
||||
|
||||
/**
|
||||
* Builder for model PayPalWalletCustomerRequest
|
||||
* Builder for model PaypalWalletCustomerRequest
|
||||
*
|
||||
* @see PayPalWalletCustomerRequest
|
||||
* @see PaypalWalletCustomerRequest
|
||||
*/
|
||||
class PayPalWalletCustomerRequestBuilder
|
||||
class PaypalWalletCustomerRequestBuilder
|
||||
{
|
||||
/**
|
||||
* @var PayPalWalletCustomerRequest
|
||||
* @var PaypalWalletCustomerRequest
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(PayPalWalletCustomerRequest $instance)
|
||||
private function __construct(PaypalWalletCustomerRequest $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet customer request Builder object.
|
||||
* Initializes a new paypal wallet customer request Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new PayPalWalletCustomerRequest());
|
||||
return new self(new PaypalWalletCustomerRequest());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -76,9 +76,9 @@ class PayPalWalletCustomerRequestBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet customer request object.
|
||||
* Initializes a new paypal wallet customer request object.
|
||||
*/
|
||||
public function build(): PayPalWalletCustomerRequest
|
||||
public function build(): PaypalWalletCustomerRequest
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -11,31 +11,31 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletExperienceContext;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletExperienceContext;
|
||||
|
||||
/**
|
||||
* Builder for model PayPalWalletExperienceContext
|
||||
* Builder for model PaypalWalletExperienceContext
|
||||
*
|
||||
* @see PayPalWalletExperienceContext
|
||||
* @see PaypalWalletExperienceContext
|
||||
*/
|
||||
class PayPalWalletExperienceContextBuilder
|
||||
class PaypalWalletExperienceContextBuilder
|
||||
{
|
||||
/**
|
||||
* @var PayPalWalletExperienceContext
|
||||
* @var PaypalWalletExperienceContext
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(PayPalWalletExperienceContext $instance)
|
||||
private function __construct(PaypalWalletExperienceContext $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet experience context Builder object.
|
||||
* Initializes a new paypal wallet experience context Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new PayPalWalletExperienceContext());
|
||||
return new self(new PaypalWalletExperienceContext());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -111,9 +111,9 @@ class PayPalWalletExperienceContextBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet experience context object.
|
||||
* Initializes a new paypal wallet experience context object.
|
||||
*/
|
||||
public function build(): PayPalWalletExperienceContext
|
||||
public function build(): PaypalWalletExperienceContext
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -13,34 +13,34 @@ namespace PaypalServerSdkLib\Models\Builders;
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\Address;
|
||||
use PaypalServerSdkLib\Models\Name;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletAttributesResponse;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletResponse;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletAttributesResponse;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletResponse;
|
||||
use PaypalServerSdkLib\Models\PhoneNumber;
|
||||
use PaypalServerSdkLib\Models\TaxInfo;
|
||||
|
||||
/**
|
||||
* Builder for model PayPalWalletResponse
|
||||
* Builder for model PaypalWalletResponse
|
||||
*
|
||||
* @see PayPalWalletResponse
|
||||
* @see PaypalWalletResponse
|
||||
*/
|
||||
class PayPalWalletResponseBuilder
|
||||
class PaypalWalletResponseBuilder
|
||||
{
|
||||
/**
|
||||
* @var PayPalWalletResponse
|
||||
* @var PaypalWalletResponse
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(PayPalWalletResponse $instance)
|
||||
private function __construct(PaypalWalletResponse $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet response Builder object.
|
||||
* Initializes a new paypal wallet response Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new PayPalWalletResponse());
|
||||
return new self(new PaypalWalletResponse());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -136,16 +136,16 @@ class PayPalWalletResponseBuilder
|
||||
/**
|
||||
* Sets attributes field.
|
||||
*/
|
||||
public function attributes(?PayPalWalletAttributesResponse $value): self
|
||||
public function attributes(?PaypalWalletAttributesResponse $value): self
|
||||
{
|
||||
$this->instance->setAttributes($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet response object.
|
||||
* Initializes a new paypal wallet response object.
|
||||
*/
|
||||
public function build(): PayPalWalletResponse
|
||||
public function build(): PaypalWalletResponse
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -11,31 +11,31 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletVaultInstruction;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletVaultInstruction;
|
||||
|
||||
/**
|
||||
* Builder for model PayPalWalletVaultInstruction
|
||||
* Builder for model PaypalWalletVaultInstruction
|
||||
*
|
||||
* @see PayPalWalletVaultInstruction
|
||||
* @see PaypalWalletVaultInstruction
|
||||
*/
|
||||
class PayPalWalletVaultInstructionBuilder
|
||||
class PaypalWalletVaultInstructionBuilder
|
||||
{
|
||||
/**
|
||||
* @var PayPalWalletVaultInstruction
|
||||
* @var PaypalWalletVaultInstruction
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(PayPalWalletVaultInstruction $instance)
|
||||
private function __construct(PaypalWalletVaultInstruction $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet vault instruction Builder object.
|
||||
* Initializes a new paypal wallet vault instruction Builder object.
|
||||
*/
|
||||
public static function init(string $usageType): self
|
||||
{
|
||||
return new self(new PayPalWalletVaultInstruction($usageType));
|
||||
return new self(new PaypalWalletVaultInstruction($usageType));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -84,9 +84,9 @@ class PayPalWalletVaultInstructionBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet vault instruction object.
|
||||
* Initializes a new paypal wallet vault instruction object.
|
||||
*/
|
||||
public function build(): PayPalWalletVaultInstruction
|
||||
public function build(): PaypalWalletVaultInstruction
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -11,32 +11,32 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletCustomer;
|
||||
use PaypalServerSdkLib\Models\PayPalWalletVaultResponse;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletCustomer;
|
||||
use PaypalServerSdkLib\Models\PaypalWalletVaultResponse;
|
||||
|
||||
/**
|
||||
* Builder for model PayPalWalletVaultResponse
|
||||
* Builder for model PaypalWalletVaultResponse
|
||||
*
|
||||
* @see PayPalWalletVaultResponse
|
||||
* @see PaypalWalletVaultResponse
|
||||
*/
|
||||
class PayPalWalletVaultResponseBuilder
|
||||
class PaypalWalletVaultResponseBuilder
|
||||
{
|
||||
/**
|
||||
* @var PayPalWalletVaultResponse
|
||||
* @var PaypalWalletVaultResponse
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(PayPalWalletVaultResponse $instance)
|
||||
private function __construct(PaypalWalletVaultResponse $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet vault response Builder object.
|
||||
* Initializes a new paypal wallet vault response Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new PayPalWalletVaultResponse());
|
||||
return new self(new PaypalWalletVaultResponse());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -69,16 +69,16 @@ class PayPalWalletVaultResponseBuilder
|
||||
/**
|
||||
* Sets customer field.
|
||||
*/
|
||||
public function customer(?PayPalWalletCustomer $value): self
|
||||
public function customer(?PaypalWalletCustomer $value): self
|
||||
{
|
||||
$this->instance->setCustomer($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new pay pal wallet vault response object.
|
||||
* Initializes a new paypal wallet vault response object.
|
||||
*/
|
||||
public function build(): PayPalWalletVaultResponse
|
||||
public function build(): PaypalWalletVaultResponse
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -13,7 +13,7 @@ namespace PaypalServerSdkLib\Models\Builders;
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\SetupTokenRequestCard;
|
||||
use PaypalServerSdkLib\Models\SetupTokenRequestPaymentSource;
|
||||
use PaypalServerSdkLib\Models\VaultPayPalWalletRequest;
|
||||
use PaypalServerSdkLib\Models\VaultPaypalWalletRequest;
|
||||
use PaypalServerSdkLib\Models\VaultTokenRequest;
|
||||
use PaypalServerSdkLib\Models\VaultVenmoRequest;
|
||||
|
||||
@@ -54,7 +54,7 @@ class SetupTokenRequestPaymentSourceBuilder
|
||||
/**
|
||||
* Sets paypal field.
|
||||
*/
|
||||
public function paypal(?VaultPayPalWalletRequest $value): self
|
||||
public function paypal(?VaultPaypalWalletRequest $value): self
|
||||
{
|
||||
$this->instance->setPaypal($value);
|
||||
return $this;
|
||||
|
||||
@@ -11,7 +11,7 @@ declare(strict_types=1);
|
||||
namespace PaypalServerSdkLib\Models\Builders;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\PayPalPaymentToken;
|
||||
use PaypalServerSdkLib\Models\PaypalPaymentToken;
|
||||
use PaypalServerSdkLib\Models\SetupTokenResponseCard;
|
||||
use PaypalServerSdkLib\Models\SetupTokenResponsePaymentSource;
|
||||
use PaypalServerSdkLib\Models\VenmoPaymentToken;
|
||||
@@ -53,7 +53,7 @@ class SetupTokenResponsePaymentSourceBuilder
|
||||
/**
|
||||
* Sets paypal field.
|
||||
*/
|
||||
public function paypal(?PayPalPaymentToken $value): self
|
||||
public function paypal(?PaypalPaymentToken $value): self
|
||||
{
|
||||
$this->instance->setPaypal($value);
|
||||
return $this;
|
||||
|
||||
@@ -13,31 +13,31 @@ namespace PaypalServerSdkLib\Models\Builders;
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\VaultedDigitalWalletShippingDetails;
|
||||
use PaypalServerSdkLib\Models\VaultExperienceContext;
|
||||
use PaypalServerSdkLib\Models\VaultPayPalWalletRequest;
|
||||
use PaypalServerSdkLib\Models\VaultPaypalWalletRequest;
|
||||
|
||||
/**
|
||||
* Builder for model VaultPayPalWalletRequest
|
||||
* Builder for model VaultPaypalWalletRequest
|
||||
*
|
||||
* @see VaultPayPalWalletRequest
|
||||
* @see VaultPaypalWalletRequest
|
||||
*/
|
||||
class VaultPayPalWalletRequestBuilder
|
||||
class VaultPaypalWalletRequestBuilder
|
||||
{
|
||||
/**
|
||||
* @var VaultPayPalWalletRequest
|
||||
* @var VaultPaypalWalletRequest
|
||||
*/
|
||||
private $instance;
|
||||
|
||||
private function __construct(VaultPayPalWalletRequest $instance)
|
||||
private function __construct(VaultPaypalWalletRequest $instance)
|
||||
{
|
||||
$this->instance = $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new vault pay pal wallet request Builder object.
|
||||
* Initializes a new vault paypal wallet request Builder object.
|
||||
*/
|
||||
public static function init(): self
|
||||
{
|
||||
return new self(new VaultPayPalWalletRequest());
|
||||
return new self(new VaultPaypalWalletRequest());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -95,9 +95,9 @@ class VaultPayPalWalletRequestBuilder
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new vault pay pal wallet request object.
|
||||
* Initializes a new vault paypal wallet request object.
|
||||
*/
|
||||
public function build(): VaultPayPalWalletRequest
|
||||
public function build(): VaultPaypalWalletRequest
|
||||
{
|
||||
return CoreHelper::clone($this->instance);
|
||||
}
|
||||
@@ -80,10 +80,10 @@ class CardVerificationProcessorResponse implements \JsonSerializable
|
||||
{
|
||||
$json = [];
|
||||
if (isset($this->avsCode)) {
|
||||
$json['avs_code'] = AVSCode::checkValue($this->avsCode);
|
||||
$json['avs_code'] = AvsCode::checkValue($this->avsCode);
|
||||
}
|
||||
if (isset($this->cvvCode)) {
|
||||
$json['cvv_code'] = CVVCode::checkValue($this->cvvCode);
|
||||
$json['cvv_code'] = CvvCode::checkValue($this->cvvCode);
|
||||
}
|
||||
|
||||
return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user