forked from LiveCarta/PayPal-PHP-Server-SDK
Compare commits
7 Commits
0.6.0
...
initialize
| Author | SHA1 | Date | |
|---|---|---|---|
|
f465f0920c | ||
|
|
7d36472b6e | ||
|
|
1522ab5293 | ||
|
|
eb2608f55a | ||
|
|
b8521e83cc | ||
|
|
f423f69aee | ||
|
|
b20aa829db |
10
.codegenignore
Normal file
10
.codegenignore
Normal file
@@ -0,0 +1,10 @@
|
||||
tests/E2E/**
|
||||
tests/UnitTests/**
|
||||
tests/ClientFactory.php
|
||||
tests/WebDriverUtilities.php
|
||||
tests/bootstrap.php
|
||||
tests/Controllers/BaseTestController.php
|
||||
.gitignore
|
||||
.github/**
|
||||
phpunit.xml
|
||||
selenium.jar
|
||||
46
.github/workflows/test-runner.yml
vendored
Normal file
46
.github/workflows/test-runner.yml
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
name: Tests
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
test:
|
||||
name: Running all tests
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Set up PHP
|
||||
uses: shivammathur/setup-php@v2
|
||||
with:
|
||||
php-version: '8.2'
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
composer install
|
||||
composer require php-webdriver/webdriver --dev
|
||||
composer require phpunit/phpunit --dev
|
||||
|
||||
- name: Run Lint Tests
|
||||
run: composer lint
|
||||
|
||||
- name: Run Analyzer Tests
|
||||
run: composer analyze
|
||||
|
||||
- name: Set up Java 11
|
||||
uses: actions/setup-java@v3
|
||||
with:
|
||||
java-version: '11'
|
||||
distribution: 'temurin'
|
||||
|
||||
- name: Run Selenium Server
|
||||
run: java -jar selenium.jar standalone &
|
||||
|
||||
- name: Run tests
|
||||
run: ./vendor/bin/phpunit --testdox
|
||||
env:
|
||||
CLIENT_ID: ${{ secrets.CLIENT_ID }}
|
||||
CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
|
||||
EMAIL: ${{ secrets.EMAIL }}
|
||||
PASSWORD: ${{ secrets.PASSWORD }}
|
||||
4
LICENSE
4
LICENSE
@@ -1,8 +1,8 @@
|
||||
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.
|
||||
|
||||
53
README.md
53
README.md
@@ -1,24 +1,9 @@
|
||||
|
||||
# Getting Started with PayPal Server SDK
|
||||
# Getting Started with Paypal Server SDK
|
||||
|
||||
## Introduction
|
||||
|
||||
### ⚠️ 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.*
|
||||
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.
|
||||
|
||||
Find out more here: [https://developer.paypal.com/docs/api/orders/v2/](https://developer.paypal.com/docs/api/orders/v2/)
|
||||
|
||||
@@ -27,23 +12,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.6.0"
|
||||
composer require "paypal/paypal-server-sdk:0.5.1"
|
||||
```
|
||||
|
||||
Or add it to the composer.json file manually as given below:
|
||||
|
||||
```php
|
||||
"require": {
|
||||
"paypal/paypal-server-sdk": "0.6.0"
|
||||
"paypal/paypal-server-sdk": "0.5.1"
|
||||
}
|
||||
```
|
||||
|
||||
You can also view the package at:
|
||||
https://packagist.org/packages/paypal/paypal-server-sdk#0.6.0
|
||||
https://packagist.org/packages/paypal/paypal-server-sdk#0.5.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.6.0/doc/client.md)
|
||||
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/client.md)
|
||||
|
||||
The following parameters are configurable for the API Client:
|
||||
|
||||
@@ -59,13 +44,13 @@ 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.6.0/doc/logging-configuration-builder.md) | Represents the logging configurations for API calls |
|
||||
| `clientCredentialsAuth` | [`ClientCredentialsAuth`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/auth/oauth-2-client-credentials-grant.md) | The Credentials Setter for OAuth 2 Client Credentials Grant |
|
||||
| `loggingConfiguration` | [`LoggingConfigurationBuilder`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.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.5.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:
|
||||
|
||||
```php
|
||||
$client = PaypalServerSdkClientBuilder::init()
|
||||
$client = PaypalServerSDKClientBuilder::init()
|
||||
->clientCredentialsAuthCredentials(
|
||||
ClientCredentialsAuthCredentialsBuilder::init(
|
||||
'OAuthClientId',
|
||||
@@ -105,20 +90,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.6.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.5.1/doc/auth/oauth-2-client-credentials-grant.md)
|
||||
|
||||
## List of APIs
|
||||
|
||||
* [Orders](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/controllers/orders.md)
|
||||
* [Payments](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/controllers/payments.md)
|
||||
* [Vault](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/controllers/vault.md)
|
||||
* [Orders](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/controllers/orders.md)
|
||||
* [Payments](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/controllers/payments.md)
|
||||
* [Vault](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/controllers/vault.md)
|
||||
|
||||
## Classes Documentation
|
||||
|
||||
* [ApiException](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/api-exception.md)
|
||||
* [HttpRequest](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/http-request.md)
|
||||
* [HttpResponse](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/http-response.md)
|
||||
* [LoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/logging-configuration-builder.md)
|
||||
* [RequestLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/request-logging-configuration-builder.md)
|
||||
* [ResponseLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/response-logging-configuration-builder.md)
|
||||
* [ApiException](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/api-exception.md)
|
||||
* [HttpRequest](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/http-request.md)
|
||||
* [HttpResponse](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/http-response.md)
|
||||
* [LoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/logging-configuration-builder.md)
|
||||
* [RequestLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/request-logging-configuration-builder.md)
|
||||
* [ResponseLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/response-logging-configuration-builder.md)
|
||||
|
||||
|
||||
@@ -22,12 +22,12 @@
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"PaypalServerSdkLib\\": "src/"
|
||||
"PaypalServerSDKLib\\": "src/"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"PaypalServerSdkLib\\Tests\\": "tests/"
|
||||
"PaypalServerSDKLib\\Tests\\": "tests/"
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
|
||||
@@ -27,7 +27,7 @@ Documentation for accessing and setting credentials for Oauth2.
|
||||
You must initialize the client with *OAuth 2.0 Client Credentials Grant* credentials as shown in the following code snippet. This will fetch the OAuth token automatically when any of the endpoints, requiring *OAuth 2.0 Client Credentials Grant* autentication, are called.
|
||||
|
||||
```php
|
||||
$client = PaypalServerSdkClientBuilder::init()
|
||||
$client = PaypalServerSDKClientBuilder::init()
|
||||
->clientCredentialsAuthCredentials(
|
||||
ClientCredentialsAuthCredentialsBuilder::init(
|
||||
'OAuthClientId',
|
||||
@@ -46,7 +46,7 @@ Your application can also manually provide an OAuthToken using the setter `oAuth
|
||||
Whenever the OAuth Token gets updated, the provided callback implementation will be executed. For instance, you may use it to store your access token whenever it gets updated.
|
||||
|
||||
```php
|
||||
$client = PaypalServerSdkClientBuilder::init()
|
||||
$client = PaypalServerSDKClientBuilder::init()
|
||||
->clientCredentialsAuthCredentials(
|
||||
ClientCredentialsAuthCredentialsBuilder::init(
|
||||
'OAuthClientId',
|
||||
@@ -68,7 +68,7 @@ $client = PaypalServerSdkClientBuilder::init()
|
||||
To authorize a client using a stored access token, set up the `oAuthTokenProvider` in `ClientCredentialsAuthCredentialsBuilder` along with the other auth parameters before creating the client:
|
||||
|
||||
```php
|
||||
$client = PaypalServerSdkClientBuilder::init()
|
||||
$client = PaypalServerSDKClientBuilder::init()
|
||||
->clientCredentialsAuthCredentials(
|
||||
ClientCredentialsAuthCredentialsBuilder::init(
|
||||
'OAuthClientId',
|
||||
|
||||
@@ -21,7 +21,7 @@ The following parameters are configurable for the API Client:
|
||||
The API client can be initialized as follows:
|
||||
|
||||
```php
|
||||
$client = PaypalServerSdkClientBuilder::init()
|
||||
$client = PaypalServerSDKClientBuilder::init()
|
||||
->clientCredentialsAuthCredentials(
|
||||
ClientCredentialsAuthCredentialsBuilder::init(
|
||||
'OAuthClientId',
|
||||
@@ -46,7 +46,7 @@ API calls return an `ApiResponse` object that includes the following fields:
|
||||
| `getHeaders` | Headers of the HTTP response as a Hash |
|
||||
| `getResult` | The deserialized body of the HTTP response as a String |
|
||||
|
||||
## PayPal Server SDK Client
|
||||
## Paypal Server SDK Client
|
||||
|
||||
The gateway for the SDK. This class acts as a factory for the Controllers and also holds the configuration of the SDK.
|
||||
|
||||
|
||||
@@ -12,110 +12,16 @@ $ordersController = $client->getOrdersController();
|
||||
|
||||
## Methods
|
||||
|
||||
* [Orders Authorize](../../doc/controllers/orders.md#orders-authorize)
|
||||
* [Orders Track Create](../../doc/controllers/orders.md#orders-track-create)
|
||||
* [Orders Create](../../doc/controllers/orders.md#orders-create)
|
||||
* [Orders Patch](../../doc/controllers/orders.md#orders-patch)
|
||||
* [Orders Capture](../../doc/controllers/orders.md#orders-capture)
|
||||
* [Orders Get](../../doc/controllers/orders.md#orders-get)
|
||||
* [Orders Patch](../../doc/controllers/orders.md#orders-patch)
|
||||
* [Orders Confirm](../../doc/controllers/orders.md#orders-confirm)
|
||||
* [Orders Authorize](../../doc/controllers/orders.md#orders-authorize)
|
||||
* [Orders Capture](../../doc/controllers/orders.md#orders-capture)
|
||||
* [Orders Track Create](../../doc/controllers/orders.md#orders-track-create)
|
||||
* [Orders Trackers Patch](../../doc/controllers/orders.md#orders-trackers-patch)
|
||||
|
||||
|
||||
# Orders Authorize
|
||||
|
||||
Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#authorize-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersAuthorize(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which to authorize.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=,-]*$` |
|
||||
| `paypalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
| `body` | [`?OrderAuthorizeRequest`](../../doc/models/order-authorize-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`OrderAuthorizeResponse`](../../doc/models/order-authorize-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersAuthorize($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The authorized payment failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Track Create
|
||||
|
||||
Adds tracking information for an Order.
|
||||
|
||||
```php
|
||||
function ordersTrackCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order that the tracking information is associated with.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `body` | [`OrderTrackerRequest`](../../doc/models/order-tracker-request.md) | Body, Required | - |
|
||||
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'body' => OrderTrackerRequestBuilder::init(
|
||||
'capture_id8'
|
||||
)
|
||||
->notifyPayer(false)
|
||||
->build()
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersTrackCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Create
|
||||
|
||||
Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see <a href="https://developer.paypal.com/docs/checkout/advanced/processing/">checkout</a> or <a href="https://developer.paypal.com/docs/multiparty/checkout/advanced/processing/">multiparty checkout</a>.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#create-order">Orders v2 errors</a>.</blockquote>
|
||||
@@ -129,14 +35,14 @@ function ordersCreate(array $options): ApiResponse
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `body` | [`OrderRequest`](../../doc/models/order-request.md) | Body, Required | - |
|
||||
| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` |
|
||||
| `paypalPartnerAttributionId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `paypalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` |
|
||||
| `payPalPartnerAttributionId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `payPalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=,-]*$` |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
@@ -169,6 +75,44 @@ $apiResponse = $ordersController->ordersCreate($collect);
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Get
|
||||
|
||||
Shows details for an order, by ID.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#get-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersGet(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which to show details.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `fields` | `?string` | Query, Optional | A comma-separated list of fields that should be returned for the order. Valid filter field is `payment_source`.<br>**Constraints**: *Pattern*: `^[a-z_]*$` |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersGet($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Patch
|
||||
|
||||
Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the `COMPLETED` status.<br/><br/>To make an update, you must provide a `reference_id`. If you omit this value with an order that contains only one purchase unit, PayPal sets the value to `default` which enables you to use the path: <code>\"/purchase_units/@reference_id=='default'/{attribute-or-object}\"</code>. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see <a href="https://developer.paypal.com/docs/checkout/advanced/processing/">checkout</a> or <a href="https://developer.paypal.com/docs/multiparty/checkout/advanced/processing/">multiparty checkout</a>.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#patch-order">Orders v2 errors</a>.</blockquote>Patchable attributes or objects:<br/><br/><table><thead><th>Attribute</th><th>Op</th><th>Notes</th></thead><tbody><tr><td><code>intent</code></td><td>replace</td><td></td></tr><tr><td><code>payer</code></td><td>replace, add</td><td>Using replace op for <code>payer</code> will replace the whole <code>payer</code> object with the value sent in request.</td></tr><tr><td><code>purchase_units</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].custom_id</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].description</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].payee.email</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].shipping.name</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.email_address</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.phone_number</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.options</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.address</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.type</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].soft_descriptor</code></td><td>replace, remove</td><td></td></tr><tr><td><code>purchase_units[].amount</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].items</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].invoice_id</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].payment_instruction</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].payment_instruction.disbursement_mode</code></td><td>replace</td><td>By default, <code>disbursement_mode</code> is <code>INSTANT</code>.</td></tr><tr><td><code>purchase_units[].payment_instruction.payee_receivable_fx_rate_id</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].payment_instruction.platform_fees</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].supplementary_data.airline</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].supplementary_data.card</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>application_context.client_configuration</code></td><td>replace, add</td><td></td></tr></tbody></table>
|
||||
@@ -186,7 +130,7 @@ function ordersPatch(array $options): ApiResponse
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance.
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance.
|
||||
|
||||
## Example Usage
|
||||
|
||||
@@ -214,91 +158,6 @@ $apiResponse = $ordersController->ordersPatch($collect);
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Capture
|
||||
|
||||
Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#capture-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersCapture(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| 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` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=,-]*$` |
|
||||
| `paypalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
| `body` | [`?OrderCaptureRequest`](../../doc/models/order-capture-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersCapture($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The authorized payment failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Get
|
||||
|
||||
Shows details for an order, by ID.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#get-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersGet(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which to show details.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `fields` | `?string` | Query, Optional | A comma-separated list of fields that should be returned for the order. Valid filter field is `payment_source`.<br>**Constraints**: *Pattern*: `^[a-z_]*$` |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersGet($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Confirm
|
||||
|
||||
Payer confirms their intent to pay for the the Order with the given payment source.
|
||||
@@ -312,13 +171,13 @@ 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` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=]*$` |
|
||||
| `body` | [`?ConfirmOrderRequest`](../../doc/models/confirm-order-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
@@ -347,6 +206,147 @@ $apiResponse = $ordersController->ordersConfirm($collect);
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Authorize
|
||||
|
||||
Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#authorize-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersAuthorize(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which to authorize.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=,-]*$` |
|
||||
| `payPalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
| `body` | [`?OrderAuthorizeRequest`](../../doc/models/order-authorize-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`OrderAuthorizeResponse`](../../doc/models/order-authorize-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersAuthorize($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The authorized payment failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Capture
|
||||
|
||||
Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#capture-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersCapture(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| 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` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=,-]*$` |
|
||||
| `payPalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
| `body` | [`?OrderCaptureRequest`](../../doc/models/order-capture-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersCapture($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The authorized payment failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Track Create
|
||||
|
||||
Adds tracking information for an Order.
|
||||
|
||||
```php
|
||||
function ordersTrackCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order that the tracking information is associated with.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `body` | [`OrderTrackerRequest`](../../doc/models/order-tracker-request.md) | Body, Required | - |
|
||||
| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'body' => OrderTrackerRequestBuilder::init(
|
||||
'capture_id8'
|
||||
)
|
||||
->notifyPayer(false)
|
||||
->build()
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersTrackCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Trackers Patch
|
||||
|
||||
Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects:<br/><br/><table><thead><th>Attribute</th><th>Op</th><th>Notes</th></thead><tbody></tr><tr><td><code>items</code></td><td>replace</td><td>Using replace op for <code>items</code> will replace the entire <code>items</code> object with the value sent in request.</td></tr><tr><td><code>notify_payer</code></td><td>replace, add</td><td></td></tr><tr><td><code>status</code></td><td>replace</td><td>Only patching status to CANCELLED is currently supported.</td></tr></tbody></table>
|
||||
@@ -365,7 +365,7 @@ function ordersTrackersPatch(array $options): ApiResponse
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance.
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance.
|
||||
|
||||
## Example Usage
|
||||
|
||||
|
||||
@@ -14,8 +14,8 @@ $paymentsController = $client->getPaymentsController();
|
||||
|
||||
* [Authorizations Get](../../doc/controllers/payments.md#authorizations-get)
|
||||
* [Authorizations Capture](../../doc/controllers/payments.md#authorizations-capture)
|
||||
* [Authorizations Void](../../doc/controllers/payments.md#authorizations-void)
|
||||
* [Authorizations Reauthorize](../../doc/controllers/payments.md#authorizations-reauthorize)
|
||||
* [Authorizations Void](../../doc/controllers/payments.md#authorizations-void)
|
||||
* [Captures Get](../../doc/controllers/payments.md#captures-get)
|
||||
* [Captures Refund](../../doc/controllers/payments.md#captures-refund)
|
||||
* [Refunds Get](../../doc/controllers/payments.md#refunds-get)
|
||||
@@ -37,7 +37,7 @@ function authorizationsGet(string $authorizationId): ApiResponse
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentAuthorization`](../../doc/models/payment-authorization.md).
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentAuthorization`](../../doc/models/payment-authorization.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
@@ -71,13 +71,13 @@ function authorizationsCapture(array $options): ApiResponse
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to capture. |
|
||||
| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
|
||||
| `body` | [`?CaptureRequest`](../../doc/models/capture-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CapturedPayment`](../../doc/models/captured-payment.md).
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CapturedPayment`](../../doc/models/captured-payment.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
@@ -107,6 +107,51 @@ $apiResponse = $paymentsController->authorizationsCapture($collect);
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Authorizations Reauthorize
|
||||
|
||||
Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires.<br/><br/>If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment.<br/><br/>A reauthorized payment itself has a new honor period of three days.<br/><br/>You can reauthorize an authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on context and geography, for example in US it is up to 115% of the original authorized amount, not to exceed an increase of $75 USD.<br/><br/>Supports only the `amount` request parameter.<blockquote><strong>Note:</strong> This request is currently not supported for Partner use cases.</blockquote>
|
||||
|
||||
```php
|
||||
function authorizationsReauthorize(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to reauthorize. |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
|
||||
| `body` | [`?ReauthorizeRequest`](../../doc/models/reauthorize-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentAuthorization`](../../doc/models/payment-authorization.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'authorizationId' => 'authorization_id8',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $paymentsController->authorizationsReauthorize($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The request failed because it either is semantically incorrect or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | The request failed because an internal server error occurred. | `ApiException` |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Authorizations Void
|
||||
|
||||
Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured.
|
||||
@@ -120,12 +165,12 @@ function authorizationsVoid(array $options): ApiResponse
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to void. |
|
||||
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion).<blockquote><strong>Note:</strong>For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.</blockquote> |
|
||||
| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion).<blockquote><strong>Note:</strong>For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.</blockquote> |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`?PaymentAuthorization`](../../doc/models/payment-authorization.md).
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`?PaymentAuthorization`](../../doc/models/payment-authorization.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
@@ -152,51 +197,6 @@ $apiResponse = $paymentsController->authorizationsVoid($collect);
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Authorizations Reauthorize
|
||||
|
||||
Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires.<br/><br/>If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment.<br/><br/>A reauthorized payment itself has a new honor period of three days.<br/><br/>You can reauthorize an authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on context and geography, for example in US it is up to 115% of the original authorized amount, not to exceed an increase of $75 USD.<br/><br/>Supports only the `amount` request parameter.<blockquote><strong>Note:</strong> This request is currently not supported for Partner use cases.</blockquote>
|
||||
|
||||
```php
|
||||
function authorizationsReauthorize(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to reauthorize. |
|
||||
| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
|
||||
| `body` | [`?ReauthorizeRequest`](../../doc/models/reauthorize-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentAuthorization`](../../doc/models/payment-authorization.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'authorizationId' => 'authorization_id8',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $paymentsController->authorizationsReauthorize($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The request failed because it either is semantically incorrect or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | The request failed because an internal server error occurred. | `ApiException` |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Captures Get
|
||||
|
||||
Shows details for a captured payment, by ID.
|
||||
@@ -213,7 +213,7 @@ function capturesGet(string $captureId): ApiResponse
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CapturedPayment`](../../doc/models/captured-payment.md).
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CapturedPayment`](../../doc/models/captured-payment.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
@@ -247,14 +247,14 @@ 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
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Refund`](../../doc/models/refund.md).
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Refund`](../../doc/models/refund.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
@@ -297,7 +297,7 @@ function refundsGet(string $refundId): ApiResponse
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Refund`](../../doc/models/refund.md).
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Refund`](../../doc/models/refund.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
|
||||
@@ -12,14 +12,57 @@ $vaultController = $client->getVaultController();
|
||||
|
||||
## Methods
|
||||
|
||||
* [Payment-Tokens Create](../../doc/controllers/vault.md#payment-tokens-create)
|
||||
* [Customer Payment-Tokens Get](../../doc/controllers/vault.md#customer-payment-tokens-get)
|
||||
* [Payment-Tokens Get](../../doc/controllers/vault.md#payment-tokens-get)
|
||||
* [Payment-Tokens Create](../../doc/controllers/vault.md#payment-tokens-create)
|
||||
* [Setup-Tokens Create](../../doc/controllers/vault.md#setup-tokens-create)
|
||||
* [Payment-Tokens Delete](../../doc/controllers/vault.md#payment-tokens-delete)
|
||||
* [Setup-Tokens Create](../../doc/controllers/vault.md#setup-tokens-create)
|
||||
* [Setup-Tokens Get](../../doc/controllers/vault.md#setup-tokens-get)
|
||||
|
||||
|
||||
# Payment-Tokens Create
|
||||
|
||||
Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.
|
||||
|
||||
```php
|
||||
function paymentTokensCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `payPalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
|
||||
| `body` | [`PaymentTokenRequest`](../../doc/models/payment-token-request.md) | Body, Required | Payment Token creation with a financial instrument and an optional customer_id. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentTokenResponse`](../../doc/models/payment-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'payPalRequestId' => 'PayPal-Request-Id6',
|
||||
'body' => PaymentTokenRequestBuilder::init(
|
||||
PaymentTokenRequestPaymentSourceBuilder::init()->build()
|
||||
)->build()
|
||||
];
|
||||
|
||||
$apiResponse = $vaultController->paymentTokensCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | Request contains reference to resources that do not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Customer Payment-Tokens Get
|
||||
|
||||
Returns all payment tokens for a customer.
|
||||
@@ -39,7 +82,7 @@ function customerPaymentTokensGet(array $options): ApiResponse
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CustomerVaultPaymentTokensResponse`](../../doc/models/customer-vault-payment-tokens-response.md).
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CustomerVaultPaymentTokensResponse`](../../doc/models/customer-vault-payment-tokens-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
@@ -79,7 +122,7 @@ function paymentTokensGet(string $id): ApiResponse
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentTokenResponse`](../../doc/models/payment-token-response.md).
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentTokenResponse`](../../doc/models/payment-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
@@ -99,91 +142,6 @@ $apiResponse = $vaultController->paymentTokensGet($id);
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Payment-Tokens Create
|
||||
|
||||
Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.
|
||||
|
||||
```php
|
||||
function paymentTokensCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `paypalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
|
||||
| `body` | [`PaymentTokenRequest`](../../doc/models/payment-token-request.md) | Body, Required | Payment Token creation with a financial instrument and an optional customer_id. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentTokenResponse`](../../doc/models/payment-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'paypalRequestId' => 'PayPal-Request-Id6',
|
||||
'body' => PaymentTokenRequestBuilder::init(
|
||||
PaymentTokenRequestPaymentSourceBuilder::init()->build()
|
||||
)->build()
|
||||
];
|
||||
|
||||
$apiResponse = $vaultController->paymentTokensCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | Request contains reference to resources that do not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Setup-Tokens Create
|
||||
|
||||
Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer.
|
||||
|
||||
```php
|
||||
function setupTokensCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `paypalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
|
||||
| `body` | [`SetupTokenRequest`](../../doc/models/setup-token-request.md) | Body, Required | Setup Token creation with a instrument type optional financial instrument details and customer_id. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`SetupTokenResponse`](../../doc/models/setup-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'paypalRequestId' => 'PayPal-Request-Id6',
|
||||
'body' => SetupTokenRequestBuilder::init(
|
||||
SetupTokenRequestPaymentSourceBuilder::init()->build()
|
||||
)->build()
|
||||
];
|
||||
|
||||
$apiResponse = $vaultController->setupTokensCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Payment-Tokens Delete
|
||||
|
||||
Delete the payment token associated with the payment token id.
|
||||
@@ -200,7 +158,7 @@ function paymentTokensDelete(string $id): ApiResponse
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance.
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance.
|
||||
|
||||
## Example Usage
|
||||
|
||||
@@ -219,6 +177,48 @@ $apiResponse = $vaultController->paymentTokensDelete($id);
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Setup-Tokens Create
|
||||
|
||||
Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer.
|
||||
|
||||
```php
|
||||
function setupTokensCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `payPalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
|
||||
| `body` | [`SetupTokenRequest`](../../doc/models/setup-token-request.md) | Body, Required | Setup Token creation with a instrument type optional financial instrument details and customer_id. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`SetupTokenResponse`](../../doc/models/setup-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'payPalRequestId' => 'PayPal-Request-Id6',
|
||||
'body' => SetupTokenRequestBuilder::init(
|
||||
SetupTokenRequestPaymentSourceBuilder::init()->build()
|
||||
)->build()
|
||||
];
|
||||
|
||||
$apiResponse = $vaultController->setupTokensCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Setup-Tokens Get
|
||||
|
||||
Returns a readable representation of temporarily vaulted payment source associated with the setup token id.
|
||||
@@ -235,7 +235,7 @@ function setupTokensGet(string $id): ApiResponse
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`SetupTokenResponse`](../../doc/models/setup-token-response.md).
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`SetupTokenResponse`](../../doc/models/setup-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
|
||||
@@ -19,25 +19,25 @@ Represents the logging configurations for API calls. Create instance using `Logg
|
||||
|
||||
In order to provide custom logger, any implementation of the `Psr\Log\LoggerInterface` can be used so that you can override the `log` behavior and provide its instance directly in the SDK client initialization.
|
||||
|
||||
The following example uses `Monolog\Logger` implementation of `Psr\Log\LoggerInterface` for PaypalServerSdkClient initialization.
|
||||
The following example uses `Monolog\Logger` implementation of `Psr\Log\LoggerInterface` for PaypalServerSDKClient initialization.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
use PaypalServerSdkLib\PaypalServerSdkClientBuilder;
|
||||
use PaypalServerSdkLib\Logging\LoggingConfigurationBuilder;
|
||||
use PaypalServerSdkLib\Logging\RequestLoggingConfigurationBuilder;
|
||||
use PaypalServerSdkLib\Logging\ResponseLoggingConfigurationBuilder;
|
||||
use PaypalServerSDKLib\PaypalServerSDKClientBuilder;
|
||||
use PaypalServerSDKLib\Logging\LoggingConfigurationBuilder;
|
||||
use PaypalServerSDKLib\Logging\RequestLoggingConfigurationBuilder;
|
||||
use PaypalServerSDKLib\Logging\ResponseLoggingConfigurationBuilder;
|
||||
use Psr\Log\LogLevel;
|
||||
use Monolog\Logger;
|
||||
use Monolog\Handler\StreamHandler;
|
||||
|
||||
// create a log channel
|
||||
$logger = new Logger('PaypalServerSdk');
|
||||
$logger = new Logger('PaypalServerSDK');
|
||||
$logger->pushHandler(new StreamHandler(__DIR__ . '/api_data.log'));
|
||||
|
||||
// initialize the sdk client using this logger
|
||||
$client = PaypalServerSdkClientBuilder::init()
|
||||
$client = PaypalServerSDKClientBuilder::init()
|
||||
->loggingConfiguration(
|
||||
LoggingConfigurationBuilder::init()
|
||||
->logger($logger)
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Avs Code
|
||||
# AVS Code
|
||||
|
||||
The address verification code for Visa, Discover, Mastercard, or American Express transactions.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`AvsCode`
|
||||
`AVSCode`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Blik Experience Context
|
||||
# BLIK Experience Context
|
||||
|
||||
Customizes the payer experience during the approval process for the BLIK payment.
|
||||
|
||||
## Structure
|
||||
|
||||
`BlikExperienceContext`
|
||||
`BLIKExperienceContext`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Blik Level 0 Payment Object
|
||||
# BLIK Level 0 Payment Object
|
||||
|
||||
Information used to pay using BLIK level_0 flow.
|
||||
|
||||
## Structure
|
||||
|
||||
`BlikLevel0PaymentObject`
|
||||
`BLIKLevel0PaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Blik One Click Payment Object
|
||||
# BLIK One Click Payment Object
|
||||
|
||||
Information used to pay using BLIK one-click flow.
|
||||
|
||||
## Structure
|
||||
|
||||
`BlikOneClickPaymentObject`
|
||||
`BLIKOneClickPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Blik One Click Payment Request
|
||||
# BLIK One Click Payment Request
|
||||
|
||||
Information used to pay using BLIK one-click flow.
|
||||
|
||||
## Structure
|
||||
|
||||
`BlikOneClickPaymentRequest`
|
||||
`BLIKOneClickPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Blik Payment Object
|
||||
# BLIK Payment Object
|
||||
|
||||
Information used to pay using BLIK.
|
||||
|
||||
## Structure
|
||||
|
||||
`BlikPaymentObject`
|
||||
`BLIKPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -14,7 +14,7 @@ Information used to pay using BLIK.
|
||||
| `name` | `?string` | Optional | The full name representation like Mr J Smith.<br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void |
|
||||
| `countryCode` | `?string` | Optional | The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.</blockquote><br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): ?string | setCountryCode(?string countryCode): void |
|
||||
| `email` | `?string` | Optional | The internationalized email address.<blockquote><strong>Note:</strong> Up to 64 characters are allowed before and 255 characters are allowed after the <code>@</code> sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted <code>@</code> sign exists.</blockquote><br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: ``^(?:[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\|\[(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?\|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$`` | getEmail(): ?string | setEmail(?string email): void |
|
||||
| `oneClick` | [`?BlikOneClickPaymentObject`](../../doc/models/blik-one-click-payment-object.md) | Optional | Information used to pay using BLIK one-click flow. | getOneClick(): ?BlikOneClickPaymentObject | setOneClick(?BlikOneClickPaymentObject oneClick): void |
|
||||
| `oneClick` | [`?BLIKOneClickPaymentObject`](../../doc/models/blik-one-click-payment-object.md) | Optional | Information used to pay using BLIK one-click flow. | getOneClick(): ?BLIKOneClickPaymentObject | setOneClick(?BLIKOneClickPaymentObject oneClick): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Blik Payment Request
|
||||
# BLIK Payment Request
|
||||
|
||||
Information needed to pay using BLIK.
|
||||
|
||||
## Structure
|
||||
|
||||
`BlikPaymentRequest`
|
||||
`BLIKPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -14,9 +14,9 @@ Information needed to pay using BLIK.
|
||||
| `name` | `string` | Required | The full name representation like Mr J Smith.<br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): string | setName(string name): void |
|
||||
| `countryCode` | `string` | Required | The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.</blockquote><br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void |
|
||||
| `email` | `?string` | Optional | The internationalized email address.<blockquote><strong>Note:</strong> Up to 64 characters are allowed before and 255 characters are allowed after the <code>@</code> sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted <code>@</code> sign exists.</blockquote><br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: ``^(?:[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\|\[(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?\|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$`` | getEmail(): ?string | setEmail(?string email): void |
|
||||
| `experienceContext` | [`?BlikExperienceContext`](../../doc/models/blik-experience-context.md) | Optional | Customizes the payer experience during the approval process for the BLIK payment. | getExperienceContext(): ?BlikExperienceContext | setExperienceContext(?BlikExperienceContext experienceContext): void |
|
||||
| `level0` | [`?BlikLevel0PaymentObject`](../../doc/models/blik-level-0-payment-object.md) | Optional | Information used to pay using BLIK level_0 flow. | getLevel0(): ?BlikLevel0PaymentObject | setLevel0(?BlikLevel0PaymentObject level0): void |
|
||||
| `oneClick` | [`?BlikOneClickPaymentRequest`](../../doc/models/blik-one-click-payment-request.md) | Optional | Information used to pay using BLIK one-click flow. | getOneClick(): ?BlikOneClickPaymentRequest | setOneClick(?BlikOneClickPaymentRequest oneClick): void |
|
||||
| `experienceContext` | [`?BLIKExperienceContext`](../../doc/models/blik-experience-context.md) | Optional | Customizes the payer experience during the approval process for the BLIK payment. | getExperienceContext(): ?BLIKExperienceContext | setExperienceContext(?BLIKExperienceContext experienceContext): void |
|
||||
| `level0` | [`?BLIKLevel0PaymentObject`](../../doc/models/blik-level-0-payment-object.md) | Optional | Information used to pay using BLIK level_0 flow. | getLevel0(): ?BLIKLevel0PaymentObject | setLevel0(?BLIKLevel0PaymentObject level0): void |
|
||||
| `oneClick` | [`?BLIKOneClickPaymentRequest`](../../doc/models/blik-one-click-payment-request.md) | Optional | Information used to pay using BLIK one-click flow. | getOneClick(): ?BLIKOneClickPaymentRequest | setOneClick(?BLIKOneClickPaymentRequest oneClick): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
|
||||
@@ -11,8 +11,8 @@ The processor response information for payment requests, such as direct credit c
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `avsCode` | [`?string(AvsCode)`](../../doc/models/avs-code.md) | Optional | The address verification code for Visa, Discover, Mastercard, or American Express transactions. | getAvsCode(): ?string | setAvsCode(?string avsCode): void |
|
||||
| `cvvCode` | [`?string(CvvCode)`](../../doc/models/cvv-code.md) | Optional | The card verification value code for for Visa, Discover, Mastercard, or American Express. | getCvvCode(): ?string | setCvvCode(?string cvvCode): void |
|
||||
| `avsCode` | [`?string(AVSCode)`](../../doc/models/avs-code.md) | Optional | The address verification code for Visa, Discover, Mastercard, or American Express transactions. | getAvsCode(): ?string | setAvsCode(?string avsCode): void |
|
||||
| `cvvCode` | [`?string(CVVCode)`](../../doc/models/cvv-code.md) | Optional | The card verification value code for for Visa, Discover, Mastercard, or American Express. | getCvvCode(): ?string | setCvvCode(?string cvvCode): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Cvv Code
|
||||
# CVV Code
|
||||
|
||||
The card verification value code for for Visa, Discover, Mastercard, or American Express.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`CvvCode`
|
||||
`CVVCode`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Eci Flag
|
||||
# ECI Flag
|
||||
|
||||
Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`EciFlag`
|
||||
`ECIFlag`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Eps Payment Object
|
||||
# EPS Payment Object
|
||||
|
||||
Information used to pay using eps.
|
||||
|
||||
## Structure
|
||||
|
||||
`EpsPaymentObject`
|
||||
`EPSPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Eps Payment Request
|
||||
# EPS Payment Request
|
||||
|
||||
Information needed to pay using eps.
|
||||
|
||||
## Structure
|
||||
|
||||
`EpsPaymentRequest`
|
||||
`EPSPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Ideal Payment Object
|
||||
# IDEAL Payment Object
|
||||
|
||||
Information used to pay using iDEAL.
|
||||
|
||||
## Structure
|
||||
|
||||
`IdealPaymentObject`
|
||||
`IDEALPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Ideal Payment Request
|
||||
# IDEAL Payment Request
|
||||
|
||||
Information needed to pay using iDEAL.
|
||||
|
||||
## Structure
|
||||
|
||||
`IdealPaymentRequest`
|
||||
`IDEALPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ The request-related [HATEOAS link](/api/rest/responses/#hateoas-links) informati
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `href` | `string` | Required | The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call. | getHref(): string | setHref(string href): void |
|
||||
| `rel` | `string` | Required | The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml). | getRel(): string | setRel(string rel): void |
|
||||
| `method` | [`?string(LinkHttpMethod)`](../../doc/models/link-http-method.md) | Optional | The HTTP method required to make the related call. | getMethod(): ?string | setMethod(?string method): void |
|
||||
| `method` | [`?string(LinkHTTPMethod)`](../../doc/models/link-http-method.md) | Optional | The HTTP method required to make the related call. | getMethod(): ?string | setMethod(?string method): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Link Http Method
|
||||
# Link HTTP Method
|
||||
|
||||
The HTTP method required to make the related call.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`LinkHttpMethod`
|
||||
`LinkHTTPMethod`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Mybank Payment Object
|
||||
# My Bank Payment Object
|
||||
|
||||
Information used to pay using MyBank.
|
||||
|
||||
## Structure
|
||||
|
||||
`MybankPaymentObject`
|
||||
`MyBankPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Mybank Payment Request
|
||||
# My Bank Payment Request
|
||||
|
||||
Information needed to pay using MyBank.
|
||||
|
||||
## Structure
|
||||
|
||||
`MybankPaymentRequest`
|
||||
`MyBankPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -14,7 +14,7 @@ The Third Party Network token used to fund a payment.
|
||||
| `number` | `string` | Required | Third party network token number.<br>**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `19`, *Pattern*: `^[0-9]{13,19}$` | getNumber(): string | setNumber(string number): void |
|
||||
| `expiry` | `string` | Required | The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).<br>**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): string | setExpiry(string expiry): void |
|
||||
| `cryptogram` | `?string` | Optional | An Encrypted one-time use value that's sent along with Network Token. This field is not required to be present for recurring transactions.<br>**Constraints**: *Minimum Length*: `28`, *Maximum Length*: `32`, *Pattern*: `^.*$` | getCryptogram(): ?string | setCryptogram(?string cryptogram): void |
|
||||
| `eciFlag` | [`?string(EciFlag)`](../../doc/models/eci-flag.md) | Optional | Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getEciFlag(): ?string | setEciFlag(?string eciFlag): void |
|
||||
| `eciFlag` | [`?string(ECIFlag)`](../../doc/models/eci-flag.md) | Optional | Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getEciFlag(): ?string | setEciFlag(?string eciFlag): void |
|
||||
| `tokenRequestorId` | `?string` | Optional | A TRID, or a Token Requestor ID, is an identifier used by merchants to request network tokens from card networks. A TRID is a precursor to obtaining a network token for a credit card primary account number (PAN), and will aid in enabling secure card on file (COF) payments and reducing fraud.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `11`, *Pattern*: `^[0-9A-Z_]+$` | getTokenRequestorId(): ?string | setTokenRequestorId(?string tokenRequestorId): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -13,7 +13,7 @@ The payment source definition.
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardRequest`](../../doc/models/card-request.md) | Optional | The payment card to use to fund a payment. Can be a credit or debit card.<blockquote><strong>Note:</strong> Passing card number, cvv and expiry directly via the API requires <a href="https://www.pcisecuritystandards.org/pci_security/completing_self_assessment"> PCI SAQ D compliance</a>. <br>*PayPal offers a mechanism by which you do not have to take on the <strong>PCI SAQ D</strong> burden by using hosted fields - refer to <a href="https://developer.paypal.com/docs/checkout/advanced/integrate/">this Integration Guide</a>*.</blockquote> | getCard(): ?CardRequest | setCard(?CardRequest card): void |
|
||||
| `token` | [`?Token`](../../doc/models/token.md) | Optional | The tokenized payment source to fund a payment. | getToken(): ?Token | setToken(?Token token): void |
|
||||
| `paypal` | [`?PaypalWallet`](../../doc/models/paypal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PaypalWallet | setPaypal(?PaypalWallet paypal): 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 |
|
||||
| `applePay` | [`?ApplePayRequest`](../../doc/models/apple-pay-request.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayRequest | setApplePay(?ApplePayRequest applePay): void |
|
||||
| `googlePay` | [`?GooglePayRequest`](../../doc/models/google-pay-request.md) | Optional | Information needed to pay using Google Pay. | getGooglePay(): ?GooglePayRequest | setGooglePay(?GooglePayRequest googlePay): void |
|
||||
| `venmo` | [`?VenmoWalletRequest`](../../doc/models/venmo-wallet-request.md) | Optional | Information needed to pay using Venmo. | getVenmo(): ?VenmoWalletRequest | setVenmo(?VenmoWalletRequest venmo): void |
|
||||
|
||||
@@ -12,7 +12,7 @@ The payment source used to fund the payment.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardResponse`](../../doc/models/card-response.md) | Optional | The payment card to use to fund a payment. Card can be a credit or debit card. | getCard(): ?CardResponse | setCard(?CardResponse card): void |
|
||||
| `paypal` | [`?PaypalWalletResponse`](../../doc/models/paypal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PaypalWalletResponse | setPaypal(?PaypalWalletResponse paypal): void |
|
||||
| `paypal` | [`?PayPalWalletResponse`](../../doc/models/pay-pal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PayPalWalletResponse | setPaypal(?PayPalWalletResponse paypal): void |
|
||||
| `applePay` | [`?ApplePayPaymentObject`](../../doc/models/apple-pay-payment-object.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayPaymentObject | setApplePay(?ApplePayPaymentObject applePay): void |
|
||||
| `googlePay` | [`?GooglePayWalletResponse`](../../doc/models/google-pay-wallet-response.md) | Optional | Google Pay Wallet payment data. | getGooglePay(): ?GooglePayWalletResponse | setGooglePay(?GooglePayWalletResponse googlePay): void |
|
||||
| `venmo` | [`?VenmoWalletResponse`](../../doc/models/venmo-wallet-response.md) | Optional | Venmo wallet response. | getVenmo(): ?VenmoWalletResponse | setVenmo(?VenmoWalletResponse venmo): void |
|
||||
|
||||
@@ -13,7 +13,7 @@ The payment source definition.
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardRequest`](../../doc/models/card-request.md) | Optional | The payment card to use to fund a payment. Can be a credit or debit card.<blockquote><strong>Note:</strong> Passing card number, cvv and expiry directly via the API requires <a href="https://www.pcisecuritystandards.org/pci_security/completing_self_assessment"> PCI SAQ D compliance</a>. <br>*PayPal offers a mechanism by which you do not have to take on the <strong>PCI SAQ D</strong> burden by using hosted fields - refer to <a href="https://developer.paypal.com/docs/checkout/advanced/integrate/">this Integration Guide</a>*.</blockquote> | getCard(): ?CardRequest | setCard(?CardRequest card): void |
|
||||
| `token` | [`?Token`](../../doc/models/token.md) | Optional | The tokenized payment source to fund a payment. | getToken(): ?Token | setToken(?Token token): void |
|
||||
| `paypal` | [`?PaypalWallet`](../../doc/models/paypal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PaypalWallet | setPaypal(?PaypalWallet paypal): 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 |
|
||||
| `applePay` | [`?ApplePayRequest`](../../doc/models/apple-pay-request.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayRequest | setApplePay(?ApplePayRequest applePay): void |
|
||||
| `googlePay` | [`?GooglePayRequest`](../../doc/models/google-pay-request.md) | Optional | Information needed to pay using Google Pay. | getGooglePay(): ?GooglePayRequest | setGooglePay(?GooglePayRequest googlePay): void |
|
||||
| `venmo` | [`?VenmoWalletRequest`](../../doc/models/venmo-wallet-request.md) | Optional | Information needed to pay using Venmo. | getVenmo(): ?VenmoWalletRequest | setVenmo(?VenmoWalletRequest venmo): void |
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pa Res Status
|
||||
# PA Res Status
|
||||
|
||||
Transactions status result identifier. The outcome of the issuer's authentication.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PaResStatus`
|
||||
`PAResStatus`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Paypal Experience Landing Page
|
||||
# Pay Pal Experience Landing Page
|
||||
|
||||
The type of landing page to show on the PayPal site for customer checkout.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PaypalExperienceLandingPage`
|
||||
`PayPalExperienceLandingPage`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Paypal Experience User Action
|
||||
# Pay Pal Experience User Action
|
||||
|
||||
Configures a <strong>Continue</strong> or <strong>Pay Now</strong> checkout flow.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PaypalExperienceUserAction`
|
||||
`PayPalExperienceUserAction`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Paypal Payment Token Customer Type
|
||||
# Pay Pal Payment Token Customer Type
|
||||
|
||||
The customer type associated with the PayPal payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PaypalPaymentTokenCustomerType`
|
||||
`PayPalPaymentTokenCustomerType`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Paypal Payment Token Usage Pattern
|
||||
# Pay Pal Payment Token Usage Pattern
|
||||
|
||||
Expected business/pricing model for the billing agreement.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PaypalPaymentTokenUsagePattern`
|
||||
`PayPalPaymentTokenUsagePattern`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Paypal Payment Token Usage Type
|
||||
# Pay Pal Payment Token Usage Type
|
||||
|
||||
The usage type associated with the PayPal payment token.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PaypalPaymentTokenUsageType`
|
||||
`PayPalPaymentTokenUsageType`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
# Paypal Payment Token
|
||||
# Pay Pal Payment Token
|
||||
|
||||
## Structure
|
||||
|
||||
`PaypalPaymentToken`
|
||||
`PayPalPaymentToken`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Paypal Wallet Account Verification Status
|
||||
# Pay Pal Wallet Account Verification Status
|
||||
|
||||
The account status indicates whether the buyer has verified the financial details associated with their PayPal account.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PaypalWalletAccountVerificationStatus`
|
||||
`PayPalWalletAccountVerificationStatus`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
|
||||
# Paypal Wallet Attributes Response
|
||||
# Pay Pal 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/paypal-wallet-vault-response.md) | Optional | The details about a saved PayPal Wallet payment source. | getVault(): ?PaypalWalletVaultResponse | setVault(?PaypalWalletVaultResponse vault): void |
|
||||
| `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 |
|
||||
| `cobrandedCards` | [`?(CobrandedCard[])`](../../doc/models/cobranded-card.md) | Optional | An array of merchant cobranded cards used by buyer to complete an order. This array will be present if a merchant has onboarded their cobranded card with PayPal and provided corresponding label(s).<br>**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `25` | getCobrandedCards(): ?array | setCobrandedCards(?array cobrandedCards): void |
|
||||
|
||||
## Example (as JSON)
|
||||
@@ -1,18 +1,18 @@
|
||||
|
||||
# Paypal Wallet Attributes
|
||||
# Pay Pal 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/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 |
|
||||
| `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 |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
# Paypal Wallet Customer Request
|
||||
# Pay Pal Wallet Customer Request
|
||||
|
||||
## Structure
|
||||
|
||||
`PaypalWalletCustomerRequest`
|
||||
`PayPalWalletCustomerRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Paypal Wallet Customer
|
||||
# Pay Pal Wallet Customer
|
||||
|
||||
The details about a customer in PayPal's system of record.
|
||||
|
||||
## Structure
|
||||
|
||||
`PaypalWalletCustomer`
|
||||
`PayPalWalletCustomer`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Paypal Wallet Experience Context
|
||||
# Pay Pal 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/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 |
|
||||
| `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 |
|
||||
| `paymentMethodPreference` | [`?string(PayeePaymentMethodPreference)`](../../doc/models/payee-payment-method-preference.md) | Optional | The merchant-preferred payment methods.<br>**Default**: `PayeePaymentMethodPreference::UNRESTRICTED`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getPaymentMethodPreference(): ?string | setPaymentMethodPreference(?string paymentMethodPreference): void |
|
||||
|
||||
## Example (as JSON)
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Paypal Wallet Response
|
||||
# Pay Pal 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/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 |
|
||||
| `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 |
|
||||
| `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/paypal-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/pay-pal-wallet-attributes-response.md) | Optional | Additional attributes associated with the use of a PayPal Wallet. | getAttributes(): ?PayPalWalletAttributesResponse | setAttributes(?PayPalWalletAttributesResponse attributes): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
# Paypal Wallet Vault Instruction
|
||||
# Pay Pal 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/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 |
|
||||
| `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 |
|
||||
| `permitMultiplePaymentTokens` | `?bool` | Optional | Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.<br>**Default**: `false` | getPermitMultiplePaymentTokens(): ?bool | setPermitMultiplePaymentTokens(?bool permitMultiplePaymentTokens): void |
|
||||
|
||||
## Example (as JSON)
|
||||
@@ -1,20 +1,20 @@
|
||||
|
||||
# Paypal Wallet Vault Response
|
||||
# Pay Pal 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/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 |
|
||||
| `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 |
|
||||
| `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/paypal-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/pay-pal-wallet-customer.md) | Optional | The details about a customer in PayPal's system of record. | getCustomer(): ?PayPalWalletCustomer | setCustomer(?PayPalWalletCustomer customer): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Paypal Wallet Vault Status
|
||||
# Pay Pal Wallet Vault Status
|
||||
|
||||
The vault status.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PaypalWalletVaultStatus`
|
||||
`PayPalWalletVaultStatus`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Paypal Wallet
|
||||
# Pay Pal 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/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 |
|
||||
| `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 |
|
||||
| `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)
|
||||
@@ -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/paypal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PaypalWalletResponse | setPaypal(?PaypalWalletResponse paypal): void |
|
||||
| `paypal` | [`?PayPalWalletResponse`](../../doc/models/pay-pal-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/mybank-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/my-bank-payment-object.md) | Optional | Information used to pay using MyBank. | getMybank(): ?MyBankPaymentObject | setMybank(?MyBankPaymentObject mybank): void |
|
||||
| `p24` | [`?P24PaymentObject`](../../doc/models/p24-payment-object.md) | Optional | Information used to pay using P24(Przelewy24). | getP24(): ?P24PaymentObject | setP24(?P24PaymentObject p24): void |
|
||||
| `sofort` | [`?SofortPaymentObject`](../../doc/models/sofort-payment-object.md) | Optional | Information used to pay using Sofort. | getSofort(): ?SofortPaymentObject | setSofort(?SofortPaymentObject sofort): void |
|
||||
| `trustly` | [`?TrustlyPaymentObject`](../../doc/models/trustly-payment-object.md) | Optional | Information needed to pay using Trustly. | getTrustly(): ?TrustlyPaymentObject | setTrustly(?TrustlyPaymentObject trustly): void |
|
||||
|
||||
@@ -13,13 +13,13 @@ The payment source definition.
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardRequest`](../../doc/models/card-request.md) | Optional | The payment card to use to fund a payment. Can be a credit or debit card.<blockquote><strong>Note:</strong> Passing card number, cvv and expiry directly via the API requires <a href="https://www.pcisecuritystandards.org/pci_security/completing_self_assessment"> PCI SAQ D compliance</a>. <br>*PayPal offers a mechanism by which you do not have to take on the <strong>PCI SAQ D</strong> burden by using hosted fields - refer to <a href="https://developer.paypal.com/docs/checkout/advanced/integrate/">this Integration Guide</a>*.</blockquote> | getCard(): ?CardRequest | setCard(?CardRequest card): void |
|
||||
| `token` | [`?Token`](../../doc/models/token.md) | Optional | The tokenized payment source to fund a payment. | getToken(): ?Token | setToken(?Token token): void |
|
||||
| `paypal` | [`?PaypalWallet`](../../doc/models/paypal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PaypalWallet | setPaypal(?PaypalWallet paypal): 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 |
|
||||
| `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/mybank-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/my-bank-payment-request.md) | Optional | Information needed to pay using MyBank. | getMybank(): ?MyBankPaymentRequest | setMybank(?MyBankPaymentRequest mybank): void |
|
||||
| `p24` | [`?P24PaymentRequest`](../../doc/models/p24-payment-request.md) | Optional | Information needed to pay using P24 (Przelewy24). | getP24(): ?P24PaymentRequest | setP24(?P24PaymentRequest p24): void |
|
||||
| `sofort` | [`?SofortPaymentRequest`](../../doc/models/sofort-payment-request.md) | Optional | Information needed to pay using Sofort. | getSofort(): ?SofortPaymentRequest | setSofort(?SofortPaymentRequest sofort): void |
|
||||
| `trustly` | [`?TrustlyPaymentRequest`](../../doc/models/trustly-payment-request.md) | Optional | Information needed to pay using Trustly. | getTrustly(): ?TrustlyPaymentRequest | setTrustly(?TrustlyPaymentRequest trustly): void |
|
||||
|
||||
@@ -12,7 +12,7 @@ The vaulted payment method details.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardPaymentToken`](../../doc/models/card-payment-token.md) | Optional | Full representation of a Card Payment Token including network token. | getCard(): ?CardPaymentToken | setCard(?CardPaymentToken card): void |
|
||||
| `paypal` | [`?PaypalPaymentToken`](../../doc/models/paypal-payment-token.md) | Optional | - | getPaypal(): ?PaypalPaymentToken | setPaypal(?PaypalPaymentToken paypal): void |
|
||||
| `paypal` | [`?PayPalPaymentToken`](../../doc/models/pay-pal-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 |
|
||||
|
||||
@@ -11,8 +11,8 @@ The processor response information for payment requests, such as direct credit c
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `avsCode` | [`?string(AvsCode)`](../../doc/models/avs-code.md) | Optional | The address verification code for Visa, Discover, Mastercard, or American Express transactions. | getAvsCode(): ?string | setAvsCode(?string avsCode): void |
|
||||
| `cvvCode` | [`?string(CvvCode)`](../../doc/models/cvv-code.md) | Optional | The card verification value code for for Visa, Discover, Mastercard, or American Express. | getCvvCode(): ?string | setCvvCode(?string cvvCode): void |
|
||||
| `avsCode` | [`?string(AVSCode)`](../../doc/models/avs-code.md) | Optional | The address verification code for Visa, Discover, Mastercard, or American Express transactions. | getAvsCode(): ?string | setAvsCode(?string avsCode): void |
|
||||
| `cvvCode` | [`?string(CVVCode)`](../../doc/models/cvv-code.md) | Optional | The card verification value code for for Visa, Discover, Mastercard, or American Express. | getCvvCode(): ?string | setCvvCode(?string cvvCode): void |
|
||||
| `responseCode` | [`?string(ProcessorResponseCode)`](../../doc/models/processor-response-code.md) | Optional | Processor response code for the non-PayPal payment processor errors. | getResponseCode(): ?string | setResponseCode(?string responseCode): void |
|
||||
| `paymentAdviceCode` | [`?string(PaymentAdviceCode)`](../../doc/models/payment-advice-code.md) | Optional | The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes. | getPaymentAdviceCode(): ?string | setPaymentAdviceCode(?string paymentAdviceCode): void |
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ The payment method to vault with the instrument details.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?SetupTokenRequestCard`](../../doc/models/setup-token-request-card.md) | Optional | A Resource representing a request to vault a Card. | getCard(): ?SetupTokenRequestCard | setCard(?SetupTokenRequestCard card): void |
|
||||
| `paypal` | [`?VaultPaypalWalletRequest`](../../doc/models/vault-paypal-wallet-request.md) | Optional | A resource representing a request to vault PayPal Wallet. | getPaypal(): ?VaultPaypalWalletRequest | setPaypal(?VaultPaypalWalletRequest paypal): 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 |
|
||||
| `venmo` | [`?VaultVenmoRequest`](../../doc/models/vault-venmo-request.md) | Optional | - | getVenmo(): ?VaultVenmoRequest | setVenmo(?VaultVenmoRequest venmo): void |
|
||||
| `token` | [`?VaultTokenRequest`](../../doc/models/vault-token-request.md) | Optional | The Tokenized Payment Source representing a Request to Vault a Token. | getToken(): ?VaultTokenRequest | setToken(?VaultTokenRequest token): void |
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ The setup payment method details.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?SetupTokenResponseCard`](../../doc/models/setup-token-response-card.md) | Optional | - | getCard(): ?SetupTokenResponseCard | setCard(?SetupTokenResponseCard card): void |
|
||||
| `paypal` | [`?PaypalPaymentToken`](../../doc/models/paypal-payment-token.md) | Optional | - | getPaypal(): ?PaypalPaymentToken | setPaypal(?PaypalPaymentToken paypal): void |
|
||||
| `paypal` | [`?PayPalPaymentToken`](../../doc/models/pay-pal-payment-token.md) | Optional | - | getPaypal(): ?PayPalPaymentToken | setPaypal(?PayPalPaymentToken paypal): void |
|
||||
| `venmo` | [`?VenmoPaymentToken`](../../doc/models/venmo-payment-token.md) | Optional | - | getVenmo(): ?VenmoPaymentToken | setVenmo(?VenmoPaymentToken venmo): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -11,7 +11,7 @@ Results of 3D Secure Authentication.
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `authenticationStatus` | [`?string(PaResStatus)`](../../doc/models/pa-res-status.md) | Optional | Transactions status result identifier. The outcome of the issuer's authentication.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getAuthenticationStatus(): ?string | setAuthenticationStatus(?string authenticationStatus): void |
|
||||
| `authenticationStatus` | [`?string(PAResStatus)`](../../doc/models/pa-res-status.md) | Optional | Transactions status result identifier. The outcome of the issuer's authentication.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getAuthenticationStatus(): ?string | setAuthenticationStatus(?string authenticationStatus): void |
|
||||
| `enrollmentStatus` | [`?string(EnrollmentStatus)`](../../doc/models/enrollment-status.md) | Optional | Status of Authentication eligibility.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getEnrollmentStatus(): ?string | setEnrollmentStatus(?string enrollmentStatus): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -11,7 +11,7 @@ The Universal Product Code of the item.
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `type` | [`string(UpcType)`](../../doc/models/upc-type.md) | Required | The Universal Product Code type.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `5`, *Pattern*: `^[0-9A-Z_-]+$` | getType(): string | setType(string type): void |
|
||||
| `type` | [`string(UPCType)`](../../doc/models/upc-type.md) | Required | The Universal Product Code type.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `5`, *Pattern*: `^[0-9A-Z_-]+$` | getType(): string | setType(string type): void |
|
||||
| `code` | `string` | Required | The UPC product code of the item.<br>**Constraints**: *Minimum Length*: `6`, *Maximum Length*: `17`, *Pattern*: `^[0-9]{0,17}$` | getCode(): string | setCode(string code): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Upc Type
|
||||
# UPC Type
|
||||
|
||||
The Universal Product Code type.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`UpcType`
|
||||
`UPCType`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Vault Paypal Wallet Request
|
||||
# Vault Pay Pal Wallet Request
|
||||
|
||||
A resource representing a request to vault PayPal Wallet.
|
||||
|
||||
## Structure
|
||||
|
||||
`VaultPaypalWalletRequest`
|
||||
`VaultPayPalWalletRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
16
phpunit.xml
Normal file
16
phpunit.xml
Normal file
@@ -0,0 +1,16 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="tests/bootstrap.php" colors="true" processIsolation="false" stopOnError="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.3/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
|
||||
<testsuites>
|
||||
<testsuite name="SDK Test Suite">
|
||||
<directory suffix="Test.php">./tests</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
<php>
|
||||
<env name="SYMFONY_DEPRECATIONS_HELPER" value="disabled"/>
|
||||
</php>
|
||||
<source>
|
||||
<include>
|
||||
<directory suffix=".php">src</directory>
|
||||
</include>
|
||||
</source>
|
||||
</phpunit>
|
||||
BIN
selenium.jar
Normal file
BIN
selenium.jar
Normal file
Binary file not shown.
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib;
|
||||
namespace PaypalServerSDKLib;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use Core\Utils\JsonHelper;
|
||||
@@ -28,7 +28,7 @@ class ApiHelper
|
||||
public static function getJsonHelper(): JsonHelper
|
||||
{
|
||||
if (self::$jsonHelper == null) {
|
||||
self::$jsonHelper = new JsonHelper([], [], null, 'PaypalServerSdkLib\\Models');
|
||||
self::$jsonHelper = new JsonHelper([], [], null, 'PaypalServerSDKLib\\Models');
|
||||
}
|
||||
return self::$jsonHelper;
|
||||
}
|
||||
|
||||
@@ -3,15 +3,15 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Authentication;
|
||||
namespace PaypalServerSDKLib\Authentication;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use PaypalServerSdkLib\Models\OAuthToken;
|
||||
use PaypalServerSDKLib\Models\OAuthToken;
|
||||
|
||||
/**
|
||||
* Utility class for initializing ClientCredentialsAuth security credentials.
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Authentication;
|
||||
namespace PaypalServerSDKLib\Authentication;
|
||||
|
||||
use Closure;
|
||||
use Exception;
|
||||
@@ -18,10 +18,10 @@ use Core\Client;
|
||||
use Core\Request\Parameters\HeaderParam;
|
||||
use Core\Utils\CoreHelper;
|
||||
use InvalidArgumentException;
|
||||
use PaypalServerSdkLib\Models\OAuthToken;
|
||||
use PaypalServerSdkLib\Controllers\OAuthAuthorizationController;
|
||||
use PaypalServerSdkLib\ConfigurationDefaults;
|
||||
use PaypalServerSdkLib\ClientCredentialsAuth;
|
||||
use PaypalServerSDKLib\Models\OAuthToken;
|
||||
use PaypalServerSDKLib\Controllers\OAuthAuthorizationController;
|
||||
use PaypalServerSDKLib\ConfigurationDefaults;
|
||||
use PaypalServerSDKLib\ClientCredentialsAuth;
|
||||
|
||||
/**
|
||||
* Utility class for OAuth 2 authorization and token management
|
||||
|
||||
@@ -3,14 +3,14 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib;
|
||||
namespace PaypalServerSDKLib;
|
||||
|
||||
use PaypalServerSdkLib\Models\OAuthToken;
|
||||
use PaypalServerSDKLib\Models\OAuthToken;
|
||||
|
||||
/**
|
||||
* Interface for defining the behavior of Authentication.
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib;
|
||||
namespace PaypalServerSDKLib;
|
||||
|
||||
use Psr\Log\LogLevel;
|
||||
|
||||
|
||||
@@ -3,16 +3,16 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib;
|
||||
namespace PaypalServerSDKLib;
|
||||
|
||||
use CoreInterfaces\Http\HttpConfigurations;
|
||||
use PaypalServerSdkLib\Authentication\ClientCredentialsAuthCredentialsBuilder;
|
||||
use PaypalServerSdkLib\Logging\LoggingConfigurationBuilder;
|
||||
use PaypalServerSDKLib\Authentication\ClientCredentialsAuthCredentialsBuilder;
|
||||
use PaypalServerSDKLib\Logging\LoggingConfigurationBuilder;
|
||||
|
||||
/**
|
||||
* An interface for all configuration parameters required by the SDK.
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Controllers;
|
||||
namespace PaypalServerSDKLib\Controllers;
|
||||
|
||||
use Core\ApiCall;
|
||||
use Core\Client;
|
||||
|
||||
@@ -3,21 +3,21 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Controllers;
|
||||
namespace PaypalServerSDKLib\Controllers;
|
||||
|
||||
use Core\Request\Parameters\AdditionalFormParams;
|
||||
use Core\Request\Parameters\FormParam;
|
||||
use Core\Request\Parameters\HeaderParam;
|
||||
use Core\Response\Types\ErrorType;
|
||||
use CoreInterfaces\Core\Request\RequestMethod;
|
||||
use PaypalServerSdkLib\Exceptions\OAuthProviderException;
|
||||
use PaypalServerSdkLib\Http\ApiResponse;
|
||||
use PaypalServerSdkLib\Models\OAuthToken;
|
||||
use PaypalServerSDKLib\Exceptions\OAuthProviderException;
|
||||
use PaypalServerSDKLib\Http\ApiResponse;
|
||||
use PaypalServerSDKLib\Models\OAuthToken;
|
||||
|
||||
class OAuthAuthorizationController extends BaseController
|
||||
{
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Controllers;
|
||||
namespace PaypalServerSDKLib\Controllers;
|
||||
|
||||
use Core\Request\Parameters\BodyParam;
|
||||
use Core\Request\Parameters\HeaderParam;
|
||||
@@ -16,126 +16,13 @@ use Core\Request\Parameters\QueryParam;
|
||||
use Core\Request\Parameters\TemplateParam;
|
||||
use Core\Response\Types\ErrorType;
|
||||
use CoreInterfaces\Core\Request\RequestMethod;
|
||||
use PaypalServerSdkLib\Exceptions\ErrorException;
|
||||
use PaypalServerSdkLib\Http\ApiResponse;
|
||||
use PaypalServerSdkLib\Models\Order;
|
||||
use PaypalServerSdkLib\Models\OrderAuthorizeResponse;
|
||||
use PaypalServerSDKLib\Exceptions\ErrorException;
|
||||
use PaypalServerSDKLib\Http\ApiResponse;
|
||||
use PaypalServerSDKLib\Models\Order;
|
||||
use PaypalServerSDKLib\Models\OrderAuthorizeResponse;
|
||||
|
||||
class OrdersController extends BaseController
|
||||
{
|
||||
/**
|
||||
* Authorizes payment for an order. To successfully authorize payment for an order, the buyer must
|
||||
* first approve the order or a valid payment_source must be provided in the request. A buyer can
|
||||
* approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS
|
||||
* links in the create order response.<blockquote><strong>Note:</strong> For error handling and
|
||||
* troubleshooting, see <a href="https://developer.paypal.
|
||||
* com/api/rest/reference/orders/v2/errors/#authorize-order">Orders v2 errors</a>.</blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersAuthorize(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/authorize')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init(
|
||||
'The authorized payment failed due to insufficient permissions.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The requested action could not be performed, semantically incorrect, or fa' .
|
||||
'iled business validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(OrderAuthorizeResponse::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds tracking information for an Order.
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersTrackCreate(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/track')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
BodyParam::init($options)->extract('body'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The requested action could not be performed, semantically incorrect, or fa' .
|
||||
'iled business validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(Order::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and
|
||||
* payment processing costs. For more information about processing payments, see <a href="https:
|
||||
@@ -156,9 +43,9 @@ class OrdersController extends BaseController
|
||||
->parameters(
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
BodyParam::init($options)->extract('body'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('PayPal-Partner-Attribution-Id', $options)->extract('paypalPartnerAttributionId'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('PayPal-Partner-Attribution-Id', $options)->extract('payPalPartnerAttributionId'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal')
|
||||
);
|
||||
|
||||
@@ -193,6 +80,41 @@ class OrdersController extends BaseController
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Shows details for an order, by ID.<blockquote><strong>Note:</strong> For error handling and
|
||||
* troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#get-
|
||||
* order">Orders v2 errors</a>.</blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersGet(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/checkout/orders/{id}')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
QueryParam::init('fields', $options)->extract('fields')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(Order::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the
|
||||
* `COMPLETED` status.<br/><br/>To make an update, you must provide a `reference_id`. If you omit this
|
||||
@@ -279,6 +201,122 @@ class OrdersController extends BaseController
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Payer confirms their intent to pay for the the Order with the given payment source.
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersConfirm(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(
|
||||
RequestMethod::POST,
|
||||
'/v2/checkout/orders/{id}/confirm-payment-source'
|
||||
)
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The requested action could not be performed, semantically incorrect, or fa' .
|
||||
'iled business validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(Order::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Authorizes payment for an order. To successfully authorize payment for an order, the buyer must
|
||||
* first approve the order or a valid payment_source must be provided in the request. A buyer can
|
||||
* approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS
|
||||
* links in the create order response.<blockquote><strong>Note:</strong> For error handling and
|
||||
* troubleshooting, see <a href="https://developer.paypal.
|
||||
* com/api/rest/reference/orders/v2/errors/#authorize-order">Orders v2 errors</a>.</blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersAuthorize(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/authorize')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init(
|
||||
'The authorized payment failed due to insufficient permissions.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The requested action could not be performed, semantically incorrect, or fa' .
|
||||
'iled business validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(OrderAuthorizeResponse::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Captures payment for an order. To successfully capture payment for an order, the buyer must first
|
||||
* approve the order or a valid payment_source must be provided in the request. A buyer can approve the
|
||||
@@ -298,10 +336,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')
|
||||
);
|
||||
|
||||
@@ -346,60 +384,21 @@ class OrdersController extends BaseController
|
||||
}
|
||||
|
||||
/**
|
||||
* Shows details for an order, by ID.<blockquote><strong>Note:</strong> For error handling and
|
||||
* troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#get-
|
||||
* order">Orders v2 errors</a>.</blockquote>
|
||||
* Adds tracking information for an Order.
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersGet(array $options): ApiResponse
|
||||
public function ordersTrackCreate(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/checkout/orders/{id}')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
QueryParam::init('fields', $options)->extract('fields')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(Order::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Payer confirms their intent to pay for the the Order with the given payment source.
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersConfirm(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(
|
||||
RequestMethod::POST,
|
||||
'/v2/checkout/orders/{id}/confirm-payment-source'
|
||||
)
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/track')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
BodyParam::init($options)->extract('body'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
@@ -414,6 +413,7 @@ class OrdersController extends BaseController
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
|
||||
@@ -3,23 +3,23 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Controllers;
|
||||
namespace PaypalServerSDKLib\Controllers;
|
||||
|
||||
use Core\Request\Parameters\BodyParam;
|
||||
use Core\Request\Parameters\HeaderParam;
|
||||
use Core\Request\Parameters\TemplateParam;
|
||||
use Core\Response\Types\ErrorType;
|
||||
use CoreInterfaces\Core\Request\RequestMethod;
|
||||
use PaypalServerSdkLib\Exceptions\ErrorException;
|
||||
use PaypalServerSdkLib\Http\ApiResponse;
|
||||
use PaypalServerSdkLib\Models\CapturedPayment;
|
||||
use PaypalServerSdkLib\Models\PaymentAuthorization;
|
||||
use PaypalServerSdkLib\Models\Refund;
|
||||
use PaypalServerSDKLib\Exceptions\ErrorException;
|
||||
use PaypalServerSDKLib\Http\ApiResponse;
|
||||
use PaypalServerSDKLib\Models\CapturedPayment;
|
||||
use PaypalServerSDKLib\Models\PaymentAuthorization;
|
||||
use PaypalServerSDKLib\Models\Refund;
|
||||
|
||||
class PaymentsController extends BaseController
|
||||
{
|
||||
@@ -81,7 +81,7 @@ class PaymentsController extends BaseController
|
||||
->parameters(
|
||||
TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
@@ -136,6 +136,82 @@ class PaymentsController extends BaseController
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available,
|
||||
* reauthorize a payment after its initial three-day honor period expires. Within the 29-day
|
||||
* authorization period, you can issue multiple re-authorizations after the honor period expires.
|
||||
* <br/><br/>If 30 days have transpired since the date of the original authorization, you must create
|
||||
* an authorized payment instead of reauthorizing the original authorized payment.<br/><br/>A
|
||||
* reauthorized payment itself has a new honor period of three days.<br/><br/>You can reauthorize an
|
||||
* authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on
|
||||
* context and geography, for example in US it is up to 115% of the original authorized amount, not to
|
||||
* exceed an increase of $75 USD.<br/><br/>Supports only the `amount` request parameter.
|
||||
* <blockquote><strong>Note:</strong> This request is currently not supported for Partner use cases.
|
||||
* </blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function authorizationsReauthorize(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(
|
||||
RequestMethod::POST,
|
||||
'/v2/payments/authorizations/{authorization_id}/reauthorize'
|
||||
)
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'The request failed because it is not well-formed or is syntactically incor' .
|
||||
'rect or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init(
|
||||
'The request failed because the caller has insufficient permissions.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'404',
|
||||
ErrorType::init('The request failed because the resource does not exist.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The request failed because it either is semantically incorrect or failed b' .
|
||||
'usiness validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('The request failed because an internal server error occurred.'))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(PaymentAuthorization::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been
|
||||
* fully captured.
|
||||
@@ -153,7 +229,7 @@ class PaymentsController extends BaseController
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal')
|
||||
);
|
||||
|
||||
@@ -209,82 +285,6 @@ class PaymentsController extends BaseController
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available,
|
||||
* reauthorize a payment after its initial three-day honor period expires. Within the 29-day
|
||||
* authorization period, you can issue multiple re-authorizations after the honor period expires.
|
||||
* <br/><br/>If 30 days have transpired since the date of the original authorization, you must create
|
||||
* an authorized payment instead of reauthorizing the original authorized payment.<br/><br/>A
|
||||
* reauthorized payment itself has a new honor period of three days.<br/><br/>You can reauthorize an
|
||||
* authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on
|
||||
* context and geography, for example in US it is up to 115% of the original authorized amount, not to
|
||||
* exceed an increase of $75 USD.<br/><br/>Supports only the `amount` request parameter.
|
||||
* <blockquote><strong>Note:</strong> This request is currently not supported for Partner use cases.
|
||||
* </blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function authorizationsReauthorize(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(
|
||||
RequestMethod::POST,
|
||||
'/v2/payments/authorizations/{authorization_id}/reauthorize'
|
||||
)
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'The request failed because it is not well-formed or is syntactically incor' .
|
||||
'rect or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init(
|
||||
'The request failed because the caller has insufficient permissions.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'404',
|
||||
ErrorType::init('The request failed because the resource does not exist.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The request failed because it either is semantically incorrect or failed b' .
|
||||
'usiness validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('The request failed because an internal server error occurred.'))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(PaymentAuthorization::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Shows details for a captured payment, by ID.
|
||||
*
|
||||
@@ -342,9 +342,9 @@ class PaymentsController extends BaseController
|
||||
->parameters(
|
||||
TemplateParam::init('capture_id', $options)->extract('captureId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Controllers;
|
||||
namespace PaypalServerSDKLib\Controllers;
|
||||
|
||||
use Core\Request\Parameters\BodyParam;
|
||||
use Core\Request\Parameters\HeaderParam;
|
||||
@@ -16,14 +16,66 @@ use Core\Request\Parameters\QueryParam;
|
||||
use Core\Request\Parameters\TemplateParam;
|
||||
use Core\Response\Types\ErrorType;
|
||||
use CoreInterfaces\Core\Request\RequestMethod;
|
||||
use PaypalServerSdkLib\Exceptions\ErrorException;
|
||||
use PaypalServerSdkLib\Http\ApiResponse;
|
||||
use PaypalServerSdkLib\Models\CustomerVaultPaymentTokensResponse;
|
||||
use PaypalServerSdkLib\Models\PaymentTokenResponse;
|
||||
use PaypalServerSdkLib\Models\SetupTokenResponse;
|
||||
use PaypalServerSDKLib\Exceptions\ErrorException;
|
||||
use PaypalServerSDKLib\Http\ApiResponse;
|
||||
use PaypalServerSDKLib\Models\CustomerVaultPaymentTokensResponse;
|
||||
use PaypalServerSDKLib\Models\PaymentTokenResponse;
|
||||
use PaypalServerSDKLib\Models\SetupTokenResponse;
|
||||
|
||||
class VaultController extends BaseController
|
||||
{
|
||||
/**
|
||||
* Creates a Payment Token from the given payment source and adds it to the Vault of the associated
|
||||
* customer.
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function paymentTokensCreate(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/payment-tokens')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'404',
|
||||
ErrorType::init(
|
||||
'Request contains reference to resources that do not exist.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The requested action could not be performed, semantically incorrect, or fa' .
|
||||
'iled business validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->type(PaymentTokenResponse::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns all payment tokens for a customer.
|
||||
*
|
||||
@@ -96,22 +148,17 @@ class VaultController extends BaseController
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a Payment Token from the given payment source and adds it to the Vault of the associated
|
||||
* customer.
|
||||
* Delete the payment token associated with the payment token id.
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
* @param string $id ID of the payment token.
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function paymentTokensCreate(array $options): ApiResponse
|
||||
public function paymentTokensDelete(string $id): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/payment-tokens')
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v3/vault/payment-tokens/{id}')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
->parameters(TemplateParam::init('id', $id));
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
@@ -125,23 +172,7 @@ class VaultController extends BaseController
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'404',
|
||||
ErrorType::init(
|
||||
'Request contains reference to resources that do not exist.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The requested action could not be performed, semantically incorrect, or fa' .
|
||||
'iled business validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->type(PaymentTokenResponse::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
@@ -160,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')
|
||||
);
|
||||
@@ -192,37 +223,6 @@ class VaultController extends BaseController
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the payment token associated with the payment token id.
|
||||
*
|
||||
* @param string $id ID of the payment token.
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function paymentTokensDelete(string $id): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v3/vault/payment-tokens/{id}')
|
||||
->auth('Oauth2')
|
||||
->parameters(TemplateParam::init('id', $id));
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a readable representation of temporarily vaulted payment source associated with the setup
|
||||
* token id.
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib;
|
||||
namespace PaypalServerSDKLib;
|
||||
|
||||
/**
|
||||
* Environments available for API
|
||||
|
||||
@@ -3,16 +3,16 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Exceptions;
|
||||
namespace PaypalServerSDKLib\Exceptions;
|
||||
|
||||
use CoreInterfaces\Sdk\ExceptionInterface;
|
||||
use PaypalServerSdkLib\Http\HttpResponse;
|
||||
use PaypalServerSdkLib\Http\HttpRequest;
|
||||
use PaypalServerSDKLib\Http\HttpResponse;
|
||||
use PaypalServerSDKLib\Http\HttpRequest;
|
||||
|
||||
/**
|
||||
* Thrown when there is a network error or HTTP response status code is not okay.
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Exceptions;
|
||||
namespace PaypalServerSDKLib\Exceptions;
|
||||
|
||||
/**
|
||||
* The error details.
|
||||
@@ -31,27 +31,27 @@ class ErrorException extends ApiException
|
||||
private $debugId;
|
||||
|
||||
/**
|
||||
* @var \PaypalServerSdkLib\Models\ErrorDetails[]|null
|
||||
* @var \PaypalServerSDKLib\Models\ErrorDetails[]|null
|
||||
*/
|
||||
private $details;
|
||||
|
||||
/**
|
||||
* @var \PaypalServerSdkLib\Models\LinkDescription[]|null
|
||||
* @var \PaypalServerSDKLib\Models\LinkDescription[]|null
|
||||
*/
|
||||
private $links;
|
||||
|
||||
/**
|
||||
* @param string $reason
|
||||
* @param \PaypalServerSdkLib\Http\HttpRequest $request
|
||||
* @param \PaypalServerSdkLib\Http\HttpResponse $response
|
||||
* @param \PaypalServerSDKLib\Http\HttpRequest $request
|
||||
* @param \PaypalServerSDKLib\Http\HttpResponse $response
|
||||
* @param string $name
|
||||
* @param string $messageProperty
|
||||
* @param string $debugId
|
||||
*/
|
||||
public function __construct(
|
||||
string $reason,
|
||||
\PaypalServerSdkLib\Http\HttpRequest $request,
|
||||
\PaypalServerSdkLib\Http\HttpResponse $response,
|
||||
\PaypalServerSDKLib\Http\HttpRequest $request,
|
||||
\PaypalServerSDKLib\Http\HttpResponse $response,
|
||||
string $name,
|
||||
string $messageProperty,
|
||||
string $debugId
|
||||
@@ -129,7 +129,7 @@ class ErrorException extends ApiException
|
||||
* Returns Details.
|
||||
* An array of additional details about the error.
|
||||
*
|
||||
* @return \PaypalServerSdkLib\Models\ErrorDetails[]|null
|
||||
* @return \PaypalServerSDKLib\Models\ErrorDetails[]|null
|
||||
*/
|
||||
public function getDetails(): ?array
|
||||
{
|
||||
@@ -142,7 +142,7 @@ class ErrorException extends ApiException
|
||||
*
|
||||
* @maps details
|
||||
*
|
||||
* @param \PaypalServerSdkLib\Models\ErrorDetails[]|null $details
|
||||
* @param \PaypalServerSDKLib\Models\ErrorDetails[]|null $details
|
||||
*/
|
||||
public function setDetails(?array $details): void
|
||||
{
|
||||
@@ -153,7 +153,7 @@ class ErrorException extends ApiException
|
||||
* Returns Links.
|
||||
* An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links).
|
||||
*
|
||||
* @return \PaypalServerSdkLib\Models\LinkDescription[]|null
|
||||
* @return \PaypalServerSDKLib\Models\LinkDescription[]|null
|
||||
*/
|
||||
public function getLinks(): ?array
|
||||
{
|
||||
@@ -166,7 +166,7 @@ class ErrorException extends ApiException
|
||||
*
|
||||
* @maps links
|
||||
*
|
||||
* @param \PaypalServerSdkLib\Models\LinkDescription[]|null $links
|
||||
* @param \PaypalServerSDKLib\Models\LinkDescription[]|null $links
|
||||
*/
|
||||
public function setLinks(?array $links): void
|
||||
{
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Exceptions;
|
||||
namespace PaypalServerSDKLib\Exceptions;
|
||||
|
||||
/**
|
||||
* OAuth 2 Authorization endpoint exception.
|
||||
@@ -32,14 +32,14 @@ class OAuthProviderException extends ApiException
|
||||
|
||||
/**
|
||||
* @param string $reason
|
||||
* @param \PaypalServerSdkLib\Http\HttpRequest $request
|
||||
* @param \PaypalServerSdkLib\Http\HttpResponse $response
|
||||
* @param \PaypalServerSDKLib\Http\HttpRequest $request
|
||||
* @param \PaypalServerSDKLib\Http\HttpResponse $response
|
||||
* @param string $error
|
||||
*/
|
||||
public function __construct(
|
||||
string $reason,
|
||||
\PaypalServerSdkLib\Http\HttpRequest $request,
|
||||
\PaypalServerSdkLib\Http\HttpResponse $response,
|
||||
\PaypalServerSDKLib\Http\HttpRequest $request,
|
||||
\PaypalServerSDKLib\Http\HttpResponse $response,
|
||||
string $error
|
||||
) {
|
||||
parent::__construct($reason, $request, $response);
|
||||
@@ -61,7 +61,7 @@ class OAuthProviderException extends ApiException
|
||||
*
|
||||
* @required
|
||||
* @maps error
|
||||
* @factory \PaypalServerSdkLib\Models\OAuthProviderError::checkValue
|
||||
* @factory \PaypalServerSDKLib\Models\OAuthProviderError::checkValue
|
||||
*/
|
||||
public function setError(string $error): void
|
||||
{
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Http;
|
||||
namespace PaypalServerSDKLib\Http;
|
||||
|
||||
use Core\Types\Sdk\CoreApiResponse;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Http;
|
||||
namespace PaypalServerSDKLib\Http;
|
||||
|
||||
use Core\Types\Sdk\CoreCallback;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Http;
|
||||
namespace PaypalServerSDKLib\Http;
|
||||
|
||||
use Core\Types\Sdk\CoreContext;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Http;
|
||||
namespace PaypalServerSDKLib\Http;
|
||||
|
||||
use CoreInterfaces\Core\Request\RequestMethod;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Http;
|
||||
namespace PaypalServerSDKLib\Http;
|
||||
|
||||
use Core\Types\Sdk\CoreRequest;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Http;
|
||||
namespace PaypalServerSDKLib\Http;
|
||||
|
||||
use Core\Types\Sdk\CoreResponse;
|
||||
|
||||
|
||||
@@ -3,14 +3,14 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Logging;
|
||||
namespace PaypalServerSDKLib\Logging;
|
||||
|
||||
use PaypalServerSdkLib\ConfigurationDefaults;
|
||||
use PaypalServerSDKLib\ConfigurationDefaults;
|
||||
use Core\Logger\Configuration\LoggingConfiguration;
|
||||
use Core\Logger\ConsoleLogger;
|
||||
use Core\Utils\CoreHelper;
|
||||
|
||||
@@ -3,14 +3,14 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Logging;
|
||||
namespace PaypalServerSDKLib\Logging;
|
||||
|
||||
use PaypalServerSdkLib\ConfigurationDefaults;
|
||||
use PaypalServerSDKLib\ConfigurationDefaults;
|
||||
use Core\Logger\Configuration\RequestConfiguration;
|
||||
use Core\Utils\CoreHelper;
|
||||
|
||||
|
||||
@@ -3,14 +3,14 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Logging;
|
||||
namespace PaypalServerSDKLib\Logging;
|
||||
|
||||
use PaypalServerSdkLib\ConfigurationDefaults;
|
||||
use PaypalServerSDKLib\ConfigurationDefaults;
|
||||
use Core\Logger\Configuration\ResponseConfiguration;
|
||||
use Core\Utils\CoreHelper;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models;
|
||||
namespace PaypalServerSDKLib\Models;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use Exception;
|
||||
@@ -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.");
|
||||
}
|
||||
}
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models;
|
||||
namespace PaypalServerSDKLib\Models;
|
||||
|
||||
use stdClass;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models;
|
||||
namespace PaypalServerSDKLib\Models;
|
||||
|
||||
use stdClass;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models;
|
||||
namespace PaypalServerSDKLib\Models;
|
||||
|
||||
use stdClass;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models;
|
||||
namespace PaypalServerSDKLib\Models;
|
||||
|
||||
use stdClass;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models;
|
||||
namespace PaypalServerSDKLib\Models;
|
||||
|
||||
use stdClass;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models;
|
||||
namespace PaypalServerSDKLib\Models;
|
||||
|
||||
use stdClass;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models;
|
||||
namespace PaypalServerSDKLib\Models;
|
||||
|
||||
use stdClass;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models;
|
||||
namespace PaypalServerSDKLib\Models;
|
||||
|
||||
use stdClass;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models;
|
||||
namespace PaypalServerSDKLib\Models;
|
||||
|
||||
use stdClass;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models;
|
||||
namespace PaypalServerSDKLib\Models;
|
||||
|
||||
use stdClass;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models;
|
||||
namespace PaypalServerSDKLib\Models;
|
||||
|
||||
use stdClass;
|
||||
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* PaypalServerSdkLib
|
||||
* PaypalServerSDKLib
|
||||
*
|
||||
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
||||
*/
|
||||
|
||||
namespace PaypalServerSdkLib\Models;
|
||||
namespace PaypalServerSDKLib\Models;
|
||||
|
||||
use Core\Utils\CoreHelper;
|
||||
use Exception;
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user