1
0

7 Commits

Author SHA1 Message Date
moizgillani
f465f0920c Rename PaypalServerSdkClientBuilder.php to PaypalServerSDKClientBuilder.php 2024-09-16 15:04:20 +05:00
moizgillani
7d36472b6e Rename PaypalServerSdkClient.php to PaypalServerSDKClient.php 2024-09-16 15:03:53 +05:00
moizgillani
1522ab5293 client name updated 2024-09-16 15:00:03 +05:00
moizgillani
eb2608f55a Merge branch 'main' into initialize 2024-09-16 14:49:52 +05:00
moizgillani
b8521e83cc Merge branch 'main' into initialize 2024-09-10 15:07:21 +05:00
moizgillani
f423f69aee sdk files removed 2024-09-10 15:06:47 +05:00
moizgillani
b20aa829db repo initialized with test cases 2024-09-06 15:38:17 +05:00
569 changed files with 5567 additions and 3624 deletions

10
.codegenignore Normal file
View File

@@ -0,0 +1,10 @@
tests/E2E/**
tests/UnitTests/**
tests/ClientFactory.php
tests/WebDriverUtilities.php
tests/bootstrap.php
tests/Controllers/BaseTestController.php
.gitignore
.github/**
phpunit.xml
selenium.jar

46
.github/workflows/test-runner.yml vendored Normal file
View File

@@ -0,0 +1,46 @@
name: Tests
on:
workflow_dispatch:
jobs:
test:
name: Running all tests
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.2'
- name: Install dependencies
run: |
composer install
composer require php-webdriver/webdriver --dev
composer require phpunit/phpunit --dev
- name: Run Lint Tests
run: composer lint
- name: Run Analyzer Tests
run: composer analyze
- name: Set up Java 11
uses: actions/setup-java@v3
with:
java-version: '11'
distribution: 'temurin'
- name: Run Selenium Server
run: java -jar selenium.jar standalone &
- name: Run tests
run: ./vendor/bin/phpunit --testdox
env:
CLIENT_ID: ${{ secrets.CLIENT_ID }}
CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
EMAIL: ${{ secrets.EMAIL }}
PASSWORD: ${{ secrets.PASSWORD }}

View File

@@ -1,8 +1,8 @@
The PayPal Server SDK is released under the following license: The PayPal Server SDK is released under the following license:
Copyright (c) 2024 PAYPAL, INC. Copyright (c) 2024 PAYPAL, INC.
SDK LICENSE SDK LICENSE
NOTICE TO USER: PayPal, Inc. is providing the Software and Documentation for use under the terms of this Agreement. Any use, reproduction, modification or distribution of the Software or Documentation, or any derivatives or portions hereof, constitutes your acceptance of this Agreement. NOTICE TO USER: PayPal, Inc. is providing the Software and Documentation for use under the terms of this Agreement. Any use, reproduction, modification or distribution of the Software or Documentation, or any derivatives or portions hereof, constitutes your acceptance of this Agreement.
As used in this Agreement, "PayPal" means PayPal, Inc. "Software" means the software code accompanying this agreement. "Documentation" means the documents, specifications and all other items accompanying this Agreement other than the Software. As used in this Agreement, "PayPal" means PayPal, Inc. "Software" means the software code accompanying this agreement. "Documentation" means the documents, specifications and all other items accompanying this Agreement other than the Software.

View File

@@ -1,24 +1,9 @@
# Getting Started with PayPal Server SDK # Getting Started with Paypal Server SDK
## Introduction ## Introduction
### ⚠️ Beta Release Notice An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders., Call the Payments API to authorize payments, capture authorized payments, refund payments that have already been captured, and show payment information. Use the Payments API in conjunction with the <a href="/docs/api/orders/v2/">Orders API</a>. For more information, see the <a href="/docs/checkout/">PayPal Checkout Overview</a>., The Payment Method Tokens API saves payment methods so payers don't have to enter details for future transactions. Payers can check out faster or pay without being present after they agree to save a payment method.<br><br>The API associates a payment method with a temporary setup token. Pass the setup token to the API to exchange the setup token for a permanent token.<br><br>The permanent token represents a payment method that's saved to the vault. This token can be used repeatedly for checkout or recurring transactions such as subscriptions.<br><br>The Payment Method Tokens API is available in the US only.
This version is considered a **beta release**. While we have done our best to ensure stability and functionality, there may still be bugs, incomplete features, or breaking changes in future updates.
#### Important Notes
- **Available Features:** This SDK currently contains only 3 of PayPal's API endpoints. Additional endpoints and functionality will be added in the future.
- **API Changes:** Expect potential changes in APIs and features as we finalize the product.
### Information
The PayPal Server SDK provides integration access to the PayPal REST APIs. The API endpoints are divided into distinct controllers:
- Orders Controller: <a href="https://developer.paypal.com/docs/api/orders/v2/">Orders API v2</a>
- Payments Controller: <a href="https://developer.paypal.com/docs/api/payments/v2/">Payments API v2</a>
- Vault Controller: <a href="https://developer.paypal.com/docs/api/payment-tokens/v3/">Payment Method Tokens API v3</a> *Available in the US only.*
Find out more here: [https://developer.paypal.com/docs/api/orders/v2/](https://developer.paypal.com/docs/api/orders/v2/) Find out more here: [https://developer.paypal.com/docs/api/orders/v2/](https://developer.paypal.com/docs/api/orders/v2/)
@@ -27,23 +12,23 @@ Find out more here: [https://developer.paypal.com/docs/api/orders/v2/](https://d
Run the following command to install the package and automatically add the dependency to your composer.json file: Run the following command to install the package and automatically add the dependency to your composer.json file:
```php ```php
composer require "paypal/paypal-server-sdk:0.6.1" composer require "paypal/paypal-server-sdk:0.5.1"
``` ```
Or add it to the composer.json file manually as given below: Or add it to the composer.json file manually as given below:
```php ```php
"require": { "require": {
"paypal/paypal-server-sdk": "0.6.1" "paypal/paypal-server-sdk": "0.5.1"
} }
``` ```
You can also view the package at: You can also view the package at:
https://packagist.org/packages/paypal/paypal-server-sdk#0.6.1 https://packagist.org/packages/paypal/paypal-server-sdk#0.5.1
## Initialize the API Client ## Initialize the API Client
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/client.md) **_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/client.md)
The following parameters are configurable for the API Client: The following parameters are configurable for the API Client:
@@ -59,13 +44,13 @@ The following parameters are configurable for the API Client:
| `retryOnTimeout` | `bool` | Whether to retry on request timeout.<br>*Default*: `true` | | `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` | | `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'` | | `httpMethodsToRetry` | `array` | Http methods to retry against.<br>*Default*: `'GET', 'PUT'` |
| `loggingConfiguration` | [`LoggingConfigurationBuilder`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/logging-configuration-builder.md) | Represents the logging configurations for API calls | | `loggingConfiguration` | [`LoggingConfigurationBuilder`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/logging-configuration-builder.md) | Represents the logging configurations for API calls |
| `clientCredentialsAuth` | [`ClientCredentialsAuth`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/auth/oauth-2-client-credentials-grant.md) | The Credentials Setter for OAuth 2 Client Credentials Grant | | `clientCredentialsAuth` | [`ClientCredentialsAuth`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/auth/oauth-2-client-credentials-grant.md) | The Credentials Setter for OAuth 2 Client Credentials Grant |
The API client can be initialized as follows: The API client can be initialized as follows:
```php ```php
$client = PaypalServerSdkClientBuilder::init() $client = PaypalServerSDKClientBuilder::init()
->clientCredentialsAuthCredentials( ->clientCredentialsAuthCredentials(
ClientCredentialsAuthCredentialsBuilder::init( ClientCredentialsAuthCredentialsBuilder::init(
'OAuthClientId', 'OAuthClientId',
@@ -105,20 +90,20 @@ The SDK can be configured to use a different environment for making API calls. A
This API uses the following authentication schemes. This API uses the following authentication schemes.
* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/auth/oauth-2-client-credentials-grant.md) * [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/auth/oauth-2-client-credentials-grant.md)
## List of APIs ## List of APIs
* [Orders](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/controllers/orders.md) * [Orders](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/controllers/orders.md)
* [Payments](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/controllers/payments.md) * [Payments](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/controllers/payments.md)
* [Vault](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/controllers/vault.md) * [Vault](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/controllers/vault.md)
## Classes Documentation ## Classes Documentation
* [ApiException](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/api-exception.md) * [ApiException](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/api-exception.md)
* [HttpRequest](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/http-request.md) * [HttpRequest](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/http-request.md)
* [HttpResponse](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/http-response.md) * [HttpResponse](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/http-response.md)
* [LoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/logging-configuration-builder.md) * [LoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/logging-configuration-builder.md)
* [RequestLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/request-logging-configuration-builder.md) * [RequestLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/request-logging-configuration-builder.md)
* [ResponseLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.6.1/doc/response-logging-configuration-builder.md) * [ResponseLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/response-logging-configuration-builder.md)

View File

@@ -22,12 +22,12 @@
}, },
"autoload": { "autoload": {
"psr-4": { "psr-4": {
"PaypalServerSdkLib\\": "src/" "PaypalServerSDKLib\\": "src/"
} }
}, },
"autoload-dev": { "autoload-dev": {
"psr-4": { "psr-4": {
"PaypalServerSdkLib\\Tests\\": "tests/" "PaypalServerSDKLib\\Tests\\": "tests/"
} }
}, },
"scripts": { "scripts": {

View File

@@ -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. 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 ```php
$client = PaypalServerSdkClientBuilder::init() $client = PaypalServerSDKClientBuilder::init()
->clientCredentialsAuthCredentials( ->clientCredentialsAuthCredentials(
ClientCredentialsAuthCredentialsBuilder::init( ClientCredentialsAuthCredentialsBuilder::init(
'OAuthClientId', '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. 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 ```php
$client = PaypalServerSdkClientBuilder::init() $client = PaypalServerSDKClientBuilder::init()
->clientCredentialsAuthCredentials( ->clientCredentialsAuthCredentials(
ClientCredentialsAuthCredentialsBuilder::init( ClientCredentialsAuthCredentialsBuilder::init(
'OAuthClientId', '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: 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 ```php
$client = PaypalServerSdkClientBuilder::init() $client = PaypalServerSDKClientBuilder::init()
->clientCredentialsAuthCredentials( ->clientCredentialsAuthCredentials(
ClientCredentialsAuthCredentialsBuilder::init( ClientCredentialsAuthCredentialsBuilder::init(
'OAuthClientId', 'OAuthClientId',

View File

@@ -21,7 +21,7 @@ The following parameters are configurable for the API Client:
The API client can be initialized as follows: The API client can be initialized as follows:
```php ```php
$client = PaypalServerSdkClientBuilder::init() $client = PaypalServerSDKClientBuilder::init()
->clientCredentialsAuthCredentials( ->clientCredentialsAuthCredentials(
ClientCredentialsAuthCredentialsBuilder::init( ClientCredentialsAuthCredentialsBuilder::init(
'OAuthClientId', '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 | | `getHeaders` | Headers of the HTTP response as a Hash |
| `getResult` | The deserialized body of the HTTP response as a String | | `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. The gateway for the SDK. This class acts as a factory for the Controllers and also holds the configuration of the SDK.

View File

@@ -35,15 +35,14 @@ function ordersCreate(array $options): ApiResponse
| Parameter | Type | Tags | Description | | Parameter | Type | Tags | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `body` | [`OrderRequest`](../../doc/models/order-request.md) | Body, Required | - | | `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. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` | | `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` | | `payPalPartnerAttributionId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
| `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=,-]*$` | | `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=,-]*$` |
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
## Response Type ## 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 ## Example Usage
@@ -89,12 +88,11 @@ function ordersGet(array $options): ApiResponse
| Parameter | Type | Tags | Description | | 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]+$` | | `id` | `string` | Template, Required | The ID of the order for which to show details.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
| `fields` | `?string` | Query, Optional | A comma-separated list of fields that should be returned for the order. Valid filter field is `payment_source`.<br>**Constraints**: *Pattern*: `^[a-z_]*$` | | `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 ## 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 ## Example Usage
@@ -128,12 +126,11 @@ function ordersPatch(array $options): ApiResponse
| Parameter | Type | Tags | Description | | Parameter | Type | Tags | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `id` | `string` | Template, Required | The ID of the order to update.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` | | `id` | `string` | Template, Required | The ID of the order to update.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
| `body` | [`?(Patch[])`](../../doc/models/patch.md) | Body, Optional | - | | `body` | [`?(Patch[])`](../../doc/models/patch.md) | Body, Optional | - |
## Response Type ## Response Type
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance.
## Example Usage ## Example Usage
@@ -174,21 +171,25 @@ function ordersConfirm(array $options): ApiResponse
| Parameter | Type | Tags | Description | | 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]+$` | | `id` | `string` | Template, Required | The ID of the order for which the payer confirms their intent to pay.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
| `paypalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | | `payPalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=]*$` | | `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 | - | | `body` | [`?ConfirmOrderRequest`](../../doc/models/confirm-order-request.md) | Body, Optional | - |
## Response Type ## 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 ## Example Usage
```php ```php
$collect = [ $collect = [
'id' => 'id0', 'id' => 'id0',
'prefer' => 'return=minimal' 'prefer' => 'return=minimal',
'body' => ConfirmOrderRequestBuilder::init(
PaymentSourceBuilder::init()->build()
)
->processingInstruction(ProcessingInstruction::NO_INSTRUCTION)
->build()
]; ];
$apiResponse = $ordersController->ordersConfirm($collect); $apiResponse = $ordersController->ordersConfirm($collect);
@@ -218,15 +219,15 @@ function ordersAuthorize(array $options): ApiResponse
| Parameter | Type | Tags | Description | | 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]+$` | | `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. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` | | `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=,-]*$` | | `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` | | `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>. | | `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 | - | | `body` | [`?OrderAuthorizeRequest`](../../doc/models/order-authorize-request.md) | Body, Optional | - |
## Response Type ## 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). 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 ## Example Usage
@@ -265,15 +266,15 @@ function ordersCapture(array $options): ApiResponse
| Parameter | Type | Tags | Description | | 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]+$` | | `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. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` | | `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=,-]*$` | | `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` | | `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>. | | `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 | - | | `body` | [`?OrderCaptureRequest`](../../doc/models/order-capture-request.md) | Body, Optional | - |
## Response Type ## 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 ## Example Usage
@@ -313,11 +314,11 @@ function ordersTrackCreate(array $options): ApiResponse
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `id` | `string` | Template, Required | The ID of the order that the tracking information is associated with.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` | | `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 | - | | `body` | [`OrderTrackerRequest`](../../doc/models/order-tracker-request.md) | Body, Required | - |
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. | | `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
## Response Type ## 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 ## Example Usage
@@ -360,12 +361,11 @@ function ordersTrackersPatch(array $options): ApiResponse
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `id` | `string` | Template, Required | The ID of the order that the tracking information is associated with.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` | | `id` | `string` | Template, Required | The ID of the order that the tracking information is associated with.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
| `trackerId` | `string` | Template, Required | The order tracking ID.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` | | `trackerId` | `string` | Template, Required | The order tracking ID.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
| `body` | [`?(Patch[])`](../../doc/models/patch.md) | Body, Optional | - | | `body` | [`?(Patch[])`](../../doc/models/patch.md) | Body, Optional | - |
## Response Type ## Response Type
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance.
## Example Usage ## Example Usage

View File

@@ -26,7 +26,7 @@ $paymentsController = $client->getPaymentsController();
Shows details for an authorized payment, by ID. Shows details for an authorized payment, by ID.
```php ```php
function authorizationsGet(array $options): ApiResponse function authorizationsGet(string $authorizationId): ApiResponse
``` ```
## Parameters ## Parameters
@@ -34,20 +34,17 @@ function authorizationsGet(array $options): ApiResponse
| Parameter | Type | Tags | Description | | Parameter | Type | Tags | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `authorizationId` | `string` | Template, Required | The ID of the authorized payment for which to show details. | | `authorizationId` | `string` | Template, Required | The ID of the authorized payment for which to show details. |
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion).<blockquote><strong>Note:</strong>For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.</blockquote> |
## Response Type ## 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 ## Example Usage
```php ```php
$collect = [ $authorizationId = 'authorization_id8';
'authorizationId' => 'authorization_id8'
];
$apiResponse = $paymentsController->authorizationsGet($collect); $apiResponse = $paymentsController->authorizationsGet($authorizationId);
``` ```
## Errors ## Errors
@@ -55,6 +52,7 @@ $apiResponse = $paymentsController->authorizationsGet($collect);
| HTTP Status Code | Error Description | Exception Class | | 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) | | 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) | | 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
| 500 | The request failed because an internal server error occurred. | `ApiException` | | 500 | The request failed because an internal server error occurred. | `ApiException` |
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) | | Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
@@ -73,14 +71,13 @@ function authorizationsCapture(array $options): ApiResponse
| Parameter | Type | Tags | Description | | Parameter | Type | Tags | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to capture. | | `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'` | | `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion).<blockquote><strong>Note:</strong>For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.</blockquote> |
| `body` | [`?CaptureRequest`](../../doc/models/capture-request.md) | Body, Optional | - | | `body` | [`?CaptureRequest`](../../doc/models/capture-request.md) | Body, Optional | - |
## Response Type ## 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 ## Example Usage
@@ -123,14 +120,13 @@ function authorizationsReauthorize(array $options): ApiResponse
| Parameter | Type | Tags | Description | | Parameter | Type | Tags | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to reauthorize. | | `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to reauthorize. |
| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. | | `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` | | `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion).<blockquote><strong>Note:</strong>For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.</blockquote> |
| `body` | [`?ReauthorizeRequest`](../../doc/models/reauthorize-request.md) | Body, Optional | - | | `body` | [`?ReauthorizeRequest`](../../doc/models/reauthorize-request.md) | Body, Optional | - |
## Response Type ## 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 ## Example Usage
@@ -149,6 +145,7 @@ $apiResponse = $paymentsController->authorizationsReauthorize($collect);
| --- | --- | --- | | --- | --- | --- |
| 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) | | 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) | | 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) | | 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) | | 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` | | 500 | The request failed because an internal server error occurred. | `ApiException` |
@@ -168,13 +165,12 @@ function authorizationsVoid(array $options): ApiResponse
| Parameter | Type | Tags | Description | | Parameter | Type | Tags | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to void. | | `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to void. |
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion).<blockquote><strong>Note:</strong>For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.</blockquote> | | `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion).<blockquote><strong>Note:</strong>For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.</blockquote> |
| `paypalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` | | `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 ## 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 ## Example Usage
@@ -191,6 +187,7 @@ $apiResponse = $paymentsController->authorizationsVoid($collect);
| HTTP Status Code | Error Description | Exception Class | | 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) | | 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) | | 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) | | 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
@@ -216,7 +213,7 @@ function capturesGet(string $captureId): ApiResponse
## Response Type ## 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 ## Example Usage
@@ -250,14 +247,14 @@ function capturesRefund(array $options): ApiResponse
| Parameter | Type | Tags | Description | | Parameter | Type | Tags | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `captureId` | `string` | Template, Required | The PayPal-generated ID for the captured payment to refund. | | `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'` | | `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 | - | | `body` | [`?RefundRequest`](../../doc/models/refund-request.md) | Body, Optional | - |
## Response Type ## 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 ## Example Usage
@@ -289,7 +286,7 @@ $apiResponse = $paymentsController->capturesRefund($collect);
Shows details for a refund, by ID. Shows details for a refund, by ID.
```php ```php
function refundsGet(array $options): ApiResponse function refundsGet(string $refundId): ApiResponse
``` ```
## Parameters ## Parameters
@@ -297,20 +294,17 @@ function refundsGet(array $options): ApiResponse
| Parameter | Type | Tags | Description | | Parameter | Type | Tags | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `refundId` | `string` | Template, Required | The PayPal-generated ID for the refund for which to show details. | | `refundId` | `string` | Template, Required | The PayPal-generated ID for the refund for which to show details. |
| `paypalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion).<blockquote><strong>Note:</strong>For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.</blockquote> |
## Response Type ## 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 ## Example Usage
```php ```php
$collect = [ $refundId = 'refund_id4';
'refundId' => 'refund_id4'
];
$apiResponse = $paymentsController->refundsGet($collect); $apiResponse = $paymentsController->refundsGet($refundId);
``` ```
## Errors ## Errors

View File

@@ -32,18 +32,18 @@ function paymentTokensCreate(array $options): ApiResponse
| Parameter | Type | Tags | Description | | Parameter | Type | Tags | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `paypalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. | | `payPalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
| `body` | [`PaymentTokenRequest`](../../doc/models/payment-token-request.md) | Body, Required | Payment Token creation with a financial instrument and an optional customer_id. | | `body` | [`PaymentTokenRequest`](../../doc/models/payment-token-request.md) | Body, Required | Payment Token creation with a financial instrument and an optional customer_id. |
## Response Type ## 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 ## Example Usage
```php ```php
$collect = [ $collect = [
'paypalRequestId' => 'PayPal-Request-Id6', 'payPalRequestId' => 'PayPal-Request-Id6',
'body' => PaymentTokenRequestBuilder::init( 'body' => PaymentTokenRequestBuilder::init(
PaymentTokenRequestPaymentSourceBuilder::init()->build() PaymentTokenRequestPaymentSourceBuilder::init()->build()
)->build() )->build()
@@ -82,7 +82,7 @@ function customerPaymentTokensGet(array $options): ApiResponse
## Response Type ## 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 ## Example Usage
@@ -122,7 +122,7 @@ function paymentTokensGet(string $id): ApiResponse
## Response Type ## 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 ## Example Usage
@@ -158,7 +158,7 @@ function paymentTokensDelete(string $id): ApiResponse
## Response Type ## Response Type
This method returns a `PaypalServerSdkLib\Utils\ApiResponse` instance. This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance.
## Example Usage ## Example Usage
@@ -189,18 +189,18 @@ function setupTokensCreate(array $options): ApiResponse
| Parameter | Type | Tags | Description | | Parameter | Type | Tags | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `paypalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. | | `payPalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
| `body` | [`SetupTokenRequest`](../../doc/models/setup-token-request.md) | Body, Required | Setup Token creation with a instrument type optional financial instrument details and customer_id. | | `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 ## 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 ## Example Usage
```php ```php
$collect = [ $collect = [
'paypalRequestId' => 'PayPal-Request-Id6', 'payPalRequestId' => 'PayPal-Request-Id6',
'body' => SetupTokenRequestBuilder::init( 'body' => SetupTokenRequestBuilder::init(
SetupTokenRequestPaymentSourceBuilder::init()->build() SetupTokenRequestPaymentSourceBuilder::init()->build()
)->build() )->build()
@@ -235,7 +235,7 @@ function setupTokensGet(string $id): ApiResponse
## Response Type ## 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 ## Example Usage

View File

@@ -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. 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
<?php <?php
use PaypalServerSdkLib\PaypalServerSdkClientBuilder; use PaypalServerSDKLib\PaypalServerSDKClientBuilder;
use PaypalServerSdkLib\Logging\LoggingConfigurationBuilder; use PaypalServerSDKLib\Logging\LoggingConfigurationBuilder;
use PaypalServerSdkLib\Logging\RequestLoggingConfigurationBuilder; use PaypalServerSDKLib\Logging\RequestLoggingConfigurationBuilder;
use PaypalServerSdkLib\Logging\ResponseLoggingConfigurationBuilder; use PaypalServerSDKLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel; use Psr\Log\LogLevel;
use Monolog\Logger; use Monolog\Logger;
use Monolog\Handler\StreamHandler; use Monolog\Handler\StreamHandler;
// create a log channel // create a log channel
$logger = new Logger('PaypalServerSdk'); $logger = new Logger('PaypalServerSDK');
$logger->pushHandler(new StreamHandler(__DIR__ . '/api_data.log')); $logger->pushHandler(new StreamHandler(__DIR__ . '/api_data.log'));
// initialize the sdk client using this logger // initialize the sdk client using this logger
$client = PaypalServerSdkClientBuilder::init() $client = PaypalServerSDKClientBuilder::init()
->loggingConfiguration( ->loggingConfiguration(
LoggingConfigurationBuilder::init() LoggingConfigurationBuilder::init()
->logger($logger) ->logger($logger)

View File

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

View File

@@ -1,11 +1,11 @@
# Blik Experience Context # BLIK Experience Context
Customizes the payer experience during the approval process for the BLIK payment. Customizes the payer experience during the approval process for the BLIK payment.
## Structure ## Structure
`BlikExperienceContext` `BLIKExperienceContext`
## Fields ## Fields

View File

@@ -1,11 +1,11 @@
# Blik Level 0 Payment Object # BLIK Level 0 Payment Object
Information used to pay using BLIK level_0 flow. Information used to pay using BLIK level_0 flow.
## Structure ## Structure
`BlikLevel0PaymentObject` `BLIKLevel0PaymentObject`
## Fields ## Fields

View File

@@ -1,11 +1,11 @@
# Blik One Click Payment Object # BLIK One Click Payment Object
Information used to pay using BLIK one-click flow. Information used to pay using BLIK one-click flow.
## Structure ## Structure
`BlikOneClickPaymentObject` `BLIKOneClickPaymentObject`
## Fields ## Fields

View File

@@ -1,11 +1,11 @@
# Blik One Click Payment Request # BLIK One Click Payment Request
Information used to pay using BLIK one-click flow. Information used to pay using BLIK one-click flow.
## Structure ## Structure
`BlikOneClickPaymentRequest` `BLIKOneClickPaymentRequest`
## Fields ## Fields

View File

@@ -1,11 +1,11 @@
# Blik Payment Object # BLIK Payment Object
Information used to pay using BLIK. Information used to pay using BLIK.
## Structure ## Structure
`BlikPaymentObject` `BLIKPaymentObject`
## Fields ## 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 | | `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 | | `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 | | `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) ## Example (as JSON)

View File

@@ -1,11 +1,11 @@
# Blik Payment Request # BLIK Payment Request
Information needed to pay using BLIK. Information needed to pay using BLIK.
## Structure ## Structure
`BlikPaymentRequest` `BLIKPaymentRequest`
## Fields ## 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 | | `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 | | `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 | | `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 | | `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 | | `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 | | `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) ## Example (as JSON)

View File

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

View File

@@ -11,8 +11,8 @@ The processor response information for payment requests, such as direct credit c
| Name | Type | Tags | Description | Getter | Setter | | 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 | | `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 | | `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) ## Example (as JSON)

View File

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

View File

@@ -1,11 +1,11 @@
# Cvv Code # CVV Code
The card verification value code for for Visa, Discover, Mastercard, or American Express. The card verification value code for for Visa, Discover, Mastercard, or American Express.
## Enumeration ## Enumeration
`CvvCode` `CVVCode`
## Fields ## Fields

View File

@@ -1,11 +1,11 @@
# Eci Flag # ECI Flag
Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor. 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 ## Enumeration
`EciFlag` `ECIFlag`
## Fields ## Fields

View File

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

View File

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

View File

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

View File

@@ -1,33 +0,0 @@
# Google Pay Card
The payment card used to fund a Google Pay payment. Can be a credit or debit card.
## Structure
`GooglePayCard`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `name` | `?string` | Optional | The card holder's name as it appears on the card.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `300`, *Pattern*: `^.{1,300}$` | getName(): ?string | setName(?string name): void |
| `number` | `?string` | Optional | The primary account number (PAN) for the payment card.<br>**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `19`, *Pattern*: `^[0-9]{13,19}$` | getNumber(): ?string | setNumber(?string number): void |
| `expiry` | `?string` | Optional | The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).<br>**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7`, *Pattern*: `^[0-9]{4}-(0[1-9]\|1[0-2])$` | getExpiry(): ?string | setExpiry(?string expiry): void |
| `lastDigits` | `?string` | Optional | The last digits of the payment card.<br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `4`, *Pattern*: `^[0-9]{2,4}$` | getLastDigits(): ?string | setLastDigits(?string lastDigits): void |
| `type` | [`?string(CardType)`](../../doc/models/card-type.md) | Optional | Type of card. i.e Credit, Debit and so on.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getType(): ?string | setType(?string type): void |
| `brand` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | The card network or brand. Applies to credit, debit, gift, and payment cards.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getBrand(): ?string | setBrand(?string brand): void |
| `billingAddress` | [`?PortablePostalAddressMediumGrained`](../../doc/models/portable-postal-address-medium-grained.md) | Optional | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getBillingAddress(): ?PortablePostalAddressMediumGrained | setBillingAddress(?PortablePostalAddressMediumGrained billingAddress): void |
## Example (as JSON)
```json
{
"name": "name4",
"number": "number2",
"expiry": "expiry2",
"last_digits": "last_digits8",
"type": "DEBIT"
}
```

View File

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

View File

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

View File

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

View File

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

View File

@@ -13,7 +13,7 @@ The request-related [HATEOAS link](/api/rest/responses/#hateoas-links) informati
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| `href` | `string` | Required | The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call. | getHref(): string | setHref(string href): void | | `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 | | `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) ## Example (as JSON)

View File

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

View File

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

View File

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

View File

@@ -14,7 +14,7 @@ The Third Party Network token used to fund a payment.
| `number` | `string` | Required | Third party network token number.<br>**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `19`, *Pattern*: `^[0-9]{13,19}$` | getNumber(): string | setNumber(string number): void | | `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 | | `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 | | `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 | | `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) ## Example (as JSON)

View File

@@ -13,7 +13,7 @@ The payment source definition.
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| `card` | [`?CardRequest`](../../doc/models/card-request.md) | Optional | The payment card to use to fund a payment. Can be a credit or debit card.<blockquote><strong>Note:</strong> Passing card number, cvv and expiry directly via the API requires <a href="https://www.pcisecuritystandards.org/pci_security/completing_self_assessment"> PCI SAQ D compliance</a>. <br>*PayPal offers a mechanism by which you do not have to take on the <strong>PCI SAQ D</strong> burden by using hosted fields - refer to <a href="https://developer.paypal.com/docs/checkout/advanced/integrate/">this Integration Guide</a>*.</blockquote> | getCard(): ?CardRequest | setCard(?CardRequest card): void | | `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 | | `token` | [`?Token`](../../doc/models/token.md) | Optional | The tokenized payment source to fund a payment. | getToken(): ?Token | setToken(?Token token): void |
| `paypal` | [`?PaypalWallet`](../../doc/models/paypal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PaypalWallet | setPaypal(?PaypalWallet paypal): void | | `paypal` | [`?PayPalWallet`](../../doc/models/pay-pal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PayPalWallet | setPaypal(?PayPalWallet paypal): void |
| `applePay` | [`?ApplePayRequest`](../../doc/models/apple-pay-request.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayRequest | setApplePay(?ApplePayRequest applePay): void | | `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 | | `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 | | `venmo` | [`?VenmoWalletRequest`](../../doc/models/venmo-wallet-request.md) | Optional | Information needed to pay using Venmo. | getVenmo(): ?VenmoWalletRequest | setVenmo(?VenmoWalletRequest venmo): void |
@@ -108,13 +108,6 @@ The payment source definition.
"message_id": "message_id0", "message_id": "message_id0",
"message_expiration": "message_expiration2", "message_expiration": "message_expiration2",
"payment_method": "CARD", "payment_method": "CARD",
"card": {
"name": "name6",
"number": "number6",
"expiry": "expiry4",
"last_digits": "last_digits0",
"type": "UNKNOWN"
},
"authentication_method": "PAN_ONLY", "authentication_method": "PAN_ONLY",
"cryptogram": "cryptogram6", "cryptogram": "cryptogram6",
"eci_indicator": "eci_indicator0" "eci_indicator": "eci_indicator0"

View File

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

View File

@@ -12,7 +12,7 @@ The payment source used to fund the payment.
| Name | Type | Tags | Description | Getter | Setter | | 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 | | `card` | [`?CardResponse`](../../doc/models/card-response.md) | Optional | The payment card to use to fund a payment. Card can be a credit or debit card. | getCard(): ?CardResponse | setCard(?CardResponse card): void |
| `paypal` | [`?PaypalWalletResponse`](../../doc/models/paypal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PaypalWalletResponse | setPaypal(?PaypalWalletResponse paypal): void | | `paypal` | [`?PayPalWalletResponse`](../../doc/models/pay-pal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PayPalWalletResponse | setPaypal(?PayPalWalletResponse paypal): void |
| `applePay` | [`?ApplePayPaymentObject`](../../doc/models/apple-pay-payment-object.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayPaymentObject | setApplePay(?ApplePayPaymentObject applePay): void | | `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 | | `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 | | `venmo` | [`?VenmoWalletResponse`](../../doc/models/venmo-wallet-response.md) | Optional | Venmo wallet response. | getVenmo(): ?VenmoWalletResponse | setVenmo(?VenmoWalletResponse venmo): void |

View File

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

View File

@@ -13,7 +13,7 @@ The payment source definition.
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| `card` | [`?CardRequest`](../../doc/models/card-request.md) | Optional | The payment card to use to fund a payment. Can be a credit or debit card.<blockquote><strong>Note:</strong> Passing card number, cvv and expiry directly via the API requires <a href="https://www.pcisecuritystandards.org/pci_security/completing_self_assessment"> PCI SAQ D compliance</a>. <br>*PayPal offers a mechanism by which you do not have to take on the <strong>PCI SAQ D</strong> burden by using hosted fields - refer to <a href="https://developer.paypal.com/docs/checkout/advanced/integrate/">this Integration Guide</a>*.</blockquote> | getCard(): ?CardRequest | setCard(?CardRequest card): void | | `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 | | `token` | [`?Token`](../../doc/models/token.md) | Optional | The tokenized payment source to fund a payment. | getToken(): ?Token | setToken(?Token token): void |
| `paypal` | [`?PaypalWallet`](../../doc/models/paypal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PaypalWallet | setPaypal(?PaypalWallet paypal): void | | `paypal` | [`?PayPalWallet`](../../doc/models/pay-pal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PayPalWallet | setPaypal(?PayPalWallet paypal): void |
| `applePay` | [`?ApplePayRequest`](../../doc/models/apple-pay-request.md) | Optional | Information needed to pay using ApplePay. | getApplePay(): ?ApplePayRequest | setApplePay(?ApplePayRequest applePay): void | | `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 | | `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 | | `venmo` | [`?VenmoWalletRequest`](../../doc/models/venmo-wallet-request.md) | Optional | Information needed to pay using Venmo. | getVenmo(): ?VenmoWalletRequest | setVenmo(?VenmoWalletRequest venmo): void |
@@ -108,13 +108,6 @@ The payment source definition.
"message_id": "message_id0", "message_id": "message_id0",
"message_expiration": "message_expiration2", "message_expiration": "message_expiration2",
"payment_method": "CARD", "payment_method": "CARD",
"card": {
"name": "name6",
"number": "number6",
"expiry": "expiry4",
"last_digits": "last_digits0",
"type": "UNKNOWN"
},
"authentication_method": "PAN_ONLY", "authentication_method": "PAN_ONLY",
"cryptogram": "cryptogram6", "cryptogram": "cryptogram6",
"eci_indicator": "eci_indicator0" "eci_indicator": "eci_indicator0"

View File

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

View File

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

View File

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

View File

@@ -1,11 +1,11 @@
# Pa Res Status # PA Res Status
Transactions status result identifier. The outcome of the issuer's authentication. Transactions status result identifier. The outcome of the issuer's authentication.
## Enumeration ## Enumeration
`PaResStatus` `PAResStatus`
## Fields ## Fields

View File

@@ -1,11 +1,11 @@
# Paypal Experience Landing Page # Pay Pal Experience Landing Page
The type of landing page to show on the PayPal site for customer checkout. The type of landing page to show on the PayPal site for customer checkout.
## Enumeration ## Enumeration
`PaypalExperienceLandingPage` `PayPalExperienceLandingPage`
## Fields ## Fields

View File

@@ -1,11 +1,11 @@
# Paypal Experience User Action # Pay Pal Experience User Action
Configures a <strong>Continue</strong> or <strong>Pay Now</strong> checkout flow. Configures a <strong>Continue</strong> or <strong>Pay Now</strong> checkout flow.
## Enumeration ## Enumeration
`PaypalExperienceUserAction` `PayPalExperienceUserAction`
## Fields ## Fields

View File

@@ -1,11 +1,11 @@
# Paypal Payment Token Customer Type # Pay Pal Payment Token Customer Type
The customer type associated with the PayPal payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer. 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 ## Enumeration
`PaypalPaymentTokenCustomerType` `PayPalPaymentTokenCustomerType`
## Fields ## Fields

View File

@@ -1,11 +1,11 @@
# Paypal Payment Token Usage Pattern # Pay Pal Payment Token Usage Pattern
Expected business/pricing model for the billing agreement. Expected business/pricing model for the billing agreement.
## Enumeration ## Enumeration
`PaypalPaymentTokenUsagePattern` `PayPalPaymentTokenUsagePattern`
## Fields ## Fields

View File

@@ -1,11 +1,11 @@
# Paypal Payment Token Usage Type # Pay Pal Payment Token Usage Type
The usage type associated with the PayPal payment token. The usage type associated with the PayPal payment token.
## Enumeration ## Enumeration
`PaypalPaymentTokenUsageType` `PayPalPaymentTokenUsageType`
## Fields ## Fields

View File

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

View File

@@ -1,11 +1,11 @@
# Paypal Wallet Account Verification Status # Pay Pal Wallet Account Verification Status
The account status indicates whether the buyer has verified the financial details associated with their PayPal account. The account status indicates whether the buyer has verified the financial details associated with their PayPal account.
## Enumeration ## Enumeration
`PaypalWalletAccountVerificationStatus` `PayPalWalletAccountVerificationStatus`
## Fields ## Fields

View File

@@ -1,17 +1,17 @@
# Paypal Wallet Attributes Response # Pay Pal Wallet Attributes Response
Additional attributes associated with the use of a PayPal Wallet. Additional attributes associated with the use of a PayPal Wallet.
## Structure ## Structure
`PaypalWalletAttributesResponse` `PayPalWalletAttributesResponse`
## Fields ## Fields
| Name | Type | Tags | Description | Getter | Setter | | Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| `vault` | [`?PaypalWalletVaultResponse`](../../doc/models/paypal-wallet-vault-response.md) | Optional | The details about a saved PayPal Wallet payment source. | getVault(): ?PaypalWalletVaultResponse | setVault(?PaypalWalletVaultResponse vault): void | | `vault` | [`?PayPalWalletVaultResponse`](../../doc/models/pay-pal-wallet-vault-response.md) | Optional | The details about a saved PayPal Wallet payment source. | getVault(): ?PayPalWalletVaultResponse | setVault(?PayPalWalletVaultResponse vault): void |
| `cobrandedCards` | [`?(CobrandedCard[])`](../../doc/models/cobranded-card.md) | Optional | An array of merchant cobranded cards used by buyer to complete an order. This array will be present if a merchant has onboarded their cobranded card with PayPal and provided corresponding label(s).<br>**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `25` | getCobrandedCards(): ?array | setCobrandedCards(?array cobrandedCards): void | | `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) ## Example (as JSON)

View File

@@ -1,18 +1,18 @@
# Paypal Wallet Attributes # Pay Pal Wallet Attributes
Additional attributes associated with the use of this PayPal Wallet. Additional attributes associated with the use of this PayPal Wallet.
## Structure ## Structure
`PaypalWalletAttributes` `PayPalWalletAttributes`
## Fields ## Fields
| Name | Type | Tags | Description | Getter | Setter | | Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| `customer` | [`?PaypalWalletCustomerRequest`](../../doc/models/paypal-wallet-customer-request.md) | Optional | - | getCustomer(): ?PaypalWalletCustomerRequest | setCustomer(?PaypalWalletCustomerRequest customer): void | | `customer` | [`?PayPalWalletCustomerRequest`](../../doc/models/pay-pal-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 | | `vault` | [`?PayPalWalletVaultInstruction`](../../doc/models/pay-pal-wallet-vault-instruction.md) | Optional | - | getVault(): ?PayPalWalletVaultInstruction | setVault(?PayPalWalletVaultInstruction vault): void |
## Example (as JSON) ## Example (as JSON)

View File

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

View File

@@ -1,11 +1,11 @@
# Paypal Wallet Customer # Pay Pal Wallet Customer
The details about a customer in PayPal's system of record. The details about a customer in PayPal's system of record.
## Structure ## Structure
`PaypalWalletCustomer` `PayPalWalletCustomer`
## Fields ## Fields

View File

@@ -1,11 +1,11 @@
# Paypal Wallet Experience Context # Pay Pal Wallet Experience Context
Customizes the payer experience during the approval process for payment with PayPal.<blockquote><strong>Note:</strong> Partners and Marketplaces might configure <code>brand_name</code> and <code>shipping_preference</code> during partner account setup, which overrides the request values.</blockquote> 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 ## Structure
`PaypalWalletExperienceContext` `PayPalWalletExperienceContext`
## Fields ## 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 | | `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 | | `returnUrl` | `?string` | Optional | Describes the URL. | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void |
| `cancelUrl` | `?string` | Optional | Describes the URL. | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void | | `cancelUrl` | `?string` | Optional | Describes the URL. | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void |
| `landingPage` | [`?string(PaypalExperienceLandingPage)`](../../doc/models/paypal-experience-landing-page.md) | Optional | The type of landing page to show on the PayPal site for customer checkout.<br>**Default**: `PaypalExperienceLandingPage::NO_PREFERENCE`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `13`, *Pattern*: `^[0-9A-Z_]+$` | getLandingPage(): ?string | setLandingPage(?string landingPage): void | | `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/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 | | `userAction` | [`?string(PayPalExperienceUserAction)`](../../doc/models/pay-pal-experience-user-action.md) | Optional | Configures a <strong>Continue</strong> or <strong>Pay Now</strong> checkout flow.<br>**Default**: `PayPalExperienceUserAction::CONTINUE_`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `8`, *Pattern*: `^[0-9A-Z_]+$` | getUserAction(): ?string | setUserAction(?string userAction): void |
| `paymentMethodPreference` | [`?string(PayeePaymentMethodPreference)`](../../doc/models/payee-payment-method-preference.md) | Optional | The merchant-preferred payment methods.<br>**Default**: `PayeePaymentMethodPreference::UNRESTRICTED`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getPaymentMethodPreference(): ?string | setPaymentMethodPreference(?string paymentMethodPreference): void | | `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) ## Example (as JSON)

View File

@@ -1,11 +1,11 @@
# Paypal Wallet Response # Pay Pal Wallet Response
The PayPal Wallet response. The PayPal Wallet response.
## Structure ## Structure
`PaypalWalletResponse` `PayPalWalletResponse`
## Fields ## 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 | | `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 | | `accountId` | `?string` | Optional | The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is used to encode the result.<br>**Constraints**: *Minimum Length*: `13`, *Maximum Length*: `13`, *Pattern*: `^[2-9A-HJ-NP-Z]{13}$` | getAccountId(): ?string | setAccountId(?string accountId): void |
| `accountStatus` | [`?string(PaypalWalletAccountVerificationStatus)`](../../doc/models/paypal-wallet-account-verification-status.md) | Optional | The account status indicates whether the buyer has verified the financial details associated with their PayPal account.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getAccountStatus(): ?string | setAccountStatus(?string accountStatus): void | | `accountStatus` | [`?string(PayPalWalletAccountVerificationStatus)`](../../doc/models/pay-pal-wallet-account-verification-status.md) | Optional | The account status indicates whether the buyer has verified the financial details associated with their PayPal account.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getAccountStatus(): ?string | setAccountStatus(?string accountStatus): void |
| `name` | [`?Name`](../../doc/models/name.md) | Optional | The name of the party. | getName(): ?Name | setName(?Name name): void | | `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 | | `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 | | `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 | | `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 | | `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 | | `address` | [`?Address`](../../doc/models/address.md) | Optional | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getAddress(): ?Address | setAddress(?Address address): void |
| `attributes` | [`?PaypalWalletAttributesResponse`](../../doc/models/paypal-wallet-attributes-response.md) | Optional | Additional attributes associated with the use of a PayPal Wallet. | getAttributes(): ?PaypalWalletAttributesResponse | setAttributes(?PaypalWalletAttributesResponse attributes): void | | `attributes` | [`?PayPalWalletAttributesResponse`](../../doc/models/pay-pal-wallet-attributes-response.md) | Optional | Additional attributes associated with the use of a PayPal Wallet. | getAttributes(): ?PayPalWalletAttributesResponse | setAttributes(?PayPalWalletAttributesResponse attributes): void |
## Example (as JSON) ## Example (as JSON)

View File

@@ -1,9 +1,9 @@
# Paypal Wallet Vault Instruction # Pay Pal Wallet Vault Instruction
## Structure ## Structure
`PaypalWalletVaultInstruction` `PayPalWalletVaultInstruction`
## Fields ## 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 | | `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 | | `description` | `?string` | Optional | The description displayed to PayPal consumer on the approval flow for PayPal, as well as on the PayPal payment token management experience on PayPal.com.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | getDescription(): ?string | setDescription(?string description): void |
| `usagePattern` | [`?string(PaypalPaymentTokenUsagePattern)`](../../doc/models/paypal-payment-token-usage-pattern.md) | Optional | Expected business/pricing model for the billing agreement.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `30` | getUsagePattern(): ?string | setUsagePattern(?string usagePattern): void | | `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/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 | | `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/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 | | `customerType` | [`?string(PayPalPaymentTokenCustomerType)`](../../doc/models/pay-pal-payment-token-customer-type.md) | Optional | The customer type associated with the PayPal payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer.<br>**Default**: `PayPalPaymentTokenCustomerType::CONSUMER`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getCustomerType(): ?string | setCustomerType(?string customerType): void |
| `permitMultiplePaymentTokens` | `?bool` | Optional | Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source.<br>**Default**: `false` | getPermitMultiplePaymentTokens(): ?bool | setPermitMultiplePaymentTokens(?bool permitMultiplePaymentTokens): void | | `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) ## Example (as JSON)

View File

@@ -1,20 +1,20 @@
# Paypal Wallet Vault Response # Pay Pal Wallet Vault Response
The details about a saved PayPal Wallet payment source. The details about a saved PayPal Wallet payment source.
## Structure ## Structure
`PaypalWalletVaultResponse` `PayPalWalletVaultResponse`
## Fields ## Fields
| Name | Type | Tags | Description | Getter | Setter | | 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 | | `id` | `?string` | Optional | The PayPal-generated ID for the saved payment source.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getId(): ?string | setId(?string id): void |
| `status` | [`?string(PaypalWalletVaultStatus)`](../../doc/models/paypal-wallet-vault-status.md) | Optional | The vault status.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void | | `status` | [`?string(PayPalWalletVaultStatus)`](../../doc/models/pay-pal-wallet-vault-status.md) | Optional | The vault status.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void |
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related HATEOAS links.<br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getLinks(): ?array | setLinks(?array links): void | | `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related HATEOAS links.<br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getLinks(): ?array | setLinks(?array links): void |
| `customer` | [`?PaypalWalletCustomer`](../../doc/models/paypal-wallet-customer.md) | Optional | The details about a customer in PayPal's system of record. | getCustomer(): ?PaypalWalletCustomer | setCustomer(?PaypalWalletCustomer customer): void | | `customer` | [`?PayPalWalletCustomer`](../../doc/models/pay-pal-wallet-customer.md) | Optional | The details about a customer in PayPal's system of record. | getCustomer(): ?PayPalWalletCustomer | setCustomer(?PayPalWalletCustomer customer): void |
## Example (as JSON) ## Example (as JSON)

View File

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

View File

@@ -1,11 +1,11 @@
# Paypal Wallet # Pay Pal Wallet
A resource that identifies a PayPal Wallet is used for payment. A resource that identifies a PayPal Wallet is used for payment.
## Structure ## Structure
`PaypalWallet` `PayPalWallet`
## Fields ## 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 | | `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 | | `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 | | `address` | [`?Address`](../../doc/models/address.md) | Optional | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getAddress(): ?Address | setAddress(?Address address): void |
| `attributes` | [`?PaypalWalletAttributes`](../../doc/models/paypal-wallet-attributes.md) | Optional | Additional attributes associated with the use of this PayPal Wallet. | getAttributes(): ?PaypalWalletAttributes | setAttributes(?PaypalWalletAttributes attributes): void | | `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/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 | | `experienceContext` | [`?PayPalWalletExperienceContext`](../../doc/models/pay-pal-wallet-experience-context.md) | Optional | Customizes the payer experience during the approval process for payment with PayPal.<blockquote><strong>Note:</strong> Partners and Marketplaces might configure <code>brand_name</code> and <code>shipping_preference</code> during partner account setup, which overrides the request values.</blockquote> | getExperienceContext(): ?PayPalWalletExperienceContext | setExperienceContext(?PayPalWalletExperienceContext experienceContext): void |
| `billingAgreementId` | `?string` | Optional | The PayPal billing agreement ID. References an approved recurring payment for goods or services.<br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `128`, *Pattern*: `^[a-zA-Z0-9-]+$` | getBillingAgreementId(): ?string | setBillingAgreementId(?string billingAgreementId): void | | `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) ## Example (as JSON)

View File

@@ -12,13 +12,13 @@ The payment source used to fund the payment.
| Name | Type | Tags | Description | Getter | Setter | | 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 | | `card` | [`?CardResponse`](../../doc/models/card-response.md) | Optional | The payment card to use to fund a payment. Card can be a credit or debit card. | getCard(): ?CardResponse | setCard(?CardResponse card): void |
| `paypal` | [`?PaypalWalletResponse`](../../doc/models/paypal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PaypalWalletResponse | setPaypal(?PaypalWalletResponse paypal): void | | `paypal` | [`?PayPalWalletResponse`](../../doc/models/pay-pal-wallet-response.md) | Optional | The PayPal Wallet response. | getPaypal(): ?PayPalWalletResponse | setPaypal(?PayPalWalletResponse paypal): void |
| `bancontact` | [`?BancontactPaymentObject`](../../doc/models/bancontact-payment-object.md) | Optional | Information used to pay Bancontact. | getBancontact(): ?BancontactPaymentObject | setBancontact(?BancontactPaymentObject bancontact): void | | `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 | | `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 | | `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 | | `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 | | `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 | | `mybank` | [`?MyBankPaymentObject`](../../doc/models/my-bank-payment-object.md) | Optional | Information used to pay using MyBank. | getMybank(): ?MyBankPaymentObject | setMybank(?MyBankPaymentObject mybank): void |
| `p24` | [`?P24PaymentObject`](../../doc/models/p24-payment-object.md) | Optional | Information used to pay using P24(Przelewy24). | getP24(): ?P24PaymentObject | setP24(?P24PaymentObject p24): void | | `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 | | `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 | | `trustly` | [`?TrustlyPaymentObject`](../../doc/models/trustly-payment-object.md) | Optional | Information needed to pay using Trustly. | getTrustly(): ?TrustlyPaymentObject | setTrustly(?TrustlyPaymentObject trustly): void |

View File

@@ -13,13 +13,13 @@ The payment source definition.
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| `card` | [`?CardRequest`](../../doc/models/card-request.md) | Optional | The payment card to use to fund a payment. Can be a credit or debit card.<blockquote><strong>Note:</strong> Passing card number, cvv and expiry directly via the API requires <a href="https://www.pcisecuritystandards.org/pci_security/completing_self_assessment"> PCI SAQ D compliance</a>. <br>*PayPal offers a mechanism by which you do not have to take on the <strong>PCI SAQ D</strong> burden by using hosted fields - refer to <a href="https://developer.paypal.com/docs/checkout/advanced/integrate/">this Integration Guide</a>*.</blockquote> | getCard(): ?CardRequest | setCard(?CardRequest card): void | | `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 | | `token` | [`?Token`](../../doc/models/token.md) | Optional | The tokenized payment source to fund a payment. | getToken(): ?Token | setToken(?Token token): void |
| `paypal` | [`?PaypalWallet`](../../doc/models/paypal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PaypalWallet | setPaypal(?PaypalWallet paypal): void | | `paypal` | [`?PayPalWallet`](../../doc/models/pay-pal-wallet.md) | Optional | A resource that identifies a PayPal Wallet is used for payment. | getPaypal(): ?PayPalWallet | setPaypal(?PayPalWallet paypal): void |
| `bancontact` | [`?BancontactPaymentRequest`](../../doc/models/bancontact-payment-request.md) | Optional | Information needed to pay using Bancontact. | getBancontact(): ?BancontactPaymentRequest | setBancontact(?BancontactPaymentRequest bancontact): void | | `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 | | `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 | | `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 | | `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 | | `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 | | `mybank` | [`?MyBankPaymentRequest`](../../doc/models/my-bank-payment-request.md) | Optional | Information needed to pay using MyBank. | getMybank(): ?MyBankPaymentRequest | setMybank(?MyBankPaymentRequest mybank): void |
| `p24` | [`?P24PaymentRequest`](../../doc/models/p24-payment-request.md) | Optional | Information needed to pay using P24 (Przelewy24). | getP24(): ?P24PaymentRequest | setP24(?P24PaymentRequest p24): void | | `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 | | `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 | | `trustly` | [`?TrustlyPaymentRequest`](../../doc/models/trustly-payment-request.md) | Optional | Information needed to pay using Trustly. | getTrustly(): ?TrustlyPaymentRequest | setTrustly(?TrustlyPaymentRequest trustly): void |

View File

@@ -12,7 +12,7 @@ The vaulted payment method details.
| Name | Type | Tags | Description | Getter | Setter | | 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 | | `card` | [`?CardPaymentToken`](../../doc/models/card-payment-token.md) | Optional | Full representation of a Card Payment Token including network token. | getCard(): ?CardPaymentToken | setCard(?CardPaymentToken card): void |
| `paypal` | [`?PaypalPaymentToken`](../../doc/models/paypal-payment-token.md) | Optional | - | getPaypal(): ?PaypalPaymentToken | setPaypal(?PaypalPaymentToken paypal): void | | `paypal` | [`?PayPalPaymentToken`](../../doc/models/pay-pal-payment-token.md) | Optional | - | getPaypal(): ?PayPalPaymentToken | setPaypal(?PayPalPaymentToken paypal): void |
| `venmo` | [`?VenmoPaymentToken`](../../doc/models/venmo-payment-token.md) | Optional | - | getVenmo(): ?VenmoPaymentToken | setVenmo(?VenmoPaymentToken venmo): void | | `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 | | `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 | | `bank` | `mixed` | Optional | Full representation of a Bank Payment Token. | getBank(): | setBank( bank): void |

View File

@@ -1,33 +0,0 @@
# Portable Postal Address Medium Grained
The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).
## Structure
`PortablePostalAddressMediumGrained`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `addressLine1` | `?string` | Optional | The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.<br>**Constraints**: *Maximum Length*: `300` | getAddressLine1(): ?string | setAddressLine1(?string addressLine1): void |
| `addressLine2` | `?string` | Optional | The second line of the address, for example, a suite or apartment number.<br>**Constraints**: *Maximum Length*: `300` | getAddressLine2(): ?string | setAddressLine2(?string addressLine2): void |
| `adminArea2` | `?string` | Optional | A city, town, or village. Smaller than `admin_area_level_1`.<br>**Constraints**: *Maximum Length*: `120` | getAdminArea2(): ?string | setAdminArea2(?string adminArea2): void |
| `adminArea1` | `?string` | Optional | The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is:<ul><li>UK. A county.</li><li>US. A state.</li><li>Canada. A province.</li><li>Japan. A prefecture.</li><li>Switzerland. A *kanton*.</li></ul><br>**Constraints**: *Maximum Length*: `300` | getAdminArea1(): ?string | setAdminArea1(?string adminArea1): void |
| `postalCode` | `?string` | Optional | The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).<br>**Constraints**: *Maximum Length*: `60` | getPostalCode(): ?string | setPostalCode(?string postalCode): void |
| `countryCode` | `string` | Required | The [2-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.</blockquote><br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void |
## Example (as JSON)
```json
{
"address_line_1": "address_line_16",
"address_line_2": "address_line_24",
"admin_area_2": "admin_area_22",
"admin_area_1": "admin_area_10",
"postal_code": "postal_code6",
"country_code": "country_code6"
}
```

View File

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

View File

@@ -11,8 +11,8 @@ The processor response information for payment requests, such as direct credit c
| Name | Type | Tags | Description | Getter | Setter | | 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 | | `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 | | `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 | | `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 | | `paymentAdviceCode` | [`?string(PaymentAdviceCode)`](../../doc/models/payment-advice-code.md) | Optional | The declined payment transactions might have payment advice codes. The card networks, like Visa and Mastercard, return payment advice codes. | getPaymentAdviceCode(): ?string | setPaymentAdviceCode(?string paymentAdviceCode): void |

View File

@@ -12,7 +12,7 @@ The payment method to vault with the instrument details.
| Name | Type | Tags | Description | Getter | Setter | | 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 | | `card` | [`?SetupTokenRequestCard`](../../doc/models/setup-token-request-card.md) | Optional | A Resource representing a request to vault a Card. | getCard(): ?SetupTokenRequestCard | setCard(?SetupTokenRequestCard card): void |
| `paypal` | [`?VaultPaypalWalletRequest`](../../doc/models/vault-paypal-wallet-request.md) | Optional | A resource representing a request to vault PayPal Wallet. | getPaypal(): ?VaultPaypalWalletRequest | setPaypal(?VaultPaypalWalletRequest paypal): void | | `paypal` | [`?VaultPayPalWalletRequest`](../../doc/models/vault-pay-pal-wallet-request.md) | Optional | A resource representing a request to vault PayPal Wallet. | getPaypal(): ?VaultPayPalWalletRequest | setPaypal(?VaultPayPalWalletRequest paypal): void |
| `venmo` | [`?VaultVenmoRequest`](../../doc/models/vault-venmo-request.md) | Optional | - | getVenmo(): ?VaultVenmoRequest | setVenmo(?VaultVenmoRequest venmo): void | | `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 | | `token` | [`?VaultTokenRequest`](../../doc/models/vault-token-request.md) | Optional | The Tokenized Payment Source representing a Request to Vault a Token. | getToken(): ?VaultTokenRequest | setToken(?VaultTokenRequest token): void |

View File

@@ -12,7 +12,7 @@ The setup payment method details.
| Name | Type | Tags | Description | Getter | Setter | | Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| `card` | [`?SetupTokenResponseCard`](../../doc/models/setup-token-response-card.md) | Optional | - | getCard(): ?SetupTokenResponseCard | setCard(?SetupTokenResponseCard card): void | | `card` | [`?SetupTokenResponseCard`](../../doc/models/setup-token-response-card.md) | Optional | - | getCard(): ?SetupTokenResponseCard | setCard(?SetupTokenResponseCard card): void |
| `paypal` | [`?PaypalPaymentToken`](../../doc/models/paypal-payment-token.md) | Optional | - | getPaypal(): ?PaypalPaymentToken | setPaypal(?PaypalPaymentToken paypal): void | | `paypal` | [`?PayPalPaymentToken`](../../doc/models/pay-pal-payment-token.md) | Optional | - | getPaypal(): ?PayPalPaymentToken | setPaypal(?PayPalPaymentToken paypal): void |
| `venmo` | [`?VenmoPaymentToken`](../../doc/models/venmo-payment-token.md) | Optional | - | getVenmo(): ?VenmoPaymentToken | setVenmo(?VenmoPaymentToken venmo): void | | `venmo` | [`?VenmoPaymentToken`](../../doc/models/venmo-payment-token.md) | Optional | - | getVenmo(): ?VenmoPaymentToken | setVenmo(?VenmoPaymentToken venmo): void |
## Example (as JSON) ## Example (as JSON)

View File

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

View File

@@ -13,7 +13,7 @@ The shipping details.
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| `name` | [`?ShippingName`](../../doc/models/shipping-name.md) | Optional | The name of the party. | getName(): ?ShippingName | setName(?ShippingName name): void | | `name` | [`?ShippingName`](../../doc/models/shipping-name.md) | Optional | The name of the party. | getName(): ?ShippingName | setName(?ShippingName name): void |
| `phoneNumber` | [`?PhoneNumberWithCountryCode`](../../doc/models/phone-number-with-country-code.md) | Optional | The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): ?PhoneNumberWithCountryCode | setPhoneNumber(?PhoneNumberWithCountryCode phoneNumber): void | | `phoneNumber` | [`?PhoneNumberWithCountryCode`](../../doc/models/phone-number-with-country-code.md) | Optional | The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): ?PhoneNumberWithCountryCode | setPhoneNumber(?PhoneNumberWithCountryCode phoneNumber): void |
| `type` | [`?string(FulfillmentType)`](../../doc/models/fulfillment-type.md) | Optional | A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getType(): ?string | setType(?string type): void | | `type` | [`?string(FullfillmentType)`](../../doc/models/fullfillment-type.md) | Optional | A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getType(): ?string | setType(?string type): void |
| `options` | [`?(ShippingOption[])`](../../doc/models/shipping-option.md) | Optional | An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.<br>**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `10` | getOptions(): ?array | setOptions(?array options): void | | `options` | [`?(ShippingOption[])`](../../doc/models/shipping-option.md) | Optional | An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.<br>**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `10` | getOptions(): ?array | setOptions(?array options): void |
| `address` | [`?Address`](../../doc/models/address.md) | Optional | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getAddress(): ?Address | setAddress(?Address address): void | | `address` | [`?Address`](../../doc/models/address.md) | Optional | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getAddress(): ?Address | setAddress(?Address address): void |

View File

@@ -13,7 +13,7 @@ The order shipping details.
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| `name` | [`?ShippingName`](../../doc/models/shipping-name.md) | Optional | The name of the party. | getName(): ?ShippingName | setName(?ShippingName name): void | | `name` | [`?ShippingName`](../../doc/models/shipping-name.md) | Optional | The name of the party. | getName(): ?ShippingName | setName(?ShippingName name): void |
| `phoneNumber` | [`?PhoneNumberWithCountryCode`](../../doc/models/phone-number-with-country-code.md) | Optional | The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): ?PhoneNumberWithCountryCode | setPhoneNumber(?PhoneNumberWithCountryCode phoneNumber): void | | `phoneNumber` | [`?PhoneNumberWithCountryCode`](../../doc/models/phone-number-with-country-code.md) | Optional | The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). | getPhoneNumber(): ?PhoneNumberWithCountryCode | setPhoneNumber(?PhoneNumberWithCountryCode phoneNumber): void |
| `type` | [`?string(FulfillmentType)`](../../doc/models/fulfillment-type.md) | Optional | A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getType(): ?string | setType(?string type): void | | `type` | [`?string(FullfillmentType)`](../../doc/models/fullfillment-type.md) | Optional | A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getType(): ?string | setType(?string type): void |
| `options` | [`?(ShippingOption[])`](../../doc/models/shipping-option.md) | Optional | An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.<br>**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `10` | getOptions(): ?array | setOptions(?array options): void | | `options` | [`?(ShippingOption[])`](../../doc/models/shipping-option.md) | Optional | An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items.<br>**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `10` | getOptions(): ?array | setOptions(?array options): void |
| `address` | [`?Address`](../../doc/models/address.md) | Optional | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getAddress(): ?Address | setAddress(?Address address): void | | `address` | [`?Address`](../../doc/models/address.md) | Optional | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getAddress(): ?Address | setAddress(?Address address): void |
| `trackers` | [`?(OrderTrackerResponse[])`](../../doc/models/order-tracker-response.md) | Optional | An array of trackers for a transaction. | getTrackers(): ?array | setTrackers(?array trackers): void | | `trackers` | [`?(OrderTrackerResponse[])`](../../doc/models/order-tracker-response.md) | Optional | An array of trackers for a transaction. | getTrackers(): ?array | setTrackers(?array trackers): void |

View File

@@ -11,7 +11,7 @@ Results of 3D Secure Authentication.
| Name | Type | Tags | Description | Getter | Setter | | 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 | | `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) ## Example (as JSON)

View File

@@ -11,7 +11,7 @@ The Universal Product Code of the item.
| Name | Type | Tags | Description | Getter | Setter | | 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 | | `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) ## Example (as JSON)

View File

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

View File

@@ -1,11 +1,11 @@
# Vault Paypal Wallet Request # Vault Pay Pal Wallet Request
A resource representing a request to vault PayPal Wallet. A resource representing a request to vault PayPal Wallet.
## Structure ## Structure
`VaultPaypalWalletRequest` `VaultPayPalWalletRequest`
## Fields ## Fields

View File

@@ -12,7 +12,7 @@ The shipping details.
| Name | Type | Tags | Description | Getter | Setter | | Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| `name` | [`?ShippingName`](../../doc/models/shipping-name.md) | Optional | The name of the party. | getName(): ?ShippingName | setName(?ShippingName name): void | | `name` | [`?ShippingName`](../../doc/models/shipping-name.md) | Optional | The name of the party. | getName(): ?ShippingName | setName(?ShippingName name): void |
| `type` | [`?string(FulfillmentType)`](../../doc/models/fulfillment-type.md) | Optional | A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getType(): ?string | setType(?string type): void | | `type` | [`?string(FullfillmentType)`](../../doc/models/fullfillment-type.md) | Optional | A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getType(): ?string | setType(?string type): void |
| `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 | | `address` | [`?Address`](../../doc/models/address.md) | Optional | The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). | getAddress(): ?Address | setAddress(?Address address): void |
## Example (as JSON) ## Example (as JSON)

16
phpunit.xml Normal file
View File

@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="tests/bootstrap.php" colors="true" processIsolation="false" stopOnError="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.3/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
<testsuites>
<testsuite name="SDK Test Suite">
<directory suffix="Test.php">./tests</directory>
</testsuite>
</testsuites>
<php>
<env name="SYMFONY_DEPRECATIONS_HELPER" value="disabled"/>
</php>
<source>
<include>
<directory suffix=".php">src</directory>
</include>
</source>
</phpunit>

BIN
selenium.jar Normal file

Binary file not shown.

View File

@@ -3,12 +3,12 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/ */
namespace PaypalServerSdkLib; namespace PaypalServerSDKLib;
use Core\Utils\CoreHelper; use Core\Utils\CoreHelper;
use Core\Utils\JsonHelper; use Core\Utils\JsonHelper;
@@ -28,7 +28,7 @@ class ApiHelper
public static function getJsonHelper(): JsonHelper public static function getJsonHelper(): JsonHelper
{ {
if (self::$jsonHelper == null) { if (self::$jsonHelper == null) {
self::$jsonHelper = new JsonHelper([], [], null, 'PaypalServerSdkLib\\Models'); self::$jsonHelper = new JsonHelper([], [], null, 'PaypalServerSDKLib\\Models');
} }
return self::$jsonHelper; return self::$jsonHelper;
} }

View File

@@ -3,15 +3,15 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/ */
namespace PaypalServerSdkLib\Authentication; namespace PaypalServerSDKLib\Authentication;
use Core\Utils\CoreHelper; use Core\Utils\CoreHelper;
use PaypalServerSdkLib\Models\OAuthToken; use PaypalServerSDKLib\Models\OAuthToken;
/** /**
* Utility class for initializing ClientCredentialsAuth security credentials. * Utility class for initializing ClientCredentialsAuth security credentials.

View File

@@ -3,12 +3,12 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/ */
namespace PaypalServerSdkLib\Authentication; namespace PaypalServerSDKLib\Authentication;
use Closure; use Closure;
use Exception; use Exception;
@@ -18,10 +18,10 @@ use Core\Client;
use Core\Request\Parameters\HeaderParam; use Core\Request\Parameters\HeaderParam;
use Core\Utils\CoreHelper; use Core\Utils\CoreHelper;
use InvalidArgumentException; use InvalidArgumentException;
use PaypalServerSdkLib\Models\OAuthToken; use PaypalServerSDKLib\Models\OAuthToken;
use PaypalServerSdkLib\Controllers\OAuthAuthorizationController; use PaypalServerSDKLib\Controllers\OAuthAuthorizationController;
use PaypalServerSdkLib\ConfigurationDefaults; use PaypalServerSDKLib\ConfigurationDefaults;
use PaypalServerSdkLib\ClientCredentialsAuth; use PaypalServerSDKLib\ClientCredentialsAuth;
/** /**
* Utility class for OAuth 2 authorization and token management * Utility class for OAuth 2 authorization and token management

View File

@@ -3,14 +3,14 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * 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. * Interface for defining the behavior of Authentication.

View File

@@ -3,12 +3,12 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/ */
namespace PaypalServerSdkLib; namespace PaypalServerSDKLib;
use Psr\Log\LogLevel; use Psr\Log\LogLevel;

View File

@@ -3,16 +3,16 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/ */
namespace PaypalServerSdkLib; namespace PaypalServerSDKLib;
use CoreInterfaces\Http\HttpConfigurations; use CoreInterfaces\Http\HttpConfigurations;
use PaypalServerSdkLib\Authentication\ClientCredentialsAuthCredentialsBuilder; use PaypalServerSDKLib\Authentication\ClientCredentialsAuthCredentialsBuilder;
use PaypalServerSdkLib\Logging\LoggingConfigurationBuilder; use PaypalServerSDKLib\Logging\LoggingConfigurationBuilder;
/** /**
* An interface for all configuration parameters required by the SDK. * An interface for all configuration parameters required by the SDK.

View File

@@ -3,12 +3,12 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/ */
namespace PaypalServerSdkLib\Controllers; namespace PaypalServerSDKLib\Controllers;
use Core\ApiCall; use Core\ApiCall;
use Core\Client; use Core\Client;

View File

@@ -3,21 +3,21 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * 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\AdditionalFormParams;
use Core\Request\Parameters\FormParam; use Core\Request\Parameters\FormParam;
use Core\Request\Parameters\HeaderParam; use Core\Request\Parameters\HeaderParam;
use Core\Response\Types\ErrorType; use Core\Response\Types\ErrorType;
use CoreInterfaces\Core\Request\RequestMethod; use CoreInterfaces\Core\Request\RequestMethod;
use PaypalServerSdkLib\Exceptions\OAuthProviderException; use PaypalServerSDKLib\Exceptions\OAuthProviderException;
use PaypalServerSdkLib\Http\ApiResponse; use PaypalServerSDKLib\Http\ApiResponse;
use PaypalServerSdkLib\Models\OAuthToken; use PaypalServerSDKLib\Models\OAuthToken;
class OAuthAuthorizationController extends BaseController class OAuthAuthorizationController extends BaseController
{ {

View File

@@ -3,12 +3,12 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * 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\BodyParam;
use Core\Request\Parameters\HeaderParam; use Core\Request\Parameters\HeaderParam;
@@ -16,10 +16,10 @@ use Core\Request\Parameters\QueryParam;
use Core\Request\Parameters\TemplateParam; use Core\Request\Parameters\TemplateParam;
use Core\Response\Types\ErrorType; use Core\Response\Types\ErrorType;
use CoreInterfaces\Core\Request\RequestMethod; use CoreInterfaces\Core\Request\RequestMethod;
use PaypalServerSdkLib\Exceptions\ErrorException; use PaypalServerSDKLib\Exceptions\ErrorException;
use PaypalServerSdkLib\Http\ApiResponse; use PaypalServerSDKLib\Http\ApiResponse;
use PaypalServerSdkLib\Models\Order; use PaypalServerSDKLib\Models\Order;
use PaypalServerSdkLib\Models\OrderAuthorizeResponse; use PaypalServerSDKLib\Models\OrderAuthorizeResponse;
class OrdersController extends BaseController class OrdersController extends BaseController
{ {
@@ -43,11 +43,10 @@ class OrdersController extends BaseController
->parameters( ->parameters(
HeaderParam::init('Content-Type', 'application/json'), HeaderParam::init('Content-Type', 'application/json'),
BodyParam::init($options)->extract('body'), BodyParam::init($options)->extract('body'),
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'), HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
HeaderParam::init('PayPal-Partner-Attribution-Id', $options)->extract('paypalPartnerAttributionId'), HeaderParam::init('PayPal-Partner-Attribution-Id', $options)->extract('payPalPartnerAttributionId'),
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'), HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'), HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal')
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion')
); );
$_resHandler = $this->responseHandler() $_resHandler = $this->responseHandler()
@@ -96,7 +95,6 @@ class OrdersController extends BaseController
->auth('Oauth2') ->auth('Oauth2')
->parameters( ->parameters(
TemplateParam::init('id', $options)->extract('id'), TemplateParam::init('id', $options)->extract('id'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
QueryParam::init('fields', $options)->extract('fields') QueryParam::init('fields', $options)->extract('fields')
); );
@@ -169,7 +167,6 @@ class OrdersController extends BaseController
->parameters( ->parameters(
TemplateParam::init('id', $options)->extract('id'), TemplateParam::init('id', $options)->extract('id'),
HeaderParam::init('Content-Type', 'application/json'), HeaderParam::init('Content-Type', 'application/json'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
BodyParam::init($options)->extract('body') BodyParam::init($options)->extract('body')
); );
@@ -221,8 +218,7 @@ class OrdersController extends BaseController
->parameters( ->parameters(
TemplateParam::init('id', $options)->extract('id'), TemplateParam::init('id', $options)->extract('id'),
HeaderParam::init('Content-Type', 'application/json'), HeaderParam::init('Content-Type', 'application/json'),
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'), HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'), HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
BodyParam::init($options)->extract('body') BodyParam::init($options)->extract('body')
); );
@@ -274,10 +270,10 @@ class OrdersController extends BaseController
->parameters( ->parameters(
TemplateParam::init('id', $options)->extract('id'), TemplateParam::init('id', $options)->extract('id'),
HeaderParam::init('Content-Type', 'application/json'), 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('Prefer', $options)->extract('prefer', 'return=minimal'),
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'), HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'), HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'),
BodyParam::init($options)->extract('body') BodyParam::init($options)->extract('body')
); );
@@ -340,10 +336,10 @@ class OrdersController extends BaseController
->parameters( ->parameters(
TemplateParam::init('id', $options)->extract('id'), TemplateParam::init('id', $options)->extract('id'),
HeaderParam::init('Content-Type', 'application/json'), 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('Prefer', $options)->extract('prefer', 'return=minimal'),
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'), HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('payPalClientMetadataId'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'), HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'),
BodyParam::init($options)->extract('body') BodyParam::init($options)->extract('body')
); );
@@ -402,7 +398,7 @@ class OrdersController extends BaseController
TemplateParam::init('id', $options)->extract('id'), TemplateParam::init('id', $options)->extract('id'),
HeaderParam::init('Content-Type', 'application/json'), HeaderParam::init('Content-Type', 'application/json'),
BodyParam::init($options)->extract('body'), BodyParam::init($options)->extract('body'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion') HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion')
); );
$_resHandler = $this->responseHandler() $_resHandler = $this->responseHandler()
@@ -459,7 +455,6 @@ class OrdersController extends BaseController
TemplateParam::init('id', $options)->extract('id'), TemplateParam::init('id', $options)->extract('id'),
TemplateParam::init('tracker_id', $options)->extract('trackerId'), TemplateParam::init('tracker_id', $options)->extract('trackerId'),
HeaderParam::init('Content-Type', 'application/json'), HeaderParam::init('Content-Type', 'application/json'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
BodyParam::init($options)->extract('body') BodyParam::init($options)->extract('body')
); );

View File

@@ -3,41 +3,38 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * 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\BodyParam;
use Core\Request\Parameters\HeaderParam; use Core\Request\Parameters\HeaderParam;
use Core\Request\Parameters\TemplateParam; use Core\Request\Parameters\TemplateParam;
use Core\Response\Types\ErrorType; use Core\Response\Types\ErrorType;
use CoreInterfaces\Core\Request\RequestMethod; use CoreInterfaces\Core\Request\RequestMethod;
use PaypalServerSdkLib\Exceptions\ErrorException; use PaypalServerSDKLib\Exceptions\ErrorException;
use PaypalServerSdkLib\Http\ApiResponse; use PaypalServerSDKLib\Http\ApiResponse;
use PaypalServerSdkLib\Models\CapturedPayment; use PaypalServerSDKLib\Models\CapturedPayment;
use PaypalServerSdkLib\Models\PaymentAuthorization; use PaypalServerSDKLib\Models\PaymentAuthorization;
use PaypalServerSdkLib\Models\Refund; use PaypalServerSDKLib\Models\Refund;
class PaymentsController extends BaseController class PaymentsController extends BaseController
{ {
/** /**
* Shows details for an authorized payment, by ID. * Shows details for an authorized payment, by ID.
* *
* @param array $options Array with all options for search * @param string $authorizationId The ID of the authorized payment for which to show details.
* *
* @return ApiResponse Response from the API call * @return ApiResponse Response from the API call
*/ */
public function authorizationsGet(array $options): ApiResponse public function authorizationsGet(string $authorizationId): ApiResponse
{ {
$_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payments/authorizations/{authorization_id}') $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payments/authorizations/{authorization_id}')
->auth('Oauth2') ->auth('Oauth2')
->parameters( ->parameters(TemplateParam::init('authorization_id', $authorizationId));
TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion')
);
$_resHandler = $this->responseHandler() $_resHandler = $this->responseHandler()
->throwErrorOn( ->throwErrorOn(
@@ -48,6 +45,13 @@ class PaymentsController extends BaseController
ErrorException::class ErrorException::class
) )
) )
->throwErrorOn(
'403',
ErrorType::init(
'The request failed because the caller has insufficient permissions.',
ErrorException::class
)
)
->throwErrorOn( ->throwErrorOn(
'404', '404',
ErrorType::init('The request failed because the resource does not exist.', ErrorException::class) ErrorType::init('The request failed because the resource does not exist.', ErrorException::class)
@@ -77,9 +81,8 @@ class PaymentsController extends BaseController
->parameters( ->parameters(
TemplateParam::init('authorization_id', $options)->extract('authorizationId'), TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
HeaderParam::init('Content-Type', 'application/json'), 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('Prefer', $options)->extract('prefer', 'return=minimal'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
BodyParam::init($options)->extract('body') BodyParam::init($options)->extract('body')
); );
@@ -160,9 +163,8 @@ class PaymentsController extends BaseController
->parameters( ->parameters(
TemplateParam::init('authorization_id', $options)->extract('authorizationId'), TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
HeaderParam::init('Content-Type', 'application/json'), 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('Prefer', $options)->extract('prefer', 'return=minimal'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
BodyParam::init($options)->extract('body') BodyParam::init($options)->extract('body')
); );
@@ -183,6 +185,13 @@ class PaymentsController extends BaseController
ErrorException::class ErrorException::class
) )
) )
->throwErrorOn(
'403',
ErrorType::init(
'The request failed because the caller has insufficient permissions.',
ErrorException::class
)
)
->throwErrorOn( ->throwErrorOn(
'404', '404',
ErrorType::init('The request failed because the resource does not exist.', ErrorException::class) ErrorType::init('The request failed because the resource does not exist.', ErrorException::class)
@@ -220,12 +229,19 @@ class PaymentsController extends BaseController
->auth('Oauth2') ->auth('Oauth2')
->parameters( ->parameters(
TemplateParam::init('authorization_id', $options)->extract('authorizationId'), TemplateParam::init('authorization_id', $options)->extract('authorizationId'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'), HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('payPalAuthAssertion'),
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal') HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal')
); );
$_resHandler = $this->responseHandler() $_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( ->throwErrorOn(
'401', '401',
ErrorType::init( ErrorType::init(
@@ -326,9 +342,9 @@ class PaymentsController extends BaseController
->parameters( ->parameters(
TemplateParam::init('capture_id', $options)->extract('captureId'), TemplateParam::init('capture_id', $options)->extract('captureId'),
HeaderParam::init('Content-Type', 'application/json'), 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('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') BodyParam::init($options)->extract('body')
); );
@@ -386,18 +402,15 @@ class PaymentsController extends BaseController
/** /**
* Shows details for a refund, by ID. * Shows details for a refund, by ID.
* *
* @param array $options Array with all options for search * @param string $refundId The PayPal-generated ID for the refund for which to show details.
* *
* @return ApiResponse Response from the API call * @return ApiResponse Response from the API call
*/ */
public function refundsGet(array $options): ApiResponse public function refundsGet(string $refundId): ApiResponse
{ {
$_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payments/refunds/{refund_id}') $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payments/refunds/{refund_id}')
->auth('Oauth2') ->auth('Oauth2')
->parameters( ->parameters(TemplateParam::init('refund_id', $refundId));
TemplateParam::init('refund_id', $options)->extract('refundId'),
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion')
);
$_resHandler = $this->responseHandler() $_resHandler = $this->responseHandler()
->throwErrorOn( ->throwErrorOn(

View File

@@ -3,12 +3,12 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * 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\BodyParam;
use Core\Request\Parameters\HeaderParam; use Core\Request\Parameters\HeaderParam;
@@ -16,11 +16,11 @@ use Core\Request\Parameters\QueryParam;
use Core\Request\Parameters\TemplateParam; use Core\Request\Parameters\TemplateParam;
use Core\Response\Types\ErrorType; use Core\Response\Types\ErrorType;
use CoreInterfaces\Core\Request\RequestMethod; use CoreInterfaces\Core\Request\RequestMethod;
use PaypalServerSdkLib\Exceptions\ErrorException; use PaypalServerSDKLib\Exceptions\ErrorException;
use PaypalServerSdkLib\Http\ApiResponse; use PaypalServerSDKLib\Http\ApiResponse;
use PaypalServerSdkLib\Models\CustomerVaultPaymentTokensResponse; use PaypalServerSDKLib\Models\CustomerVaultPaymentTokensResponse;
use PaypalServerSdkLib\Models\PaymentTokenResponse; use PaypalServerSDKLib\Models\PaymentTokenResponse;
use PaypalServerSdkLib\Models\SetupTokenResponse; use PaypalServerSDKLib\Models\SetupTokenResponse;
class VaultController extends BaseController class VaultController extends BaseController
{ {
@@ -37,7 +37,7 @@ class VaultController extends BaseController
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/payment-tokens') $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/payment-tokens')
->auth('Oauth2') ->auth('Oauth2')
->parameters( ->parameters(
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'), HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
HeaderParam::init('Content-Type', 'application/json'), HeaderParam::init('Content-Type', 'application/json'),
BodyParam::init($options)->extract('body') BodyParam::init($options)->extract('body')
); );
@@ -191,7 +191,7 @@ class VaultController extends BaseController
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/setup-tokens') $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v3/vault/setup-tokens')
->auth('Oauth2') ->auth('Oauth2')
->parameters( ->parameters(
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'), HeaderParam::init('PayPal-Request-Id', $options)->extract('payPalRequestId'),
HeaderParam::init('Content-Type', 'application/json'), HeaderParam::init('Content-Type', 'application/json'),
BodyParam::init($options)->extract('body') BodyParam::init($options)->extract('body')
); );

View File

@@ -3,12 +3,12 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/ */
namespace PaypalServerSdkLib; namespace PaypalServerSDKLib;
/** /**
* Environments available for API * Environments available for API

View File

@@ -3,16 +3,16 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/ */
namespace PaypalServerSdkLib\Exceptions; namespace PaypalServerSDKLib\Exceptions;
use CoreInterfaces\Sdk\ExceptionInterface; use CoreInterfaces\Sdk\ExceptionInterface;
use PaypalServerSdkLib\Http\HttpResponse; use PaypalServerSDKLib\Http\HttpResponse;
use PaypalServerSdkLib\Http\HttpRequest; use PaypalServerSDKLib\Http\HttpRequest;
/** /**
* Thrown when there is a network error or HTTP response status code is not okay. * Thrown when there is a network error or HTTP response status code is not okay.

View File

@@ -3,12 +3,12 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/ */
namespace PaypalServerSdkLib\Exceptions; namespace PaypalServerSDKLib\Exceptions;
/** /**
* The error details. * The error details.
@@ -31,27 +31,27 @@ class ErrorException extends ApiException
private $debugId; private $debugId;
/** /**
* @var \PaypalServerSdkLib\Models\ErrorDetails[]|null * @var \PaypalServerSDKLib\Models\ErrorDetails[]|null
*/ */
private $details; private $details;
/** /**
* @var \PaypalServerSdkLib\Models\LinkDescription[]|null * @var \PaypalServerSDKLib\Models\LinkDescription[]|null
*/ */
private $links; private $links;
/** /**
* @param string $reason * @param string $reason
* @param \PaypalServerSdkLib\Http\HttpRequest $request * @param \PaypalServerSDKLib\Http\HttpRequest $request
* @param \PaypalServerSdkLib\Http\HttpResponse $response * @param \PaypalServerSDKLib\Http\HttpResponse $response
* @param string $name * @param string $name
* @param string $messageProperty * @param string $messageProperty
* @param string $debugId * @param string $debugId
*/ */
public function __construct( public function __construct(
string $reason, string $reason,
\PaypalServerSdkLib\Http\HttpRequest $request, \PaypalServerSDKLib\Http\HttpRequest $request,
\PaypalServerSdkLib\Http\HttpResponse $response, \PaypalServerSDKLib\Http\HttpResponse $response,
string $name, string $name,
string $messageProperty, string $messageProperty,
string $debugId string $debugId
@@ -129,7 +129,7 @@ class ErrorException extends ApiException
* Returns Details. * Returns Details.
* An array of additional details about the error. * An array of additional details about the error.
* *
* @return \PaypalServerSdkLib\Models\ErrorDetails[]|null * @return \PaypalServerSDKLib\Models\ErrorDetails[]|null
*/ */
public function getDetails(): ?array public function getDetails(): ?array
{ {
@@ -142,7 +142,7 @@ class ErrorException extends ApiException
* *
* @maps details * @maps details
* *
* @param \PaypalServerSdkLib\Models\ErrorDetails[]|null $details * @param \PaypalServerSDKLib\Models\ErrorDetails[]|null $details
*/ */
public function setDetails(?array $details): void public function setDetails(?array $details): void
{ {
@@ -153,7 +153,7 @@ class ErrorException extends ApiException
* Returns Links. * Returns Links.
* An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-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 public function getLinks(): ?array
{ {
@@ -166,7 +166,7 @@ class ErrorException extends ApiException
* *
* @maps links * @maps links
* *
* @param \PaypalServerSdkLib\Models\LinkDescription[]|null $links * @param \PaypalServerSDKLib\Models\LinkDescription[]|null $links
*/ */
public function setLinks(?array $links): void public function setLinks(?array $links): void
{ {

View File

@@ -3,12 +3,12 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/ */
namespace PaypalServerSdkLib\Exceptions; namespace PaypalServerSDKLib\Exceptions;
/** /**
* OAuth 2 Authorization endpoint exception. * OAuth 2 Authorization endpoint exception.
@@ -32,14 +32,14 @@ class OAuthProviderException extends ApiException
/** /**
* @param string $reason * @param string $reason
* @param \PaypalServerSdkLib\Http\HttpRequest $request * @param \PaypalServerSDKLib\Http\HttpRequest $request
* @param \PaypalServerSdkLib\Http\HttpResponse $response * @param \PaypalServerSDKLib\Http\HttpResponse $response
* @param string $error * @param string $error
*/ */
public function __construct( public function __construct(
string $reason, string $reason,
\PaypalServerSdkLib\Http\HttpRequest $request, \PaypalServerSDKLib\Http\HttpRequest $request,
\PaypalServerSdkLib\Http\HttpResponse $response, \PaypalServerSDKLib\Http\HttpResponse $response,
string $error string $error
) { ) {
parent::__construct($reason, $request, $response); parent::__construct($reason, $request, $response);
@@ -61,7 +61,7 @@ class OAuthProviderException extends ApiException
* *
* @required * @required
* @maps error * @maps error
* @factory \PaypalServerSdkLib\Models\OAuthProviderError::checkValue * @factory \PaypalServerSDKLib\Models\OAuthProviderError::checkValue
*/ */
public function setError(string $error): void public function setError(string $error): void
{ {

View File

@@ -3,12 +3,12 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/ */
namespace PaypalServerSdkLib\Http; namespace PaypalServerSDKLib\Http;
use Core\Types\Sdk\CoreApiResponse; use Core\Types\Sdk\CoreApiResponse;

View File

@@ -3,12 +3,12 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/ */
namespace PaypalServerSdkLib\Http; namespace PaypalServerSDKLib\Http;
use Core\Types\Sdk\CoreCallback; use Core\Types\Sdk\CoreCallback;

View File

@@ -3,12 +3,12 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/ */
namespace PaypalServerSdkLib\Http; namespace PaypalServerSDKLib\Http;
use Core\Types\Sdk\CoreContext; use Core\Types\Sdk\CoreContext;

View File

@@ -3,12 +3,12 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/ */
namespace PaypalServerSdkLib\Http; namespace PaypalServerSDKLib\Http;
use CoreInterfaces\Core\Request\RequestMethod; use CoreInterfaces\Core\Request\RequestMethod;

View File

@@ -3,12 +3,12 @@
declare(strict_types=1); declare(strict_types=1);
/* /*
* PaypalServerSdkLib * PaypalServerSDKLib
* *
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/ */
namespace PaypalServerSdkLib\Http; namespace PaypalServerSDKLib\Http;
use Core\Types\Sdk\CoreRequest; use Core\Types\Sdk\CoreRequest;

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