forked from LiveCarta/PayPal-PHP-Server-SDK
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7d69e11899 |
36
README.md
36
README.md
@@ -1,5 +1,5 @@
|
||||
|
||||
# Getting Started with Paypal Server SDK
|
||||
# Getting Started with PayPal Server SDK
|
||||
|
||||
## Introduction
|
||||
|
||||
@@ -27,23 +27,23 @@ Find out more here: [https://developer.paypal.com/docs/api/orders/v2/](https://d
|
||||
Run the following command to install the package and automatically add the dependency to your composer.json file:
|
||||
|
||||
```php
|
||||
composer require "paypal/paypal-server-sdk:0.5.2"
|
||||
composer require "paypal/paypal-server-sdk:0.6.0"
|
||||
```
|
||||
|
||||
Or add it to the composer.json file manually as given below:
|
||||
|
||||
```php
|
||||
"require": {
|
||||
"paypal/paypal-server-sdk": "0.5.2"
|
||||
"paypal/paypal-server-sdk": "0.6.0"
|
||||
}
|
||||
```
|
||||
|
||||
You can also view the package at:
|
||||
https://packagist.org/packages/paypal/paypal-server-sdk#0.5.2
|
||||
https://packagist.org/packages/paypal/paypal-server-sdk#0.6.0
|
||||
|
||||
## Initialize the API Client
|
||||
|
||||
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.2/doc/client.md)
|
||||
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/client.md)
|
||||
|
||||
The following parameters are configurable for the API Client:
|
||||
|
||||
@@ -59,13 +59,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.5.2/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.2/doc/auth/oauth-2-client-credentials-grant.md) | The Credentials Setter for OAuth 2 Client Credentials Grant |
|
||||
| `loggingConfiguration` | [`LoggingConfigurationBuilder`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/logging-configuration-builder.md) | Represents the logging configurations for API calls |
|
||||
| `clientCredentialsAuth` | [`ClientCredentialsAuth`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/auth/oauth-2-client-credentials-grant.md) | The Credentials Setter for OAuth 2 Client Credentials Grant |
|
||||
|
||||
The API client can be initialized as follows:
|
||||
|
||||
```php
|
||||
$client = PaypalServerSDKClientBuilder::init()
|
||||
$client = PaypalServerSdkClientBuilder::init()
|
||||
->clientCredentialsAuthCredentials(
|
||||
ClientCredentialsAuthCredentialsBuilder::init(
|
||||
'OAuthClientId',
|
||||
@@ -105,20 +105,20 @@ The SDK can be configured to use a different environment for making API calls. A
|
||||
|
||||
This API uses the following authentication schemes.
|
||||
|
||||
* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.2/doc/auth/oauth-2-client-credentials-grant.md)
|
||||
* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/auth/oauth-2-client-credentials-grant.md)
|
||||
|
||||
## List of APIs
|
||||
|
||||
* [Orders](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.2/doc/controllers/orders.md)
|
||||
* [Payments](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.2/doc/controllers/payments.md)
|
||||
* [Vault](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.2/doc/controllers/vault.md)
|
||||
* [Orders](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/controllers/orders.md)
|
||||
* [Payments](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/controllers/payments.md)
|
||||
* [Vault](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/controllers/vault.md)
|
||||
|
||||
## Classes Documentation
|
||||
|
||||
* [ApiException](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.2/doc/api-exception.md)
|
||||
* [HttpRequest](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.2/doc/http-request.md)
|
||||
* [HttpResponse](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.2/doc/http-response.md)
|
||||
* [LoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.2/doc/logging-configuration-builder.md)
|
||||
* [RequestLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.2/doc/request-logging-configuration-builder.md)
|
||||
* [ResponseLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.2/doc/response-logging-configuration-builder.md)
|
||||
* [ApiException](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/api-exception.md)
|
||||
* [HttpRequest](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/http-request.md)
|
||||
* [HttpResponse](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/http-response.md)
|
||||
* [LoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/logging-configuration-builder.md)
|
||||
* [RequestLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/request-logging-configuration-builder.md)
|
||||
* [ResponseLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.0/doc/response-logging-configuration-builder.md)
|
||||
|
||||
|
||||
@@ -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,16 +12,110 @@ $ordersController = $client->getOrdersController();
|
||||
|
||||
## Methods
|
||||
|
||||
* [Orders Create](../../doc/controllers/orders.md#orders-create)
|
||||
* [Orders Get](../../doc/controllers/orders.md#orders-get)
|
||||
* [Orders Patch](../../doc/controllers/orders.md#orders-patch)
|
||||
* [Orders Confirm](../../doc/controllers/orders.md#orders-confirm)
|
||||
* [Orders Authorize](../../doc/controllers/orders.md#orders-authorize)
|
||||
* [Orders Capture](../../doc/controllers/orders.md#orders-capture)
|
||||
* [Orders Track Create](../../doc/controllers/orders.md#orders-track-create)
|
||||
* [Orders Create](../../doc/controllers/orders.md#orders-create)
|
||||
* [Orders Patch](../../doc/controllers/orders.md#orders-patch)
|
||||
* [Orders Capture](../../doc/controllers/orders.md#orders-capture)
|
||||
* [Orders Get](../../doc/controllers/orders.md#orders-get)
|
||||
* [Orders Confirm](../../doc/controllers/orders.md#orders-confirm)
|
||||
* [Orders Trackers Patch](../../doc/controllers/orders.md#orders-trackers-patch)
|
||||
|
||||
|
||||
# Orders Authorize
|
||||
|
||||
Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#authorize-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersAuthorize(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which to authorize.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=,-]*$` |
|
||||
| `paypalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
| `body` | [`?OrderAuthorizeRequest`](../../doc/models/order-authorize-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`OrderAuthorizeResponse`](../../doc/models/order-authorize-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersAuthorize($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The authorized payment failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Track Create
|
||||
|
||||
Adds tracking information for an Order.
|
||||
|
||||
```php
|
||||
function ordersTrackCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order that the tracking information is associated with.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `body` | [`OrderTrackerRequest`](../../doc/models/order-tracker-request.md) | Body, Required | - |
|
||||
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'body' => OrderTrackerRequestBuilder::init(
|
||||
'capture_id8'
|
||||
)
|
||||
->notifyPayer(false)
|
||||
->build()
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersTrackCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Create
|
||||
|
||||
Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see <a href="https://developer.paypal.com/docs/checkout/advanced/processing/">checkout</a> or <a href="https://developer.paypal.com/docs/multiparty/checkout/advanced/processing/">multiparty checkout</a>.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#create-order">Orders v2 errors</a>.</blockquote>
|
||||
@@ -35,14 +129,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
|
||||
|
||||
@@ -75,44 +169,6 @@ $apiResponse = $ordersController->ordersCreate($collect);
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Get
|
||||
|
||||
Shows details for an order, by ID.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#get-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersGet(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which to show details.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `fields` | `?string` | Query, Optional | A comma-separated list of fields that should be returned for the order. Valid filter field is `payment_source`.<br>**Constraints**: *Pattern*: `^[a-z_]*$` |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersGet($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Patch
|
||||
|
||||
Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the `COMPLETED` status.<br/><br/>To make an update, you must provide a `reference_id`. If you omit this value with an order that contains only one purchase unit, PayPal sets the value to `default` which enables you to use the path: <code>\"/purchase_units/@reference_id=='default'/{attribute-or-object}\"</code>. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see <a href="https://developer.paypal.com/docs/checkout/advanced/processing/">checkout</a> or <a href="https://developer.paypal.com/docs/multiparty/checkout/advanced/processing/">multiparty checkout</a>.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#patch-order">Orders v2 errors</a>.</blockquote>Patchable attributes or objects:<br/><br/><table><thead><th>Attribute</th><th>Op</th><th>Notes</th></thead><tbody><tr><td><code>intent</code></td><td>replace</td><td></td></tr><tr><td><code>payer</code></td><td>replace, add</td><td>Using replace op for <code>payer</code> will replace the whole <code>payer</code> object with the value sent in request.</td></tr><tr><td><code>purchase_units</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].custom_id</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].description</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].payee.email</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].shipping.name</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.email_address</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.phone_number</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.options</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.address</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.type</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].soft_descriptor</code></td><td>replace, remove</td><td></td></tr><tr><td><code>purchase_units[].amount</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].items</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].invoice_id</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].payment_instruction</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].payment_instruction.disbursement_mode</code></td><td>replace</td><td>By default, <code>disbursement_mode</code> is <code>INSTANT</code>.</td></tr><tr><td><code>purchase_units[].payment_instruction.payee_receivable_fx_rate_id</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].payment_instruction.platform_fees</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].supplementary_data.airline</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].supplementary_data.card</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>application_context.client_configuration</code></td><td>replace, add</td><td></td></tr></tbody></table>
|
||||
@@ -130,7 +186,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
|
||||
|
||||
@@ -158,6 +214,91 @@ $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.
|
||||
@@ -171,13 +312,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
|
||||
|
||||
@@ -206,147 +347,6 @@ $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 Reauthorize](../../doc/controllers/payments.md#authorizations-reauthorize)
|
||||
* [Authorizations Void](../../doc/controllers/payments.md#authorizations-void)
|
||||
* [Authorizations Reauthorize](../../doc/controllers/payments.md#authorizations-reauthorize)
|
||||
* [Captures Get](../../doc/controllers/payments.md#captures-get)
|
||||
* [Captures Refund](../../doc/controllers/payments.md#captures-refund)
|
||||
* [Refunds Get](../../doc/controllers/payments.md#refunds-get)
|
||||
@@ -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,51 +107,6 @@ $apiResponse = $paymentsController->authorizationsCapture($collect);
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Authorizations Reauthorize
|
||||
|
||||
Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires.<br/><br/>If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment.<br/><br/>A reauthorized payment itself has a new honor period of three days.<br/><br/>You can reauthorize an authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on context and geography, for example in US it is up to 115% of the original authorized amount, not to exceed an increase of $75 USD.<br/><br/>Supports only the `amount` request parameter.<blockquote><strong>Note:</strong> This request is currently not supported for Partner use cases.</blockquote>
|
||||
|
||||
```php
|
||||
function authorizationsReauthorize(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to reauthorize. |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
|
||||
| `body` | [`?ReauthorizeRequest`](../../doc/models/reauthorize-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentAuthorization`](../../doc/models/payment-authorization.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'authorizationId' => 'authorization_id8',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $paymentsController->authorizationsReauthorize($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The request failed because it either is semantically incorrect or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | The request failed because an internal server error occurred. | `ApiException` |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Authorizations Void
|
||||
|
||||
Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured.
|
||||
@@ -165,12 +120,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
|
||||
|
||||
@@ -197,6 +152,51 @@ $apiResponse = $paymentsController->authorizationsVoid($collect);
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Authorizations Reauthorize
|
||||
|
||||
Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires.<br/><br/>If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment.<br/><br/>A reauthorized payment itself has a new honor period of three days.<br/><br/>You can reauthorize an authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on context and geography, for example in US it is up to 115% of the original authorized amount, not to exceed an increase of $75 USD.<br/><br/>Supports only the `amount` request parameter.<blockquote><strong>Note:</strong> This request is currently not supported for Partner use cases.</blockquote>
|
||||
|
||||
```php
|
||||
function authorizationsReauthorize(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to reauthorize. |
|
||||
| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
|
||||
| `body` | [`?ReauthorizeRequest`](../../doc/models/reauthorize-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentAuthorization`](../../doc/models/payment-authorization.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'authorizationId' => 'authorization_id8',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $paymentsController->authorizationsReauthorize($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The request failed because it either is semantically incorrect or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | The request failed because an internal server error occurred. | `ApiException` |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Captures Get
|
||||
|
||||
Shows details for a captured payment, by ID.
|
||||
@@ -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,57 +12,14 @@ $vaultController = $client->getVaultController();
|
||||
|
||||
## Methods
|
||||
|
||||
* [Payment-Tokens Create](../../doc/controllers/vault.md#payment-tokens-create)
|
||||
* [Customer Payment-Tokens Get](../../doc/controllers/vault.md#customer-payment-tokens-get)
|
||||
* [Payment-Tokens Get](../../doc/controllers/vault.md#payment-tokens-get)
|
||||
* [Payment-Tokens Delete](../../doc/controllers/vault.md#payment-tokens-delete)
|
||||
* [Payment-Tokens Create](../../doc/controllers/vault.md#payment-tokens-create)
|
||||
* [Setup-Tokens Create](../../doc/controllers/vault.md#setup-tokens-create)
|
||||
* [Payment-Tokens Delete](../../doc/controllers/vault.md#payment-tokens-delete)
|
||||
* [Setup-Tokens Get](../../doc/controllers/vault.md#setup-tokens-get)
|
||||
|
||||
|
||||
# Payment-Tokens Create
|
||||
|
||||
Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.
|
||||
|
||||
```php
|
||||
function paymentTokensCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `payPalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
|
||||
| `body` | [`PaymentTokenRequest`](../../doc/models/payment-token-request.md) | Body, Required | Payment Token creation with a financial instrument and an optional customer_id. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentTokenResponse`](../../doc/models/payment-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'payPalRequestId' => 'PayPal-Request-Id6',
|
||||
'body' => PaymentTokenRequestBuilder::init(
|
||||
PaymentTokenRequestPaymentSourceBuilder::init()->build()
|
||||
)->build()
|
||||
];
|
||||
|
||||
$apiResponse = $vaultController->paymentTokensCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | Request contains reference to resources that do not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Customer Payment-Tokens Get
|
||||
|
||||
Returns all payment tokens for a customer.
|
||||
@@ -82,7 +39,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
|
||||
|
||||
@@ -122,7 +79,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
|
||||
|
||||
@@ -142,6 +99,91 @@ $apiResponse = $vaultController->paymentTokensGet($id);
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Payment-Tokens Create
|
||||
|
||||
Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.
|
||||
|
||||
```php
|
||||
function paymentTokensCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `paypalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
|
||||
| `body` | [`PaymentTokenRequest`](../../doc/models/payment-token-request.md) | Body, Required | Payment Token creation with a financial instrument and an optional customer_id. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentTokenResponse`](../../doc/models/payment-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'paypalRequestId' => 'PayPal-Request-Id6',
|
||||
'body' => PaymentTokenRequestBuilder::init(
|
||||
PaymentTokenRequestPaymentSourceBuilder::init()->build()
|
||||
)->build()
|
||||
];
|
||||
|
||||
$apiResponse = $vaultController->paymentTokensCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | Request contains reference to resources that do not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Setup-Tokens Create
|
||||
|
||||
Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer.
|
||||
|
||||
```php
|
||||
function setupTokensCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `paypalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
|
||||
| `body` | [`SetupTokenRequest`](../../doc/models/setup-token-request.md) | Body, Required | Setup Token creation with a instrument type optional financial instrument details and customer_id. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`SetupTokenResponse`](../../doc/models/setup-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'paypalRequestId' => 'PayPal-Request-Id6',
|
||||
'body' => SetupTokenRequestBuilder::init(
|
||||
SetupTokenRequestPaymentSourceBuilder::init()->build()
|
||||
)->build()
|
||||
];
|
||||
|
||||
$apiResponse = $vaultController->setupTokensCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Payment-Tokens Delete
|
||||
|
||||
Delete the payment token associated with the payment token id.
|
||||
@@ -158,7 +200,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
|
||||
|
||||
@@ -177,48 +219,6 @@ $apiResponse = $vaultController->paymentTokensDelete($id);
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Setup-Tokens Create
|
||||
|
||||
Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer.
|
||||
|
||||
```php
|
||||
function setupTokensCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `payPalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
|
||||
| `body` | [`SetupTokenRequest`](../../doc/models/setup-token-request.md) | Body, Required | Setup Token creation with a instrument type optional financial instrument details and customer_id. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`SetupTokenResponse`](../../doc/models/setup-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'payPalRequestId' => 'PayPal-Request-Id6',
|
||||
'body' => SetupTokenRequestBuilder::init(
|
||||
SetupTokenRequestPaymentSourceBuilder::init()->build()
|
||||
)->build()
|
||||
];
|
||||
|
||||
$apiResponse = $vaultController->setupTokensCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Setup-Tokens Get
|
||||
|
||||
Returns a readable representation of temporarily vaulted payment source associated with the setup token id.
|
||||
@@ -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 @@
|
||||
|
||||
# My Bank Payment Object
|
||||
# Mybank Payment Object
|
||||
|
||||
Information used to pay using MyBank.
|
||||
|
||||
## Structure
|
||||
|
||||
`MyBankPaymentObject`
|
||||
`MybankPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# My Bank Payment Request
|
||||
# Mybank Payment Request
|
||||
|
||||
Information needed to pay using MyBank.
|
||||
|
||||
## Structure
|
||||
|
||||
`MyBankPaymentRequest`
|
||||
`MybankPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -14,7 +14,7 @@ The Third Party Network token used to fund a payment.
|
||||
| `number` | `string` | Required | Third party network token number.<br>**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `19`, *Pattern*: `^[0-9]{13,19}$` | getNumber(): string | setNumber(string number): void |
|
||||
| `expiry` | `string` | Required | The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).<br>**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): string | setExpiry(string expiry): void |
|
||||
| `cryptogram` | `?string` | Optional | An Encrypted one-time use value that's sent along with Network Token. This field is not required to be present for recurring transactions.<br>**Constraints**: *Minimum Length*: `28`, *Maximum Length*: `32`, *Pattern*: `^.*$` | getCryptogram(): ?string | setCryptogram(?string cryptogram): void |
|
||||
| `eciFlag` | [`?string(ECIFlag)`](../../doc/models/eci-flag.md) | Optional | Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getEciFlag(): ?string | setEciFlag(?string eciFlag): void |
|
||||
| `eciFlag` | [`?string(EciFlag)`](../../doc/models/eci-flag.md) | Optional | Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getEciFlag(): ?string | setEciFlag(?string eciFlag): void |
|
||||
| `tokenRequestorId` | `?string` | Optional | A TRID, or a Token Requestor ID, is an identifier used by merchants to request network tokens from card networks. A TRID is a precursor to obtaining a network token for a credit card primary account number (PAN), and will aid in enabling secure card on file (COF) payments and reducing fraud.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `11`, *Pattern*: `^[0-9A-Z_]+$` | getTokenRequestorId(): ?string | setTokenRequestorId(?string tokenRequestorId): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -13,7 +13,7 @@ The payment source definition.
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardRequest`](../../doc/models/card-request.md) | Optional | The payment card to use to fund a payment. Can be a credit or debit card.<blockquote><strong>Note:</strong> Passing card number, cvv and expiry directly via the API requires <a href="https://www.pcisecuritystandards.org/pci_security/completing_self_assessment"> PCI SAQ D compliance</a>. <br>*PayPal offers a mechanism by which you do not have to take on the <strong>PCI SAQ D</strong> burden by using hosted fields - refer to <a href="https://developer.paypal.com/docs/checkout/advanced/integrate/">this Integration Guide</a>*.</blockquote> | getCard(): ?CardRequest | setCard(?CardRequest card): void |
|
||||
| `token` | [`?Token`](../../doc/models/token.md) | Optional | The tokenized payment source to fund a payment. | getToken(): ?Token | setToken(?Token token): void |
|
||||
| `paypal` | [`?PayPalWallet`](../../doc/models/pay-pal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PayPalWallet | setPaypal(?PayPalWallet paypal): void |
|
||||
| `paypal` | [`?PaypalWallet`](../../doc/models/paypal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PaypalWallet | setPaypal(?PaypalWallet paypal): void |
|
||||
| `applePay` | [`?ApplePayRequest`](../../doc/models/apple-pay-request.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayRequest | setApplePay(?ApplePayRequest applePay): void |
|
||||
| `googlePay` | [`?GooglePayRequest`](../../doc/models/google-pay-request.md) | Optional | Information needed to pay using Google Pay. | getGooglePay(): ?GooglePayRequest | setGooglePay(?GooglePayRequest googlePay): void |
|
||||
| `venmo` | [`?VenmoWalletRequest`](../../doc/models/venmo-wallet-request.md) | Optional | Information needed to pay using Venmo. | getVenmo(): ?VenmoWalletRequest | setVenmo(?VenmoWalletRequest venmo): void |
|
||||
|
||||
@@ -12,7 +12,7 @@ The payment source used to fund the payment.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardResponse`](../../doc/models/card-response.md) | Optional | The payment card to use to fund a payment. Card can be a credit or debit card. | getCard(): ?CardResponse | setCard(?CardResponse card): void |
|
||||
| `paypal` | [`?PayPalWalletResponse`](../../doc/models/pay-pal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PayPalWalletResponse | setPaypal(?PayPalWalletResponse paypal): void |
|
||||
| `paypal` | [`?PaypalWalletResponse`](../../doc/models/paypal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PaypalWalletResponse | setPaypal(?PaypalWalletResponse paypal): void |
|
||||
| `applePay` | [`?ApplePayPaymentObject`](../../doc/models/apple-pay-payment-object.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayPaymentObject | setApplePay(?ApplePayPaymentObject applePay): void |
|
||||
| `googlePay` | [`?GooglePayWalletResponse`](../../doc/models/google-pay-wallet-response.md) | Optional | Google Pay Wallet payment data. | getGooglePay(): ?GooglePayWalletResponse | setGooglePay(?GooglePayWalletResponse googlePay): void |
|
||||
| `venmo` | [`?VenmoWalletResponse`](../../doc/models/venmo-wallet-response.md) | Optional | Venmo wallet response. | getVenmo(): ?VenmoWalletResponse | setVenmo(?VenmoWalletResponse venmo): void |
|
||||
|
||||
@@ -13,7 +13,7 @@ The payment source definition.
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardRequest`](../../doc/models/card-request.md) | Optional | The payment card to use to fund a payment. Can be a credit or debit card.<blockquote><strong>Note:</strong> Passing card number, cvv and expiry directly via the API requires <a href="https://www.pcisecuritystandards.org/pci_security/completing_self_assessment"> PCI SAQ D compliance</a>. <br>*PayPal offers a mechanism by which you do not have to take on the <strong>PCI SAQ D</strong> burden by using hosted fields - refer to <a href="https://developer.paypal.com/docs/checkout/advanced/integrate/">this Integration Guide</a>*.</blockquote> | getCard(): ?CardRequest | setCard(?CardRequest card): void |
|
||||
| `token` | [`?Token`](../../doc/models/token.md) | Optional | The tokenized payment source to fund a payment. | getToken(): ?Token | setToken(?Token token): void |
|
||||
| `paypal` | [`?PayPalWallet`](../../doc/models/pay-pal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PayPalWallet | setPaypal(?PayPalWallet paypal): void |
|
||||
| `paypal` | [`?PaypalWallet`](../../doc/models/paypal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PaypalWallet | setPaypal(?PaypalWallet paypal): void |
|
||||
| `applePay` | [`?ApplePayRequest`](../../doc/models/apple-pay-request.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayRequest | setApplePay(?ApplePayRequest applePay): void |
|
||||
| `googlePay` | [`?GooglePayRequest`](../../doc/models/google-pay-request.md) | Optional | Information needed to pay using Google Pay. | getGooglePay(): ?GooglePayRequest | setGooglePay(?GooglePayRequest googlePay): void |
|
||||
| `venmo` | [`?VenmoWalletRequest`](../../doc/models/venmo-wallet-request.md) | Optional | Information needed to pay using Venmo. | getVenmo(): ?VenmoWalletRequest | setVenmo(?VenmoWalletRequest venmo): void |
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# PA Res Status
|
||||
# Pa Res Status
|
||||
|
||||
Transactions status result identifier. The outcome of the issuer's authentication.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PAResStatus`
|
||||
`PaResStatus`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -12,13 +12,13 @@ The payment source used to fund the payment.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardResponse`](../../doc/models/card-response.md) | Optional | The payment card to use to fund a payment. Card can be a credit or debit card. | getCard(): ?CardResponse | setCard(?CardResponse card): void |
|
||||
| `paypal` | [`?PayPalWalletResponse`](../../doc/models/pay-pal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PayPalWalletResponse | setPaypal(?PayPalWalletResponse paypal): void |
|
||||
| `paypal` | [`?PaypalWalletResponse`](../../doc/models/paypal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PaypalWalletResponse | setPaypal(?PaypalWalletResponse paypal): void |
|
||||
| `bancontact` | [`?BancontactPaymentObject`](../../doc/models/bancontact-payment-object.md) | Optional | Information used to pay Bancontact. | getBancontact(): ?BancontactPaymentObject | setBancontact(?BancontactPaymentObject bancontact): void |
|
||||
| `blik` | [`?BLIKPaymentObject`](../../doc/models/blik-payment-object.md) | Optional | Information used to pay using BLIK. | getBlik(): ?BLIKPaymentObject | setBlik(?BLIKPaymentObject blik): void |
|
||||
| `eps` | [`?EPSPaymentObject`](../../doc/models/eps-payment-object.md) | Optional | Information used to pay using eps. | getEps(): ?EPSPaymentObject | setEps(?EPSPaymentObject eps): void |
|
||||
| `blik` | [`?BlikPaymentObject`](../../doc/models/blik-payment-object.md) | Optional | Information used to pay using BLIK. | getBlik(): ?BlikPaymentObject | setBlik(?BlikPaymentObject blik): void |
|
||||
| `eps` | [`?EpsPaymentObject`](../../doc/models/eps-payment-object.md) | Optional | Information used to pay using eps. | getEps(): ?EpsPaymentObject | setEps(?EpsPaymentObject eps): void |
|
||||
| `giropay` | [`?GiropayPaymentObject`](../../doc/models/giropay-payment-object.md) | Optional | Information needed to pay using giropay. | getGiropay(): ?GiropayPaymentObject | setGiropay(?GiropayPaymentObject giropay): void |
|
||||
| `ideal` | [`?IDEALPaymentObject`](../../doc/models/ideal-payment-object.md) | Optional | Information used to pay using iDEAL. | getIdeal(): ?IDEALPaymentObject | setIdeal(?IDEALPaymentObject ideal): void |
|
||||
| `mybank` | [`?MyBankPaymentObject`](../../doc/models/my-bank-payment-object.md) | Optional | Information used to pay using MyBank. | getMybank(): ?MyBankPaymentObject | setMybank(?MyBankPaymentObject mybank): void |
|
||||
| `ideal` | [`?IdealPaymentObject`](../../doc/models/ideal-payment-object.md) | Optional | Information used to pay using iDEAL. | getIdeal(): ?IdealPaymentObject | setIdeal(?IdealPaymentObject ideal): void |
|
||||
| `mybank` | [`?MybankPaymentObject`](../../doc/models/mybank-payment-object.md) | Optional | Information used to pay using MyBank. | getMybank(): ?MybankPaymentObject | setMybank(?MybankPaymentObject mybank): void |
|
||||
| `p24` | [`?P24PaymentObject`](../../doc/models/p24-payment-object.md) | Optional | Information used to pay using P24(Przelewy24). | getP24(): ?P24PaymentObject | setP24(?P24PaymentObject p24): void |
|
||||
| `sofort` | [`?SofortPaymentObject`](../../doc/models/sofort-payment-object.md) | Optional | Information used to pay using Sofort. | getSofort(): ?SofortPaymentObject | setSofort(?SofortPaymentObject sofort): void |
|
||||
| `trustly` | [`?TrustlyPaymentObject`](../../doc/models/trustly-payment-object.md) | Optional | Information needed to pay using Trustly. | getTrustly(): ?TrustlyPaymentObject | setTrustly(?TrustlyPaymentObject trustly): void |
|
||||
|
||||
@@ -13,13 +13,13 @@ The payment source definition.
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardRequest`](../../doc/models/card-request.md) | Optional | The payment card to use to fund a payment. Can be a credit or debit card.<blockquote><strong>Note:</strong> Passing card number, cvv and expiry directly via the API requires <a href="https://www.pcisecuritystandards.org/pci_security/completing_self_assessment"> PCI SAQ D compliance</a>. <br>*PayPal offers a mechanism by which you do not have to take on the <strong>PCI SAQ D</strong> burden by using hosted fields - refer to <a href="https://developer.paypal.com/docs/checkout/advanced/integrate/">this Integration Guide</a>*.</blockquote> | getCard(): ?CardRequest | setCard(?CardRequest card): void |
|
||||
| `token` | [`?Token`](../../doc/models/token.md) | Optional | The tokenized payment source to fund a payment. | getToken(): ?Token | setToken(?Token token): void |
|
||||
| `paypal` | [`?PayPalWallet`](../../doc/models/pay-pal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PayPalWallet | setPaypal(?PayPalWallet paypal): void |
|
||||
| `paypal` | [`?PaypalWallet`](../../doc/models/paypal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PaypalWallet | setPaypal(?PaypalWallet paypal): void |
|
||||
| `bancontact` | [`?BancontactPaymentRequest`](../../doc/models/bancontact-payment-request.md) | Optional | Information needed to pay using Bancontact. | getBancontact(): ?BancontactPaymentRequest | setBancontact(?BancontactPaymentRequest bancontact): void |
|
||||
| `blik` | [`?BLIKPaymentRequest`](../../doc/models/blik-payment-request.md) | Optional | Information needed to pay using BLIK. | getBlik(): ?BLIKPaymentRequest | setBlik(?BLIKPaymentRequest blik): void |
|
||||
| `eps` | [`?EPSPaymentRequest`](../../doc/models/eps-payment-request.md) | Optional | Information needed to pay using eps. | getEps(): ?EPSPaymentRequest | setEps(?EPSPaymentRequest eps): void |
|
||||
| `blik` | [`?BlikPaymentRequest`](../../doc/models/blik-payment-request.md) | Optional | Information needed to pay using BLIK. | getBlik(): ?BlikPaymentRequest | setBlik(?BlikPaymentRequest blik): void |
|
||||
| `eps` | [`?EpsPaymentRequest`](../../doc/models/eps-payment-request.md) | Optional | Information needed to pay using eps. | getEps(): ?EpsPaymentRequest | setEps(?EpsPaymentRequest eps): void |
|
||||
| `giropay` | [`?GiropayPaymentRequest`](../../doc/models/giropay-payment-request.md) | Optional | Information needed to pay using giropay. | getGiropay(): ?GiropayPaymentRequest | setGiropay(?GiropayPaymentRequest giropay): void |
|
||||
| `ideal` | [`?IDEALPaymentRequest`](../../doc/models/ideal-payment-request.md) | Optional | Information needed to pay using iDEAL. | getIdeal(): ?IDEALPaymentRequest | setIdeal(?IDEALPaymentRequest ideal): void |
|
||||
| `mybank` | [`?MyBankPaymentRequest`](../../doc/models/my-bank-payment-request.md) | Optional | Information needed to pay using MyBank. | getMybank(): ?MyBankPaymentRequest | setMybank(?MyBankPaymentRequest mybank): void |
|
||||
| `ideal` | [`?IdealPaymentRequest`](../../doc/models/ideal-payment-request.md) | Optional | Information needed to pay using iDEAL. | getIdeal(): ?IdealPaymentRequest | setIdeal(?IdealPaymentRequest ideal): void |
|
||||
| `mybank` | [`?MybankPaymentRequest`](../../doc/models/mybank-payment-request.md) | Optional | Information needed to pay using MyBank. | getMybank(): ?MybankPaymentRequest | setMybank(?MybankPaymentRequest mybank): void |
|
||||
| `p24` | [`?P24PaymentRequest`](../../doc/models/p24-payment-request.md) | Optional | Information needed to pay using P24 (Przelewy24). | getP24(): ?P24PaymentRequest | setP24(?P24PaymentRequest p24): void |
|
||||
| `sofort` | [`?SofortPaymentRequest`](../../doc/models/sofort-payment-request.md) | Optional | Information needed to pay using Sofort. | getSofort(): ?SofortPaymentRequest | setSofort(?SofortPaymentRequest sofort): void |
|
||||
| `trustly` | [`?TrustlyPaymentRequest`](../../doc/models/trustly-payment-request.md) | Optional | Information needed to pay using Trustly. | getTrustly(): ?TrustlyPaymentRequest | setTrustly(?TrustlyPaymentRequest trustly): void |
|
||||
|
||||
@@ -12,7 +12,7 @@ The vaulted payment method details.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?CardPaymentToken`](../../doc/models/card-payment-token.md) | Optional | Full representation of a Card Payment Token including network token. | getCard(): ?CardPaymentToken | setCard(?CardPaymentToken card): void |
|
||||
| `paypal` | [`?PayPalPaymentToken`](../../doc/models/pay-pal-payment-token.md) | Optional | - | getPaypal(): ?PayPalPaymentToken | setPaypal(?PayPalPaymentToken paypal): void |
|
||||
| `paypal` | [`?PaypalPaymentToken`](../../doc/models/paypal-payment-token.md) | Optional | - | getPaypal(): ?PaypalPaymentToken | setPaypal(?PaypalPaymentToken paypal): void |
|
||||
| `venmo` | [`?VenmoPaymentToken`](../../doc/models/venmo-payment-token.md) | Optional | - | getVenmo(): ?VenmoPaymentToken | setVenmo(?VenmoPaymentToken venmo): void |
|
||||
| `applePay` | [`?ApplePayPaymentToken`](../../doc/models/apple-pay-payment-token.md) | Optional | A resource representing a response for Apple Pay. | getApplePay(): ?ApplePayPaymentToken | setApplePay(?ApplePayPaymentToken applePay): void |
|
||||
| `bank` | `mixed` | Optional | Full representation of a Bank Payment Token. | getBank(): | setBank( bank): void |
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Experience Landing Page
|
||||
# Paypal Experience Landing Page
|
||||
|
||||
The type of landing page to show on the PayPal site for customer checkout.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PayPalExperienceLandingPage`
|
||||
`PaypalExperienceLandingPage`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Experience User Action
|
||||
# Paypal Experience User Action
|
||||
|
||||
Configures a <strong>Continue</strong> or <strong>Pay Now</strong> checkout flow.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PayPalExperienceUserAction`
|
||||
`PaypalExperienceUserAction`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Payment Token Customer Type
|
||||
# Paypal Payment Token Customer Type
|
||||
|
||||
The customer type associated with the PayPal payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PayPalPaymentTokenCustomerType`
|
||||
`PaypalPaymentTokenCustomerType`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Payment Token Usage Pattern
|
||||
# Paypal Payment Token Usage Pattern
|
||||
|
||||
Expected business/pricing model for the billing agreement.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PayPalPaymentTokenUsagePattern`
|
||||
`PaypalPaymentTokenUsagePattern`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Payment Token Usage Type
|
||||
# Paypal Payment Token Usage Type
|
||||
|
||||
The usage type associated with the PayPal payment token.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PayPalPaymentTokenUsageType`
|
||||
`PaypalPaymentTokenUsageType`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
# Pay Pal Payment Token
|
||||
# Paypal Payment Token
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalPaymentToken`
|
||||
`PaypalPaymentToken`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Wallet Account Verification Status
|
||||
# Paypal Wallet Account Verification Status
|
||||
|
||||
The account status indicates whether the buyer has verified the financial details associated with their PayPal account.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PayPalWalletAccountVerificationStatus`
|
||||
`PaypalWalletAccountVerificationStatus`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
|
||||
# Pay Pal Wallet Attributes Response
|
||||
# Paypal Wallet Attributes Response
|
||||
|
||||
Additional attributes associated with the use of a PayPal Wallet.
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletAttributesResponse`
|
||||
`PaypalWalletAttributesResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `vault` | [`?PayPalWalletVaultResponse`](../../doc/models/pay-pal-wallet-vault-response.md) | Optional | The details about a saved PayPal Wallet payment source. | getVault(): ?PayPalWalletVaultResponse | setVault(?PayPalWalletVaultResponse vault): void |
|
||||
| `vault` | [`?PaypalWalletVaultResponse`](../../doc/models/paypal-wallet-vault-response.md) | Optional | The details about a saved PayPal Wallet payment source. | getVault(): ?PaypalWalletVaultResponse | setVault(?PaypalWalletVaultResponse vault): void |
|
||||
| `cobrandedCards` | [`?(CobrandedCard[])`](../../doc/models/cobranded-card.md) | Optional | An array of merchant cobranded cards used by buyer to complete an order. This array will be present if a merchant has onboarded their cobranded card with PayPal and provided corresponding label(s).<br>**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `25` | getCobrandedCards(): ?array | setCobrandedCards(?array cobrandedCards): void |
|
||||
|
||||
## Example (as JSON)
|
||||
@@ -1,18 +1,18 @@
|
||||
|
||||
# Pay Pal Wallet Attributes
|
||||
# Paypal Wallet Attributes
|
||||
|
||||
Additional attributes associated with the use of this PayPal Wallet.
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletAttributes`
|
||||
`PaypalWalletAttributes`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `customer` | [`?PayPalWalletCustomerRequest`](../../doc/models/pay-pal-wallet-customer-request.md) | Optional | - | getCustomer(): ?PayPalWalletCustomerRequest | setCustomer(?PayPalWalletCustomerRequest customer): void |
|
||||
| `vault` | [`?PayPalWalletVaultInstruction`](../../doc/models/pay-pal-wallet-vault-instruction.md) | Optional | - | getVault(): ?PayPalWalletVaultInstruction | setVault(?PayPalWalletVaultInstruction vault): void |
|
||||
| `customer` | [`?PaypalWalletCustomerRequest`](../../doc/models/paypal-wallet-customer-request.md) | Optional | - | getCustomer(): ?PaypalWalletCustomerRequest | setCustomer(?PaypalWalletCustomerRequest customer): void |
|
||||
| `vault` | [`?PaypalWalletVaultInstruction`](../../doc/models/paypal-wallet-vault-instruction.md) | Optional | - | getVault(): ?PaypalWalletVaultInstruction | setVault(?PaypalWalletVaultInstruction vault): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
# Pay Pal Wallet Customer Request
|
||||
# Paypal Wallet Customer Request
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletCustomerRequest`
|
||||
`PaypalWalletCustomerRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Wallet Customer
|
||||
# Paypal Wallet Customer
|
||||
|
||||
The details about a customer in PayPal's system of record.
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletCustomer`
|
||||
`PaypalWalletCustomer`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Wallet Experience Context
|
||||
# Paypal Wallet Experience Context
|
||||
|
||||
Customizes the payer experience during the approval process for payment with PayPal.<blockquote><strong>Note:</strong> Partners and Marketplaces might configure <code>brand_name</code> and <code>shipping_preference</code> during partner account setup, which overrides the request values.</blockquote>
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletExperienceContext`
|
||||
`PaypalWalletExperienceContext`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -16,8 +16,8 @@ Customizes the payer experience during the approval process for payment with Pay
|
||||
| `shippingPreference` | [`?string(ShippingPreference)`](../../doc/models/shipping-preference.md) | Optional | The location from which the shipping address is derived.<br>**Default**: `ShippingPreference::GET_FROM_FILE`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `24`, *Pattern*: `^[A-Z_]+$` | getShippingPreference(): ?string | setShippingPreference(?string shippingPreference): void |
|
||||
| `returnUrl` | `?string` | Optional | Describes the URL. | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void |
|
||||
| `cancelUrl` | `?string` | Optional | Describes the URL. | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void |
|
||||
| `landingPage` | [`?string(PayPalExperienceLandingPage)`](../../doc/models/pay-pal-experience-landing-page.md) | Optional | The type of landing page to show on the PayPal site for customer checkout.<br>**Default**: `PayPalExperienceLandingPage::NO_PREFERENCE`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `13`, *Pattern*: `^[0-9A-Z_]+$` | getLandingPage(): ?string | setLandingPage(?string landingPage): void |
|
||||
| `userAction` | [`?string(PayPalExperienceUserAction)`](../../doc/models/pay-pal-experience-user-action.md) | Optional | Configures a <strong>Continue</strong> or <strong>Pay Now</strong> checkout flow.<br>**Default**: `PayPalExperienceUserAction::CONTINUE_`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `8`, *Pattern*: `^[0-9A-Z_]+$` | getUserAction(): ?string | setUserAction(?string userAction): void |
|
||||
| `landingPage` | [`?string(PaypalExperienceLandingPage)`](../../doc/models/paypal-experience-landing-page.md) | Optional | The type of landing page to show on the PayPal site for customer checkout.<br>**Default**: `PaypalExperienceLandingPage::NO_PREFERENCE`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `13`, *Pattern*: `^[0-9A-Z_]+$` | getLandingPage(): ?string | setLandingPage(?string landingPage): void |
|
||||
| `userAction` | [`?string(PaypalExperienceUserAction)`](../../doc/models/paypal-experience-user-action.md) | Optional | Configures a <strong>Continue</strong> or <strong>Pay Now</strong> checkout flow.<br>**Default**: `PaypalExperienceUserAction::CONTINUE_`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `8`, *Pattern*: `^[0-9A-Z_]+$` | getUserAction(): ?string | setUserAction(?string userAction): void |
|
||||
| `paymentMethodPreference` | [`?string(PayeePaymentMethodPreference)`](../../doc/models/payee-payment-method-preference.md) | Optional | The merchant-preferred payment methods.<br>**Default**: `PayeePaymentMethodPreference::UNRESTRICTED`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getPaymentMethodPreference(): ?string | setPaymentMethodPreference(?string paymentMethodPreference): void |
|
||||
|
||||
## Example (as JSON)
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Wallet Response
|
||||
# Paypal Wallet Response
|
||||
|
||||
The PayPal Wallet response.
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletResponse`
|
||||
`PaypalWalletResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -13,7 +13,7 @@ The PayPal Wallet response.
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `emailAddress` | `?string` | Optional | The internationalized email address.<blockquote><strong>Note:</strong> Up to 64 characters are allowed before and 255 characters are allowed after the <code>@</code> sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted <code>@</code> sign exists.</blockquote><br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: ``(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])`` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void |
|
||||
| `accountId` | `?string` | Optional | The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is used to encode the result.<br>**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `13`, *Pattern*: `^[2-9A-HJ-NP-Z]{13}$` | getAccountId(): ?string | setAccountId(?string accountId): void |
|
||||
| `accountStatus` | [`?string(PayPalWalletAccountVerificationStatus)`](../../doc/models/pay-pal-wallet-account-verification-status.md) | Optional | The account status indicates whether the buyer has verified the financial details associated with their PayPal account.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getAccountStatus(): ?string | setAccountStatus(?string accountStatus): void |
|
||||
| `accountStatus` | [`?string(PaypalWalletAccountVerificationStatus)`](../../doc/models/paypal-wallet-account-verification-status.md) | Optional | The account status indicates whether the buyer has verified the financial details associated with their PayPal account.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getAccountStatus(): ?string | setAccountStatus(?string accountStatus): void |
|
||||
| `name` | [`?Name`](../../doc/models/name.md) | Optional | The name of the party. | getName(): ?Name | setName(?Name name): void |
|
||||
| `phoneType` | [`?string(PhoneType)`](../../doc/models/phone-type.md) | Optional | The phone type. | getPhoneType(): ?string | setPhoneType(?string phoneType): void |
|
||||
| `phoneNumber` | [`?PhoneNumber`](../../doc/models/phone-number.md) | Optional | The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): ?PhoneNumber | setPhoneNumber(?PhoneNumber phoneNumber): void |
|
||||
@@ -21,7 +21,7 @@ The PayPal Wallet response.
|
||||
| `businessName` | `?string` | Optional | The business name of the PayPal account holder (populated for business accounts only)<br>**Constraints**: *Minimum Length*: `0`, *Maximum Length*: `300`, *Pattern*: `^.*$` | getBusinessName(): ?string | setBusinessName(?string businessName): void |
|
||||
| `taxInfo` | [`?TaxInfo`](../../doc/models/tax-info.md) | Optional | The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` are required. | getTaxInfo(): ?TaxInfo | setTaxInfo(?TaxInfo taxInfo): void |
|
||||
| `address` | [`?Address`](../../doc/models/address.md) | Optional | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getAddress(): ?Address | setAddress(?Address address): void |
|
||||
| `attributes` | [`?PayPalWalletAttributesResponse`](../../doc/models/pay-pal-wallet-attributes-response.md) | Optional | Additional attributes associated with the use of a PayPal Wallet. | getAttributes(): ?PayPalWalletAttributesResponse | setAttributes(?PayPalWalletAttributesResponse attributes): void |
|
||||
| `attributes` | [`?PaypalWalletAttributesResponse`](../../doc/models/paypal-wallet-attributes-response.md) | Optional | Additional attributes associated with the use of a PayPal Wallet. | getAttributes(): ?PaypalWalletAttributesResponse | setAttributes(?PaypalWalletAttributesResponse attributes): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
# Pay Pal Wallet Vault Instruction
|
||||
# Paypal Wallet Vault Instruction
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletVaultInstruction`
|
||||
`PaypalWalletVaultInstruction`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -11,9 +11,9 @@
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `storeInVault` | [`?string(StoreInVaultInstruction)`](../../doc/models/store-in-vault-instruction.md) | Optional | Defines how and when the payment source gets vaulted.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStoreInVault(): ?string | setStoreInVault(?string storeInVault): void |
|
||||
| `description` | `?string` | Optional | The description displayed to PayPal consumer on the approval flow for PayPal, as well as on the PayPal payment token management experience on PayPal.com.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | getDescription(): ?string | setDescription(?string description): void |
|
||||
| `usagePattern` | [`?string(PayPalPaymentTokenUsagePattern)`](../../doc/models/pay-pal-payment-token-usage-pattern.md) | Optional | Expected business/pricing model for the billing agreement.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `30` | getUsagePattern(): ?string | setUsagePattern(?string usagePattern): void |
|
||||
| `usageType` | [`string(PayPalPaymentTokenUsageType)`](../../doc/models/pay-pal-payment-token-usage-type.md) | Required | The usage type associated with the PayPal payment token.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getUsageType(): string | setUsageType(string usageType): void |
|
||||
| `customerType` | [`?string(PayPalPaymentTokenCustomerType)`](../../doc/models/pay-pal-payment-token-customer-type.md) | Optional | The customer type associated with the PayPal payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.<br>**Default**: `PayPalPaymentTokenCustomerType::CONSUMER`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getCustomerType(): ?string | setCustomerType(?string customerType): void |
|
||||
| `usagePattern` | [`?string(PaypalPaymentTokenUsagePattern)`](../../doc/models/paypal-payment-token-usage-pattern.md) | Optional | Expected business/pricing model for the billing agreement.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `30` | getUsagePattern(): ?string | setUsagePattern(?string usagePattern): void |
|
||||
| `usageType` | [`string(PaypalPaymentTokenUsageType)`](../../doc/models/paypal-payment-token-usage-type.md) | Required | The usage type associated with the PayPal payment token.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getUsageType(): string | setUsageType(string usageType): void |
|
||||
| `customerType` | [`?string(PaypalPaymentTokenCustomerType)`](../../doc/models/paypal-payment-token-customer-type.md) | Optional | The customer type associated with the PayPal payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.<br>**Default**: `PaypalPaymentTokenCustomerType::CONSUMER`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getCustomerType(): ?string | setCustomerType(?string customerType): void |
|
||||
| `permitMultiplePaymentTokens` | `?bool` | Optional | Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.<br>**Default**: `false` | getPermitMultiplePaymentTokens(): ?bool | setPermitMultiplePaymentTokens(?bool permitMultiplePaymentTokens): void |
|
||||
|
||||
## Example (as JSON)
|
||||
@@ -1,20 +1,20 @@
|
||||
|
||||
# Pay Pal Wallet Vault Response
|
||||
# Paypal Wallet Vault Response
|
||||
|
||||
The details about a saved PayPal Wallet payment source.
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWalletVaultResponse`
|
||||
`PaypalWalletVaultResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `id` | `?string` | Optional | The PayPal-generated ID for the saved payment source.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getId(): ?string | setId(?string id): void |
|
||||
| `status` | [`?string(PayPalWalletVaultStatus)`](../../doc/models/pay-pal-wallet-vault-status.md) | Optional | The vault status.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void |
|
||||
| `status` | [`?string(PaypalWalletVaultStatus)`](../../doc/models/paypal-wallet-vault-status.md) | Optional | The vault status.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related HATEOAS links.<br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getLinks(): ?array | setLinks(?array links): void |
|
||||
| `customer` | [`?PayPalWalletCustomer`](../../doc/models/pay-pal-wallet-customer.md) | Optional | The details about a customer in PayPal's system of record. | getCustomer(): ?PayPalWalletCustomer | setCustomer(?PayPalWalletCustomer customer): void |
|
||||
| `customer` | [`?PaypalWalletCustomer`](../../doc/models/paypal-wallet-customer.md) | Optional | The details about a customer in PayPal's system of record. | getCustomer(): ?PaypalWalletCustomer | setCustomer(?PaypalWalletCustomer customer): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Wallet Vault Status
|
||||
# Paypal Wallet Vault Status
|
||||
|
||||
The vault status.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`PayPalWalletVaultStatus`
|
||||
`PaypalWalletVaultStatus`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Pay Pal Wallet
|
||||
# Paypal Wallet
|
||||
|
||||
A resource that identifies a PayPal Wallet is used for payment.
|
||||
|
||||
## Structure
|
||||
|
||||
`PayPalWallet`
|
||||
`PaypalWallet`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -18,8 +18,8 @@ A resource that identifies a PayPal Wallet is used for payment.
|
||||
| `birthDate` | `?string` | Optional | The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard `date_time` type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.<br>**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `10`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[1-2][0-9]\|3[0-1])$` | getBirthDate(): ?string | setBirthDate(?string birthDate): void |
|
||||
| `taxInfo` | [`?TaxInfo`](../../doc/models/tax-info.md) | Optional | The tax ID of the customer. The customer is also known as the payer. Both `tax_id` and `tax_id_type` are required. | getTaxInfo(): ?TaxInfo | setTaxInfo(?TaxInfo taxInfo): void |
|
||||
| `address` | [`?Address`](../../doc/models/address.md) | Optional | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getAddress(): ?Address | setAddress(?Address address): void |
|
||||
| `attributes` | [`?PayPalWalletAttributes`](../../doc/models/pay-pal-wallet-attributes.md) | Optional | Additional attributes associated with the use of this PayPal Wallet. | getAttributes(): ?PayPalWalletAttributes | setAttributes(?PayPalWalletAttributes attributes): void |
|
||||
| `experienceContext` | [`?PayPalWalletExperienceContext`](../../doc/models/pay-pal-wallet-experience-context.md) | Optional | Customizes the payer experience during the approval process for payment with PayPal.<blockquote><strong>Note:</strong> Partners and Marketplaces might configure <code>brand_name</code> and <code>shipping_preference</code> during partner account setup, which overrides the request values.</blockquote> | getExperienceContext(): ?PayPalWalletExperienceContext | setExperienceContext(?PayPalWalletExperienceContext experienceContext): void |
|
||||
| `attributes` | [`?PaypalWalletAttributes`](../../doc/models/paypal-wallet-attributes.md) | Optional | Additional attributes associated with the use of this PayPal Wallet. | getAttributes(): ?PaypalWalletAttributes | setAttributes(?PaypalWalletAttributes attributes): void |
|
||||
| `experienceContext` | [`?PaypalWalletExperienceContext`](../../doc/models/paypal-wallet-experience-context.md) | Optional | Customizes the payer experience during the approval process for payment with PayPal.<blockquote><strong>Note:</strong> Partners and Marketplaces might configure <code>brand_name</code> and <code>shipping_preference</code> during partner account setup, which overrides the request values.</blockquote> | getExperienceContext(): ?PaypalWalletExperienceContext | setExperienceContext(?PaypalWalletExperienceContext experienceContext): void |
|
||||
| `billingAgreementId` | `?string` | Optional | The PayPal billing agreement ID. References an approved recurring payment for goods or services.<br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `128`, *Pattern*: `^[a-zA-Z0-9-]+$` | getBillingAgreementId(): ?string | setBillingAgreementId(?string billingAgreementId): void |
|
||||
|
||||
## Example (as JSON)
|
||||
@@ -11,8 +11,8 @@ The processor response information for payment requests, such as direct credit c
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `avsCode` | [`?string(AVSCode)`](../../doc/models/avs-code.md) | Optional | The address verification code for Visa, Discover, Mastercard, or American Express transactions. | getAvsCode(): ?string | setAvsCode(?string avsCode): void |
|
||||
| `cvvCode` | [`?string(CVVCode)`](../../doc/models/cvv-code.md) | Optional | The card verification value code for for Visa, Discover, Mastercard, or American Express. | getCvvCode(): ?string | setCvvCode(?string cvvCode): void |
|
||||
| `avsCode` | [`?string(AvsCode)`](../../doc/models/avs-code.md) | Optional | The address verification code for Visa, Discover, Mastercard, or American Express transactions. | getAvsCode(): ?string | setAvsCode(?string avsCode): void |
|
||||
| `cvvCode` | [`?string(CvvCode)`](../../doc/models/cvv-code.md) | Optional | The card verification value code for for Visa, Discover, Mastercard, or American Express. | getCvvCode(): ?string | setCvvCode(?string cvvCode): void |
|
||||
| `responseCode` | [`?string(ProcessorResponseCode)`](../../doc/models/processor-response-code.md) | Optional | Processor response code for the non-PayPal payment processor errors. | getResponseCode(): ?string | setResponseCode(?string responseCode): void |
|
||||
| `paymentAdviceCode` | [`?string(PaymentAdviceCode)`](../../doc/models/payment-advice-code.md) | Optional | The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes. | getPaymentAdviceCode(): ?string | setPaymentAdviceCode(?string paymentAdviceCode): void |
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ The payment method to vault with the instrument details.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?SetupTokenRequestCard`](../../doc/models/setup-token-request-card.md) | Optional | A Resource representing a request to vault a Card. | getCard(): ?SetupTokenRequestCard | setCard(?SetupTokenRequestCard card): void |
|
||||
| `paypal` | [`?VaultPayPalWalletRequest`](../../doc/models/vault-pay-pal-wallet-request.md) | Optional | A resource representing a request to vault PayPal Wallet. | getPaypal(): ?VaultPayPalWalletRequest | setPaypal(?VaultPayPalWalletRequest paypal): void |
|
||||
| `paypal` | [`?VaultPaypalWalletRequest`](../../doc/models/vault-paypal-wallet-request.md) | Optional | A resource representing a request to vault PayPal Wallet. | getPaypal(): ?VaultPaypalWalletRequest | setPaypal(?VaultPaypalWalletRequest paypal): void |
|
||||
| `venmo` | [`?VaultVenmoRequest`](../../doc/models/vault-venmo-request.md) | Optional | - | getVenmo(): ?VaultVenmoRequest | setVenmo(?VaultVenmoRequest venmo): void |
|
||||
| `token` | [`?VaultTokenRequest`](../../doc/models/vault-token-request.md) | Optional | The Tokenized Payment Source representing a Request to Vault a Token. | getToken(): ?VaultTokenRequest | setToken(?VaultTokenRequest token): void |
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ The setup payment method details.
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?SetupTokenResponseCard`](../../doc/models/setup-token-response-card.md) | Optional | - | getCard(): ?SetupTokenResponseCard | setCard(?SetupTokenResponseCard card): void |
|
||||
| `paypal` | [`?PayPalPaymentToken`](../../doc/models/pay-pal-payment-token.md) | Optional | - | getPaypal(): ?PayPalPaymentToken | setPaypal(?PayPalPaymentToken paypal): void |
|
||||
| `paypal` | [`?PaypalPaymentToken`](../../doc/models/paypal-payment-token.md) | Optional | - | getPaypal(): ?PaypalPaymentToken | setPaypal(?PaypalPaymentToken paypal): void |
|
||||
| `venmo` | [`?VenmoPaymentToken`](../../doc/models/venmo-payment-token.md) | Optional | - | getVenmo(): ?VenmoPaymentToken | setVenmo(?VenmoPaymentToken venmo): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -11,7 +11,7 @@ Results of 3D Secure Authentication.
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `authenticationStatus` | [`?string(PAResStatus)`](../../doc/models/pa-res-status.md) | Optional | Transactions status result identifier. The outcome of the issuer's authentication.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getAuthenticationStatus(): ?string | setAuthenticationStatus(?string authenticationStatus): void |
|
||||
| `authenticationStatus` | [`?string(PaResStatus)`](../../doc/models/pa-res-status.md) | Optional | Transactions status result identifier. The outcome of the issuer's authentication.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getAuthenticationStatus(): ?string | setAuthenticationStatus(?string authenticationStatus): void |
|
||||
| `enrollmentStatus` | [`?string(EnrollmentStatus)`](../../doc/models/enrollment-status.md) | Optional | Status of Authentication eligibility.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getEnrollmentStatus(): ?string | setEnrollmentStatus(?string enrollmentStatus): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -11,7 +11,7 @@ The Universal Product Code of the item.
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `type` | [`string(UPCType)`](../../doc/models/upc-type.md) | Required | The Universal Product Code type.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `5`, *Pattern*: `^[0-9A-Z_-]+$` | getType(): string | setType(string type): void |
|
||||
| `type` | [`string(UpcType)`](../../doc/models/upc-type.md) | Required | The Universal Product Code type.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `5`, *Pattern*: `^[0-9A-Z_-]+$` | getType(): string | setType(string type): void |
|
||||
| `code` | `string` | Required | The UPC product code of the item.<br>**Constraints**: *Minimum Length*: `6`, *Maximum Length*: `17`, *Pattern*: `^[0-9]{0,17}$` | getCode(): string | setCode(string code): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# UPC Type
|
||||
# Upc Type
|
||||
|
||||
The Universal Product Code type.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`UPCType`
|
||||
`UpcType`
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
|
||||
# Vault Pay Pal Wallet Request
|
||||
# Vault Paypal Wallet Request
|
||||
|
||||
A resource representing a request to vault PayPal Wallet.
|
||||
|
||||
## Structure
|
||||
|
||||
`VaultPayPalWalletRequest`
|
||||
`VaultPaypalWalletRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
@@ -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,13 +16,126 @@ 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:
|
||||
@@ -43,9 +156,9 @@ class OrdersController extends BaseController
|
||||
->parameters(
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
BodyParam::init($options)->extract('body'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('PayPal-Partner-Attribution-Id', $options)->extract('payPalPartnerAttributionId'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('PayPal-Partner-Attribution-Id', $options)->extract('paypalPartnerAttributionId'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal')
|
||||
);
|
||||
|
||||
@@ -80,41 +193,6 @@ class OrdersController extends BaseController
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Shows details for an order, by ID.<blockquote><strong>Note:</strong> For error handling and
|
||||
* troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#get-
|
||||
* order">Orders v2 errors</a>.</blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersGet(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/checkout/orders/{id}')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
QueryParam::init('fields', $options)->extract('fields')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(Order::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the
|
||||
* `COMPLETED` status.<br/><br/>To make an update, you must provide a `reference_id`. If you omit this
|
||||
@@ -201,122 +279,6 @@ class OrdersController extends BaseController
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Payer confirms their intent to pay for the the Order with the given payment source.
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersConfirm(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(
|
||||
RequestMethod::POST,
|
||||
'/v2/checkout/orders/{id}/confirm-payment-source'
|
||||
)
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The requested action could not be performed, semantically incorrect, or fa' .
|
||||
'iled business validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(Order::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Authorizes payment for an order. To successfully authorize payment for an order, the buyer must
|
||||
* first approve the order or a valid payment_source must be provided in the request. A buyer can
|
||||
* approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS
|
||||
* links in the create order response.<blockquote><strong>Note:</strong> For error handling and
|
||||
* troubleshooting, see <a href="https://developer.paypal.
|
||||
* com/api/rest/reference/orders/v2/errors/#authorize-order">Orders v2 errors</a>.</blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersAuthorize(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/authorize')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init(
|
||||
'The authorized payment failed due to insufficient permissions.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The requested action could not be performed, semantically incorrect, or fa' .
|
||||
'iled business validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(OrderAuthorizeResponse::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Captures payment for an order. To successfully capture payment for an order, the buyer must first
|
||||
* approve the order or a valid payment_source must be provided in the request. A buyer can approve the
|
||||
@@ -336,10 +298,10 @@ class OrdersController extends BaseController
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'),
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
@@ -384,21 +346,60 @@ class OrdersController extends BaseController
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds tracking information for an Order.
|
||||
* Shows details for an order, by ID.<blockquote><strong>Note:</strong> For error handling and
|
||||
* troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#get-
|
||||
* order">Orders v2 errors</a>.</blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersTrackCreate(array $options): ApiResponse
|
||||
public function ordersGet(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/track')
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/checkout/orders/{id}')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
QueryParam::init('fields', $options)->extract('fields')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(Order::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Payer confirms their intent to pay for the the Order with the given payment source.
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function ordersConfirm(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(
|
||||
RequestMethod::POST,
|
||||
'/v2/checkout/orders/{id}/confirm-payment-source'
|
||||
)
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('id', $options)->extract('id'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
BodyParam::init($options)->extract('body'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion')
|
||||
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
@@ -413,7 +414,6 @@ class OrdersController extends BaseController
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
|
||||
@@ -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,82 +136,6 @@ class PaymentsController extends BaseController
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available,
|
||||
* reauthorize a payment after its initial three-day honor period expires. Within the 29-day
|
||||
* authorization period, you can issue multiple re-authorizations after the honor period expires.
|
||||
* <br/><br/>If 30 days have transpired since the date of the original authorization, you must create
|
||||
* an authorized payment instead of reauthorizing the original authorized payment.<br/><br/>A
|
||||
* reauthorized payment itself has a new honor period of three days.<br/><br/>You can reauthorize an
|
||||
* authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on
|
||||
* context and geography, for example in US it is up to 115% of the original authorized amount, not to
|
||||
* exceed an increase of $75 USD.<br/><br/>Supports only the `amount` request parameter.
|
||||
* <blockquote><strong>Note:</strong> This request is currently not supported for Partner use cases.
|
||||
* </blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function authorizationsReauthorize(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(
|
||||
RequestMethod::POST,
|
||||
'/v2/payments/authorizations/{authorization_id}/reauthorize'
|
||||
)
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'The request failed because it is not well-formed or is syntactically incor' .
|
||||
'rect or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init(
|
||||
'The request failed because the caller has insufficient permissions.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'404',
|
||||
ErrorType::init('The request failed because the resource does not exist.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The request failed because it either is semantically incorrect or failed b' .
|
||||
'usiness validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('The request failed because an internal server error occurred.'))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(PaymentAuthorization::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been
|
||||
* fully captured.
|
||||
@@ -229,7 +153,7 @@ class PaymentsController extends BaseController
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal')
|
||||
);
|
||||
|
||||
@@ -285,6 +209,82 @@ class PaymentsController extends BaseController
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available,
|
||||
* reauthorize a payment after its initial three-day honor period expires. Within the 29-day
|
||||
* authorization period, you can issue multiple re-authorizations after the honor period expires.
|
||||
* <br/><br/>If 30 days have transpired since the date of the original authorization, you must create
|
||||
* an authorized payment instead of reauthorizing the original authorized payment.<br/><br/>A
|
||||
* reauthorized payment itself has a new honor period of three days.<br/><br/>You can reauthorize an
|
||||
* authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on
|
||||
* context and geography, for example in US it is up to 115% of the original authorized amount, not to
|
||||
* exceed an increase of $75 USD.<br/><br/>Supports only the `amount` request parameter.
|
||||
* <blockquote><strong>Note:</strong> This request is currently not supported for Partner use cases.
|
||||
* </blockquote>
|
||||
*
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function authorizationsReauthorize(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(
|
||||
RequestMethod::POST,
|
||||
'/v2/payments/authorizations/{authorization_id}/reauthorize'
|
||||
)
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'The request failed because it is not well-formed or is syntactically incor' .
|
||||
'rect or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'401',
|
||||
ErrorType::init(
|
||||
'Authentication failed due to missing authorization header, or invalid auth' .
|
||||
'entication credentials.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init(
|
||||
'The request failed because the caller has insufficient permissions.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'404',
|
||||
ErrorType::init('The request failed because the resource does not exist.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The request failed because it either is semantically incorrect or failed b' .
|
||||
'usiness validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('The request failed because an internal server error occurred.'))
|
||||
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
||||
->type(PaymentAuthorization::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Shows details for a captured payment, by ID.
|
||||
*
|
||||
@@ -342,9 +342,9 @@ class PaymentsController extends BaseController
|
||||
->parameters(
|
||||
TemplateParam::init('capture_id', $options)->extract('captureId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'),
|
||||
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
|
||||
@@ -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,66 +16,14 @@ 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.
|
||||
*
|
||||
@@ -148,17 +96,22 @@ class VaultController extends BaseController
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the payment token associated with the payment token id.
|
||||
* Creates a Payment Token from the given payment source and adds it to the Vault of the associated
|
||||
* customer.
|
||||
*
|
||||
* @param string $id ID of the payment token.
|
||||
* @param array $options Array with all options for search
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function paymentTokensDelete(string $id): ApiResponse
|
||||
public function paymentTokensCreate(array $options): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v3/vault/payment-tokens/{id}')
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/payment-tokens')
|
||||
->auth('Oauth2')
|
||||
->parameters(TemplateParam::init('id', $id));
|
||||
->parameters(
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
@@ -172,7 +125,23 @@ class VaultController extends BaseController
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'404',
|
||||
ErrorType::init(
|
||||
'Request contains reference to resources that do not exist.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'422',
|
||||
ErrorType::init(
|
||||
'The requested action could not be performed, semantically incorrect, or fa' .
|
||||
'iled business validation.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->type(PaymentTokenResponse::class)
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
@@ -191,7 +160,7 @@ class VaultController extends BaseController
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/setup-tokens')
|
||||
->auth('Oauth2')
|
||||
->parameters(
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
|
||||
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
||||
HeaderParam::init('Content-Type', 'application/json'),
|
||||
BodyParam::init($options)->extract('body')
|
||||
);
|
||||
@@ -223,6 +192,37 @@ class VaultController extends BaseController
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the payment token associated with the payment token id.
|
||||
*
|
||||
* @param string $id ID of the payment token.
|
||||
*
|
||||
* @return ApiResponse Response from the API call
|
||||
*/
|
||||
public function paymentTokensDelete(string $id): ApiResponse
|
||||
{
|
||||
$_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v3/vault/payment-tokens/{id}')
|
||||
->auth('Oauth2')
|
||||
->parameters(TemplateParam::init('id', $id));
|
||||
|
||||
$_resHandler = $this->responseHandler()
|
||||
->throwErrorOn(
|
||||
'400',
|
||||
ErrorType::init(
|
||||
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
||||
ErrorException::class
|
||||
)
|
||||
)
|
||||
->throwErrorOn(
|
||||
'403',
|
||||
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
||||
)
|
||||
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
||||
->returnApiResponse();
|
||||
|
||||
return $this->execute($_reqBuilder, $_resHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a readable representation of temporarily vaulted payment source associated with the setup
|
||||
* token id.
|
||||
|
||||
@@ -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 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;
|
||||
|
||||
@@ -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;
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user