1
0

6 Commits
0.5.0 ... 0.6.1

Author SHA1 Message Date
PayPalServerSDKs
b26f3e7dcd Automated commit message 2024-11-21 20:04:48 +00:00
PayPalServerSDKs
00fde18df4 Automated commit message 2024-11-21 17:43:29 +00:00
Dani Kirby
de24c9e488 Automated commit message (#9)
Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
2024-10-22 09:41:42 -05:00
Dani Kirby
4bc534dfec Automated commit message (#8)
Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
2024-10-01 11:34:21 -05:00
Dani Kirby
09148245f7 Automated commit message (#5)
Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
2024-09-10 10:31:38 -05:00
Dani Kirby
6b43a4225b Beta Release 0.5.0 (#3)
* Automated commit message

* Automated commit message

* Automated commit message

* Automated commit message

---------

Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
2024-09-09 12:10:34 -05:00
180 changed files with 2111 additions and 862 deletions

22
LICENSE
View File

@@ -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 PayPals or any third partys 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 PayPals or any third partys 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 PayPals or any third partys 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 PayPals or any third partys 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.

View File

@@ -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.1"
```
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.1"
}
```
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.1
## 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.1/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.1/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.1/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.1/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.1/doc/controllers/orders.md)
* [Payments](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/controllers/payments.md)
* [Vault](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/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.1/doc/api-exception.md)
* [HttpRequest](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/http-request.md)
* [HttpResponse](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/http-response.md)
* [LoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/logging-configuration-builder.md)
* [RequestLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/request-logging-configuration-builder.md)
* [ResponseLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/response-logging-configuration-builder.md)

View File

@@ -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.

View File

@@ -35,10 +35,11 @@ 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. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).<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=,-]*$` |
| `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
@@ -88,6 +89,7 @@ function ordersGet(array $options): ApiResponse
| 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]+$` |
| `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>. |
| `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
@@ -126,6 +128,7 @@ function ordersPatch(array $options): ApiResponse
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `id` | `string` | Template, Required | The ID of the order to update.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
| `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` | [`?(Patch[])`](../../doc/models/patch.md) | Body, Optional | - |
## Response Type
@@ -171,7 +174,8 @@ function ordersConfirm(array $options): ApiResponse
| 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` |
| `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>. |
| `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 | - |
@@ -184,12 +188,7 @@ This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getR
```php
$collect = [
'id' => 'id0',
'prefer' => 'return=minimal',
'body' => ConfirmOrderRequestBuilder::init(
PaymentSourceBuilder::init()->build()
)
->processingInstruction(ProcessingInstruction::NO_INSTRUCTION)
->build()
'prefer' => 'return=minimal'
];
$apiResponse = $ordersController->ordersConfirm($collect);
@@ -219,10 +218,10 @@ function ordersAuthorize(array $options): ApiResponse
| 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` |
| `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. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).<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` | [`?OrderAuthorizeRequest`](../../doc/models/order-authorize-request.md) | Body, Optional | - |
## Response Type
@@ -266,10 +265,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. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).<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
@@ -314,7 +313,7 @@ function ordersTrackCreate(array $options): ApiResponse
| --- | --- | --- | --- |
| `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>. |
| `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
@@ -361,6 +360,7 @@ function ordersTrackersPatch(array $options): ApiResponse
| --- | --- | --- | --- |
| `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]+$` |
| `trackerId` | `string` | Template, Required | The order tracking ID.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
| `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` | [`?(Patch[])`](../../doc/models/patch.md) | Body, Optional | - |
## Response Type

View File

@@ -26,7 +26,7 @@ $paymentsController = $client->getPaymentsController();
Shows details for an authorized payment, by ID.
```php
function authorizationsGet(string $authorizationId): ApiResponse
function authorizationsGet(array $options): ApiResponse
```
## Parameters
@@ -34,6 +34,7 @@ function authorizationsGet(string $authorizationId): ApiResponse
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `authorizationId` | `string` | Template, Required | The ID of the authorized payment for which to show details. |
| `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> |
## Response Type
@@ -42,9 +43,11 @@ This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getR
## Example Usage
```php
$authorizationId = 'authorization_id8';
$collect = [
'authorizationId' => 'authorization_id8'
];
$apiResponse = $paymentsController->authorizationsGet($authorizationId);
$apiResponse = $paymentsController->authorizationsGet($collect);
```
## Errors
@@ -52,7 +55,6 @@ $apiResponse = $paymentsController->authorizationsGet($authorizationId);
| 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) |
| 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) |
| 500 | The request failed because an internal server error occurred. | `ApiException` |
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
@@ -71,8 +73,9 @@ 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'` |
| `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` | [`?CaptureRequest`](../../doc/models/capture-request.md) | Body, Optional | - |
## Response Type
@@ -120,8 +123,9 @@ function authorizationsReauthorize(array $options): ApiResponse
| 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. |
| `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> |
| `body` | [`?ReauthorizeRequest`](../../doc/models/reauthorize-request.md) | Body, Optional | - |
## Response Type
@@ -145,7 +149,6 @@ $apiResponse = $paymentsController->authorizationsReauthorize($collect);
| --- | --- | --- |
| 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` |
@@ -165,7 +168,8 @@ 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> |
| `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'` |
## Response Type
@@ -187,7 +191,6 @@ $apiResponse = $paymentsController->authorizationsVoid($collect);
| 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) |
@@ -247,9 +250,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
@@ -286,7 +289,7 @@ $apiResponse = $paymentsController->capturesRefund($collect);
Shows details for a refund, by ID.
```php
function refundsGet(string $refundId): ApiResponse
function refundsGet(array $options): ApiResponse
```
## Parameters
@@ -294,6 +297,7 @@ function refundsGet(string $refundId): ApiResponse
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `refundId` | `string` | Template, Required | The PayPal-generated ID for the refund for which to show details. |
| `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> |
## Response Type
@@ -302,9 +306,11 @@ This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getR
## Example Usage
```php
$refundId = 'refund_id4';
$collect = [
'refundId' => 'refund_id4'
];
$apiResponse = $paymentsController->refundsGet($refundId);
$apiResponse = $paymentsController->refundsGet($collect);
```
## Errors

View File

@@ -32,7 +32,7 @@ function paymentTokensCreate(array $options): ApiResponse
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `payPalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
| `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
@@ -43,7 +43,7 @@ This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getR
```php
$collect = [
'payPalRequestId' => 'PayPal-Request-Id6',
'paypalRequestId' => 'PayPal-Request-Id6',
'body' => PaymentTokenRequestBuilder::init(
PaymentTokenRequestPaymentSourceBuilder::init()->build()
)->build()
@@ -189,7 +189,7 @@ function setupTokensCreate(array $options): ApiResponse
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `payPalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
| `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
@@ -200,7 +200,7 @@ This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getR
```php
$collect = [
'payPalRequestId' => 'PayPal-Request-Id6',
'paypalRequestId' => 'PayPal-Request-Id6',
'body' => SetupTokenRequestBuilder::init(
SetupTokenRequestPaymentSourceBuilder::init()->build()
)->build()

View File

@@ -1,11 +1,11 @@
# AVS Code
# Avs Code
The address verification code for Visa, Discover, Mastercard, or American Express transactions.
## Enumeration
`AVSCode`
`AvsCode`
## Fields

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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)

View File

@@ -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)

View File

@@ -17,6 +17,7 @@ Card Verification details including the authorization details and 3D SECURE deta
| `time` | `?string` | Optional | The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote><br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `64`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])[T,t]([0-1][0-9]\|2[0-3]):[0-5][0-9]:([0-5][0-9]\|60)([.][0-9]+)?([Zz]\|[+-][0-9]{2}:[0-9]{2})$` | getTime(): ?string | setTime(?string time): void |
| `amount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getAmount(): ?Money | setAmount(?Money amount): void |
| `processorResponse` | [`?CardVerificationProcessorResponse`](../../doc/models/card-verification-processor-response.md) | Optional | The processor response information for payment requests, such as direct credit card transactions. | getProcessorResponse(): ?CardVerificationProcessorResponse | setProcessorResponse(?CardVerificationProcessorResponse processorResponse): void |
| `threeDSecure` | `mixed` | Optional | DEPRECATED. This field is DEPRECATED. Please find the 3D secure authentication data in 'three_d_secure' object under 'authentication_result' object instead of the 'verification' field. | getThreeDSecure(): | setThreeDSecure( threeDSecure): void |
## Example (as JSON)

View File

@@ -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)

View File

@@ -12,7 +12,7 @@ Payer confirms the intent to pay for the Order using the provided payment source
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `paymentSource` | [`PaymentSource`](../../doc/models/payment-source.md) | Required | The payment source definition. | getPaymentSource(): PaymentSource | setPaymentSource(PaymentSource paymentSource): void |
| `processingInstruction` | [`?string(ProcessingInstruction)`](../../doc/models/processing-instruction.md) | Optional | The instruction to process an order.<br>**Default**: `ProcessingInstruction::NO_INSTRUCTION`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[0-9A-Z_]+$` | getProcessingInstruction(): ?string | setProcessingInstruction(?string processingInstruction): void |
| `processingInstruction` | `mixed` | Optional | - | getProcessingInstruction(): | setProcessingInstruction( processingInstruction): void |
| `applicationContext` | [`?OrderConfirmApplicationContext`](../../doc/models/order-confirm-application-context.md) | Optional | Customizes the payer confirmation experience. | getApplicationContext(): ?OrderConfirmApplicationContext | setApplicationContext(?OrderConfirmApplicationContext applicationContext): void |
## Example (as JSON)
@@ -86,7 +86,10 @@ Payer confirms the intent to pay for the Order using the provided payment source
}
}
},
"processing_instruction": "NO_INSTRUCTION",
"processing_instruction": {
"key1": "val1",
"key2": "val2"
},
"application_context": {
"brand_name": "brand_name8",
"locale": "locale2",

View File

@@ -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

View File

@@ -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

View File

@@ -1,11 +1,11 @@
# EPS Payment Object
# Eps Payment Object
Information used to pay using eps.
## Structure
`EPSPaymentObject`
`EpsPaymentObject`
## Fields

View File

@@ -1,11 +1,11 @@
# EPS Payment Request
# Eps Payment Request
Information needed to pay using eps.
## Structure
`EPSPaymentRequest`
`EpsPaymentRequest`
## Fields

View File

@@ -1,11 +1,11 @@
# Fullfillment Type
# Fulfillment Type
A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.
## Enumeration
`FullfillmentType`
`FulfillmentType`
## Fields

View File

@@ -0,0 +1,33 @@
# Google Pay Card
The payment card used to fund a Google Pay payment. Can be a credit or debit card.
## Structure
`GooglePayCard`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `name` | `?string` | Optional | The card holder's name as it appears on the card.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `300`, *Pattern*: `^.{1,300}$` | getName(): ?string | setName(?string name): void |
| `number` | `?string` | Optional | The primary account number (PAN) for the payment card.<br>**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `19`, *Pattern*: `^[0-9]{13,19}$` | getNumber(): ?string | setNumber(?string number): void |
| `expiry` | `?string` | Optional | 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 |
| `lastDigits` | `?string` | Optional | The last digits of the payment card.<br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `4`, *Pattern*: `^[0-9]{2,4}$` | getLastDigits(): ?string | setLastDigits(?string lastDigits): void |
| `type` | [`?string(CardType)`](../../doc/models/card-type.md) | Optional | Type of card. i.e Credit, Debit and so on.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getType(): ?string | setType(?string type): void |
| `brand` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getBrand(): ?string | setBrand(?string brand): void |
| `billingAddress` | [`?PortablePostalAddressMediumGrained`](../../doc/models/portable-postal-address-medium-grained.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). | getBillingAddress(): ?PortablePostalAddressMediumGrained | setBillingAddress(?PortablePostalAddressMediumGrained billingAddress): void |
## Example (as JSON)
```json
{
"name": "name4",
"number": "number2",
"expiry": "expiry2",
"last_digits": "last_digits8",
"type": "DEBIT"
}
```

View File

@@ -14,6 +14,7 @@ Details shared by Google for the merchant to be shared with PayPal. This is requ
| `messageId` | `?string` | Optional | A unique ID that identifies the message in case it needs to be revoked or located at a later time.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `250`, *Pattern*: `^.*$` | getMessageId(): ?string | setMessageId(?string messageId): void |
| `messageExpiration` | `?string` | Optional | Date and time at which the message expires as UTC milliseconds since epoch. Integrators should reject any message that's expired.<br>**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `13`, *Pattern*: `\d{13}` | getMessageExpiration(): ?string | setMessageExpiration(?string messageExpiration): void |
| `paymentMethod` | [`string(GooglePayPaymentMethod)`](../../doc/models/google-pay-payment-method.md) | Required | The type of the payment credential. Currently, only CARD is supported.<br>**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `4` | getPaymentMethod(): string | setPaymentMethod(string paymentMethod): void |
| `card` | [`GooglePayCard`](../../doc/models/google-pay-card.md) | Required | The payment card used to fund a Google Pay payment. Can be a credit or debit card. | getCard(): GooglePayCard | setCard(GooglePayCard card): void |
| `authenticationMethod` | [`string(GooglePayAuthenticationMethod)`](../../doc/models/google-pay-authentication-method.md) | Required | Authentication Method which is used for the card transaction.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `50` | getAuthenticationMethod(): string | setAuthenticationMethod(string authenticationMethod): void |
| `cryptogram` | `?string` | Optional | Base-64 cryptographic identifier used by card schemes to validate the token verification result. This is a conditionally required field if authentication_method is CRYPTOGRAM_3DS.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2000` | getCryptogram(): ?string | setCryptogram(?string cryptogram): void |
| `eciIndicator` | `?string` | Optional | Electronic Commerce Indicator may not always be present. It is only returned for tokens on the Visa card network. This value is passed through in the payment authorization request.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `256`, *Pattern*: `^.*$` | getEciIndicator(): ?string | setEciIndicator(?string eciIndicator): void |
@@ -25,6 +26,13 @@ Details shared by Google for the merchant to be shared with PayPal. This is requ
"message_id": "message_id4",
"message_expiration": "message_expiration8",
"payment_method": "CARD",
"card": {
"name": "name6",
"number": "number6",
"expiry": "expiry4",
"last_digits": "last_digits0",
"type": "UNKNOWN"
},
"authentication_method": "PAN_ONLY",
"cryptogram": "cryptogram0",
"eci_indicator": "eci_indicator4"

View File

@@ -46,6 +46,13 @@ Information needed to pay using Google Pay.
"message_id": "message_id0",
"message_expiration": "message_expiration2",
"payment_method": "CARD",
"card": {
"name": "name6",
"number": "number6",
"expiry": "expiry4",
"last_digits": "last_digits0",
"type": "UNKNOWN"
},
"authentication_method": "PAN_ONLY",
"cryptogram": "cryptogram6",
"eci_indicator": "eci_indicator0"

View File

@@ -1,11 +1,11 @@
# IDEAL Payment Object
# Ideal Payment Object
Information used to pay using iDEAL.
## Structure
`IDEALPaymentObject`
`IdealPaymentObject`
## Fields

View File

@@ -1,11 +1,11 @@
# IDEAL Payment Request
# Ideal Payment Request
Information needed to pay using iDEAL.
## Structure
`IDEALPaymentRequest`
`IdealPaymentRequest`
## Fields

View File

@@ -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)

View File

@@ -1,11 +1,11 @@
# Link HTTP Method
# Link Http Method
The HTTP method required to make the related call.
## Enumeration
`LinkHTTPMethod`
`LinkHttpMethod`
## Fields

View File

@@ -1,11 +1,11 @@
# My Bank Payment Object
# Mybank Payment Object
Information used to pay using MyBank.
## Structure
`MyBankPaymentObject`
`MybankPaymentObject`
## Fields

View File

@@ -1,11 +1,11 @@
# My Bank Payment Request
# Mybank Payment Request
Information needed to pay using MyBank.
## Structure
`MyBankPaymentRequest`
`MybankPaymentRequest`
## Fields

View File

@@ -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)

View File

@@ -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 |
@@ -108,6 +108,13 @@ The payment source definition.
"message_id": "message_id0",
"message_expiration": "message_expiration2",
"payment_method": "CARD",
"card": {
"name": "name6",
"number": "number6",
"expiry": "expiry4",
"last_digits": "last_digits0",
"type": "UNKNOWN"
},
"authentication_method": "PAN_ONLY",
"cryptogram": "cryptogram6",
"eci_indicator": "eci_indicator0"

View File

@@ -104,6 +104,13 @@ The authorization of an order request.
"message_id": "message_id0",
"message_expiration": "message_expiration2",
"payment_method": "CARD",
"card": {
"name": "name6",
"number": "number6",
"expiry": "expiry4",
"last_digits": "last_digits0",
"type": "UNKNOWN"
},
"authentication_method": "PAN_ONLY",
"cryptogram": "cryptogram6",
"eci_indicator": "eci_indicator0"

View File

@@ -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 |

View File

@@ -14,7 +14,7 @@
| `id` | `?string` | Optional | The ID of the order. | getId(): ?string | setId(?string id): void |
| `paymentSource` | [`?OrderAuthorizeResponsePaymentSource`](../../doc/models/order-authorize-response-payment-source.md) | Optional | The payment source used to fund the payment. | getPaymentSource(): ?OrderAuthorizeResponsePaymentSource | setPaymentSource(?OrderAuthorizeResponsePaymentSource paymentSource): void |
| `intent` | [`?string(CheckoutPaymentIntent)`](../../doc/models/checkout-payment-intent.md) | Optional | The intent to either capture payment immediately or authorize a payment for an order after order creation. | getIntent(): ?string | setIntent(?string intent): void |
| `processingInstruction` | [`?string(ProcessingInstruction)`](../../doc/models/processing-instruction.md) | Optional | The instruction to process an order.<br>**Default**: `ProcessingInstruction::NO_INSTRUCTION`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[0-9A-Z_]+$` | getProcessingInstruction(): ?string | setProcessingInstruction(?string processingInstruction): void |
| `processingInstruction` | `mixed` | Optional | - | getProcessingInstruction(): | setProcessingInstruction( processingInstruction): void |
| `payer` | [`?Payer`](../../doc/models/payer.md) | Optional | - | getPayer(): ?Payer | setPayer(?Payer payer): void |
| `purchaseUnits` | [`?(PurchaseUnit[])`](../../doc/models/purchase-unit.md) | Optional | An array of purchase units. Each purchase unit establishes a contract between a customer and merchant. Each purchase unit represents either a full or partial order that the customer intends to purchase from the merchant.<br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getPurchaseUnits(): ?array | setPurchaseUnits(?array purchaseUnits): void |
| `status` | [`?string(OrderStatus)`](../../doc/models/order-status.md) | Optional | The order status.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void |
@@ -24,7 +24,6 @@
```json
{
"processing_instruction": "NO_INSTRUCTION",
"create_time": "create_time0",
"update_time": "update_time4",
"id": "id4",

View File

@@ -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 |
@@ -108,6 +108,13 @@ The payment source definition.
"message_id": "message_id0",
"message_expiration": "message_expiration2",
"payment_method": "CARD",
"card": {
"name": "name6",
"number": "number6",
"expiry": "expiry4",
"last_digits": "last_digits0",
"type": "UNKNOWN"
},
"authentication_method": "PAN_ONLY",
"cryptogram": "cryptogram6",
"eci_indicator": "eci_indicator0"

View File

@@ -104,6 +104,13 @@ Completes an capture payment for an order.
"message_id": "message_id0",
"message_expiration": "message_expiration2",
"payment_method": "CARD",
"card": {
"name": "name6",
"number": "number6",
"expiry": "expiry4",
"last_digits": "last_digits0",
"type": "UNKNOWN"
},
"authentication_method": "PAN_ONLY",
"cryptogram": "cryptogram6",
"eci_indicator": "eci_indicator0"

View File

@@ -25,7 +25,7 @@ The tracking details of an order.
"capture_id": "capture_id0",
"notify_payer": false,
"tracking_number": "tracking_number6",
"carrier": "SNTGLOBAL_API",
"carrier": "HOMERUNNER",
"carrier_name_other": "carrier_name_other0",
"items": [
{

View File

@@ -16,17 +16,16 @@ The order details.
| `id` | `?string` | Optional | The ID of the order. | getId(): ?string | setId(?string id): void |
| `paymentSource` | [`?PaymentSourceResponse`](../../doc/models/payment-source-response.md) | Optional | The payment source used to fund the payment. | getPaymentSource(): ?PaymentSourceResponse | setPaymentSource(?PaymentSourceResponse paymentSource): void |
| `intent` | [`?string(CheckoutPaymentIntent)`](../../doc/models/checkout-payment-intent.md) | Optional | The intent to either capture payment immediately or authorize a payment for an order after order creation. | getIntent(): ?string | setIntent(?string intent): void |
| `processingInstruction` | [`?string(ProcessingInstruction)`](../../doc/models/processing-instruction.md) | Optional | The instruction to process an order.<br>**Default**: `ProcessingInstruction::NO_INSTRUCTION`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[0-9A-Z_]+$` | getProcessingInstruction(): ?string | setProcessingInstruction(?string processingInstruction): void |
| `processingInstruction` | `mixed` | Optional | - | getProcessingInstruction(): | setProcessingInstruction( processingInstruction): void |
| `payer` | [`?Payer`](../../doc/models/payer.md) | Optional | - | getPayer(): ?Payer | setPayer(?Payer payer): void |
| `purchaseUnits` | [`?(PurchaseUnit[])`](../../doc/models/purchase-unit.md) | Optional | An array of purchase units. Each purchase unit establishes a contract between a customer and merchant. Each purchase unit represents either a full or partial order that the customer intends to purchase from the merchant.<br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getPurchaseUnits(): ?array | setPurchaseUnits(?array purchaseUnits): void |
| `status` | [`?string(OrderStatus)`](../../doc/models/order-status.md) | Optional | The order 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. To complete payer approval, use the `approve` link to redirect the payer. The API caller has 3 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 3 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include `application_context.return_url` is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment. | getLinks(): ?array | setLinks(?array links): void |
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related HATEOAS links. To complete payer approval, use the `approve` link to redirect the payer. The API caller has 6 hours (default setting, this which can be changed by your account manager to 24/48/72 hours to accommodate your use case) from the time the order is created, to redirect your payer. Once redirected, the API caller has 6 hours for the payer to approve the order and either authorize or capture the order. If you are not using the PayPal JavaScript SDK to initiate PayPal Checkout (in context) ensure that you include `application_context.return_url` is specified or you will get "We're sorry, Things don't appear to be working at the moment" after the payer approves the payment. | getLinks(): ?array | setLinks(?array links): void |
## Example (as JSON)
```json
{
"processing_instruction": "NO_INSTRUCTION",
"create_time": "create_time8",
"update_time": "update_time4",
"id": "id2",

View File

@@ -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

View File

@@ -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 |

View File

@@ -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 |

View File

@@ -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 |

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -1,9 +1,9 @@
# Pay Pal Payment Token
# Paypal Payment Token
## Structure
`PayPalPaymentToken`
`PaypalPaymentToken`
## Fields

View File

@@ -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

View File

@@ -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)

View File

@@ -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)

View File

@@ -1,9 +1,9 @@
# Pay Pal Wallet Customer Request
# Paypal Wallet Customer Request
## Structure
`PayPalWalletCustomerRequest`
`PaypalWalletCustomerRequest`
## Fields

View File

@@ -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

View File

@@ -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)

View File

@@ -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)

View File

@@ -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)

View File

@@ -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)

View File

@@ -1,11 +1,11 @@
# Pay Pal Wallet Vault Status
# Paypal Wallet Vault Status
The vault status.
## Enumeration
`PayPalWalletVaultStatus`
`PaypalWalletVaultStatus`
## Fields

View File

@@ -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)

View File

@@ -0,0 +1,33 @@
# Portable Postal Address Medium Grained
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).
## Structure
`PortablePostalAddressMediumGrained`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `addressLine1` | `?string` | Optional | The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.<br>**Constraints**: *Maximum Length*: `300` | getAddressLine1(): ?string | setAddressLine1(?string addressLine1): void |
| `addressLine2` | `?string` | Optional | The second line of the address, for example, a suite or apartment number.<br>**Constraints**: *Maximum Length*: `300` | getAddressLine2(): ?string | setAddressLine2(?string addressLine2): void |
| `adminArea2` | `?string` | Optional | A city, town, or village. Smaller than `admin_area_level_1`.<br>**Constraints**: *Maximum Length*: `120` | getAdminArea2(): ?string | setAdminArea2(?string adminArea2): void |
| `adminArea1` | `?string` | Optional | The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:<ul><li>UK. A county.</li><li>US. A state.</li><li>Canada. A province.</li><li>Japan. A prefecture.</li><li>Switzerland. A *kanton*.</li></ul><br>**Constraints**: *Maximum Length*: `300` | getAdminArea1(): ?string | setAdminArea1(?string adminArea1): void |
| `postalCode` | `?string` | Optional | The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).<br>**Constraints**: *Maximum Length*: `60` | getPostalCode(): ?string | setPostalCode(?string postalCode): void |
| `countryCode` | `string` | Required | The [2-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 |
## Example (as JSON)
```json
{
"address_line_1": "address_line_16",
"address_line_2": "address_line_24",
"admin_area_2": "admin_area_22",
"admin_area_1": "admin_area_10",
"postal_code": "postal_code6",
"country_code": "country_code6"
}
```

View File

@@ -1,16 +0,0 @@
# Processing Instruction
The instruction to process an order.
## Enumeration
`ProcessingInstruction`
## Fields
| Name |
| --- |
| `ORDER_COMPLETE_ON_PAYMENT_APPROVAL` |
| `NO_INSTRUCTION` |

View File

@@ -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 |

View File

@@ -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 |

View File

@@ -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)

View File

@@ -1287,4 +1287,112 @@ The carrier for the shipment. Some carriers have a global version as well as loc
| `LOGINEXT_WEBHOOK` |
| `EMS` |
| `SPEEDY` |
| `ZOOM_RED` |
| `NAVLUNGO` |
| `CASTLEPARCELS` |
| `WEEE` |
| `PACKALY` |
| `YUNHUIPOST` |
| `YOUPARCEL` |
| `LEMAN` |
| `MOOVIN` |
| `URB_IT` |
| `MULTIENTREGAPANAMA` |
| `JUSDASR` |
| `DISCOUNTPOST` |
| `RHENUS_UK` |
| `SWISHIP_JP` |
| `GLS_US` |
| `SMTL` |
| `EMEGA` |
| `EXPRESSONE_SV` |
| `HEPSIJET` |
| `WELIVERY` |
| `BRINGER` |
| `EASYROUTES` |
| `MRW` |
| `RPM` |
| `DPD_PRT` |
| `GLS_ROMANIA` |
| `LMPARCEL` |
| `GTAGSM` |
| `DOMINO` |
| `ESHIPPER` |
| `TRANSPAK` |
| `XINDUS` |
| `AOYUE` |
| `EASYPARCEL` |
| `EXPRESSONE` |
| `SENDEO_KARGO` |
| `SPEEDAF` |
| `ETOWER` |
| `GCX` |
| `NINJAVAN_VN` |
| `ALLEGRO` |
| `JUMPPOINT` |
| `SHIPGLOBAL_US` |
| `KINISI` |
| `OAKH` |
| `AWEST` |
| `BARSAN` |
| `ENERGOLOGISTIC` |
| `MADROOEX` |
| `GOBOLT` |
| `SWISS_UNIVERSAL_EXPRESS` |
| `IORDIRECT` |
| `XMSZM` |
| `GLS_HUN` |
| `SENDY` |
| `BRAUNSEXPRESS` |
| `GRANDSLAMEXPRESS` |
| `XGS` |
| `OTSCHILE` |
| `PACK_UP` |
| `PARCELSTARS` |
| `TEAMEXPRESSLLC` |
| `ASYADEXPRESS` |
| `TDN` |
| `EARLYBIRD` |
| `CACESA` |
| `PARCELJET` |
| `MNG_KARGO` |
| `SUPERPACKLINE` |
| `SPEEDX` |
| `VESYL` |
| `SKYKING` |
| `DIRMENSAJERIA` |
| `NETLOGIXGROUP` |
| `ZYOU` |
| `JAWAR` |
| `AGSYSTEMS` |
| `GPS` |
| `PTT_KARGO` |
| `MAERGO` |
| `ARIHANTCOURIER` |
| `VTFE` |
| `YUNANT` |
| `URBIFY` |
| `PACK_MAN` |
| `LIEFERGRUN` |
| `OBIBOX` |
| `PAIKEDA` |
| `SCOTTY` |
| `INTELCOM_CA` |
| `SWE` |
| `ASENDIA` |
| `DPD_AT` |
| `RELAY` |
| `ATA` |
| `SKYEXPRESS_INTERNATIONAL` |
| `SURAT_KARGO` |
| `SGLINK` |
| `FLEETOPTICSINC` |
| `SHOPLINE` |
| `PIGGYSHIP` |
| `LOGOIX` |
| `KOLAY_GELSIN` |
| `ASSOCIATED_COURIERS` |
| `UPS_CHECKER` |
| `WINESHIPPING` |
| `SPEDISCI` |

View File

@@ -13,7 +13,7 @@ The shipping details.
| --- | --- | --- | --- | --- | --- |
| `name` | [`?ShippingName`](../../doc/models/shipping-name.md) | Optional | The name of the party. | getName(): ?ShippingName | setName(?ShippingName name): void |
| `phoneNumber` | [`?PhoneNumberWithCountryCode`](../../doc/models/phone-number-with-country-code.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(): ?PhoneNumberWithCountryCode | setPhoneNumber(?PhoneNumberWithCountryCode phoneNumber): void |
| `type` | [`?string(FullfillmentType)`](../../doc/models/fullfillment-type.md) | Optional | A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getType(): ?string | setType(?string type): void |
| `type` | [`?string(FulfillmentType)`](../../doc/models/fulfillment-type.md) | Optional | A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getType(): ?string | setType(?string type): void |
| `options` | [`?(ShippingOption[])`](../../doc/models/shipping-option.md) | Optional | An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.<br>**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `10` | getOptions(): ?array | setOptions(?array options): 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 |

View File

@@ -13,7 +13,7 @@ The order shipping details.
| --- | --- | --- | --- | --- | --- |
| `name` | [`?ShippingName`](../../doc/models/shipping-name.md) | Optional | The name of the party. | getName(): ?ShippingName | setName(?ShippingName name): void |
| `phoneNumber` | [`?PhoneNumberWithCountryCode`](../../doc/models/phone-number-with-country-code.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(): ?PhoneNumberWithCountryCode | setPhoneNumber(?PhoneNumberWithCountryCode phoneNumber): void |
| `type` | [`?string(FullfillmentType)`](../../doc/models/fullfillment-type.md) | Optional | A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getType(): ?string | setType(?string type): void |
| `type` | [`?string(FulfillmentType)`](../../doc/models/fulfillment-type.md) | Optional | A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getType(): ?string | setType(?string type): void |
| `options` | [`?(ShippingOption[])`](../../doc/models/shipping-option.md) | Optional | An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.<br>**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `10` | getOptions(): ?array | setOptions(?array options): 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 |
| `trackers` | [`?(OrderTrackerResponse[])`](../../doc/models/order-tracker-response.md) | Optional | An array of trackers for a transaction. | getTrackers(): ?array | setTrackers(?array trackers): void |

View File

@@ -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)

View File

@@ -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)

View File

@@ -1,11 +1,11 @@
# UPC Type
# Upc Type
The Universal Product Code type.
## Enumeration
`UPCType`
`UpcType`
## Fields

View File

@@ -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

View File

@@ -12,7 +12,7 @@ The shipping details.
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `name` | [`?ShippingName`](../../doc/models/shipping-name.md) | Optional | The name of the party. | getName(): ?ShippingName | setName(?ShippingName name): void |
| `type` | [`?string(FullfillmentType)`](../../doc/models/fullfillment-type.md) | Optional | A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getType(): ?string | setType(?string type): void |
| `type` | [`?string(FulfillmentType)`](../../doc/models/fulfillment-type.md) | Optional | A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getType(): ?string | setType(?string type): 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 |
## Example (as JSON)

View File

@@ -43,10 +43,11 @@ 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('Prefer', $options)->extract('prefer', 'return=minimal')
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'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion')
);
$_resHandler = $this->responseHandler()
@@ -95,6 +96,7 @@ class OrdersController extends BaseController
->auth('Oauth2')
->parameters(
TemplateParam::init('id', $options)->extract('id'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
QueryParam::init('fields', $options)->extract('fields')
);
@@ -167,6 +169,7 @@ class OrdersController extends BaseController
->parameters(
TemplateParam::init('id', $options)->extract('id'),
HeaderParam::init('Content-Type', 'application/json'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
BodyParam::init($options)->extract('body')
);
@@ -218,7 +221,8 @@ class OrdersController extends BaseController
->parameters(
TemplateParam::init('id', $options)->extract('id'),
HeaderParam::init('Content-Type', 'application/json'),
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
BodyParam::init($options)->extract('body')
);
@@ -270,10 +274,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')
);
@@ -336,10 +340,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')
);
@@ -398,7 +402,7 @@ class OrdersController extends BaseController
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-Auth-Assertion', $options)->extract('paypalAuthAssertion')
);
$_resHandler = $this->responseHandler()
@@ -455,6 +459,7 @@ class OrdersController extends BaseController
TemplateParam::init('id', $options)->extract('id'),
TemplateParam::init('tracker_id', $options)->extract('trackerId'),
HeaderParam::init('Content-Type', 'application/json'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
BodyParam::init($options)->extract('body')
);

View File

@@ -26,15 +26,18 @@ class PaymentsController extends BaseController
/**
* Shows details for an authorized payment, by ID.
*
* @param string $authorizationId The ID of the authorized payment for which to show details.
* @param array $options Array with all options for search
*
* @return ApiResponse Response from the API call
*/
public function authorizationsGet(string $authorizationId): ApiResponse
public function authorizationsGet(array $options): ApiResponse
{
$_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payments/authorizations/{authorization_id}')
->auth('Oauth2')
->parameters(TemplateParam::init('authorization_id', $authorizationId));
->parameters(
TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion')
);
$_resHandler = $this->responseHandler()
->throwErrorOn(
@@ -45,13 +48,6 @@ class PaymentsController extends BaseController
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)
@@ -81,8 +77,9 @@ 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'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
BodyParam::init($options)->extract('body')
);
@@ -163,8 +160,9 @@ 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'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
BodyParam::init($options)->extract('body')
);
@@ -185,13 +183,6 @@ class PaymentsController extends BaseController
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)
@@ -229,19 +220,12 @@ 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('PayPal-Request-Id', $options)->extract('paypalRequestId'),
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal')
);
$_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(
@@ -342,9 +326,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')
);
@@ -402,15 +386,18 @@ class PaymentsController extends BaseController
/**
* Shows details for a refund, by ID.
*
* @param string $refundId The PayPal-generated ID for the refund for which to show details.
* @param array $options Array with all options for search
*
* @return ApiResponse Response from the API call
*/
public function refundsGet(string $refundId): ApiResponse
public function refundsGet(array $options): ApiResponse
{
$_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payments/refunds/{refund_id}')
->auth('Oauth2')
->parameters(TemplateParam::init('refund_id', $refundId));
->parameters(
TemplateParam::init('refund_id', $options)->extract('refundId'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion')
);
$_resHandler = $this->responseHandler()
->throwErrorOn(

View File

@@ -37,7 +37,7 @@ class VaultController extends BaseController
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/payment-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')
);
@@ -191,7 +191,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')
);

View File

@@ -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.");
}
}

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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;
}

View File

@@ -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;
}

View File

@@ -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);
}
}

View File

@@ -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);
}

View 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);
}
}

View File

@@ -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);
}

View File

@@ -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);
}

View File

@@ -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);
}

View File

@@ -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);
}

View File

@@ -94,6 +94,15 @@ class CardVerificationDetailsBuilder
return $this;
}
/**
* Sets three d secure field.
*/
public function threeDSecure($value): self
{
$this->instance->setThreeDSecure($value);
return $this;
}
/**
* Initializes a new card verification details object.
*/

View File

@@ -43,7 +43,7 @@ class ConfirmOrderRequestBuilder
/**
* Sets processing instruction field.
*/
public function processingInstruction(?string $value): self
public function processingInstruction($value): self
{
$this->instance->setProcessingInstruction($value);
return $this;

View File

@@ -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);
}

View File

@@ -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);
}

View File

@@ -0,0 +1,112 @@
<?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\GooglePayCard;
use PaypalServerSdkLib\Models\PortablePostalAddressMediumGrained;
/**
* Builder for model GooglePayCard
*
* @see GooglePayCard
*/
class GooglePayCardBuilder
{
/**
* @var GooglePayCard
*/
private $instance;
private function __construct(GooglePayCard $instance)
{
$this->instance = $instance;
}
/**
* Initializes a new google pay card Builder object.
*/
public static function init(): self
{
return new self(new GooglePayCard());
}
/**
* Sets name field.
*/
public function name(?string $value): self
{
$this->instance->setName($value);
return $this;
}
/**
* Sets number field.
*/
public function number(?string $value): self
{
$this->instance->setNumber($value);
return $this;
}
/**
* Sets expiry field.
*/
public function expiry(?string $value): self
{
$this->instance->setExpiry($value);
return $this;
}
/**
* Sets last digits field.
*/
public function lastDigits(?string $value): self
{
$this->instance->setLastDigits($value);
return $this;
}
/**
* Sets type field.
*/
public function type(?string $value): self
{
$this->instance->setType($value);
return $this;
}
/**
* Sets brand field.
*/
public function brand(?string $value): self
{
$this->instance->setBrand($value);
return $this;
}
/**
* Sets billing address field.
*/
public function billingAddress(?PortablePostalAddressMediumGrained $value): self
{
$this->instance->setBillingAddress($value);
return $this;
}
/**
* Initializes a new google pay card object.
*/
public function build(): GooglePayCard
{
return CoreHelper::clone($this->instance);
}
}

View File

@@ -11,6 +11,7 @@ declare(strict_types=1);
namespace PaypalServerSdkLib\Models\Builders;
use Core\Utils\CoreHelper;
use PaypalServerSdkLib\Models\GooglePayCard;
use PaypalServerSdkLib\Models\GooglePayDecryptedTokenData;
/**
@@ -33,9 +34,9 @@ class GooglePayDecryptedTokenDataBuilder
/**
* Initializes a new google pay decrypted token data Builder object.
*/
public static function init(string $paymentMethod, string $authenticationMethod): self
public static function init(string $paymentMethod, GooglePayCard $card, string $authenticationMethod): self
{
return new self(new GooglePayDecryptedTokenData($paymentMethod, $authenticationMethod));
return new self(new GooglePayDecryptedTokenData($paymentMethod, $card, $authenticationMethod));
}
/**

View File

@@ -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);
}

View File

@@ -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);
}

View File

@@ -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);
}

View File

@@ -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);
}

Some files were not shown because too many files have changed in this diff Show More