forked from LiveCarta/PayPal-PHP-Server-SDK
Compare commits
9 Commits
0.5.0
...
initialize
| Author | SHA1 | Date | |
|---|---|---|---|
|
f465f0920c | ||
|
|
7d36472b6e | ||
|
|
1522ab5293 | ||
|
|
eb2608f55a | ||
|
|
09148245f7 | ||
|
|
b8521e83cc | ||
|
|
f423f69aee | ||
|
|
6b43a4225b | ||
|
|
b20aa829db |
10
.codegenignore
Normal file
10
.codegenignore
Normal file
@@ -0,0 +1,10 @@
|
||||
tests/E2E/**
|
||||
tests/UnitTests/**
|
||||
tests/ClientFactory.php
|
||||
tests/WebDriverUtilities.php
|
||||
tests/bootstrap.php
|
||||
tests/Controllers/BaseTestController.php
|
||||
.gitignore
|
||||
.github/**
|
||||
phpunit.xml
|
||||
selenium.jar
|
||||
1
.gitattributes
vendored
Normal file
1
.gitattributes
vendored
Normal file
@@ -0,0 +1 @@
|
||||
**/*.php -lf
|
||||
46
.github/workflows/test-runner.yml
vendored
Normal file
46
.github/workflows/test-runner.yml
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
name: Tests
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
test:
|
||||
name: Running all tests
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Set up PHP
|
||||
uses: shivammathur/setup-php@v2
|
||||
with:
|
||||
php-version: '8.2'
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
composer install
|
||||
composer require php-webdriver/webdriver --dev
|
||||
composer require phpunit/phpunit --dev
|
||||
|
||||
- name: Run Lint Tests
|
||||
run: composer lint
|
||||
|
||||
- name: Run Analyzer Tests
|
||||
run: composer analyze
|
||||
|
||||
- name: Set up Java 11
|
||||
uses: actions/setup-java@v3
|
||||
with:
|
||||
java-version: '11'
|
||||
distribution: 'temurin'
|
||||
|
||||
- name: Run Selenium Server
|
||||
run: java -jar selenium.jar standalone &
|
||||
|
||||
- name: Run tests
|
||||
run: ./vendor/bin/phpunit --testdox
|
||||
env:
|
||||
CLIENT_ID: ${{ secrets.CLIENT_ID }}
|
||||
CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
|
||||
EMAIL: ${{ secrets.EMAIL }}
|
||||
PASSWORD: ${{ secrets.PASSWORD }}
|
||||
4
.gitignore
vendored
Normal file
4
.gitignore
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
composer.phar
|
||||
vendor/
|
||||
.phpunit.result.cache
|
||||
coverage/
|
||||
79
.phan/config.php
Normal file
79
.phan/config.php
Normal file
@@ -0,0 +1,79 @@
|
||||
<?php
|
||||
|
||||
$vendor_dir = getenv('COMPOSER_VENDOR_DIR') ?: 'vendor';
|
||||
|
||||
/**
|
||||
* This configuration will be read and overlaid on top of the
|
||||
* default configuration. Command line arguments will be applied
|
||||
* after this file is read.
|
||||
*/
|
||||
return [
|
||||
// Supported values: `'5.6'`, `'7.0'`, `'7.1'`, `'7.2'`, `'7.3'`, `null`.
|
||||
// If this is set to `null`,
|
||||
// then Phan assumes the PHP version which is closest to the minor version
|
||||
// of the php executable used to execute Phan.
|
||||
//
|
||||
// Note that the **only** effect of choosing `'5.6'` is to infer that functions removed in php 7.0 exist.
|
||||
// (See `backward_compatibility_checks` for additional options)
|
||||
'target_php_version' => '7.2',
|
||||
|
||||
// A list of directories that should be parsed for class and
|
||||
// method information. After excluding the directories
|
||||
// defined in exclude_analysis_directory_list, the remaining
|
||||
// files will be statically analyzed for errors.
|
||||
//
|
||||
// Thus, both first-party and third-party code being used by
|
||||
// your application should be included in this list.
|
||||
'directory_list' => [
|
||||
'src',
|
||||
$vendor_dir . '/psr/log',
|
||||
$vendor_dir . '/apimatic/unirest-php',
|
||||
$vendor_dir . '/apimatic/core',
|
||||
$vendor_dir . '/apimatic/core-interfaces'
|
||||
],
|
||||
|
||||
// A directory list that defines files that will be excluded
|
||||
// from static analysis, but whose class and method
|
||||
// information should be included.
|
||||
//
|
||||
// Generally, you'll want to include the directories for
|
||||
// third-party code (such as "vendor/") in this list.
|
||||
//
|
||||
// n.b.: If you'd like to parse but not analyze 3rd
|
||||
// party code, directories containing that code
|
||||
// should be added to both the `directory_list`
|
||||
// and `exclude_analysis_directory_list` arrays.
|
||||
'exclude_analysis_directory_list' => [
|
||||
$vendor_dir
|
||||
],
|
||||
|
||||
'plugin_config' => [
|
||||
'infer_pure_methods' => true
|
||||
],
|
||||
|
||||
'plugins' => [
|
||||
'AlwaysReturnPlugin',
|
||||
'DuplicateArrayKeyPlugin',
|
||||
'PregRegexCheckerPlugin',
|
||||
'PrintfCheckerPlugin',
|
||||
'UnreachableCodePlugin',
|
||||
'InvokePHPNativeSyntaxCheckPlugin',
|
||||
'UseReturnValuePlugin',
|
||||
'EmptyStatementListPlugin',
|
||||
'LoopVariableReusePlugin',
|
||||
'RedundantAssignmentPlugin',
|
||||
'NonBoolBranchPlugin',
|
||||
'NonBoolInLogicalArithPlugin',
|
||||
'InvalidVariableIssetPlugin',
|
||||
'NoAssertPlugin',
|
||||
'DuplicateExpressionPlugin',
|
||||
'WhitespacePlugin',
|
||||
'PHPDocToRealTypesPlugin',
|
||||
'PHPDocRedundantPlugin',
|
||||
'PreferNamespaceUsePlugin',
|
||||
'StrictComparisonPlugin',
|
||||
'EmptyMethodAndFunctionPlugin',
|
||||
'DollarDollarPlugin',
|
||||
'AvoidableGetterPlugin'
|
||||
]
|
||||
];
|
||||
35
LICENSE
Normal file
35
LICENSE
Normal file
@@ -0,0 +1,35 @@
|
||||
The PayPal Server SDK is released under the following license:
|
||||
|
||||
Copyright (c) 2024 PAYPAL, INC.
|
||||
|
||||
SDK LICENSE
|
||||
|
||||
NOTICE TO USER: PayPal, Inc. is providing the Software and Documentation for use under the terms of this Agreement. Any use, reproduction, modification or distribution of the Software or Documentation, or any derivatives or portions hereof, constitutes your acceptance of this Agreement.
|
||||
As used in this Agreement, "PayPal" means PayPal, Inc. "Software" means the software code accompanying this agreement. "Documentation" means the documents, specifications and all other items accompanying this Agreement other than the Software.
|
||||
|
||||
1. LICENSE GRANT
|
||||
Subject to the terms of this Agreement, PayPal hereby grants you a non-exclusive, worldwide, royalty free license to use, reproduce, prepare derivative works from, publicly display, publicly perform, distribute and sublicense the Software for any purpose, other than perpetration of any fraud or violation of any law, statute, ordinance, or regulation (for example, those governing financial services, consumer protections, unfair competition, anti-discrimination or false advertising), provided the copyright notice below appears in a conspicuous location within the source code of the distributed Software and this license is distributed in the supporting documentation of the Software you distribute. Furthermore, you must comply with all third party licenses in order to use the third party software contained in the Software.
|
||||
Subject to the terms of this Agreement, PayPal hereby grants you a non-exclusive, worldwide, royalty free license to use, reproduce, publicly display, publicly perform, distribute and sublicense the Documentation for any purpose, other than perpetration of any fraud or violation of any law, statute, ordinance, or regulation (for example, those governing financial services, consumer protections, unfair competition, anti-discrimination or false advertising). You may not modify the Documentation.
|
||||
No title to the intellectual property in the Software or Documentation is transferred to you under the terms of this Agreement. You do not acquire any rights to the Software or the Documentation except as expressly set forth in this Agreement.
|
||||
Nothing in this Agreement provides you with any right, title, or license to use PayPal’s or any third party’s copyright, patent, trademark, trade secret, or other intellectual property rights, or rights of publicity or privacy, beyond the rights specifically granted herein. You may not infringe PayPal’s or any third party’s copyright, patent, trademark, trade secret, or other intellectual property rights, or rights of publicity or privacy.
|
||||
If you choose to distribute the Software in a commercial product, you do so with the understanding that you agree to defend, indemnify and hold harmless PayPal and its suppliers against any losses, damages and costs arising from the claims, lawsuits or other legal actions arising out of such distribution. You may distribute the Software in object code form under your own license, provided that your license agreement:
|
||||
(a) complies with the terms and conditions of this license agreement;
|
||||
(b) effectively disclaims all warranties and conditions, express or implied, on behalf of PayPal;
|
||||
(c) effectively excludes all liability for damages on behalf of PayPal;
|
||||
(d) states that any provisions that differ from this Agreement are offered by you alone and not PayPal; and
|
||||
(e) states that the Software is available from you or PayPal and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
|
||||
|
||||
2. DISCLAIMER OF WARRANTY
|
||||
PAYPAL LICENSES THE SOFTWARE AND DOCUMENTATION TO YOU ONLY ON AN "AS IS" BASIS WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. PAYPAL MAKES NO WARRANTY THAT THE SOFTWARE OR DOCUMENTATION WILL BE ERROR-FREE. Each user of the Software or Documentation is solely responsible for determining the appropriateness of using and distributing the Software and Documentation and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs, or equipment, and unavailability or interruption of operations. Use of the Software and Documentation is made with the understanding that PayPal will not provide you with any technical or customer support or maintenance. Some states or jurisdictions do not allow the exclusion of implied warranties or limitations on how long an implied warranty may last, so the above limitations may not apply to you. To the extent permissible, any implied warranties are limited to ninety (90) days.
|
||||
|
||||
3. LIMITATION OF LIABILITY
|
||||
PAYPAL AND ITS SUPPLIERS SHALL NOT BE LIABLE FOR LOSS OR DAMAGE ARISING OUT OF THIS AGREEMENT OR FROM THE USE OF THE SOFTWARE OR DOCUMENTATION. IN NO EVENT WILL PAYPAL OR ITS SUPPLIERS BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, INCIDENTAL, OR SPECIAL DAMAGES INCLUDING LOST PROFITS, LOST SAVINGS, COSTS, FEES, OR EXPENSES OF ANY KIND ARISING OUT OF ANY PROVISION OF THIS AGREEMENT OR THE USE OR THE INABILITY TO USE THE SOFTWARE OR DOCUMENTATION, HOWEVER CAUSED AND UNDER ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR TORT INCLUDING NEGLIGENCE (OR OTHERWISE), EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. PAYPAL'S AGGREGATE LIABILITY AND THAT OF ITS SUPPLIERS UNDER OR IN CONNECTION WITH THIS AGREEMENT SHALL BE LIMITED TO THE AMOUNT PAID BY YOU FOR THE SOFTWARE AND DOCUMENTATION.
|
||||
|
||||
4. TRADEMARK USAGE
|
||||
PayPal is a trademark PayPal, Inc. in the United States and other countries. Such trademarks may not be used to endorse or promote any product unless expressly permitted under separate agreement with PayPal.
|
||||
|
||||
5. TERM
|
||||
Your rights under this Agreement shall terminate if you fail to comply with any of the material terms or conditions of this Agreement and do not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all your rights under this Agreement terminate, you agree to cease use and distribution of the Software and Documentation as soon as reasonably practicable.
|
||||
|
||||
6. GOVERNING LAW AND JURISDICTION.
|
||||
This Agreement is governed by the statutes and laws of the State of California, without regard to the conflicts of law principles thereof. If any part of this Agreement is found void and unenforceable, it will not affect the validity of the balance of the Agreement, which shall remain valid and enforceable according to its terms. Any dispute arising out of or related to this Agreement shall be brought in the courts of Santa Clara County, California, USA.
|
||||
110
README.md
110
README.md
@@ -1 +1,109 @@
|
||||
# PayPal-PHP-Server-SDK
|
||||
|
||||
# Getting Started with Paypal Server SDK
|
||||
|
||||
## Introduction
|
||||
|
||||
An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders., Call the Payments API to authorize payments, capture authorized payments, refund payments that have already been captured, and show payment information. Use the Payments API in conjunction with the <a href="/docs/api/orders/v2/">Orders API</a>. For more information, see the <a href="/docs/checkout/">PayPal Checkout Overview</a>., The Payment Method Tokens API saves payment methods so payers don't have to enter details for future transactions. Payers can check out faster or pay without being present after they agree to save a payment method.<br><br>The API associates a payment method with a temporary setup token. Pass the setup token to the API to exchange the setup token for a permanent token.<br><br>The permanent token represents a payment method that's saved to the vault. This token can be used repeatedly for checkout or recurring transactions such as subscriptions.<br><br>The Payment Method Tokens API is available in the US only.
|
||||
|
||||
Find out more here: [https://developer.paypal.com/docs/api/orders/v2/](https://developer.paypal.com/docs/api/orders/v2/)
|
||||
|
||||
## Install the Package
|
||||
|
||||
Run the following command to install the package and automatically add the dependency to your composer.json file:
|
||||
|
||||
```php
|
||||
composer require "paypal/paypal-server-sdk:0.5.1"
|
||||
```
|
||||
|
||||
Or add it to the composer.json file manually as given below:
|
||||
|
||||
```php
|
||||
"require": {
|
||||
"paypal/paypal-server-sdk": "0.5.1"
|
||||
}
|
||||
```
|
||||
|
||||
You can also view the package at:
|
||||
https://packagist.org/packages/paypal/paypal-server-sdk#0.5.1
|
||||
|
||||
## Initialize the API Client
|
||||
|
||||
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/client.md)
|
||||
|
||||
The following parameters are configurable for the API Client:
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| `environment` | `Environment` | The API environment. <br> **Default: `Environment.SANDBOX`** |
|
||||
| `timeout` | `int` | Timeout for API calls in seconds.<br>*Default*: `0` |
|
||||
| `enableRetries` | `bool` | Whether to enable retries and backoff feature.<br>*Default*: `false` |
|
||||
| `numberOfRetries` | `int` | The number of retries to make.<br>*Default*: `0` |
|
||||
| `retryInterval` | `float` | The retry time interval between the endpoint calls.<br>*Default*: `1` |
|
||||
| `backOffFactor` | `float` | Exponential backoff factor to increase interval between retries.<br>*Default*: `2` |
|
||||
| `maximumRetryWaitTime` | `int` | The maximum wait time in seconds for overall retrying requests.<br>*Default*: `0` |
|
||||
| `retryOnTimeout` | `bool` | Whether to retry on request timeout.<br>*Default*: `true` |
|
||||
| `httpStatusCodesToRetry` | `array` | Http status codes to retry against.<br>*Default*: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524` |
|
||||
| `httpMethodsToRetry` | `array` | Http methods to retry against.<br>*Default*: `'GET', 'PUT'` |
|
||||
| `loggingConfiguration` | [`LoggingConfigurationBuilder`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/logging-configuration-builder.md) | Represents the logging configurations for API calls |
|
||||
| `clientCredentialsAuth` | [`ClientCredentialsAuth`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/auth/oauth-2-client-credentials-grant.md) | The Credentials Setter for OAuth 2 Client Credentials Grant |
|
||||
|
||||
The API client can be initialized as follows:
|
||||
|
||||
```php
|
||||
$client = PaypalServerSDKClientBuilder::init()
|
||||
->clientCredentialsAuthCredentials(
|
||||
ClientCredentialsAuthCredentialsBuilder::init(
|
||||
'OAuthClientId',
|
||||
'OAuthClientSecret'
|
||||
)
|
||||
)
|
||||
->environment(Environment::SANDBOX)
|
||||
->loggingConfiguration(
|
||||
LoggingConfigurationBuilder::init()
|
||||
->level(LogLevel::INFO)
|
||||
->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
|
||||
->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
|
||||
)
|
||||
->build();
|
||||
```
|
||||
|
||||
API calls return an `ApiResponse` object that includes the following fields:
|
||||
|
||||
| Field | Description |
|
||||
| --- | --- |
|
||||
| `getStatusCode` | Status code of the HTTP response |
|
||||
| `getHeaders` | Headers of the HTTP response as a Hash |
|
||||
| `getResult` | The deserialized body of the HTTP response as a String |
|
||||
|
||||
## Environments
|
||||
|
||||
The SDK can be configured to use a different environment for making API calls. Available environments are:
|
||||
|
||||
### Fields
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| Production | PayPal Live Environment |
|
||||
| Sandbox | **Default** PayPal Sandbox Environment |
|
||||
|
||||
## Authorization
|
||||
|
||||
This API uses the following authentication schemes.
|
||||
|
||||
* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/auth/oauth-2-client-credentials-grant.md)
|
||||
|
||||
## List of APIs
|
||||
|
||||
* [Orders](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/controllers/orders.md)
|
||||
* [Payments](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/controllers/payments.md)
|
||||
* [Vault](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/controllers/vault.md)
|
||||
|
||||
## Classes Documentation
|
||||
|
||||
* [ApiException](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/api-exception.md)
|
||||
* [HttpRequest](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/http-request.md)
|
||||
* [HttpResponse](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/http-response.md)
|
||||
* [LoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/logging-configuration-builder.md)
|
||||
* [RequestLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/request-logging-configuration-builder.md)
|
||||
* [ResponseLoggingConfigurationBuilder](https://www.github.com/paypal/PayPal-PHP-Server-SDK/tree/0.5.1/doc/response-logging-configuration-builder.md)
|
||||
|
||||
|
||||
41
composer.json
Normal file
41
composer.json
Normal file
@@ -0,0 +1,41 @@
|
||||
{
|
||||
"name": "paypal/paypal-server-sdk",
|
||||
"description": "PayPal's SDK for interacting with the REST APIs",
|
||||
"type": "library",
|
||||
"keywords": [],
|
||||
"homepage": "https://github.com/paypal/PayPal-PHP-Server-SDK",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [],
|
||||
"support": {},
|
||||
"require": {
|
||||
"php": "^7.2 || ^8.0",
|
||||
"ext-json": "*",
|
||||
"apimatic/unirest-php": "^4.0.0",
|
||||
"apimatic/core-interfaces": "~0.1.5",
|
||||
"apimatic/core": "~0.3.11"
|
||||
},
|
||||
"require-dev": {
|
||||
"squizlabs/php_codesniffer": "^3.5",
|
||||
"phan/phan": "5.4.2"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"PaypalServerSDKLib\\": "src/"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"PaypalServerSDKLib\\Tests\\": "tests/"
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"lint-src": "phpcs --standard=phpcs-ruleset.xml src/",
|
||||
"lint-src-fix": "phpcbf --standard=phpcs-ruleset.xml src/",
|
||||
"analyze": "phan --allow-polyfill-parser -p",
|
||||
"lint": [
|
||||
"@lint-src"
|
||||
]
|
||||
}
|
||||
}
|
||||
13
doc/api-exception.md
Normal file
13
doc/api-exception.md
Normal file
@@ -0,0 +1,13 @@
|
||||
|
||||
# ApiException
|
||||
|
||||
Thrown when there is a network error or HTTP response status code is not okay.
|
||||
|
||||
## Methods
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| getHttpRequest() | [`HttpRequest`](http-request.md) | Returns the HTTP request. |
|
||||
| getHttpResponse() | ?[`HttpResponse`](http-response.md) | Returns the HTTP response. |
|
||||
| hasResponse() | bool | Is the response available? |
|
||||
|
||||
88
doc/auth/oauth-2-client-credentials-grant.md
Normal file
88
doc/auth/oauth-2-client-credentials-grant.md
Normal file
@@ -0,0 +1,88 @@
|
||||
|
||||
# OAuth 2 Client Credentials Grant
|
||||
|
||||
|
||||
|
||||
Documentation for accessing and setting credentials for Oauth2.
|
||||
|
||||
## Auth Credentials
|
||||
|
||||
| Name | Type | Description | Setter | Getter |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| OAuthClientId | `string` | OAuth 2 Client ID | `oAuthClientId` | `getOAuthClientId()` |
|
||||
| OAuthClientSecret | `string` | OAuth 2 Client Secret | `oAuthClientSecret` | `getOAuthClientSecret()` |
|
||||
| OAuthToken | `OAuthToken\|null` | Object for storing information about the OAuth token | `oAuthToken` | `getOAuthToken()` |
|
||||
| OAuthClockSkew | `int` | Clock skew time in seconds applied while checking the OAuth Token expiry. | `oAuthClockSkew` | - |
|
||||
| OAuthTokenProvider | `callable(OAuthToken, ClientCredentialsAuthManager): OAuthToken` | Registers a callback for oAuth Token Provider used for automatic token fetching/refreshing. | `oAuthTokenProvider` | - |
|
||||
| OAuthOnTokenUpdate | `callable(OAuthToken): void` | Registers a callback for token update event. | `oAuthOnTokenUpdate` | - |
|
||||
|
||||
|
||||
|
||||
**Note:** Auth credentials can be set using `ClientCredentialsAuthCredentialsBuilder::init()` in `clientCredentialsAuthCredentials` method in the client builder and accessed through `getClientCredentialsAuth` method in the client instance.
|
||||
|
||||
## Usage Example
|
||||
|
||||
### Client Initialization
|
||||
|
||||
You must initialize the client with *OAuth 2.0 Client Credentials Grant* credentials as shown in the following code snippet. This will fetch the OAuth token automatically when any of the endpoints, requiring *OAuth 2.0 Client Credentials Grant* autentication, are called.
|
||||
|
||||
```php
|
||||
$client = PaypalServerSDKClientBuilder::init()
|
||||
->clientCredentialsAuthCredentials(
|
||||
ClientCredentialsAuthCredentialsBuilder::init(
|
||||
'OAuthClientId',
|
||||
'OAuthClientSecret'
|
||||
)
|
||||
)
|
||||
->build();
|
||||
```
|
||||
|
||||
|
||||
|
||||
Your application can also manually provide an OAuthToken using the setter `oAuthToken` in `ClientCredentialsAuthCredentialsBuilder` object. This function takes in an instance of OAuthToken containing information for authorizing client requests and refreshing the token itself.
|
||||
|
||||
### Adding OAuth Token Update Callback
|
||||
|
||||
Whenever the OAuth Token gets updated, the provided callback implementation will be executed. For instance, you may use it to store your access token whenever it gets updated.
|
||||
|
||||
```php
|
||||
$client = PaypalServerSDKClientBuilder::init()
|
||||
->clientCredentialsAuthCredentials(
|
||||
ClientCredentialsAuthCredentialsBuilder::init(
|
||||
'OAuthClientId',
|
||||
'OAuthClientSecret'
|
||||
)
|
||||
->oAuthOnTokenUpdate(
|
||||
function (OAuthToken $oAuthToken): void {
|
||||
// Add the callback handler to perform operations like save to DB or file etc.
|
||||
// It will be triggered whenever the token gets updated.
|
||||
$this->saveTokenToDatabase($oAuthToken);
|
||||
}
|
||||
)
|
||||
)
|
||||
->build();
|
||||
```
|
||||
|
||||
### Adding Custom OAuth Token Provider
|
||||
|
||||
To authorize a client using a stored access token, set up the `oAuthTokenProvider` in `ClientCredentialsAuthCredentialsBuilder` along with the other auth parameters before creating the client:
|
||||
|
||||
```php
|
||||
$client = PaypalServerSDKClientBuilder::init()
|
||||
->clientCredentialsAuthCredentials(
|
||||
ClientCredentialsAuthCredentialsBuilder::init(
|
||||
'OAuthClientId',
|
||||
'OAuthClientSecret'
|
||||
)
|
||||
->oAuthTokenProvider(
|
||||
function (?OAuthToken $lastOAuthToken, ClientCredentialsAuthManager $authManager): OAuthToken {
|
||||
// Add the callback handler to provide a new OAuth token.
|
||||
// It will be triggered whenever the lastOAuthToken is null or expired.
|
||||
return $this->loadTokenFromDatabase() ?? $authManager->fetchToken();
|
||||
}
|
||||
)
|
||||
)
|
||||
->build();
|
||||
```
|
||||
|
||||
|
||||
61
doc/client.md
Normal file
61
doc/client.md
Normal file
@@ -0,0 +1,61 @@
|
||||
|
||||
# Client Class Documentation
|
||||
|
||||
The following parameters are configurable for the API Client:
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| `environment` | `Environment` | The API environment. <br> **Default: `Environment.SANDBOX`** |
|
||||
| `timeout` | `int` | Timeout for API calls in seconds.<br>*Default*: `0` |
|
||||
| `enableRetries` | `bool` | Whether to enable retries and backoff feature.<br>*Default*: `false` |
|
||||
| `numberOfRetries` | `int` | The number of retries to make.<br>*Default*: `0` |
|
||||
| `retryInterval` | `float` | The retry time interval between the endpoint calls.<br>*Default*: `1` |
|
||||
| `backOffFactor` | `float` | Exponential backoff factor to increase interval between retries.<br>*Default*: `2` |
|
||||
| `maximumRetryWaitTime` | `int` | The maximum wait time in seconds for overall retrying requests.<br>*Default*: `0` |
|
||||
| `retryOnTimeout` | `bool` | Whether to retry on request timeout.<br>*Default*: `true` |
|
||||
| `httpStatusCodesToRetry` | `array` | Http status codes to retry against.<br>*Default*: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524` |
|
||||
| `httpMethodsToRetry` | `array` | Http methods to retry against.<br>*Default*: `'GET', 'PUT'` |
|
||||
| `loggingConfiguration` | [`LoggingConfigurationBuilder`](logging-configuration-builder.md) | Represents the logging configurations for API calls |
|
||||
| `clientCredentialsAuth` | [`ClientCredentialsAuth`](auth/oauth-2-client-credentials-grant.md) | The Credentials Setter for OAuth 2 Client Credentials Grant |
|
||||
|
||||
The API client can be initialized as follows:
|
||||
|
||||
```php
|
||||
$client = PaypalServerSDKClientBuilder::init()
|
||||
->clientCredentialsAuthCredentials(
|
||||
ClientCredentialsAuthCredentialsBuilder::init(
|
||||
'OAuthClientId',
|
||||
'OAuthClientSecret'
|
||||
)
|
||||
)
|
||||
->environment(Environment::SANDBOX)
|
||||
->loggingConfiguration(
|
||||
LoggingConfigurationBuilder::init()
|
||||
->level(LogLevel::INFO)
|
||||
->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
|
||||
->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
|
||||
)
|
||||
->build();
|
||||
```
|
||||
|
||||
API calls return an `ApiResponse` object that includes the following fields:
|
||||
|
||||
| Field | Description |
|
||||
| --- | --- |
|
||||
| `getStatusCode` | Status code of the HTTP response |
|
||||
| `getHeaders` | Headers of the HTTP response as a Hash |
|
||||
| `getResult` | The deserialized body of the HTTP response as a String |
|
||||
|
||||
## 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.
|
||||
|
||||
## Controllers
|
||||
|
||||
| Name | Description |
|
||||
| --- | --- |
|
||||
| getOrdersController() | Gets OrdersController |
|
||||
| getPaymentsController() | Gets PaymentsController |
|
||||
| getVaultController() | Gets VaultController |
|
||||
| getOAuthAuthorizationController() | Gets OAuthAuthorizationController |
|
||||
|
||||
396
doc/controllers/orders.md
Normal file
396
doc/controllers/orders.md
Normal file
@@ -0,0 +1,396 @@
|
||||
# Orders
|
||||
|
||||
Use the `/orders` resource to create, update, retrieve, authorize, capture and track orders.
|
||||
|
||||
```php
|
||||
$ordersController = $client->getOrdersController();
|
||||
```
|
||||
|
||||
## Class Name
|
||||
|
||||
`OrdersController`
|
||||
|
||||
## Methods
|
||||
|
||||
* [Orders Create](../../doc/controllers/orders.md#orders-create)
|
||||
* [Orders Get](../../doc/controllers/orders.md#orders-get)
|
||||
* [Orders Patch](../../doc/controllers/orders.md#orders-patch)
|
||||
* [Orders Confirm](../../doc/controllers/orders.md#orders-confirm)
|
||||
* [Orders Authorize](../../doc/controllers/orders.md#orders-authorize)
|
||||
* [Orders Capture](../../doc/controllers/orders.md#orders-capture)
|
||||
* [Orders Track Create](../../doc/controllers/orders.md#orders-track-create)
|
||||
* [Orders Trackers Patch](../../doc/controllers/orders.md#orders-trackers-patch)
|
||||
|
||||
|
||||
# Orders Create
|
||||
|
||||
Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see <a href="https://developer.paypal.com/docs/checkout/advanced/processing/">checkout</a> or <a href="https://developer.paypal.com/docs/multiparty/checkout/advanced/processing/">multiparty checkout</a>.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#create-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `body` | [`OrderRequest`](../../doc/models/order-request.md) | Body, Required | - |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` |
|
||||
| `payPalPartnerAttributionId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `payPalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=,-]*$` |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'body' => OrderRequestBuilder::init(
|
||||
CheckoutPaymentIntent::CAPTURE,
|
||||
[
|
||||
PurchaseUnitRequestBuilder::init(
|
||||
AmountWithBreakdownBuilder::init(
|
||||
'currency_code6',
|
||||
'value0'
|
||||
)->build()
|
||||
)->build()
|
||||
]
|
||||
)->build(),
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Get
|
||||
|
||||
Shows details for an order, by ID.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#get-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersGet(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which to show details.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `fields` | `?string` | Query, Optional | A comma-separated list of fields that should be returned for the order. Valid filter field is `payment_source`.<br>**Constraints**: *Pattern*: `^[a-z_]*$` |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersGet($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Patch
|
||||
|
||||
Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the `COMPLETED` status.<br/><br/>To make an update, you must provide a `reference_id`. If you omit this value with an order that contains only one purchase unit, PayPal sets the value to `default` which enables you to use the path: <code>\"/purchase_units/@reference_id=='default'/{attribute-or-object}\"</code>. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see <a href="https://developer.paypal.com/docs/checkout/advanced/processing/">checkout</a> or <a href="https://developer.paypal.com/docs/multiparty/checkout/advanced/processing/">multiparty checkout</a>.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#patch-order">Orders v2 errors</a>.</blockquote>Patchable attributes or objects:<br/><br/><table><thead><th>Attribute</th><th>Op</th><th>Notes</th></thead><tbody><tr><td><code>intent</code></td><td>replace</td><td></td></tr><tr><td><code>payer</code></td><td>replace, add</td><td>Using replace op for <code>payer</code> will replace the whole <code>payer</code> object with the value sent in request.</td></tr><tr><td><code>purchase_units</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].custom_id</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].description</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].payee.email</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].shipping.name</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.email_address</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.phone_number</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.options</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.address</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.type</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].soft_descriptor</code></td><td>replace, remove</td><td></td></tr><tr><td><code>purchase_units[].amount</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].items</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].invoice_id</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].payment_instruction</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].payment_instruction.disbursement_mode</code></td><td>replace</td><td>By default, <code>disbursement_mode</code> is <code>INSTANT</code>.</td></tr><tr><td><code>purchase_units[].payment_instruction.payee_receivable_fx_rate_id</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].payment_instruction.platform_fees</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].supplementary_data.airline</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].supplementary_data.card</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>application_context.client_configuration</code></td><td>replace, add</td><td></td></tr></tbody></table>
|
||||
|
||||
```php
|
||||
function ordersPatch(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| 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]+$` |
|
||||
| `body` | [`?(Patch[])`](../../doc/models/patch.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'body' => [
|
||||
PatchBuilder::init(
|
||||
PatchOp::ADD
|
||||
)->build()
|
||||
]
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersPatch($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Confirm
|
||||
|
||||
Payer confirms their intent to pay for the the Order with the given payment source.
|
||||
|
||||
```php
|
||||
function ordersConfirm(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which the payer confirms their intent to pay.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `payPalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=]*$` |
|
||||
| `body` | [`?ConfirmOrderRequest`](../../doc/models/confirm-order-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'prefer' => 'return=minimal',
|
||||
'body' => ConfirmOrderRequestBuilder::init(
|
||||
PaymentSourceBuilder::init()->build()
|
||||
)
|
||||
->processingInstruction(ProcessingInstruction::NO_INSTRUCTION)
|
||||
->build()
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersConfirm($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Authorize
|
||||
|
||||
Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#authorize-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersAuthorize(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which to authorize.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=,-]*$` |
|
||||
| `payPalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
| `body` | [`?OrderAuthorizeRequest`](../../doc/models/order-authorize-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`OrderAuthorizeResponse`](../../doc/models/order-authorize-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersAuthorize($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The authorized payment failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Capture
|
||||
|
||||
Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#capture-order">Orders v2 errors</a>.</blockquote>
|
||||
|
||||
```php
|
||||
function ordersCapture(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order for which to capture a payment.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `108` |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[a-zA-Z=,-]*$` |
|
||||
| `payPalClientMetadataId` | `?string` | Header, Optional | **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` |
|
||||
| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
| `body` | [`?OrderCaptureRequest`](../../doc/models/order-capture-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersCapture($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The authorized payment failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Track Create
|
||||
|
||||
Adds tracking information for an Order.
|
||||
|
||||
```php
|
||||
function ordersTrackCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order that the tracking information is associated with.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `body` | [`OrderTrackerRequest`](../../doc/models/order-tracker-request.md) | Body, Required | - |
|
||||
| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Order`](../../doc/models/order.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'body' => OrderTrackerRequestBuilder::init(
|
||||
'capture_id8'
|
||||
)
|
||||
->notifyPayer(false)
|
||||
->build()
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersTrackCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Orders Trackers Patch
|
||||
|
||||
Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects:<br/><br/><table><thead><th>Attribute</th><th>Op</th><th>Notes</th></thead><tbody></tr><tr><td><code>items</code></td><td>replace</td><td>Using replace op for <code>items</code> will replace the entire <code>items</code> object with the value sent in request.</td></tr><tr><td><code>notify_payer</code></td><td>replace, add</td><td></td></tr><tr><td><code>status</code></td><td>replace</td><td>Only patching status to CANCELLED is currently supported.</td></tr></tbody></table>
|
||||
|
||||
```php
|
||||
function ordersTrackersPatch(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | The ID of the order that the tracking information is associated with.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `trackerId` | `string` | Template, Required | The order tracking ID.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[A-Z0-9]+$` |
|
||||
| `body` | [`?(Patch[])`](../../doc/models/patch.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'id' => 'id0',
|
||||
'trackerId' => 'tracker_id2',
|
||||
'body' => [
|
||||
PatchBuilder::init(
|
||||
PatchOp::ADD
|
||||
)->build()
|
||||
]
|
||||
];
|
||||
|
||||
$apiResponse = $ordersController->ordersTrackersPatch($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
319
doc/controllers/payments.md
Normal file
319
doc/controllers/payments.md
Normal file
@@ -0,0 +1,319 @@
|
||||
# Payments
|
||||
|
||||
Use the `/payments` resource to authorize, capture, void authorizations, and retrieve captures.
|
||||
|
||||
```php
|
||||
$paymentsController = $client->getPaymentsController();
|
||||
```
|
||||
|
||||
## Class Name
|
||||
|
||||
`PaymentsController`
|
||||
|
||||
## Methods
|
||||
|
||||
* [Authorizations Get](../../doc/controllers/payments.md#authorizations-get)
|
||||
* [Authorizations Capture](../../doc/controllers/payments.md#authorizations-capture)
|
||||
* [Authorizations Reauthorize](../../doc/controllers/payments.md#authorizations-reauthorize)
|
||||
* [Authorizations Void](../../doc/controllers/payments.md#authorizations-void)
|
||||
* [Captures Get](../../doc/controllers/payments.md#captures-get)
|
||||
* [Captures Refund](../../doc/controllers/payments.md#captures-refund)
|
||||
* [Refunds Get](../../doc/controllers/payments.md#refunds-get)
|
||||
|
||||
|
||||
# Authorizations Get
|
||||
|
||||
Shows details for an authorized payment, by ID.
|
||||
|
||||
```php
|
||||
function authorizationsGet(string $authorizationId): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `authorizationId` | `string` | Template, Required | The ID of the authorized payment for which to show details. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentAuthorization`](../../doc/models/payment-authorization.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$authorizationId = 'authorization_id8';
|
||||
|
||||
$apiResponse = $paymentsController->authorizationsGet($authorizationId);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | The request failed because an internal server error occurred. | `ApiException` |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Authorizations Capture
|
||||
|
||||
Captures an authorized payment, by ID.
|
||||
|
||||
```php
|
||||
function authorizationsCapture(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to capture. |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
|
||||
| `body` | [`?CaptureRequest`](../../doc/models/capture-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`CapturedPayment`](../../doc/models/captured-payment.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'authorizationId' => 'authorization_id8',
|
||||
'prefer' => 'return=minimal',
|
||||
'body' => CaptureRequestBuilder::init()
|
||||
->finalCapture(false)
|
||||
->build()
|
||||
];
|
||||
|
||||
$apiResponse = $paymentsController->authorizationsCapture($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 409 | The server has detected a conflict while processing this request. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The request failed because it is semantically incorrect or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | The request failed because an internal server error occurred. | `ApiException` |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Authorizations Reauthorize
|
||||
|
||||
Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires.<br/><br/>If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment.<br/><br/>A reauthorized payment itself has a new honor period of three days.<br/><br/>You can reauthorize an authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on context and geography, for example in US it is up to 115% of the original authorized amount, not to exceed an increase of $75 USD.<br/><br/>Supports only the `amount` request parameter.<blockquote><strong>Note:</strong> This request is currently not supported for Partner use cases.</blockquote>
|
||||
|
||||
```php
|
||||
function authorizationsReauthorize(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to reauthorize. |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
|
||||
| `body` | [`?ReauthorizeRequest`](../../doc/models/reauthorize-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentAuthorization`](../../doc/models/payment-authorization.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'authorizationId' => 'authorization_id8',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $paymentsController->authorizationsReauthorize($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The request failed because it either is semantically incorrect or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | The request failed because an internal server error occurred. | `ApiException` |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Authorizations Void
|
||||
|
||||
Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured.
|
||||
|
||||
```php
|
||||
function authorizationsVoid(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `authorizationId` | `string` | Template, Required | The PayPal-generated ID for the authorized payment to void. |
|
||||
| `payPalAuthAssertion` | `?string` | Header, Optional | An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see [PayPal-Auth-Assertion](/docs/api/reference/api-requests/#paypal-auth-assertion).<blockquote><strong>Note:</strong>For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.</blockquote> |
|
||||
| `prefer` | `?string` | Header, Optional | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul><br>**Default**: `'return=minimal'` |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`?PaymentAuthorization`](../../doc/models/payment-authorization.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'authorizationId' => 'authorization_id8',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $paymentsController->authorizationsVoid($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 409 | The request failed because a previous call for the given resource is in progress. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The request failed because it either is semantically incorrect or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | The request failed because an internal server error occurred. | `ApiException` |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Captures Get
|
||||
|
||||
Shows details for a captured payment, by ID.
|
||||
|
||||
```php
|
||||
function capturesGet(string $captureId): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `captureId` | `string` | Template, Required | The PayPal-generated ID for the captured payment for which to show details. |
|
||||
|
||||
## 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).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$captureId = 'capture_id2';
|
||||
|
||||
$apiResponse = $paymentsController->capturesGet($captureId);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | The request failed because an internal server error occurred. | `ApiException` |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Captures Refund
|
||||
|
||||
Refunds a captured payment, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an <code>amount</code> object in the JSON request body.
|
||||
|
||||
```php
|
||||
function capturesRefund(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `captureId` | `string` | Template, Required | The PayPal-generated ID for the captured payment to refund. |
|
||||
| `payPalRequestId` | `?string` | Header, Optional | The server stores keys for 45 days. |
|
||||
| `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` | [`?RefundRequest`](../../doc/models/refund-request.md) | Body, Optional | - |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`Refund`](../../doc/models/refund.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'captureId' => 'capture_id2',
|
||||
'prefer' => 'return=minimal'
|
||||
];
|
||||
|
||||
$apiResponse = $paymentsController->capturesRefund($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | The request failed because it is not well-formed or is syntactically incorrect or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 409 | The request failed because a previous call for the given resource is in progress. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The request failed because it either is semantically incorrect or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | The request failed because an internal server error occurred. | `ApiException` |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Refunds Get
|
||||
|
||||
Shows details for a refund, by ID.
|
||||
|
||||
```php
|
||||
function refundsGet(string $refundId): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `refundId` | `string` | Template, Required | The PayPal-generated ID for the refund for which to show details. |
|
||||
|
||||
## 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).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$refundId = 'refund_id4';
|
||||
|
||||
$apiResponse = $paymentsController->refundsGet($refundId);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 401 | Authentication failed due to missing authorization header, or invalid authentication credentials. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | The request failed because the caller has insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The request failed because the resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | The request failed because an internal server error occurred. | `ApiException` |
|
||||
| Default | The error response. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
256
doc/controllers/vault.md
Normal file
256
doc/controllers/vault.md
Normal file
@@ -0,0 +1,256 @@
|
||||
# Vault
|
||||
|
||||
Use the `/vault` resource to create, retrieve, and delete payment and setup tokens.
|
||||
|
||||
```php
|
||||
$vaultController = $client->getVaultController();
|
||||
```
|
||||
|
||||
## Class Name
|
||||
|
||||
`VaultController`
|
||||
|
||||
## Methods
|
||||
|
||||
* [Payment-Tokens Create](../../doc/controllers/vault.md#payment-tokens-create)
|
||||
* [Customer Payment-Tokens Get](../../doc/controllers/vault.md#customer-payment-tokens-get)
|
||||
* [Payment-Tokens Get](../../doc/controllers/vault.md#payment-tokens-get)
|
||||
* [Payment-Tokens Delete](../../doc/controllers/vault.md#payment-tokens-delete)
|
||||
* [Setup-Tokens Create](../../doc/controllers/vault.md#setup-tokens-create)
|
||||
* [Setup-Tokens Get](../../doc/controllers/vault.md#setup-tokens-get)
|
||||
|
||||
|
||||
# Payment-Tokens Create
|
||||
|
||||
Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.
|
||||
|
||||
```php
|
||||
function paymentTokensCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `payPalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
|
||||
| `body` | [`PaymentTokenRequest`](../../doc/models/payment-token-request.md) | Body, Required | Payment Token creation with a financial instrument and an optional customer_id. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentTokenResponse`](../../doc/models/payment-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'payPalRequestId' => 'PayPal-Request-Id6',
|
||||
'body' => PaymentTokenRequestBuilder::init(
|
||||
PaymentTokenRequestPaymentSourceBuilder::init()->build()
|
||||
)->build()
|
||||
];
|
||||
|
||||
$apiResponse = $vaultController->paymentTokensCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | Request contains reference to resources that do not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Customer Payment-Tokens Get
|
||||
|
||||
Returns all payment tokens for a customer.
|
||||
|
||||
```php
|
||||
function customerPaymentTokensGet(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `customerId` | `string` | Query, Required | A unique identifier representing a specific customer in merchant's/partner's system or records.<br>**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `36`, *Pattern*: `^[0-9a-zA-Z_-]+$` |
|
||||
| `pageSize` | `?int` | Query, Optional | A non-negative, non-zero integer indicating the maximum number of results to return at one time.<br>**Default**: `5`<br>**Constraints**: `>= 1` |
|
||||
| `page` | `?int` | Query, Optional | A non-negative, non-zero integer representing the page of the results.<br>**Default**: `1`<br>**Constraints**: `>= 1` |
|
||||
| `totalRequired` | `?bool` | Query, Optional | A boolean indicating total number of items (total_items) and pages (total_pages) are expected to be returned in the response.<br>**Default**: `false` |
|
||||
|
||||
## 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).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'customerId' => 'customer_id8',
|
||||
'pageSize' => 5,
|
||||
'page' => 1,
|
||||
'totalRequired' => false
|
||||
];
|
||||
|
||||
$apiResponse = $vaultController->customerPaymentTokensGet($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Payment-Tokens Get
|
||||
|
||||
Returns a readable representation of vaulted payment source associated with the payment token id.
|
||||
|
||||
```php
|
||||
function paymentTokensGet(string $id): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | ID of the payment token.<br>**Constraints**: *Maximum Length*: `36`, *Pattern*: `^[0-9a-zA-Z_-]+$` |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`PaymentTokenResponse`](../../doc/models/payment-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$id = 'id0';
|
||||
|
||||
$apiResponse = $vaultController->paymentTokensGet($id);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Payment-Tokens Delete
|
||||
|
||||
Delete the payment token associated with the payment token id.
|
||||
|
||||
```php
|
||||
function paymentTokensDelete(string $id): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | ID of the payment token.<br>**Constraints**: *Maximum Length*: `36`, *Pattern*: `^[0-9a-zA-Z_-]+$` |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$id = 'id0';
|
||||
|
||||
$apiResponse = $vaultController->paymentTokensDelete($id);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Setup-Tokens Create
|
||||
|
||||
Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer.
|
||||
|
||||
```php
|
||||
function setupTokensCreate(array $options): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `payPalRequestId` | `string` | Header, Required | The server stores keys for 3 hours. |
|
||||
| `body` | [`SetupTokenRequest`](../../doc/models/setup-token-request.md) | Body, Required | Setup Token creation with a instrument type optional financial instrument details and customer_id. |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`SetupTokenResponse`](../../doc/models/setup-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$collect = [
|
||||
'payPalRequestId' => 'PayPal-Request-Id6',
|
||||
'body' => SetupTokenRequestBuilder::init(
|
||||
SetupTokenRequestPaymentSourceBuilder::init()->build()
|
||||
)->build()
|
||||
];
|
||||
|
||||
$apiResponse = $vaultController->setupTokensCreate($collect);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 400 | Request is not well-formed, syntactically incorrect, or violates schema. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
|
||||
# Setup-Tokens Get
|
||||
|
||||
Returns a readable representation of temporarily vaulted payment source associated with the setup token id.
|
||||
|
||||
```php
|
||||
function setupTokensGet(string $id): ApiResponse
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Tags | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `string` | Template, Required | ID of the setup token.<br>**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `36`, *Pattern*: `^[0-9a-zA-Z_-]+$` |
|
||||
|
||||
## Response Type
|
||||
|
||||
This method returns a `PaypalServerSDKLib\Utils\ApiResponse` instance. The `getResult()` method on this instance returns the response data which is of type [`SetupTokenResponse`](../../doc/models/setup-token-response.md).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```php
|
||||
$id = 'id0';
|
||||
|
||||
$apiResponse = $vaultController->setupTokensGet($id);
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| HTTP Status Code | Error Description | Exception Class |
|
||||
| --- | --- | --- |
|
||||
| 403 | Authorization failed due to insufficient permissions. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 404 | The specified resource does not exist. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 422 | The requested action could not be performed, semantically incorrect, or failed business validation. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
| 500 | An internal server error has occurred. | [`ErrorException`](../../doc/models/error-exception.md) |
|
||||
|
||||
14
doc/http-request.md
Normal file
14
doc/http-request.md
Normal file
@@ -0,0 +1,14 @@
|
||||
|
||||
# HttpRequest
|
||||
|
||||
Represents a single Http Request.
|
||||
|
||||
## Methods
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| getHttpMethod() | string | The HTTP method of the request. |
|
||||
| getQueryUrl() | string | The endpoint URL for the API request. |
|
||||
| getHeaders() | array | Request headers. |
|
||||
| getParameters() | array | Input parameters for the body. |
|
||||
|
||||
13
doc/http-response.md
Normal file
13
doc/http-response.md
Normal file
@@ -0,0 +1,13 @@
|
||||
|
||||
# HttpResponse
|
||||
|
||||
Http response received.
|
||||
|
||||
## Methods
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| getStatusCode() | int | The status code of the response. |
|
||||
| getHeaders() | array | Response headers. |
|
||||
| getRawBody() | string | Raw body of the response. |
|
||||
|
||||
50
doc/logging-configuration-builder.md
Normal file
50
doc/logging-configuration-builder.md
Normal file
@@ -0,0 +1,50 @@
|
||||
|
||||
# LoggingConfigurationBuilder Class
|
||||
|
||||
Represents the logging configurations for API calls. Create instance using `LoggingConfigurationBuilder::init()`
|
||||
|
||||
## Methods
|
||||
|
||||
| Name | Parameter Type | Description |
|
||||
| --- | --- | --- |
|
||||
| logger | `LoggerInterface` | Takes in your custom implementation of the Psr\Log\LoggerInterface.php. **Default Implementation : `ConsoleLogger`** |
|
||||
| level | `string(LogLevel)` | Defines the log message severity mentioned in Psr\Log\LogLevel.php (e.g., DEBUG, INFO, etc). **Default : `logLevel::INFO`** |
|
||||
| maskSensitiveHeaders | `bool` | Toggles the global setting to mask sensitive HTTP headers in both requests and responses before logging, safeguarding confidential data. **Default : `true`** |
|
||||
| requestConfiguration | [`RequestLoggingConfigurationBuilder`](request-logging-configuration-builder.md) | The logging configurations for an API request. |
|
||||
| responseConfiguration | [`RequestLoggingConfigurationBuilder`](response-logging-configuration-builder.md) | The logging configurations for an API response. |
|
||||
|
||||
## Usage Example
|
||||
|
||||
### Client Initialization with Custom Logger
|
||||
|
||||
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.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
use PaypalServerSDKLib\PaypalServerSDKClientBuilder;
|
||||
use PaypalServerSDKLib\Logging\LoggingConfigurationBuilder;
|
||||
use PaypalServerSDKLib\Logging\RequestLoggingConfigurationBuilder;
|
||||
use PaypalServerSDKLib\Logging\ResponseLoggingConfigurationBuilder;
|
||||
use Psr\Log\LogLevel;
|
||||
use Monolog\Logger;
|
||||
use Monolog\Handler\StreamHandler;
|
||||
|
||||
// create a log channel
|
||||
$logger = new Logger('PaypalServerSDK');
|
||||
$logger->pushHandler(new StreamHandler(__DIR__ . '/api_data.log'));
|
||||
|
||||
// initialize the sdk client using this logger
|
||||
$client = PaypalServerSDKClientBuilder::init()
|
||||
->loggingConfiguration(
|
||||
LoggingConfigurationBuilder::init()
|
||||
->logger($logger)
|
||||
->level(LogLevel::INFO)
|
||||
->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
|
||||
->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
|
||||
)
|
||||
->build();
|
||||
```
|
||||
|
||||
25
doc/models/activity-timestamps.md
Normal file
25
doc/models/activity-timestamps.md
Normal file
@@ -0,0 +1,25 @@
|
||||
|
||||
# Activity Timestamps
|
||||
|
||||
The date and time stamps that are common to authorized payment, captured payment, and refund transactions.
|
||||
|
||||
## Structure
|
||||
|
||||
`ActivityTimestamps`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `createTime` | `?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})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void |
|
||||
| `updateTime` | `?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})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"create_time": "create_time2",
|
||||
"update_time": "update_time2"
|
||||
}
|
||||
```
|
||||
|
||||
38
doc/models/address-details.md
Normal file
38
doc/models/address-details.md
Normal file
@@ -0,0 +1,38 @@
|
||||
|
||||
# Address Details
|
||||
|
||||
Address request details.
|
||||
|
||||
## Structure
|
||||
|
||||
`AddressDetails`
|
||||
|
||||
## 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 |
|
||||
| `name` | [`?Name`](../../doc/models/name.md) | Optional | The name of the party. | getName(): ?Name | setName(?Name name): void |
|
||||
| `id` | `?string` | Optional | The resource ID of the address.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[0-9A-Za-z-_]+$` | getId(): ?string | setId(?string id): void |
|
||||
| `company` | `?string` | Optional | The name of the company or business associated to the address.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `100`, *Pattern*: `^.*$` | getCompany(): ?string | setCompany(?string company): void |
|
||||
| `phone` | `?string` | Optional | The phone number that can go on the mailing label with the address to track the shipping. Phone number is in E.164 format.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `16`, *Pattern*: `^\+[1-9]\d{1,14}$` | getPhone(): ?string | setPhone(?string phone): void |
|
||||
| `phoneNumber` | [`?Phone`](../../doc/models/phone.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(): ?Phone | setPhoneNumber(?Phone phoneNumber): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"address_line_1": "address_line_10",
|
||||
"address_line_2": "address_line_20",
|
||||
"admin_area_2": "admin_area_24",
|
||||
"admin_area_1": "admin_area_16",
|
||||
"postal_code": "postal_code2",
|
||||
"country_code": "country_code0"
|
||||
}
|
||||
```
|
||||
|
||||
33
doc/models/address.md
Normal file
33
doc/models/address.md
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
# Address
|
||||
|
||||
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
|
||||
|
||||
`Address`
|
||||
|
||||
## 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_18",
|
||||
"address_line_2": "address_line_28",
|
||||
"admin_area_2": "admin_area_22",
|
||||
"admin_area_1": "admin_area_14",
|
||||
"postal_code": "postal_code0",
|
||||
"country_code": "country_code8"
|
||||
}
|
||||
```
|
||||
|
||||
48
doc/models/amount-breakdown.md
Normal file
48
doc/models/amount-breakdown.md
Normal file
@@ -0,0 +1,48 @@
|
||||
|
||||
# Amount Breakdown
|
||||
|
||||
The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
|
||||
|
||||
## Structure
|
||||
|
||||
`AmountBreakdown`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `itemTotal` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getItemTotal(): ?Money | setItemTotal(?Money itemTotal): void |
|
||||
| `shipping` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getShipping(): ?Money | setShipping(?Money shipping): void |
|
||||
| `handling` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getHandling(): ?Money | setHandling(?Money handling): void |
|
||||
| `taxTotal` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getTaxTotal(): ?Money | setTaxTotal(?Money taxTotal): void |
|
||||
| `insurance` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getInsurance(): ?Money | setInsurance(?Money insurance): void |
|
||||
| `shippingDiscount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getShippingDiscount(): ?Money | setShippingDiscount(?Money shippingDiscount): void |
|
||||
| `discount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getDiscount(): ?Money | setDiscount(?Money discount): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"item_total": {
|
||||
"currency_code": "currency_code0",
|
||||
"value": "value6"
|
||||
},
|
||||
"shipping": {
|
||||
"currency_code": "currency_code0",
|
||||
"value": "value6"
|
||||
},
|
||||
"handling": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
},
|
||||
"tax_total": {
|
||||
"currency_code": "currency_code4",
|
||||
"value": "value0"
|
||||
},
|
||||
"insurance": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
48
doc/models/amount-with-breakdown.md
Normal file
48
doc/models/amount-with-breakdown.md
Normal file
@@ -0,0 +1,48 @@
|
||||
|
||||
# Amount With Breakdown
|
||||
|
||||
The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.<br/>If you specify `amount.breakdown`, the amount equals `item_total` plus `tax_total` plus `shipping` plus `handling` plus `insurance` minus `shipping_discount` minus discount.<br/>The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs <a href="/docs/integration/direct/rest/currency-codes/">Currency Codes</a>.
|
||||
|
||||
## Structure
|
||||
|
||||
`AmountWithBreakdown`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `currencyCode` | `string` | Required | The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.<br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `3` | getCurrencyCode(): string | setCurrencyCode(string currencyCode): void |
|
||||
| `value` | `string` | Required | The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).<br>**Constraints**: *Maximum Length*: `32`, *Pattern*: `^((-?[0-9]+)\|(-?([0-9]+)?[.][0-9]+))$` | getValue(): string | setValue(string value): void |
|
||||
| `breakdown` | [`?AmountBreakdown`](../../doc/models/amount-breakdown.md) | Optional | The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any. | getBreakdown(): ?AmountBreakdown | setBreakdown(?AmountBreakdown breakdown): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"currency_code": "currency_code4",
|
||||
"value": "value0",
|
||||
"breakdown": {
|
||||
"item_total": {
|
||||
"currency_code": "currency_code0",
|
||||
"value": "value6"
|
||||
},
|
||||
"shipping": {
|
||||
"currency_code": "currency_code0",
|
||||
"value": "value6"
|
||||
},
|
||||
"handling": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
},
|
||||
"tax_total": {
|
||||
"currency_code": "currency_code4",
|
||||
"value": "value0"
|
||||
},
|
||||
"insurance": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
36
doc/models/apple-pay-attributes-response.md
Normal file
36
doc/models/apple-pay-attributes-response.md
Normal file
@@ -0,0 +1,36 @@
|
||||
|
||||
# Apple Pay Attributes Response
|
||||
|
||||
Additional attributes associated with the use of Apple Pay.
|
||||
|
||||
## Structure
|
||||
|
||||
`ApplePayAttributesResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `vault` | [`?VaultResponse`](../../doc/models/vault-response.md) | Optional | The details about a saved payment source. | getVault(): ?VaultResponse | setVault(?VaultResponse vault): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"vault": {
|
||||
"id": "id6",
|
||||
"status": "APPROVED",
|
||||
"customer": {
|
||||
"id": "id0"
|
||||
},
|
||||
"links": [
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
36
doc/models/apple-pay-attributes.md
Normal file
36
doc/models/apple-pay-attributes.md
Normal file
@@ -0,0 +1,36 @@
|
||||
|
||||
# Apple Pay Attributes
|
||||
|
||||
Additional attributes associated with apple pay.
|
||||
|
||||
## Structure
|
||||
|
||||
`ApplePayAttributes`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `customer` | [`?CustomerInformation`](../../doc/models/customer-information.md) | Optional | The details about a customer in PayPal's system of record. | getCustomer(): ?CustomerInformation | setCustomer(?CustomerInformation customer): void |
|
||||
| `vault` | [`?VaultInstruction`](../../doc/models/vault-instruction.md) | Optional | Base vaulting specification. The object can be extended for specific use cases within each payment_source that supports vaulting. | getVault(): ?VaultInstruction | setVault(?VaultInstruction vault): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"customer": {
|
||||
"id": "id0",
|
||||
"email_address": "email_address2",
|
||||
"phone": {
|
||||
"phone_type": "OTHER",
|
||||
"phone_number": {
|
||||
"national_number": "national_number6"
|
||||
}
|
||||
}
|
||||
},
|
||||
"vault": {
|
||||
"store_in_vault": "ON_SUCCESS"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
40
doc/models/apple-pay-card-response.md
Normal file
40
doc/models/apple-pay-card-response.md
Normal file
@@ -0,0 +1,40 @@
|
||||
|
||||
# Apple Pay Card Response
|
||||
|
||||
The Card from Apple Pay Wallet used to fund the payment.
|
||||
|
||||
## Structure
|
||||
|
||||
`ApplePayCardResponse`
|
||||
|
||||
## 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*: `2`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void |
|
||||
| `lastDigits` | `?string` | Optional | The last digits of the payment card.<br>**Constraints**: *Pattern*: `[0-9]{2,}` | getLastDigits(): ?string | setLastDigits(?string lastDigits): 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 |
|
||||
| `availableNetworks` | [`?(string(CardBrand)[])`](../../doc/models/card-brand.md) | Optional | Array of brands or networks associated with the card.<br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `256`, *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getAvailableNetworks(): ?array | setAvailableNetworks(?array availableNetworks): 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 |
|
||||
| `authenticationResult` | [`?AuthenticationResponse`](../../doc/models/authentication-response.md) | Optional | Results of Authentication such as 3D Secure. | getAuthenticationResult(): ?AuthenticationResponse | setAuthenticationResult(?AuthenticationResponse authenticationResult): void |
|
||||
| `attributes` | [`?CardAttributesResponse`](../../doc/models/card-attributes-response.md) | Optional | Additional attributes associated with the use of this card. | getAttributes(): ?CardAttributesResponse | setAttributes(?CardAttributesResponse attributes): void |
|
||||
| `fromRequest` | [`?CardFromRequest`](../../doc/models/card-from-request.md) | Optional | Representation of card details as received in the request. | getFromRequest(): ?CardFromRequest | setFromRequest(?CardFromRequest fromRequest): 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 |
|
||||
| `binDetails` | [`?BinDetails`](../../doc/models/bin-details.md) | Optional | Bank Identification Number (BIN) details used to fund a payment. | getBinDetails(): ?BinDetails | setBinDetails(?BinDetails binDetails): void |
|
||||
| `billingAddress` | [`?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). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): 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 |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name4",
|
||||
"last_digits": "last_digits8",
|
||||
"brand": "HIPER",
|
||||
"available_networks": [
|
||||
"RUPAY"
|
||||
],
|
||||
"type": "DEBIT"
|
||||
}
|
||||
```
|
||||
|
||||
38
doc/models/apple-pay-card.md
Normal file
38
doc/models/apple-pay-card.md
Normal file
@@ -0,0 +1,38 @@
|
||||
|
||||
# Apple Pay Card
|
||||
|
||||
The payment card to be used to fund a payment. Can be a credit or debit card.
|
||||
|
||||
## Structure
|
||||
|
||||
`ApplePayCard`
|
||||
|
||||
## 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 |
|
||||
| `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` | [`?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). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name4",
|
||||
"last_digits": "last_digits8",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "AMEX",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
"admin_area_2": "admin_area_28",
|
||||
"admin_area_1": "admin_area_14",
|
||||
"postal_code": "postal_code0",
|
||||
"country_code": "country_code8"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
45
doc/models/apple-pay-decrypted-token-data.md
Normal file
45
doc/models/apple-pay-decrypted-token-data.md
Normal file
@@ -0,0 +1,45 @@
|
||||
|
||||
# Apple Pay Decrypted Token Data
|
||||
|
||||
Information about the Payment data obtained by decrypting Apple Pay token.
|
||||
|
||||
## Structure
|
||||
|
||||
`ApplePayDecryptedTokenData`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `transactionAmount` | [`?Money`](../../doc/models/money.md) | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | getTransactionAmount(): ?Money | setTransactionAmount(?Money transactionAmount): void |
|
||||
| `tokenizedCard` | [`ApplePayTokenizedCard`](../../doc/models/apple-pay-tokenized-card.md) | Required | The payment card to use to fund a payment. Can be a credit or debit card. | getTokenizedCard(): ApplePayTokenizedCard | setTokenizedCard(ApplePayTokenizedCard tokenizedCard): void |
|
||||
| `deviceManufacturerId` | `?string` | Optional | Apple Pay Hex-encoded device manufacturer identifier. The pattern is defined by an external party and supports Unicode.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2000`, *Pattern*: `^.*$` | getDeviceManufacturerId(): ?string | setDeviceManufacturerId(?string deviceManufacturerId): void |
|
||||
| `paymentDataType` | [`?string(ApplePayPaymentDataType)`](../../doc/models/apple-pay-payment-data-type.md) | Optional | Indicates the type of payment data passed, in case of Non China the payment data is 3DSECURE and for China it is EMV.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `16`, *Pattern*: `^[0-9A-Z_]+$` | getPaymentDataType(): ?string | setPaymentDataType(?string paymentDataType): void |
|
||||
| `paymentData` | [`?ApplePayPaymentData`](../../doc/models/apple-pay-payment-data.md) | Optional | Information about the decrypted apple pay payment data for the token like cryptogram, eci indicator. | getPaymentData(): ?ApplePayPaymentData | setPaymentData(?ApplePayPaymentData paymentData): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"transaction_amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value2"
|
||||
},
|
||||
"tokenized_card": {
|
||||
"name": "name4",
|
||||
"number": "number2",
|
||||
"expiry": "expiry2",
|
||||
"card_type": "CB_NATIONALE",
|
||||
"type": "UNKNOWN"
|
||||
},
|
||||
"device_manufacturer_id": "device_manufacturer_id2",
|
||||
"payment_data_type": "3DSECURE",
|
||||
"payment_data": {
|
||||
"cryptogram": "cryptogram6",
|
||||
"eci_indicator": "eci_indicator0",
|
||||
"emv_data": "emv_data0",
|
||||
"pin": "pin4"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
16
doc/models/apple-pay-payment-data-type.md
Normal file
16
doc/models/apple-pay-payment-data-type.md
Normal file
@@ -0,0 +1,16 @@
|
||||
|
||||
# Apple Pay Payment Data Type
|
||||
|
||||
Indicates the type of payment data passed, in case of Non China the payment data is 3DSECURE and for China it is EMV.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`ApplePayPaymentDataType`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `ENUM_3DSECURE` |
|
||||
| `EMV` |
|
||||
|
||||
29
doc/models/apple-pay-payment-data.md
Normal file
29
doc/models/apple-pay-payment-data.md
Normal file
@@ -0,0 +1,29 @@
|
||||
|
||||
# Apple Pay Payment Data
|
||||
|
||||
Information about the decrypted apple pay payment data for the token like cryptogram, eci indicator.
|
||||
|
||||
## Structure
|
||||
|
||||
`ApplePayPaymentData`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `cryptogram` | `?string` | Optional | Online payment cryptogram, as defined by 3D Secure. The pattern is defined by an external party and supports Unicode.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2000`, *Pattern*: `^.*$` | getCryptogram(): ?string | setCryptogram(?string cryptogram): void |
|
||||
| `eciIndicator` | `?string` | Optional | ECI indicator, as defined by 3- Secure. The pattern is defined by an external party and supports Unicode.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `256`, *Pattern*: `^.*$` | getEciIndicator(): ?string | setEciIndicator(?string eciIndicator): void |
|
||||
| `emvData` | `?string` | Optional | Encoded Apple Pay EMV Payment Structure used for payments in China. The pattern is defined by an external party and supports Unicode.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2000`, *Pattern*: `^.*$` | getEmvData(): ?string | setEmvData(?string emvData): void |
|
||||
| `pin` | `?string` | Optional | Bank Key encrypted Apple Pay PIN. The pattern is defined by an external party and supports Unicode.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2000`, *Pattern*: `^.*$` | getPin(): ?string | setPin(?string pin): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"cryptogram": "cryptogram6",
|
||||
"eci_indicator": "eci_indicator0",
|
||||
"emv_data": "emv_data0",
|
||||
"pin": "pin4"
|
||||
}
|
||||
```
|
||||
|
||||
35
doc/models/apple-pay-payment-object.md
Normal file
35
doc/models/apple-pay-payment-object.md
Normal file
@@ -0,0 +1,35 @@
|
||||
|
||||
# Apple Pay Payment Object
|
||||
|
||||
Information needed to pay using ApplePay.
|
||||
|
||||
## Structure
|
||||
|
||||
`ApplePayPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `id` | `?string` | Optional | ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple. The pattern is defined by an external party and supports Unicode.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `250`, *Pattern*: `^.*$` | getId(): ?string | setId(?string id): void |
|
||||
| `token` | `?string` | Optional | Encrypted ApplePay token, containing card information. This token would be base64encoded. The pattern is defined by an external party and supports Unicode.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `10000`, *Pattern*: `^.*$` | getToken(): ?string | setToken(?string token): 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 |
|
||||
| `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])?\|\[(?:(?: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])+)\])$`` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): 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 |
|
||||
| `card` | [`?ApplePayCardResponse`](../../doc/models/apple-pay-card-response.md) | Optional | The Card from Apple Pay Wallet used to fund the payment. | getCard(): ?ApplePayCardResponse | setCard(?ApplePayCardResponse card): void |
|
||||
| `attributes` | [`?ApplePayAttributesResponse`](../../doc/models/apple-pay-attributes-response.md) | Optional | Additional attributes associated with the use of Apple Pay. | getAttributes(): ?ApplePayAttributesResponse | setAttributes(?ApplePayAttributesResponse attributes): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "id6",
|
||||
"token": "token0",
|
||||
"name": "name6",
|
||||
"email_address": "email_address4",
|
||||
"phone_number": {
|
||||
"national_number": "national_number6"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
36
doc/models/apple-pay-payment-token.md
Normal file
36
doc/models/apple-pay-payment-token.md
Normal file
@@ -0,0 +1,36 @@
|
||||
|
||||
# Apple Pay Payment Token
|
||||
|
||||
A resource representing a response for Apple Pay.
|
||||
|
||||
## Structure
|
||||
|
||||
`ApplePayPaymentToken`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `card` | [`?ApplePayCard`](../../doc/models/apple-pay-card.md) | Optional | The payment card to be used to fund a payment. Can be a credit or debit card. | getCard(): ?ApplePayCard | setCard(?ApplePayCard card): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
"admin_area_2": "admin_area_28",
|
||||
"admin_area_1": "admin_area_14",
|
||||
"postal_code": "postal_code0",
|
||||
"country_code": "country_code8"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
56
doc/models/apple-pay-request.md
Normal file
56
doc/models/apple-pay-request.md
Normal file
@@ -0,0 +1,56 @@
|
||||
|
||||
# Apple Pay Request
|
||||
|
||||
Information needed to pay using ApplePay.
|
||||
|
||||
## Structure
|
||||
|
||||
`ApplePayRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `id` | `?string` | Optional | ApplePay transaction identifier, this will be the unique identifier for this transaction provided by Apple. The pattern is defined by an external party and supports Unicode.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `250`, *Pattern*: `^.*$` | getId(): ?string | setId(?string id): 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 |
|
||||
| `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])?\|\[(?:(?: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])+)\])$`` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): 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 |
|
||||
| `decryptedToken` | [`?ApplePayDecryptedTokenData`](../../doc/models/apple-pay-decrypted-token-data.md) | Optional | Information about the Payment data obtained by decrypting Apple Pay token. | getDecryptedToken(): ?ApplePayDecryptedTokenData | setDecryptedToken(?ApplePayDecryptedTokenData decryptedToken): void |
|
||||
| `storedCredential` | [`?CardStoredCredential`](../../doc/models/card-stored-credential.md) | Optional | Provides additional details to process a payment using a `card` that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).<br/>Parameter compatibility:<br/><ul><li>`payment_type=ONE_TIME` is compatible only with `payment_initiator=CUSTOMER`.</li><li>`usage=FIRST` is compatible only with `payment_initiator=CUSTOMER`.</li><li>`previous_transaction_reference` or `previous_network_transaction_reference` is compatible only with `payment_initiator=MERCHANT`.</li><li>Only one of the parameters - `previous_transaction_reference` and `previous_network_transaction_reference` - can be present in the request.</li></ul> | getStoredCredential(): ?CardStoredCredential | setStoredCredential(?CardStoredCredential storedCredential): void |
|
||||
| `vaultId` | `?string` | Optional | The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getVaultId(): ?string | setVaultId(?string vaultId): void |
|
||||
| `attributes` | [`?ApplePayAttributes`](../../doc/models/apple-pay-attributes.md) | Optional | Additional attributes associated with apple pay. | getAttributes(): ?ApplePayAttributes | setAttributes(?ApplePayAttributes attributes): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "id6",
|
||||
"name": "name6",
|
||||
"email_address": "email_address4",
|
||||
"phone_number": {
|
||||
"national_number": "national_number6"
|
||||
},
|
||||
"decrypted_token": {
|
||||
"transaction_amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value2"
|
||||
},
|
||||
"tokenized_card": {
|
||||
"name": "name4",
|
||||
"number": "number2",
|
||||
"expiry": "expiry2",
|
||||
"card_type": "CB_NATIONALE",
|
||||
"type": "UNKNOWN"
|
||||
},
|
||||
"device_manufacturer_id": "device_manufacturer_id6",
|
||||
"payment_data_type": "3DSECURE",
|
||||
"payment_data": {
|
||||
"cryptogram": "cryptogram6",
|
||||
"eci_indicator": "eci_indicator0",
|
||||
"emv_data": "emv_data0",
|
||||
"pin": "pin4"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
33
doc/models/apple-pay-tokenized-card.md
Normal file
33
doc/models/apple-pay-tokenized-card.md
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
# Apple Pay Tokenized Card
|
||||
|
||||
The payment card to use to fund a payment. Can be a credit or debit card.
|
||||
|
||||
## Structure
|
||||
|
||||
`ApplePayTokenizedCard`
|
||||
|
||||
## 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 |
|
||||
| `cardType` | [`?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_]+$` | getCardType(): ?string | setCardType(?string cardType): 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` | [`?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). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name8",
|
||||
"number": "number6",
|
||||
"expiry": "expiry6",
|
||||
"card_type": "SOLO",
|
||||
"type": "STORE"
|
||||
}
|
||||
```
|
||||
|
||||
25
doc/models/assurance-details.md
Normal file
25
doc/models/assurance-details.md
Normal file
@@ -0,0 +1,25 @@
|
||||
|
||||
# Assurance Details
|
||||
|
||||
Information about cardholder possession validation and cardholder identification and verifications (ID&V).
|
||||
|
||||
## Structure
|
||||
|
||||
`AssuranceDetails`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `accountVerified` | `?bool` | Optional | If true, indicates that Cardholder possession validation has been performed on returned payment credential.<br>**Default**: `false` | getAccountVerified(): ?bool | setAccountVerified(?bool accountVerified): void |
|
||||
| `cardHolderAuthenticated` | `?bool` | Optional | If true, indicates that identification and verifications (ID&V) was performed on the returned payment credential.If false, the same risk-based authentication can be performed as you would for card transactions. This risk-based authentication can include, but not limited to, step-up with 3D Secure protocol if applicable.<br>**Default**: `false` | getCardHolderAuthenticated(): ?bool | setCardHolderAuthenticated(?bool cardHolderAuthenticated): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"account_verified": false,
|
||||
"card_holder_authenticated": false
|
||||
}
|
||||
```
|
||||
|
||||
28
doc/models/authentication-response.md
Normal file
28
doc/models/authentication-response.md
Normal file
@@ -0,0 +1,28 @@
|
||||
|
||||
# Authentication Response
|
||||
|
||||
Results of Authentication such as 3D Secure.
|
||||
|
||||
## Structure
|
||||
|
||||
`AuthenticationResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `liabilityShift` | [`?string(LiabilityShiftIndicator)`](../../doc/models/liability-shift-indicator.md) | Optional | Liability shift indicator. The outcome of the issuer's authentication.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getLiabilityShift(): ?string | setLiabilityShift(?string liabilityShift): void |
|
||||
| `threeDSecure` | [`?ThreeDSecureAuthenticationResponse`](../../doc/models/three-d-secure-authentication-response.md) | Optional | Results of 3D Secure Authentication. | getThreeDSecure(): ?ThreeDSecureAuthenticationResponse | setThreeDSecure(?ThreeDSecureAuthenticationResponse threeDSecure): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"liability_shift": "POSSIBLE",
|
||||
"three_d_secure": {
|
||||
"authentication_status": "C",
|
||||
"enrollment_status": "Y"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
16
doc/models/authorization-incomplete-reason.md
Normal file
16
doc/models/authorization-incomplete-reason.md
Normal file
@@ -0,0 +1,16 @@
|
||||
|
||||
# Authorization Incomplete Reason
|
||||
|
||||
The reason why the authorized status is `PENDING`.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`AuthorizationIncompleteReason`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `PENDING_REVIEW` |
|
||||
| `DECLINED_BY_RISK_FRAUD_FILTERS` |
|
||||
|
||||
23
doc/models/authorization-status-details.md
Normal file
23
doc/models/authorization-status-details.md
Normal file
@@ -0,0 +1,23 @@
|
||||
|
||||
# Authorization Status Details
|
||||
|
||||
The details of the authorized payment status.
|
||||
|
||||
## Structure
|
||||
|
||||
`AuthorizationStatusDetails`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `reason` | [`?string(AuthorizationIncompleteReason)`](../../doc/models/authorization-incomplete-reason.md) | Optional | The reason why the authorized status is `PENDING`.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64`, *Pattern*: `^[A-Z_]+$` | getReason(): ?string | setReason(?string reason): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"reason": "PENDING_REVIEW"
|
||||
}
|
||||
```
|
||||
|
||||
27
doc/models/authorization-status-with-details.md
Normal file
27
doc/models/authorization-status-with-details.md
Normal file
@@ -0,0 +1,27 @@
|
||||
|
||||
# Authorization Status With Details
|
||||
|
||||
The status fields and status details for an authorized payment.
|
||||
|
||||
## Structure
|
||||
|
||||
`AuthorizationStatusWithDetails`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `status` | [`?string(AuthorizationStatus)`](../../doc/models/authorization-status.md) | Optional | The status for the authorized payment. | getStatus(): ?string | setStatus(?string status): void |
|
||||
| `statusDetails` | [`?AuthorizationStatusDetails`](../../doc/models/authorization-status-details.md) | Optional | The details of the authorized payment status. | getStatusDetails(): ?AuthorizationStatusDetails | setStatusDetails(?AuthorizationStatusDetails statusDetails): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "VOIDED",
|
||||
"status_details": {
|
||||
"reason": "PENDING_REVIEW"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
20
doc/models/authorization-status.md
Normal file
20
doc/models/authorization-status.md
Normal file
@@ -0,0 +1,20 @@
|
||||
|
||||
# Authorization Status
|
||||
|
||||
The status for the authorized payment.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`AuthorizationStatus`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `CREATED` |
|
||||
| `CAPTURED` |
|
||||
| `DENIED` |
|
||||
| `PARTIALLY_CAPTURED` |
|
||||
| `VOIDED` |
|
||||
| `PENDING` |
|
||||
|
||||
44
doc/models/authorization-with-additional-data.md
Normal file
44
doc/models/authorization-with-additional-data.md
Normal file
@@ -0,0 +1,44 @@
|
||||
|
||||
# Authorization With Additional Data
|
||||
|
||||
The authorization with additional payment details, such as risk assessment and processor response. These details are populated only for certain payment methods.
|
||||
|
||||
## Structure
|
||||
|
||||
`AuthorizationWithAdditionalData`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `status` | [`?string(AuthorizationStatus)`](../../doc/models/authorization-status.md) | Optional | The status for the authorized payment. | getStatus(): ?string | setStatus(?string status): void |
|
||||
| `statusDetails` | [`?AuthorizationStatusDetails`](../../doc/models/authorization-status-details.md) | Optional | The details of the authorized payment status. | getStatusDetails(): ?AuthorizationStatusDetails | setStatusDetails(?AuthorizationStatusDetails statusDetails): void |
|
||||
| `id` | `?string` | Optional | The PayPal-generated ID for the authorized payment. | getId(): ?string | setId(?string id): 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 |
|
||||
| `invoiceId` | `?string` | Optional | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void |
|
||||
| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.<br>**Constraints**: *Maximum Length*: `255` | getCustomId(): ?string | setCustomId(?string customId): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransactionReference | setNetworkTransactionReference(?NetworkTransactionReference networkTransactionReference): void |
|
||||
| `sellerProtection` | [`?SellerProtection`](../../doc/models/seller-protection.md) | Optional | The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). | getSellerProtection(): ?SellerProtection | setSellerProtection(?SellerProtection sellerProtection): void |
|
||||
| `expirationTime` | `?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})$` | getExpirationTime(): ?string | setExpirationTime(?string expirationTime): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). | getLinks(): ?array | setLinks(?array links): void |
|
||||
| `createTime` | `?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})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void |
|
||||
| `updateTime` | `?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})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void |
|
||||
| `processorResponse` | [`?ProcessorResponse`](../../doc/models/processor-response.md) | Optional | The processor response information for payment requests, such as direct credit card transactions. | getProcessorResponse(): ?ProcessorResponse | setProcessorResponse(?ProcessorResponse processorResponse): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "VOIDED",
|
||||
"status_details": {
|
||||
"reason": "PENDING_REVIEW"
|
||||
},
|
||||
"id": "id6",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"invoice_id": "invoice_id6"
|
||||
}
|
||||
```
|
||||
|
||||
43
doc/models/authorization.md
Normal file
43
doc/models/authorization.md
Normal file
@@ -0,0 +1,43 @@
|
||||
|
||||
# Authorization
|
||||
|
||||
The authorized payment transaction.
|
||||
|
||||
## Structure
|
||||
|
||||
`Authorization`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `status` | [`?string(AuthorizationStatus)`](../../doc/models/authorization-status.md) | Optional | The status for the authorized payment. | getStatus(): ?string | setStatus(?string status): void |
|
||||
| `statusDetails` | [`?AuthorizationStatusDetails`](../../doc/models/authorization-status-details.md) | Optional | The details of the authorized payment status. | getStatusDetails(): ?AuthorizationStatusDetails | setStatusDetails(?AuthorizationStatusDetails statusDetails): void |
|
||||
| `id` | `?string` | Optional | The PayPal-generated ID for the authorized payment. | getId(): ?string | setId(?string id): 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 |
|
||||
| `invoiceId` | `?string` | Optional | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void |
|
||||
| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.<br>**Constraints**: *Maximum Length*: `255` | getCustomId(): ?string | setCustomId(?string customId): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransactionReference | setNetworkTransactionReference(?NetworkTransactionReference networkTransactionReference): void |
|
||||
| `sellerProtection` | [`?SellerProtection`](../../doc/models/seller-protection.md) | Optional | The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). | getSellerProtection(): ?SellerProtection | setSellerProtection(?SellerProtection sellerProtection): void |
|
||||
| `expirationTime` | `?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})$` | getExpirationTime(): ?string | setExpirationTime(?string expirationTime): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). | getLinks(): ?array | setLinks(?array links): void |
|
||||
| `createTime` | `?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})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void |
|
||||
| `updateTime` | `?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})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "CREATED",
|
||||
"status_details": {
|
||||
"reason": "PENDING_REVIEW"
|
||||
},
|
||||
"id": "id8",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"invoice_id": "invoice_id8"
|
||||
}
|
||||
```
|
||||
|
||||
38
doc/models/avs-code.md
Normal file
38
doc/models/avs-code.md
Normal file
@@ -0,0 +1,38 @@
|
||||
|
||||
# AVS Code
|
||||
|
||||
The address verification code for Visa, Discover, Mastercard, or American Express transactions.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`AVSCode`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `A` |
|
||||
| `B` |
|
||||
| `C` |
|
||||
| `D` |
|
||||
| `E` |
|
||||
| `F` |
|
||||
| `G` |
|
||||
| `I` |
|
||||
| `M` |
|
||||
| `N` |
|
||||
| `P` |
|
||||
| `R` |
|
||||
| `S` |
|
||||
| `U` |
|
||||
| `W` |
|
||||
| `X` |
|
||||
| `Y` |
|
||||
| `Z` |
|
||||
| `NULL` |
|
||||
| `ENUM_0` |
|
||||
| `ENUM_1` |
|
||||
| `ENUM_2` |
|
||||
| `ENUM_3` |
|
||||
| `ENUM_4` |
|
||||
|
||||
31
doc/models/bancontact-payment-object.md
Normal file
31
doc/models/bancontact-payment-object.md
Normal file
@@ -0,0 +1,31 @@
|
||||
|
||||
# Bancontact Payment Object
|
||||
|
||||
Information used to pay Bancontact.
|
||||
|
||||
## Structure
|
||||
|
||||
`BancontactPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `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 |
|
||||
| `bic` | `?string` | Optional | The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.<br>**Constraints**: *Minimum Length*: `8`, *Maximum Length*: `11`, *Pattern*: `^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$` | getBic(): ?string | setBic(?string bic): void |
|
||||
| `ibanLastChars` | `?string` | Optional | The last characters of the IBAN used to pay.<br>**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `34`, *Pattern*: `[a-zA-Z0-9]{4}` | getIbanLastChars(): ?string | setIbanLastChars(?string ibanLastChars): void |
|
||||
| `cardLastDigits` | `?string` | Optional | The last digits of the card used to fund the Bancontact payment.<br>**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `4`, *Pattern*: `[0-9]{4}` | getCardLastDigits(): ?string | setCardLastDigits(?string cardLastDigits): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name6",
|
||||
"country_code": "country_code6",
|
||||
"bic": "bic8",
|
||||
"iban_last_chars": "iban_last_chars4",
|
||||
"card_last_digits": "card_last_digits0"
|
||||
}
|
||||
```
|
||||
|
||||
33
doc/models/bancontact-payment-request.md
Normal file
33
doc/models/bancontact-payment-request.md
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
# Bancontact Payment Request
|
||||
|
||||
Information needed to pay using Bancontact.
|
||||
|
||||
## Structure
|
||||
|
||||
`BancontactPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `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 |
|
||||
| `experienceContext` | [`?ExperienceContext`](../../doc/models/experience-context.md) | Optional | Customizes the payer experience during the approval process for the payment. | getExperienceContext(): ?ExperienceContext | setExperienceContext(?ExperienceContext experienceContext): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name8",
|
||||
"country_code": "country_code8",
|
||||
"experience_context": {
|
||||
"brand_name": "brand_name2",
|
||||
"locale": "locale6",
|
||||
"shipping_preference": "NO_SHIPPING",
|
||||
"return_url": "return_url4",
|
||||
"cancel_url": "cancel_url6"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
33
doc/models/bin-details.md
Normal file
33
doc/models/bin-details.md
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
# Bin Details
|
||||
|
||||
Bank Identification Number (BIN) details used to fund a payment.
|
||||
|
||||
## Structure
|
||||
|
||||
`BinDetails`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `bin` | `?string` | Optional | The Bank Identification Number (BIN) signifies the number that is being used to identify the granular level details (except the PII information) of the card.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `25`, *Pattern*: `^[0-9]+$` | getBin(): ?string | setBin(?string bin): void |
|
||||
| `issuingBank` | `?string` | Optional | The issuer of the card instrument.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64` | getIssuingBank(): ?string | setIssuingBank(?string issuingBank): void |
|
||||
| `binCountryCode` | `?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)$` | getBinCountryCode(): ?string | setBinCountryCode(?string binCountryCode): void |
|
||||
| `products` | `?(string[])` | Optional | The type of card product assigned to the BIN by the issuer. These values are defined by the issuer and may change over time. Some examples include: PREPAID_GIFT, CONSUMER, CORPORATE.<br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `256`, *Minimum Length*: `1`, *Maximum Length*: `255` | getProducts(): ?array | setProducts(?array products): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"bin": "bin0",
|
||||
"issuing_bank": "issuing_bank0",
|
||||
"bin_country_code": "bin_country_code4",
|
||||
"products": [
|
||||
"products8",
|
||||
"products9",
|
||||
"products0"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
33
doc/models/blik-experience-context.md
Normal file
33
doc/models/blik-experience-context.md
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
# BLIK Experience Context
|
||||
|
||||
Customizes the payer experience during the approval process for the BLIK payment.
|
||||
|
||||
## Structure
|
||||
|
||||
`BLIKExperienceContext`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `brandName` | `?string` | Optional | The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.*$` | getBrandName(): ?string | setBrandName(?string brandName): void |
|
||||
| `locale` | `?string` | Optional | The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).<br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `10`, *Pattern*: `^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}\|[0-9]{3}))?$` | getLocale(): ?string | setLocale(?string locale): 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 |
|
||||
| `cancelUrl` | `?string` | Optional | Describes the URL. | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void |
|
||||
| `consumerIp` | `?string` | Optional | An Internet Protocol address (IP address). This address assigns a numerical label to each device that is connected to a computer network through the Internet Protocol. Supports IPv4 and IPv6 addresses.<br>**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `39`, *Pattern*: `^(([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])\.){3}([0-9]\|[1-9][0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])$\|^(([a-zA-Z]\|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z]\|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$\|^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}\|:))\|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}\|((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3})\|:))\|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})\|:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3})\|:))\|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})\|((:[0-9A-Fa-f]{1,4})?:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})\|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})\|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})\|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(:(((:[0-9A-Fa-f]{1,4}){1,7})\|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:)))(%.+)?\s*$` | getConsumerIp(): ?string | setConsumerIp(?string consumerIp): void |
|
||||
| `consumerUserAgent` | `?string` | Optional | The payer's User Agent. For example, Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0).<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `256`, *Pattern*: `^.*$` | getConsumerUserAgent(): ?string | setConsumerUserAgent(?string consumerUserAgent): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"shipping_preference": "GET_FROM_FILE",
|
||||
"brand_name": "brand_name0",
|
||||
"locale": "locale4",
|
||||
"return_url": "return_url2",
|
||||
"cancel_url": "cancel_url4"
|
||||
}
|
||||
```
|
||||
|
||||
23
doc/models/blik-level-0-payment-object.md
Normal file
23
doc/models/blik-level-0-payment-object.md
Normal file
@@ -0,0 +1,23 @@
|
||||
|
||||
# BLIK Level 0 Payment Object
|
||||
|
||||
Information used to pay using BLIK level_0 flow.
|
||||
|
||||
## Structure
|
||||
|
||||
`BLIKLevel0PaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `authCode` | `string` | Required | The 6-digit code used to authenticate a consumer within BLIK.<br>**Constraints**: *Minimum Length*: `6`, *Maximum Length*: `6`, *Pattern*: `^[0-9]{6}$` | getAuthCode(): string | setAuthCode(string authCode): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"auth_code": "auth_code6"
|
||||
}
|
||||
```
|
||||
|
||||
23
doc/models/blik-one-click-payment-object.md
Normal file
23
doc/models/blik-one-click-payment-object.md
Normal file
@@ -0,0 +1,23 @@
|
||||
|
||||
# BLIK One Click Payment Object
|
||||
|
||||
Information used to pay using BLIK one-click flow.
|
||||
|
||||
## Structure
|
||||
|
||||
`BLIKOneClickPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `consumerReference` | `?string` | Optional | The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant.<br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `64`, *Pattern*: `^[ -~]{3,64}$` | getConsumerReference(): ?string | setConsumerReference(?string consumerReference): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"consumer_reference": "consumer_reference0"
|
||||
}
|
||||
```
|
||||
|
||||
29
doc/models/blik-one-click-payment-request.md
Normal file
29
doc/models/blik-one-click-payment-request.md
Normal file
@@ -0,0 +1,29 @@
|
||||
|
||||
# BLIK One Click Payment Request
|
||||
|
||||
Information used to pay using BLIK one-click flow.
|
||||
|
||||
## Structure
|
||||
|
||||
`BLIKOneClickPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `authCode` | `?string` | Optional | The 6-digit code used to authenticate a consumer within BLIK.<br>**Constraints**: *Minimum Length*: `6`, *Maximum Length*: `6`, *Pattern*: `^[0-9]{6}$` | getAuthCode(): ?string | setAuthCode(?string authCode): void |
|
||||
| `consumerReference` | `string` | Required | The merchant generated, unique reference serving as a primary identifier for accounts connected between Blik and a merchant.<br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `64`, *Pattern*: `^[ -~]{3,64}$` | getConsumerReference(): string | setConsumerReference(string consumerReference): void |
|
||||
| `aliasLabel` | `?string` | Optional | A bank defined identifier used as a display name to allow the payer to differentiate between multiple registered bank accounts.<br>**Constraints**: *Minimum Length*: `8`, *Maximum Length*: `35`, *Pattern*: `^[ -~]{8,35}$` | getAliasLabel(): ?string | setAliasLabel(?string aliasLabel): void |
|
||||
| `aliasKey` | `?string` | Optional | A Blik-defined identifier for a specific Blik-enabled bank account that is associated with a given merchant. Used only in conjunction with a Consumer Reference.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `19`, *Pattern*: `^[0-9]+$` | getAliasKey(): ?string | setAliasKey(?string aliasKey): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"auth_code": "auth_code8",
|
||||
"consumer_reference": "consumer_reference6",
|
||||
"alias_label": "alias_label2",
|
||||
"alias_key": "alias_key6"
|
||||
}
|
||||
```
|
||||
|
||||
31
doc/models/blik-payment-object.md
Normal file
31
doc/models/blik-payment-object.md
Normal file
@@ -0,0 +1,31 @@
|
||||
|
||||
# BLIK Payment Object
|
||||
|
||||
Information used to pay using BLIK.
|
||||
|
||||
## Structure
|
||||
|
||||
`BLIKPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `name` | `?string` | Optional | The full name representation like Mr J Smith.<br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void |
|
||||
| `countryCode` | `?string` | Optional | The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.</blockquote><br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): ?string | setCountryCode(?string countryCode): void |
|
||||
| `email` | `?string` | Optional | The internationalized email address.<blockquote><strong>Note:</strong> Up to 64 characters are allowed before and 255 characters are allowed after the <code>@</code> sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted <code>@</code> sign exists.</blockquote><br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: ``^(?:[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\|\[(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?\|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$`` | getEmail(): ?string | setEmail(?string email): void |
|
||||
| `oneClick` | [`?BLIKOneClickPaymentObject`](../../doc/models/blik-one-click-payment-object.md) | Optional | Information used to pay using BLIK one-click flow. | getOneClick(): ?BLIKOneClickPaymentObject | setOneClick(?BLIKOneClickPaymentObject oneClick): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name8",
|
||||
"country_code": "country_code8",
|
||||
"email": "email8",
|
||||
"one_click": {
|
||||
"consumer_reference": "consumer_reference2"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
46
doc/models/blik-payment-request.md
Normal file
46
doc/models/blik-payment-request.md
Normal file
@@ -0,0 +1,46 @@
|
||||
|
||||
# BLIK Payment Request
|
||||
|
||||
Information needed to pay using BLIK.
|
||||
|
||||
## Structure
|
||||
|
||||
`BLIKPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `name` | `string` | Required | The full name representation like Mr J Smith.<br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `300` | getName(): string | setName(string name): void |
|
||||
| `countryCode` | `string` | Required | The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.</blockquote><br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2`, *Pattern*: `^([A-Z]{2}\|C2)$` | getCountryCode(): string | setCountryCode(string countryCode): void |
|
||||
| `email` | `?string` | Optional | The internationalized email address.<blockquote><strong>Note:</strong> Up to 64 characters are allowed before and 255 characters are allowed after the <code>@</code> sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted <code>@</code> sign exists.</blockquote><br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `254`, *Pattern*: ``^(?:[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\|\[(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?\|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$`` | getEmail(): ?string | setEmail(?string email): void |
|
||||
| `experienceContext` | [`?BLIKExperienceContext`](../../doc/models/blik-experience-context.md) | Optional | Customizes the payer experience during the approval process for the BLIK payment. | getExperienceContext(): ?BLIKExperienceContext | setExperienceContext(?BLIKExperienceContext experienceContext): void |
|
||||
| `level0` | [`?BLIKLevel0PaymentObject`](../../doc/models/blik-level-0-payment-object.md) | Optional | Information used to pay using BLIK level_0 flow. | getLevel0(): ?BLIKLevel0PaymentObject | setLevel0(?BLIKLevel0PaymentObject level0): void |
|
||||
| `oneClick` | [`?BLIKOneClickPaymentRequest`](../../doc/models/blik-one-click-payment-request.md) | Optional | Information used to pay using BLIK one-click flow. | getOneClick(): ?BLIKOneClickPaymentRequest | setOneClick(?BLIKOneClickPaymentRequest oneClick): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name8",
|
||||
"country_code": "country_code8",
|
||||
"email": "email8",
|
||||
"experience_context": {
|
||||
"brand_name": "brand_name2",
|
||||
"locale": "locale6",
|
||||
"shipping_preference": "NO_SHIPPING",
|
||||
"return_url": "return_url4",
|
||||
"cancel_url": "cancel_url6"
|
||||
},
|
||||
"level_0": {
|
||||
"auth_code": "auth_code8"
|
||||
},
|
||||
"one_click": {
|
||||
"auth_code": "auth_code0",
|
||||
"consumer_reference": "consumer_reference2",
|
||||
"alias_label": "alias_label6",
|
||||
"alias_key": "alias_key4"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
26
doc/models/capture-incomplete-reason.md
Normal file
26
doc/models/capture-incomplete-reason.md
Normal file
@@ -0,0 +1,26 @@
|
||||
|
||||
# Capture Incomplete Reason
|
||||
|
||||
The reason why the captured payment status is `PENDING` or `DENIED`.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`CaptureIncompleteReason`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `BUYER_COMPLAINT` |
|
||||
| `CHARGEBACK` |
|
||||
| `ECHECK` |
|
||||
| `INTERNATIONAL_WITHDRAWAL` |
|
||||
| `OTHER` |
|
||||
| `PENDING_REVIEW` |
|
||||
| `RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION` |
|
||||
| `REFUNDED` |
|
||||
| `TRANSACTION_APPROVED_AWAITING_FUNDING` |
|
||||
| `UNILATERAL` |
|
||||
| `VERIFICATION_REQUIRED` |
|
||||
| `DECLINED_BY_RISK_FRAUD_FILTERS` |
|
||||
|
||||
48
doc/models/capture-payment-instruction.md
Normal file
48
doc/models/capture-payment-instruction.md
Normal file
@@ -0,0 +1,48 @@
|
||||
|
||||
# Capture Payment Instruction
|
||||
|
||||
Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.
|
||||
|
||||
## Structure
|
||||
|
||||
`CapturePaymentInstruction`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `platformFees` | [`?(PlatformFee[])`](../../doc/models/platform-fee.md) | Optional | An array of platform or partner fees, commissions, or brokerage fees that associated with the captured payment.<br>**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `1` | getPlatformFees(): ?array | setPlatformFees(?array platformFees): void |
|
||||
| `disbursementMode` | [`?string(DisbursementMode)`](../../doc/models/disbursement-mode.md) | Optional | The funds that are held on behalf of the merchant.<br>**Default**: `DisbursementMode::INSTANT`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `16`, *Pattern*: `^[A-Z_]+$` | getDisbursementMode(): ?string | setDisbursementMode(?string disbursementMode): void |
|
||||
| `payeeReceivableFxRateId` | `?string` | Optional | FX identifier generated returned by PayPal to be used for payment processing in order to honor FX rate (for eligible integrations) to be used when amount is settled/received into the payee account.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `4000`, *Pattern*: `^.*$` | getPayeeReceivableFxRateId(): ?string | setPayeeReceivableFxRateId(?string payeeReceivableFxRateId): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"disbursement_mode": "INSTANT",
|
||||
"platform_fees": [
|
||||
{
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"payee": {
|
||||
"email_address": "email_address4",
|
||||
"merchant_id": "merchant_id6"
|
||||
}
|
||||
},
|
||||
{
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"payee": {
|
||||
"email_address": "email_address4",
|
||||
"merchant_id": "merchant_id6"
|
||||
}
|
||||
}
|
||||
],
|
||||
"payee_receivable_fx_rate_id": "payee_receivable_fx_rate_id8"
|
||||
}
|
||||
```
|
||||
|
||||
68
doc/models/capture-request.md
Normal file
68
doc/models/capture-request.md
Normal file
@@ -0,0 +1,68 @@
|
||||
|
||||
# Capture Request
|
||||
|
||||
## Structure
|
||||
|
||||
`CaptureRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `invoiceId` | `?string` | Optional | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.{1,127}$` | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void |
|
||||
| `noteToPayer` | `?string` | Optional | An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^.{1,255}$` | getNoteToPayer(): ?string | setNoteToPayer(?string noteToPayer): 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 |
|
||||
| `finalCapture` | `?bool` | Optional | Indicates whether you can make additional captures against the authorized payment. Set to `true` if you do not intend to capture additional payments against the authorization. Set to `false` if you intend to capture additional payments against the authorization.<br>**Default**: `false` | getFinalCapture(): ?bool | setFinalCapture(?bool finalCapture): void |
|
||||
| `paymentInstruction` | [`?CapturePaymentInstruction`](../../doc/models/capture-payment-instruction.md) | Optional | Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order. | getPaymentInstruction(): ?CapturePaymentInstruction | setPaymentInstruction(?CapturePaymentInstruction paymentInstruction): void |
|
||||
| `softDescriptor` | `?string` | Optional | The payment descriptor on the payer's account statement.<br>**Constraints**: *Maximum Length*: `22` | getSoftDescriptor(): ?string | setSoftDescriptor(?string softDescriptor): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"final_capture": false,
|
||||
"invoice_id": "invoice_id4",
|
||||
"note_to_payer": "note_to_payer6",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"payment_instruction": {
|
||||
"platform_fees": [
|
||||
{
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"payee": {
|
||||
"email_address": "email_address4",
|
||||
"merchant_id": "merchant_id6"
|
||||
}
|
||||
},
|
||||
{
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"payee": {
|
||||
"email_address": "email_address4",
|
||||
"merchant_id": "merchant_id6"
|
||||
}
|
||||
},
|
||||
{
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"payee": {
|
||||
"email_address": "email_address4",
|
||||
"merchant_id": "merchant_id6"
|
||||
}
|
||||
}
|
||||
],
|
||||
"disbursement_mode": "INSTANT",
|
||||
"payee_receivable_fx_rate_id": "payee_receivable_fx_rate_id0"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
23
doc/models/capture-status-details.md
Normal file
23
doc/models/capture-status-details.md
Normal file
@@ -0,0 +1,23 @@
|
||||
|
||||
# Capture Status Details
|
||||
|
||||
The details of the captured payment status.
|
||||
|
||||
## Structure
|
||||
|
||||
`CaptureStatusDetails`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `reason` | [`?string(CaptureIncompleteReason)`](../../doc/models/capture-incomplete-reason.md) | Optional | The reason why the captured payment status is `PENDING` or `DENIED`.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64`, *Pattern*: `^[A-Z_]+$` | getReason(): ?string | setReason(?string reason): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"reason": "BUYER_COMPLAINT"
|
||||
}
|
||||
```
|
||||
|
||||
27
doc/models/capture-status-with-details.md
Normal file
27
doc/models/capture-status-with-details.md
Normal file
@@ -0,0 +1,27 @@
|
||||
|
||||
# Capture Status With Details
|
||||
|
||||
The status and status details of a captured payment.
|
||||
|
||||
## Structure
|
||||
|
||||
`CaptureStatusWithDetails`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `status` | [`?string(CaptureStatus)`](../../doc/models/capture-status.md) | Optional | The status of the captured payment. | getStatus(): ?string | setStatus(?string status): void |
|
||||
| `statusDetails` | [`?CaptureStatusDetails`](../../doc/models/capture-status-details.md) | Optional | The details of the captured payment status. | getStatusDetails(): ?CaptureStatusDetails | setStatusDetails(?CaptureStatusDetails statusDetails): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "COMPLETED",
|
||||
"status_details": {
|
||||
"reason": "VERIFICATION_REQUIRED"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
20
doc/models/capture-status.md
Normal file
20
doc/models/capture-status.md
Normal file
@@ -0,0 +1,20 @@
|
||||
|
||||
# Capture Status
|
||||
|
||||
The status of the captured payment.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`CaptureStatus`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `COMPLETED` |
|
||||
| `DECLINED` |
|
||||
| `PARTIALLY_REFUNDED` |
|
||||
| `PENDING` |
|
||||
| `REFUNDED` |
|
||||
| `FAILED` |
|
||||
|
||||
48
doc/models/capture.md
Normal file
48
doc/models/capture.md
Normal file
@@ -0,0 +1,48 @@
|
||||
|
||||
# Capture
|
||||
|
||||
A captured payment.
|
||||
|
||||
## Structure
|
||||
|
||||
`Capture`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `status` | [`?string(CaptureStatus)`](../../doc/models/capture-status.md) | Optional | The status of the captured payment. | getStatus(): ?string | setStatus(?string status): void |
|
||||
| `statusDetails` | [`?CaptureStatusDetails`](../../doc/models/capture-status-details.md) | Optional | The details of the captured payment status. | getStatusDetails(): ?CaptureStatusDetails | setStatusDetails(?CaptureStatusDetails statusDetails): void |
|
||||
| `id` | `?string` | Optional | The PayPal-generated ID for the captured payment. | getId(): ?string | setId(?string id): 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 |
|
||||
| `invoiceId` | `?string` | Optional | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void |
|
||||
| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.<br>**Constraints**: *Maximum Length*: `255` | getCustomId(): ?string | setCustomId(?string customId): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransactionReference | setNetworkTransactionReference(?NetworkTransactionReference networkTransactionReference): void |
|
||||
| `sellerProtection` | [`?SellerProtection`](../../doc/models/seller-protection.md) | Optional | The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). | getSellerProtection(): ?SellerProtection | setSellerProtection(?SellerProtection sellerProtection): void |
|
||||
| `finalCapture` | `?bool` | Optional | Indicates whether you can make additional captures against the authorized payment. Set to `true` if you do not intend to capture additional payments against the authorization. Set to `false` if you intend to capture additional payments against the authorization.<br>**Default**: `false` | getFinalCapture(): ?bool | setFinalCapture(?bool finalCapture): void |
|
||||
| `sellerReceivableBreakdown` | [`?SellerReceivableBreakdown`](../../doc/models/seller-receivable-breakdown.md) | Optional | The detailed breakdown of the capture activity. This is not available for transactions that are in pending state. | getSellerReceivableBreakdown(): ?SellerReceivableBreakdown | setSellerReceivableBreakdown(?SellerReceivableBreakdown sellerReceivableBreakdown): void |
|
||||
| `disbursementMode` | [`?string(DisbursementMode)`](../../doc/models/disbursement-mode.md) | Optional | The funds that are held on behalf of the merchant.<br>**Default**: `DisbursementMode::INSTANT`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `16`, *Pattern*: `^[A-Z_]+$` | getDisbursementMode(): ?string | setDisbursementMode(?string disbursementMode): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). | getLinks(): ?array | setLinks(?array links): void |
|
||||
| `processorResponse` | [`?ProcessorResponse`](../../doc/models/processor-response.md) | Optional | The processor response information for payment requests, such as direct credit card transactions. | getProcessorResponse(): ?ProcessorResponse | setProcessorResponse(?ProcessorResponse processorResponse): void |
|
||||
| `createTime` | `?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})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void |
|
||||
| `updateTime` | `?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})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"final_capture": false,
|
||||
"disbursement_mode": "INSTANT",
|
||||
"status": "PARTIALLY_REFUNDED",
|
||||
"status_details": {
|
||||
"reason": "VERIFICATION_REQUIRED"
|
||||
},
|
||||
"id": "id6",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"invoice_id": "invoice_id6"
|
||||
}
|
||||
```
|
||||
|
||||
50
doc/models/captured-payment.md
Normal file
50
doc/models/captured-payment.md
Normal file
@@ -0,0 +1,50 @@
|
||||
|
||||
# Captured Payment
|
||||
|
||||
A captured payment.
|
||||
|
||||
## Structure
|
||||
|
||||
`CapturedPayment`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `status` | [`?string(CaptureStatus)`](../../doc/models/capture-status.md) | Optional | The status of the captured payment. | getStatus(): ?string | setStatus(?string status): void |
|
||||
| `statusDetails` | [`?CaptureStatusDetails`](../../doc/models/capture-status-details.md) | Optional | The details of the captured payment status. | getStatusDetails(): ?CaptureStatusDetails | setStatusDetails(?CaptureStatusDetails statusDetails): void |
|
||||
| `id` | `?string` | Optional | The PayPal-generated ID for the captured payment. | getId(): ?string | setId(?string id): 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 |
|
||||
| `invoiceId` | `?string` | Optional | The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives. | getInvoiceId(): ?string | setInvoiceId(?string invoiceId): void |
|
||||
| `customId` | `?string` | Optional | The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.<br>**Constraints**: *Maximum Length*: `255` | getCustomId(): ?string | setCustomId(?string customId): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getNetworkTransactionReference(): ?NetworkTransactionReference | setNetworkTransactionReference(?NetworkTransactionReference networkTransactionReference): void |
|
||||
| `sellerProtection` | [`?SellerProtection`](../../doc/models/seller-protection.md) | Optional | The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection). | getSellerProtection(): ?SellerProtection | setSellerProtection(?SellerProtection sellerProtection): void |
|
||||
| `finalCapture` | `?bool` | Optional | Indicates whether you can make additional captures against the authorized payment. Set to `true` if you do not intend to capture additional payments against the authorization. Set to `false` if you intend to capture additional payments against the authorization.<br>**Default**: `false` | getFinalCapture(): ?bool | setFinalCapture(?bool finalCapture): void |
|
||||
| `sellerReceivableBreakdown` | [`?SellerReceivableBreakdown`](../../doc/models/seller-receivable-breakdown.md) | Optional | The detailed breakdown of the capture activity. This is not available for transactions that are in pending state. | getSellerReceivableBreakdown(): ?SellerReceivableBreakdown | setSellerReceivableBreakdown(?SellerReceivableBreakdown sellerReceivableBreakdown): void |
|
||||
| `disbursementMode` | [`?string(DisbursementMode)`](../../doc/models/disbursement-mode.md) | Optional | The funds that are held on behalf of the merchant.<br>**Default**: `DisbursementMode::INSTANT`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `16`, *Pattern*: `^[A-Z_]+$` | getDisbursementMode(): ?string | setDisbursementMode(?string disbursementMode): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). | getLinks(): ?array | setLinks(?array links): void |
|
||||
| `processorResponse` | [`?ProcessorResponse`](../../doc/models/processor-response.md) | Optional | The processor response information for payment requests, such as direct credit card transactions. | getProcessorResponse(): ?ProcessorResponse | setProcessorResponse(?ProcessorResponse processorResponse): void |
|
||||
| `createTime` | `?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})$` | getCreateTime(): ?string | setCreateTime(?string createTime): void |
|
||||
| `updateTime` | `?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})$` | getUpdateTime(): ?string | setUpdateTime(?string updateTime): void |
|
||||
| `supplementaryData` | [`?PaymentSupplementaryData`](../../doc/models/payment-supplementary-data.md) | Optional | The supplementary data. | getSupplementaryData(): ?PaymentSupplementaryData | setSupplementaryData(?PaymentSupplementaryData supplementaryData): void |
|
||||
| `payee` | [`?Payee`](../../doc/models/payee.md) | Optional | The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee. | getPayee(): ?Payee | setPayee(?Payee payee): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"final_capture": false,
|
||||
"disbursement_mode": "INSTANT",
|
||||
"status": "PARTIALLY_REFUNDED",
|
||||
"status_details": {
|
||||
"reason": "VERIFICATION_REQUIRED"
|
||||
},
|
||||
"id": "id4",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
},
|
||||
"invoice_id": "invoice_id4"
|
||||
}
|
||||
```
|
||||
|
||||
44
doc/models/card-attributes-response.md
Normal file
44
doc/models/card-attributes-response.md
Normal file
@@ -0,0 +1,44 @@
|
||||
|
||||
# Card Attributes Response
|
||||
|
||||
Additional attributes associated with the use of this card.
|
||||
|
||||
## Structure
|
||||
|
||||
`CardAttributesResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `vault` | [`?CardVaultResponse`](../../doc/models/card-vault-response.md) | Optional | The details about a saved Card payment source. | getVault(): ?CardVaultResponse | setVault(?CardVaultResponse vault): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"vault": {
|
||||
"id": "id6",
|
||||
"status": "APPROVED",
|
||||
"links": [
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
}
|
||||
],
|
||||
"customer": {
|
||||
"id": "id0",
|
||||
"email_address": "email_address2",
|
||||
"phone": {
|
||||
"phone_type": "OTHER",
|
||||
"phone_number": {
|
||||
"national_number": "national_number6"
|
||||
}
|
||||
},
|
||||
"merchant_customer_id": "merchant_customer_id2"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
41
doc/models/card-attributes.md
Normal file
41
doc/models/card-attributes.md
Normal file
@@ -0,0 +1,41 @@
|
||||
|
||||
# Card Attributes
|
||||
|
||||
Additional attributes associated with the use of this card.
|
||||
|
||||
## Structure
|
||||
|
||||
`CardAttributes`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `customer` | [`?CardCustomerInformation`](../../doc/models/card-customer-information.md) | Optional | The details about a customer in PayPal's system of record. | getCustomer(): ?CardCustomerInformation | setCustomer(?CardCustomerInformation customer): void |
|
||||
| `vault` | [`?VaultInstructionBase`](../../doc/models/vault-instruction-base.md) | Optional | Basic vault instruction specification that can be extended by specific payment sources that supports vaulting. | getVault(): ?VaultInstructionBase | setVault(?VaultInstructionBase vault): void |
|
||||
| `verification` | [`?CardVerification`](../../doc/models/card-verification.md) | Optional | The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS). | getVerification(): ?CardVerification | setVerification(?CardVerification verification): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"customer": {
|
||||
"id": "id0",
|
||||
"email_address": "email_address2",
|
||||
"phone": {
|
||||
"phone_type": "OTHER",
|
||||
"phone_number": {
|
||||
"national_number": "national_number6"
|
||||
}
|
||||
},
|
||||
"merchant_customer_id": "merchant_customer_id2"
|
||||
},
|
||||
"vault": {
|
||||
"store_in_vault": "ON_SUCCESS"
|
||||
},
|
||||
"verification": {
|
||||
"method": "3D_SECURE"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
26
doc/models/card-authentication-response.md
Normal file
26
doc/models/card-authentication-response.md
Normal file
@@ -0,0 +1,26 @@
|
||||
|
||||
# Card Authentication Response
|
||||
|
||||
Results of Authentication such as 3D Secure.
|
||||
|
||||
## Structure
|
||||
|
||||
`CardAuthenticationResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `threeDSecure` | [`?ThreeDSecureAuthenticationResponse`](../../doc/models/three-d-secure-authentication-response.md) | Optional | Results of 3D Secure Authentication. | getThreeDSecure(): ?ThreeDSecureAuthenticationResponse | setThreeDSecure(?ThreeDSecureAuthenticationResponse threeDSecure): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"three_d_secure": {
|
||||
"authentication_status": "C",
|
||||
"enrollment_status": "Y"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
39
doc/models/card-brand.md
Normal file
39
doc/models/card-brand.md
Normal file
@@ -0,0 +1,39 @@
|
||||
|
||||
# Card Brand
|
||||
|
||||
The card network or brand. Applies to credit, debit, gift, and payment cards.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`CardBrand`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `VISA` |
|
||||
| `MASTERCARD` |
|
||||
| `DISCOVER` |
|
||||
| `AMEX` |
|
||||
| `SOLO` |
|
||||
| `JCB` |
|
||||
| `STAR` |
|
||||
| `DELTA` |
|
||||
| `SWITCH_` |
|
||||
| `MAESTRO` |
|
||||
| `CB_NATIONALE` |
|
||||
| `CONFIGOGA` |
|
||||
| `CONFIDIS` |
|
||||
| `ELECTRON` |
|
||||
| `CETELEM` |
|
||||
| `CHINA_UNION_PAY` |
|
||||
| `DINERS` |
|
||||
| `ELO` |
|
||||
| `HIPER` |
|
||||
| `HIPERCARD` |
|
||||
| `RUPAY` |
|
||||
| `GE` |
|
||||
| `SYNCHRONY` |
|
||||
| `EFTPOS` |
|
||||
| `UNKNOWN` |
|
||||
|
||||
34
doc/models/card-customer-information.md
Normal file
34
doc/models/card-customer-information.md
Normal file
@@ -0,0 +1,34 @@
|
||||
|
||||
# Card Customer Information
|
||||
|
||||
The details about a customer in PayPal's system of record.
|
||||
|
||||
## Structure
|
||||
|
||||
`CardCustomerInformation`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `id` | `?string` | Optional | The unique ID for a customer generated by PayPal.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `22`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getId(): ?string | setId(?string id): 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 |
|
||||
| `phone` | [`?PhoneWithType`](../../doc/models/phone-with-type.md) | Optional | The phone information. | getPhone(): ?PhoneWithType | setPhone(?PhoneWithType phone): void |
|
||||
| `merchantCustomerId` | `?string` | Optional | Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64`, *Pattern*: `^[0-9a-zA-Z-_.^*$@#]+$` | getMerchantCustomerId(): ?string | setMerchantCustomerId(?string merchantCustomerId): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "id0",
|
||||
"email_address": "email_address2",
|
||||
"phone": {
|
||||
"phone_type": "OTHER",
|
||||
"phone_number": {
|
||||
"national_number": "national_number6"
|
||||
}
|
||||
},
|
||||
"merchant_customer_id": "merchant_customer_id2"
|
||||
}
|
||||
```
|
||||
|
||||
25
doc/models/card-experience-context.md
Normal file
25
doc/models/card-experience-context.md
Normal file
@@ -0,0 +1,25 @@
|
||||
|
||||
# Card Experience Context
|
||||
|
||||
Customizes the payer experience during the 3DS Approval for payment.
|
||||
|
||||
## Structure
|
||||
|
||||
`CardExperienceContext`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `returnUrl` | `?string` | Optional | Describes the URL. | getReturnUrl(): ?string | setReturnUrl(?string returnUrl): void |
|
||||
| `cancelUrl` | `?string` | Optional | Describes the URL. | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"return_url": "return_url2",
|
||||
"cancel_url": "cancel_url0"
|
||||
}
|
||||
```
|
||||
|
||||
25
doc/models/card-from-request.md
Normal file
25
doc/models/card-from-request.md
Normal file
@@ -0,0 +1,25 @@
|
||||
|
||||
# Card From Request
|
||||
|
||||
Representation of card details as received in the request.
|
||||
|
||||
## Structure
|
||||
|
||||
`CardFromRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `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,}` | getLastDigits(): ?string | setLastDigits(?string lastDigits): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"expiry": "expiry6",
|
||||
"last_digits": "last_digits2"
|
||||
}
|
||||
```
|
||||
|
||||
45
doc/models/card-payment-token.md
Normal file
45
doc/models/card-payment-token.md
Normal file
@@ -0,0 +1,45 @@
|
||||
|
||||
# Card Payment Token
|
||||
|
||||
Full representation of a Card Payment Token including network token.
|
||||
|
||||
## Structure
|
||||
|
||||
`CardPaymentToken`
|
||||
|
||||
## 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*: `2`, *Maximum Length*: `300`, *Pattern*: `^[A-Za-z ]+$` | getName(): ?string | setName(?string name): void |
|
||||
| `lastDigits` | `?string` | Optional | The last digits of the payment card.<br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `4`, *Pattern*: `[0-9]{2,}` | getLastDigits(): ?string | setLastDigits(?string lastDigits): 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 |
|
||||
| `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 |
|
||||
| `billingAddress` | [`?AddressDetails`](../../doc/models/address-details.md) | Optional | Address request details. | getBillingAddress(): ?AddressDetails | setBillingAddress(?AddressDetails billingAddress): void |
|
||||
| `verificationStatus` | `?string` | Optional | Verification status of Card.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getVerificationStatus(): ?string | setVerificationStatus(?string verificationStatus): void |
|
||||
| `verification` | [`?CardVerificationDetails`](../../doc/models/card-verification-details.md) | Optional | Card Verification details including the authorization details and 3D SECURE details. | getVerification(): ?CardVerificationDetails | setVerification(?CardVerificationDetails verification): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransactionReferenceEntity`](../../doc/models/network-transaction-reference-entity.md) | Optional | Previous network transaction reference including id in response. | getNetworkTransactionReference(): ?NetworkTransactionReferenceEntity | setNetworkTransactionReference(?NetworkTransactionReferenceEntity networkTransactionReference): void |
|
||||
| `authenticationResult` | [`?CardAuthenticationResponse`](../../doc/models/card-authentication-response.md) | Optional | Results of Authentication such as 3D Secure. | getAuthenticationResult(): ?CardAuthenticationResponse | setAuthenticationResult(?CardAuthenticationResponse authenticationResult): void |
|
||||
| `binDetails` | [`?BinDetails`](../../doc/models/bin-details.md) | Optional | Bank Identification Number (BIN) details used to fund a payment. | getBinDetails(): ?BinDetails | setBinDetails(?BinDetails binDetails): 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 |
|
||||
| `networkToken` | `mixed` | Optional | - | getNetworkToken(): | setNetworkToken( networkToken): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name2",
|
||||
"last_digits": "last_digits6",
|
||||
"brand": "STAR",
|
||||
"expiry": "expiry0",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
"admin_area_2": "admin_area_28",
|
||||
"admin_area_1": "admin_area_14",
|
||||
"postal_code": "postal_code0",
|
||||
"country_code": "country_code8"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
44
doc/models/card-request.md
Normal file
44
doc/models/card-request.md
Normal file
@@ -0,0 +1,44 @@
|
||||
|
||||
# Card Request
|
||||
|
||||
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>
|
||||
|
||||
## Structure
|
||||
|
||||
`CardRequest`
|
||||
|
||||
## 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 |
|
||||
| `securityCode` | `?string` | Optional | The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when `payment_initiator=MERCHANT`.<br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `4`, *Pattern*: `^[0-9]{3,4}$` | getSecurityCode(): ?string | setSecurityCode(?string securityCode): void |
|
||||
| `billingAddress` | [`?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). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void |
|
||||
| `attributes` | [`?CardAttributes`](../../doc/models/card-attributes.md) | Optional | Additional attributes associated with the use of this card. | getAttributes(): ?CardAttributes | setAttributes(?CardAttributes attributes): void |
|
||||
| `vaultId` | `?string` | Optional | The PayPal-generated ID for the vaulted payment source. This ID should be stored on the merchant's server so the saved payment source can be used for future transactions.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getVaultId(): ?string | setVaultId(?string vaultId): void |
|
||||
| `singleUseToken` | `?string` | Optional | The PayPal-generated, short-lived, one-time-use token, used to communicate payment information to PayPal for transaction processing.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getSingleUseToken(): ?string | setSingleUseToken(?string singleUseToken): void |
|
||||
| `storedCredential` | [`?CardStoredCredential`](../../doc/models/card-stored-credential.md) | Optional | Provides additional details to process a payment using a `card` that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).<br/>Parameter compatibility:<br/><ul><li>`payment_type=ONE_TIME` is compatible only with `payment_initiator=CUSTOMER`.</li><li>`usage=FIRST` is compatible only with `payment_initiator=CUSTOMER`.</li><li>`previous_transaction_reference` or `previous_network_transaction_reference` is compatible only with `payment_initiator=MERCHANT`.</li><li>Only one of the parameters - `previous_transaction_reference` and `previous_network_transaction_reference` - can be present in the request.</li></ul> | getStoredCredential(): ?CardStoredCredential | setStoredCredential(?CardStoredCredential storedCredential): void |
|
||||
| `networkToken` | [`?NetworkToken`](../../doc/models/network-token.md) | Optional | The Third Party Network token used to fund a payment. | getNetworkToken(): ?NetworkToken | setNetworkToken(?NetworkToken networkToken): void |
|
||||
| `experienceContext` | [`?CardExperienceContext`](../../doc/models/card-experience-context.md) | Optional | Customizes the payer experience during the 3DS Approval for payment. | getExperienceContext(): ?CardExperienceContext | setExperienceContext(?CardExperienceContext experienceContext): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name8",
|
||||
"number": "number4",
|
||||
"expiry": "expiry6",
|
||||
"security_code": "security_code0",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
"admin_area_2": "admin_area_28",
|
||||
"admin_area_1": "admin_area_14",
|
||||
"postal_code": "postal_code0",
|
||||
"country_code": "country_code8"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
44
doc/models/card-response-entity.md
Normal file
44
doc/models/card-response-entity.md
Normal file
@@ -0,0 +1,44 @@
|
||||
|
||||
# Card Response Entity
|
||||
|
||||
Full representation of a Card Payment Token.
|
||||
|
||||
## Structure
|
||||
|
||||
`CardResponseEntity`
|
||||
|
||||
## 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*: `2`, *Maximum Length*: `300`, *Pattern*: `^[A-Za-z ]+$` | getName(): ?string | setName(?string name): void |
|
||||
| `lastDigits` | `?string` | Optional | The last digits of the payment card.<br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `4`, *Pattern*: `[0-9]{2,}` | getLastDigits(): ?string | setLastDigits(?string lastDigits): 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 |
|
||||
| `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 |
|
||||
| `billingAddress` | [`?AddressDetails`](../../doc/models/address-details.md) | Optional | Address request details. | getBillingAddress(): ?AddressDetails | setBillingAddress(?AddressDetails billingAddress): void |
|
||||
| `verificationStatus` | `?string` | Optional | Verification status of Card.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getVerificationStatus(): ?string | setVerificationStatus(?string verificationStatus): void |
|
||||
| `verification` | [`?CardVerificationDetails`](../../doc/models/card-verification-details.md) | Optional | Card Verification details including the authorization details and 3D SECURE details. | getVerification(): ?CardVerificationDetails | setVerification(?CardVerificationDetails verification): void |
|
||||
| `networkTransactionReference` | [`?NetworkTransactionReferenceEntity`](../../doc/models/network-transaction-reference-entity.md) | Optional | Previous network transaction reference including id in response. | getNetworkTransactionReference(): ?NetworkTransactionReferenceEntity | setNetworkTransactionReference(?NetworkTransactionReferenceEntity networkTransactionReference): void |
|
||||
| `authenticationResult` | [`?CardAuthenticationResponse`](../../doc/models/card-authentication-response.md) | Optional | Results of Authentication such as 3D Secure. | getAuthenticationResult(): ?CardAuthenticationResponse | setAuthenticationResult(?CardAuthenticationResponse authenticationResult): void |
|
||||
| `binDetails` | [`?BinDetails`](../../doc/models/bin-details.md) | Optional | Bank Identification Number (BIN) details used to fund a payment. | getBinDetails(): ?BinDetails | setBinDetails(?BinDetails binDetails): 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 |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name4",
|
||||
"last_digits": "last_digits8",
|
||||
"brand": "HIPER",
|
||||
"expiry": "expiry2",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
"admin_area_2": "admin_area_28",
|
||||
"admin_area_1": "admin_area_14",
|
||||
"postal_code": "postal_code0",
|
||||
"country_code": "country_code8"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
40
doc/models/card-response.md
Normal file
40
doc/models/card-response.md
Normal file
@@ -0,0 +1,40 @@
|
||||
|
||||
# Card Response
|
||||
|
||||
The payment card to use to fund a payment. Card can be a credit or debit card.
|
||||
|
||||
## Structure
|
||||
|
||||
`CardResponse`
|
||||
|
||||
## 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*: `2`, *Maximum Length*: `300` | getName(): ?string | setName(?string name): void |
|
||||
| `lastDigits` | `?string` | Optional | The last digits of the payment card.<br>**Constraints**: *Pattern*: `[0-9]{2,}` | getLastDigits(): ?string | setLastDigits(?string lastDigits): 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 |
|
||||
| `availableNetworks` | [`?(string(CardBrand)[])`](../../doc/models/card-brand.md) | Optional | Array of brands or networks associated with the card.<br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `256`, *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[A-Z_]+$` | getAvailableNetworks(): ?array | setAvailableNetworks(?array availableNetworks): 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 |
|
||||
| `authenticationResult` | [`?AuthenticationResponse`](../../doc/models/authentication-response.md) | Optional | Results of Authentication such as 3D Secure. | getAuthenticationResult(): ?AuthenticationResponse | setAuthenticationResult(?AuthenticationResponse authenticationResult): void |
|
||||
| `attributes` | [`?CardAttributesResponse`](../../doc/models/card-attributes-response.md) | Optional | Additional attributes associated with the use of this card. | getAttributes(): ?CardAttributesResponse | setAttributes(?CardAttributesResponse attributes): void |
|
||||
| `fromRequest` | [`?CardFromRequest`](../../doc/models/card-from-request.md) | Optional | Representation of card details as received in the request. | getFromRequest(): ?CardFromRequest | setFromRequest(?CardFromRequest fromRequest): 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 |
|
||||
| `binDetails` | [`?BinDetails`](../../doc/models/bin-details.md) | Optional | Bank Identification Number (BIN) details used to fund a payment. | getBinDetails(): ?BinDetails | setBinDetails(?BinDetails binDetails): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name0",
|
||||
"last_digits": "last_digits4",
|
||||
"brand": "UNKNOWN",
|
||||
"available_networks": [
|
||||
"CONFIDIS",
|
||||
"CONFIGOGA",
|
||||
"CB_NATIONALE"
|
||||
],
|
||||
"type": "CREDIT"
|
||||
}
|
||||
```
|
||||
|
||||
34
doc/models/card-stored-credential.md
Normal file
34
doc/models/card-stored-credential.md
Normal file
@@ -0,0 +1,34 @@
|
||||
|
||||
# Card Stored Credential
|
||||
|
||||
Provides additional details to process a payment using a `card` that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file).<br/>Parameter compatibility:<br/><ul><li>`payment_type=ONE_TIME` is compatible only with `payment_initiator=CUSTOMER`.</li><li>`usage=FIRST` is compatible only with `payment_initiator=CUSTOMER`.</li><li>`previous_transaction_reference` or `previous_network_transaction_reference` is compatible only with `payment_initiator=MERCHANT`.</li><li>Only one of the parameters - `previous_transaction_reference` and `previous_network_transaction_reference` - can be present in the request.</li></ul>
|
||||
|
||||
## Structure
|
||||
|
||||
`CardStoredCredential`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `paymentInitiator` | [`string(PaymentInitiator)`](../../doc/models/payment-initiator.md) | Required | The person or party who initiated or triggered the payment.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getPaymentInitiator(): string | setPaymentInitiator(string paymentInitiator): void |
|
||||
| `paymentType` | [`string(StoredPaymentSourcePaymentType)`](../../doc/models/stored-payment-source-payment-type.md) | Required | Indicates the type of the stored payment_source payment.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getPaymentType(): string | setPaymentType(string paymentType): void |
|
||||
| `usage` | [`?string(StoredPaymentSourceUsageType)`](../../doc/models/stored-payment-source-usage-type.md) | Optional | Indicates if this is a `first` or `subsequent` payment using a stored payment source (also referred to as stored credential or card on file).<br>**Default**: `StoredPaymentSourceUsageType::DERIVED`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getUsage(): ?string | setUsage(?string usage): void |
|
||||
| `previousNetworkTransactionReference` | [`?NetworkTransactionReference`](../../doc/models/network-transaction-reference.md) | Optional | Reference values used by the card network to identify a transaction. | getPreviousNetworkTransactionReference(): ?NetworkTransactionReference | setPreviousNetworkTransactionReference(?NetworkTransactionReference previousNetworkTransactionReference): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"payment_initiator": "CUSTOMER",
|
||||
"payment_type": "ONE_TIME",
|
||||
"usage": "DERIVED",
|
||||
"previous_network_transaction_reference": {
|
||||
"id": "id6",
|
||||
"date": "date2",
|
||||
"network": "DELTA",
|
||||
"acquirer_reference_number": "acquirer_reference_number8"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
53
doc/models/card-supplementary-data.md
Normal file
53
doc/models/card-supplementary-data.md
Normal file
@@ -0,0 +1,53 @@
|
||||
|
||||
# Card Supplementary Data
|
||||
|
||||
Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see <a href="https://developer.paypal.com/docs/checkout/advanced/processing/">checkout</a> or <a href="https://developer.paypal.com/docs/multiparty/checkout/advanced/processing/">multiparty checkout</a>.
|
||||
|
||||
## Structure
|
||||
|
||||
`CardSupplementaryData`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `level2` | [`?Level2CardProcessingData`](../../doc/models/level-2-card-processing-data.md) | Optional | The level 2 card processing data collections. If your merchant account has been configured for Level 2 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 2 data for your business. | getLevel2(): ?Level2CardProcessingData | setLevel2(?Level2CardProcessingData level2): void |
|
||||
| `level3` | [`?Level3CardProcessingData`](../../doc/models/level-3-card-processing-data.md) | Optional | The level 3 card processing data collections, If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. Please contact your PayPal Technical Account Manager to define level 3 data for your business. | getLevel3(): ?Level3CardProcessingData | setLevel3(?Level3CardProcessingData level3): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"level_2": {
|
||||
"invoice_id": "invoice_id4",
|
||||
"tax_total": {
|
||||
"currency_code": "currency_code4",
|
||||
"value": "value0"
|
||||
}
|
||||
},
|
||||
"level_3": {
|
||||
"shipping_amount": {
|
||||
"currency_code": "currency_code0",
|
||||
"value": "value6"
|
||||
},
|
||||
"duty_amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value2"
|
||||
},
|
||||
"discount_amount": {
|
||||
"currency_code": "currency_code2",
|
||||
"value": "value8"
|
||||
},
|
||||
"shipping_address": {
|
||||
"address_line_1": "address_line_10",
|
||||
"address_line_2": "address_line_20",
|
||||
"admin_area_2": "admin_area_24",
|
||||
"admin_area_1": "admin_area_16",
|
||||
"postal_code": "postal_code2",
|
||||
"country_code": "country_code0"
|
||||
},
|
||||
"ships_from_postal_code": "ships_from_postal_code4"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
19
doc/models/card-type.md
Normal file
19
doc/models/card-type.md
Normal file
@@ -0,0 +1,19 @@
|
||||
|
||||
# Card Type
|
||||
|
||||
Type of card. i.e Credit, Debit and so on.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`CardType`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `CREDIT` |
|
||||
| `DEBIT` |
|
||||
| `PREPAID` |
|
||||
| `STORE` |
|
||||
| `UNKNOWN` |
|
||||
|
||||
50
doc/models/card-vault-response.md
Normal file
50
doc/models/card-vault-response.md
Normal file
@@ -0,0 +1,50 @@
|
||||
|
||||
# Card Vault Response
|
||||
|
||||
The details about a saved Card payment source.
|
||||
|
||||
## Structure
|
||||
|
||||
`CardVaultResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `id` | `?string` | Optional | The PayPal-generated ID for the saved payment source.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getId(): ?string | setId(?string id): void |
|
||||
| `status` | [`?string(VaultStatus)`](../../doc/models/vault-status.md) | Optional | The vault status.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getStatus(): ?string | setStatus(?string status): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related HATEOAS links.<br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getLinks(): ?array | setLinks(?array links): void |
|
||||
| `customer` | [`?CardCustomerInformation`](../../doc/models/card-customer-information.md) | Optional | The details about a customer in PayPal's system of record. | getCustomer(): ?CardCustomerInformation | setCustomer(?CardCustomerInformation customer): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "id6",
|
||||
"status": "VAULTED",
|
||||
"links": [
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
},
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
}
|
||||
],
|
||||
"customer": {
|
||||
"id": "id0",
|
||||
"email_address": "email_address2",
|
||||
"phone": {
|
||||
"phone_type": "OTHER",
|
||||
"phone_number": {
|
||||
"national_number": "national_number6"
|
||||
}
|
||||
},
|
||||
"merchant_customer_id": "merchant_customer_id2"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
35
doc/models/card-verification-details.md
Normal file
35
doc/models/card-verification-details.md
Normal file
@@ -0,0 +1,35 @@
|
||||
|
||||
# Card Verification Details
|
||||
|
||||
Card Verification details including the authorization details and 3D SECURE details.
|
||||
|
||||
## Structure
|
||||
|
||||
`CardVerificationDetails`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `networkTransactionId` | `?string` | Optional | Transaction Identifier as given by the network to indicate a previously executed CIT authorization. Only present when authorization is successful for a verification.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `1024`, *Pattern*: `^[a-zA-Z0-9-_@.:&+=*^'~#!$%()]+$` | getNetworkTransactionId(): ?string | setNetworkTransactionId(?string networkTransactionId): void |
|
||||
| `date` | `?string` | Optional | The date that the transaction was authorized by the scheme. This field may not be returned for all networks. MasterCard refers to this field as "BankNet reference date".<br>**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `4`, *Pattern*: `^[0-9]+$` | getDate(): ?string | setDate(?string date): void |
|
||||
| `network` | [`?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_]+$` | getNetwork(): ?string | setNetwork(?string network): 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 |
|
||||
| `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 |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"network_transaction_id": "network_transaction_id4",
|
||||
"date": "date8",
|
||||
"network": "EFTPOS",
|
||||
"time": "time2",
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
18
doc/models/card-verification-method.md
Normal file
18
doc/models/card-verification-method.md
Normal file
@@ -0,0 +1,18 @@
|
||||
|
||||
# Card Verification Method
|
||||
|
||||
The method used for card verification.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`CardVerificationMethod`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `SCA_ALWAYS` |
|
||||
| `SCA_WHEN_REQUIRED` |
|
||||
| `ENUM_3D_SECURE` |
|
||||
| `AVS_CVV` |
|
||||
|
||||
25
doc/models/card-verification-processor-response.md
Normal file
25
doc/models/card-verification-processor-response.md
Normal file
@@ -0,0 +1,25 @@
|
||||
|
||||
# Card Verification Processor Response
|
||||
|
||||
The processor response information for payment requests, such as direct credit card transactions.
|
||||
|
||||
## Structure
|
||||
|
||||
`CardVerificationProcessorResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `avsCode` | [`?string(AVSCode)`](../../doc/models/avs-code.md) | Optional | The address verification code for Visa, Discover, Mastercard, or American Express transactions. | getAvsCode(): ?string | setAvsCode(?string avsCode): void |
|
||||
| `cvvCode` | [`?string(CVVCode)`](../../doc/models/cvv-code.md) | Optional | The card verification value code for for Visa, Discover, Mastercard, or American Express. | getCvvCode(): ?string | setCvvCode(?string cvvCode): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"avs_code": "E",
|
||||
"cvv_code": "All others"
|
||||
}
|
||||
```
|
||||
|
||||
23
doc/models/card-verification.md
Normal file
23
doc/models/card-verification.md
Normal file
@@ -0,0 +1,23 @@
|
||||
|
||||
# Card Verification
|
||||
|
||||
The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS).
|
||||
|
||||
## Structure
|
||||
|
||||
`CardVerification`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `method` | [`?string(CardVerificationMethod)`](../../doc/models/card-verification-method.md) | Optional | The method used for card verification.<br>**Default**: `CardVerificationMethod::SCA_WHEN_REQUIRED`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255`, *Pattern*: `^[0-9A-Z_]+$` | getMethod(): ?string | setMethod(?string method): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "SCA_WHEN_REQUIRED"
|
||||
}
|
||||
```
|
||||
|
||||
16
doc/models/checkout-payment-intent.md
Normal file
16
doc/models/checkout-payment-intent.md
Normal file
@@ -0,0 +1,16 @@
|
||||
|
||||
# Checkout Payment Intent
|
||||
|
||||
The intent to either capture payment immediately or authorize a payment for an order after order creation.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`CheckoutPaymentIntent`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `CAPTURE` |
|
||||
| `AUTHORIZE` |
|
||||
|
||||
36
doc/models/cobranded-card.md
Normal file
36
doc/models/cobranded-card.md
Normal file
@@ -0,0 +1,36 @@
|
||||
|
||||
# Cobranded Card
|
||||
|
||||
Details about the merchant cobranded card used for order purchase.
|
||||
|
||||
## Structure
|
||||
|
||||
`CobrandedCard`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `labels` | `?(string[])` | Optional | Array of labels for the cobranded card.<br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `25`, *Minimum Length*: `1`, *Maximum Length*: `256` | getLabels(): ?array | setLabels(?array labels): void |
|
||||
| `payee` | [`?PayeeBase`](../../doc/models/payee-base.md) | Optional | The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee. | getPayee(): ?PayeeBase | setPayee(?PayeeBase payee): 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 |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"labels": [
|
||||
"labels2",
|
||||
"labels3"
|
||||
],
|
||||
"payee": {
|
||||
"email_address": "email_address4",
|
||||
"merchant_id": "merchant_id6"
|
||||
},
|
||||
"amount": {
|
||||
"currency_code": "currency_code6",
|
||||
"value": "value0"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
109
doc/models/confirm-order-request.md
Normal file
109
doc/models/confirm-order-request.md
Normal file
@@ -0,0 +1,109 @@
|
||||
|
||||
# Confirm Order Request
|
||||
|
||||
Payer confirms the intent to pay for the Order using the provided payment source.
|
||||
|
||||
## Structure
|
||||
|
||||
`ConfirmOrderRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `paymentSource` | [`PaymentSource`](../../doc/models/payment-source.md) | Required | The payment source definition. | getPaymentSource(): PaymentSource | setPaymentSource(PaymentSource paymentSource): void |
|
||||
| `processingInstruction` | [`?string(ProcessingInstruction)`](../../doc/models/processing-instruction.md) | Optional | The instruction to process an order.<br>**Default**: `ProcessingInstruction::NO_INSTRUCTION`<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36`, *Pattern*: `^[0-9A-Z_]+$` | getProcessingInstruction(): ?string | setProcessingInstruction(?string processingInstruction): void |
|
||||
| `applicationContext` | [`?OrderConfirmApplicationContext`](../../doc/models/order-confirm-application-context.md) | Optional | Customizes the payer confirmation experience. | getApplicationContext(): ?OrderConfirmApplicationContext | setApplicationContext(?OrderConfirmApplicationContext applicationContext): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"payment_source": {
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"number": "number6",
|
||||
"expiry": "expiry4",
|
||||
"security_code": "security_code8",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
"admin_area_2": "admin_area_28",
|
||||
"admin_area_1": "admin_area_14",
|
||||
"postal_code": "postal_code0",
|
||||
"country_code": "country_code8"
|
||||
}
|
||||
},
|
||||
"token": {
|
||||
"id": "id6",
|
||||
"type": "BILLING_AGREEMENT"
|
||||
},
|
||||
"paypal": {
|
||||
"vault_id": "vault_id0",
|
||||
"email_address": "email_address0",
|
||||
"name": {
|
||||
"given_name": "given_name2",
|
||||
"surname": "surname8"
|
||||
},
|
||||
"phone": {
|
||||
"phone_type": "OTHER",
|
||||
"phone_number": {
|
||||
"national_number": "national_number6"
|
||||
}
|
||||
},
|
||||
"birth_date": "birth_date8"
|
||||
},
|
||||
"bancontact": {
|
||||
"name": "name0",
|
||||
"country_code": "country_code0",
|
||||
"experience_context": {
|
||||
"brand_name": "brand_name2",
|
||||
"locale": "locale6",
|
||||
"shipping_preference": "NO_SHIPPING",
|
||||
"return_url": "return_url4",
|
||||
"cancel_url": "cancel_url6"
|
||||
}
|
||||
},
|
||||
"blik": {
|
||||
"name": "name2",
|
||||
"country_code": "country_code2",
|
||||
"email": "email4",
|
||||
"experience_context": {
|
||||
"brand_name": "brand_name2",
|
||||
"locale": "locale6",
|
||||
"shipping_preference": "NO_SHIPPING",
|
||||
"return_url": "return_url4",
|
||||
"cancel_url": "cancel_url6"
|
||||
},
|
||||
"level_0": {
|
||||
"auth_code": "auth_code8"
|
||||
},
|
||||
"one_click": {
|
||||
"auth_code": "auth_code0",
|
||||
"consumer_reference": "consumer_reference2",
|
||||
"alias_label": "alias_label6",
|
||||
"alias_key": "alias_key4"
|
||||
}
|
||||
}
|
||||
},
|
||||
"processing_instruction": "NO_INSTRUCTION",
|
||||
"application_context": {
|
||||
"brand_name": "brand_name8",
|
||||
"locale": "locale2",
|
||||
"return_url": "return_url0",
|
||||
"cancel_url": "cancel_url2",
|
||||
"stored_payment_source": {
|
||||
"payment_initiator": "CUSTOMER",
|
||||
"payment_type": "RECURRING",
|
||||
"usage": "FIRST",
|
||||
"previous_network_transaction_reference": {
|
||||
"id": "id6",
|
||||
"date": "date2",
|
||||
"network": "DELTA",
|
||||
"acquirer_reference_number": "acquirer_reference_number8"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
32
doc/models/customer-information.md
Normal file
32
doc/models/customer-information.md
Normal file
@@ -0,0 +1,32 @@
|
||||
|
||||
# Customer Information
|
||||
|
||||
The details about a customer in PayPal's system of record.
|
||||
|
||||
## Structure
|
||||
|
||||
`CustomerInformation`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `id` | `?string` | Optional | The unique ID for a customer generated by PayPal.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `22`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getId(): ?string | setId(?string id): 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 |
|
||||
| `phone` | [`?PhoneWithType`](../../doc/models/phone-with-type.md) | Optional | The phone information. | getPhone(): ?PhoneWithType | setPhone(?PhoneWithType phone): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "id6",
|
||||
"email_address": "email_address4",
|
||||
"phone": {
|
||||
"phone_type": "OTHER",
|
||||
"phone_number": {
|
||||
"national_number": "national_number6"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
25
doc/models/customer-request.md
Normal file
25
doc/models/customer-request.md
Normal file
@@ -0,0 +1,25 @@
|
||||
|
||||
# Customer Request
|
||||
|
||||
Customer in merchant's or partner's system of records.
|
||||
|
||||
## Structure
|
||||
|
||||
`CustomerRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `id` | `?string` | Optional | The unique ID for a customer generated by PayPal.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `22`, *Pattern*: `^[0-9a-zA-Z_-]+$` | getId(): ?string | setId(?string id): void |
|
||||
| `merchantCustomerId` | `?string` | Optional | Merchants and partners may already have a data-store where their customer information is persisted. Use merchant_customer_id to associate the PayPal-generated customer.id to your representation of a customer.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64`, *Pattern*: `^[0-9a-zA-Z-_.^*$@#]+$` | getMerchantCustomerId(): ?string | setMerchantCustomerId(?string merchantCustomerId): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "id8",
|
||||
"merchant_customer_id": "merchant_customer_id0"
|
||||
}
|
||||
```
|
||||
|
||||
236
doc/models/customer-vault-payment-tokens-response.md
Normal file
236
doc/models/customer-vault-payment-tokens-response.md
Normal file
@@ -0,0 +1,236 @@
|
||||
|
||||
# Customer Vault Payment Tokens Response
|
||||
|
||||
Collection of payment tokens saved for a given customer.
|
||||
|
||||
## Structure
|
||||
|
||||
`CustomerVaultPaymentTokensResponse`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `totalItems` | `?int` | Optional | Total number of items.<br>**Constraints**: `>= 1`, `<= 50` | getTotalItems(): ?int | setTotalItems(?int totalItems): void |
|
||||
| `totalPages` | `?int` | Optional | Total number of pages.<br>**Constraints**: `>= 1`, `<= 10` | getTotalPages(): ?int | setTotalPages(?int totalPages): void |
|
||||
| `customer` | [`?CustomerRequest`](../../doc/models/customer-request.md) | Optional | Customer in merchant's or partner's system of records. | getCustomer(): ?CustomerRequest | setCustomer(?CustomerRequest customer): void |
|
||||
| `paymentTokens` | [`?(PaymentTokenResponse[])`](../../doc/models/payment-token-response.md) | Optional | **Constraints**: *Minimum Items*: `0`, *Maximum Items*: `64` | getPaymentTokens(): ?array | setPaymentTokens(?array paymentTokens): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of related [HATEOAS links](/api/rest/responses/#hateoas).<br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `32` | getLinks(): ?array | setLinks(?array links): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"total_items": 132,
|
||||
"total_pages": 168,
|
||||
"customer": {
|
||||
"id": "id0",
|
||||
"merchant_customer_id": "merchant_customer_id2"
|
||||
},
|
||||
"payment_tokens": [
|
||||
{
|
||||
"id": "id4",
|
||||
"customer": {
|
||||
"id": "id0",
|
||||
"merchant_customer_id": "merchant_customer_id2"
|
||||
},
|
||||
"payment_source": {
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"brand": "RUPAY",
|
||||
"expiry": "expiry4",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
"admin_area_2": "admin_area_28",
|
||||
"admin_area_1": "admin_area_14",
|
||||
"postal_code": "postal_code0",
|
||||
"country_code": "country_code8"
|
||||
}
|
||||
},
|
||||
"paypal": {
|
||||
"description": "description2",
|
||||
"shipping": {
|
||||
"name": {
|
||||
"full_name": "full_name6"
|
||||
},
|
||||
"type": "SHIPPING",
|
||||
"address": {
|
||||
"address_line_1": "address_line_16",
|
||||
"address_line_2": "address_line_26",
|
||||
"admin_area_2": "admin_area_20",
|
||||
"admin_area_1": "admin_area_12",
|
||||
"postal_code": "postal_code8",
|
||||
"country_code": "country_code6"
|
||||
}
|
||||
},
|
||||
"permit_multiple_payment_tokens": false,
|
||||
"usage_type": "usage_type2",
|
||||
"customer_type": "customer_type6"
|
||||
},
|
||||
"venmo": {
|
||||
"description": "description6",
|
||||
"shipping": {
|
||||
"name": {
|
||||
"full_name": "full_name6"
|
||||
},
|
||||
"type": "SHIPPING",
|
||||
"address": {
|
||||
"address_line_1": "address_line_16",
|
||||
"address_line_2": "address_line_26",
|
||||
"admin_area_2": "admin_area_20",
|
||||
"admin_area_1": "admin_area_12",
|
||||
"postal_code": "postal_code8",
|
||||
"country_code": "country_code6"
|
||||
}
|
||||
},
|
||||
"permit_multiple_payment_tokens": false,
|
||||
"usage_type": "usage_type6",
|
||||
"customer_type": "customer_type0"
|
||||
},
|
||||
"apple_pay": {
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
"admin_area_2": "admin_area_28",
|
||||
"admin_area_1": "admin_area_14",
|
||||
"postal_code": "postal_code0",
|
||||
"country_code": "country_code8"
|
||||
}
|
||||
}
|
||||
},
|
||||
"bank": {
|
||||
"key1": "val1",
|
||||
"key2": "val2"
|
||||
}
|
||||
},
|
||||
"links": [
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
},
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "id4",
|
||||
"customer": {
|
||||
"id": "id0",
|
||||
"merchant_customer_id": "merchant_customer_id2"
|
||||
},
|
||||
"payment_source": {
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"brand": "RUPAY",
|
||||
"expiry": "expiry4",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
"admin_area_2": "admin_area_28",
|
||||
"admin_area_1": "admin_area_14",
|
||||
"postal_code": "postal_code0",
|
||||
"country_code": "country_code8"
|
||||
}
|
||||
},
|
||||
"paypal": {
|
||||
"description": "description2",
|
||||
"shipping": {
|
||||
"name": {
|
||||
"full_name": "full_name6"
|
||||
},
|
||||
"type": "SHIPPING",
|
||||
"address": {
|
||||
"address_line_1": "address_line_16",
|
||||
"address_line_2": "address_line_26",
|
||||
"admin_area_2": "admin_area_20",
|
||||
"admin_area_1": "admin_area_12",
|
||||
"postal_code": "postal_code8",
|
||||
"country_code": "country_code6"
|
||||
}
|
||||
},
|
||||
"permit_multiple_payment_tokens": false,
|
||||
"usage_type": "usage_type2",
|
||||
"customer_type": "customer_type6"
|
||||
},
|
||||
"venmo": {
|
||||
"description": "description6",
|
||||
"shipping": {
|
||||
"name": {
|
||||
"full_name": "full_name6"
|
||||
},
|
||||
"type": "SHIPPING",
|
||||
"address": {
|
||||
"address_line_1": "address_line_16",
|
||||
"address_line_2": "address_line_26",
|
||||
"admin_area_2": "admin_area_20",
|
||||
"admin_area_1": "admin_area_12",
|
||||
"postal_code": "postal_code8",
|
||||
"country_code": "country_code6"
|
||||
}
|
||||
},
|
||||
"permit_multiple_payment_tokens": false,
|
||||
"usage_type": "usage_type6",
|
||||
"customer_type": "customer_type0"
|
||||
},
|
||||
"apple_pay": {
|
||||
"card": {
|
||||
"name": "name6",
|
||||
"last_digits": "last_digits0",
|
||||
"type": "UNKNOWN",
|
||||
"brand": "RUPAY",
|
||||
"billing_address": {
|
||||
"address_line_1": "address_line_12",
|
||||
"address_line_2": "address_line_28",
|
||||
"admin_area_2": "admin_area_28",
|
||||
"admin_area_1": "admin_area_14",
|
||||
"postal_code": "postal_code0",
|
||||
"country_code": "country_code8"
|
||||
}
|
||||
}
|
||||
},
|
||||
"bank": {
|
||||
"key1": "val1",
|
||||
"key2": "val2"
|
||||
}
|
||||
},
|
||||
"links": [
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
},
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"links": [
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
},
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
28
doc/models/cvv-code.md
Normal file
28
doc/models/cvv-code.md
Normal file
@@ -0,0 +1,28 @@
|
||||
|
||||
# CVV Code
|
||||
|
||||
The card verification value code for for Visa, Discover, Mastercard, or American Express.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`CVVCode`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `E` |
|
||||
| `I` |
|
||||
| `M` |
|
||||
| `N` |
|
||||
| `P` |
|
||||
| `S` |
|
||||
| `U` |
|
||||
| `X` |
|
||||
| `ENUM_ALL_OTHERS` |
|
||||
| `ENUM_0` |
|
||||
| `ENUM_1` |
|
||||
| `ENUM_2` |
|
||||
| `ENUM_3` |
|
||||
| `ENUM_4` |
|
||||
|
||||
16
doc/models/disbursement-mode.md
Normal file
16
doc/models/disbursement-mode.md
Normal file
@@ -0,0 +1,16 @@
|
||||
|
||||
# Disbursement Mode
|
||||
|
||||
The funds that are held on behalf of the merchant.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`DisbursementMode`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `INSTANT` |
|
||||
| `DELAYED` |
|
||||
|
||||
16
doc/models/dispute-category.md
Normal file
16
doc/models/dispute-category.md
Normal file
@@ -0,0 +1,16 @@
|
||||
|
||||
# Dispute Category
|
||||
|
||||
The condition that is covered for the transaction.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`DisputeCategory`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `ITEM_NOT_RECEIVED` |
|
||||
| `UNAUTHORIZED_TRANSACTION` |
|
||||
|
||||
20
doc/models/eci-flag.md
Normal file
20
doc/models/eci-flag.md
Normal file
@@ -0,0 +1,20 @@
|
||||
|
||||
# ECI Flag
|
||||
|
||||
Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the Gateway/Processor.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`ECIFlag`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `MASTERCARD_NON_3D_SECURE_TRANSACTION` |
|
||||
| `MASTERCARD_ATTEMPTED_AUTHENTICATION_TRANSACTION` |
|
||||
| `MASTERCARD_FULLY_AUTHENTICATED_TRANSACTION` |
|
||||
| `FULLY_AUTHENTICATED_TRANSACTION` |
|
||||
| `ATTEMPTED_AUTHENTICATION_TRANSACTION` |
|
||||
| `NON_3D_SECURE_TRANSACTION` |
|
||||
|
||||
18
doc/models/enrollment-status.md
Normal file
18
doc/models/enrollment-status.md
Normal file
@@ -0,0 +1,18 @@
|
||||
|
||||
# Enrollment Status
|
||||
|
||||
Status of Authentication eligibility.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`EnrollmentStatus`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `Y` |
|
||||
| `N` |
|
||||
| `U` |
|
||||
| `B` |
|
||||
|
||||
27
doc/models/eps-payment-object.md
Normal file
27
doc/models/eps-payment-object.md
Normal file
@@ -0,0 +1,27 @@
|
||||
|
||||
# EPS Payment Object
|
||||
|
||||
Information used to pay using eps.
|
||||
|
||||
## Structure
|
||||
|
||||
`EPSPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `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 |
|
||||
| `bic` | `?string` | Optional | The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.<br>**Constraints**: *Minimum Length*: `8`, *Maximum Length*: `11`, *Pattern*: `^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$` | getBic(): ?string | setBic(?string bic): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name6",
|
||||
"country_code": "country_code6",
|
||||
"bic": "bic8"
|
||||
}
|
||||
```
|
||||
|
||||
33
doc/models/eps-payment-request.md
Normal file
33
doc/models/eps-payment-request.md
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
# EPS Payment Request
|
||||
|
||||
Information needed to pay using eps.
|
||||
|
||||
## Structure
|
||||
|
||||
`EPSPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `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 |
|
||||
| `experienceContext` | [`?ExperienceContext`](../../doc/models/experience-context.md) | Optional | Customizes the payer experience during the approval process for the payment. | getExperienceContext(): ?ExperienceContext | setExperienceContext(?ExperienceContext experienceContext): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name8",
|
||||
"country_code": "country_code2",
|
||||
"experience_context": {
|
||||
"brand_name": "brand_name2",
|
||||
"locale": "locale6",
|
||||
"shipping_preference": "NO_SHIPPING",
|
||||
"return_url": "return_url4",
|
||||
"cancel_url": "cancel_url6"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
44
doc/models/error-details.md
Normal file
44
doc/models/error-details.md
Normal file
@@ -0,0 +1,44 @@
|
||||
|
||||
# Error Details
|
||||
|
||||
The error details. Required for client-side `4XX` errors.
|
||||
|
||||
## Structure
|
||||
|
||||
`ErrorDetails`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `field` | `?string` | Optional | The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors. | getField(): ?string | setField(?string field): void |
|
||||
| `value` | `?string` | Optional | The value of the field that caused the error. | getValue(): ?string | setValue(?string value): void |
|
||||
| `location` | `?string` | Optional | The location of the field that caused the error. Value is `body`, `path`, or `query`.<br>**Default**: `'body'` | getLocation(): ?string | setLocation(?string location): void |
|
||||
| `issue` | `string` | Required | The unique, fine-grained application-level error code. | getIssue(): string | setIssue(string issue): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links) that are either relevant to the issue by providing additional information or offering potential resolutions.<br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `4` | getLinks(): ?array | setLinks(?array links): void |
|
||||
| `description` | `?string` | Optional | The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value. | getDescription(): ?string | setDescription(?string description): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"location": "body",
|
||||
"issue": "issue8",
|
||||
"field": "field0",
|
||||
"value": "value8",
|
||||
"links": [
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
},
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
}
|
||||
],
|
||||
"description": "description4"
|
||||
}
|
||||
```
|
||||
|
||||
81
doc/models/error-exception.md
Normal file
81
doc/models/error-exception.md
Normal file
@@ -0,0 +1,81 @@
|
||||
|
||||
# Error Exception
|
||||
|
||||
The error details.
|
||||
|
||||
## Structure
|
||||
|
||||
`ErrorException`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `name` | `string` | Required | The human-readable, unique name of the error. | getName(): string | setName(string name): void |
|
||||
| `message` | `string` | Required | The message that describes the error. | getMessage(): string | setMessage(string message): void |
|
||||
| `debugId` | `string` | Required | The PayPal internal ID. Used for correlation purposes. | getDebugId(): string | setDebugId(string debugId): void |
|
||||
| `details` | [`?(ErrorDetails[])`](../../doc/models/error-details.md) | Optional | An array of additional details about the error. | getDetails(): ?array | setDetails(?array details): void |
|
||||
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links). | getLinks(): ?array | setLinks(?array links): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name4",
|
||||
"message": "message4",
|
||||
"debug_id": "debug_id0",
|
||||
"details": [
|
||||
{
|
||||
"field": "field4",
|
||||
"value": "value2",
|
||||
"location": "location4",
|
||||
"issue": "issue6",
|
||||
"links": [
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
},
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
}
|
||||
],
|
||||
"description": "description0"
|
||||
},
|
||||
{
|
||||
"field": "field4",
|
||||
"value": "value2",
|
||||
"location": "location4",
|
||||
"issue": "issue6",
|
||||
"links": [
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
},
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
}
|
||||
],
|
||||
"description": "description0"
|
||||
}
|
||||
],
|
||||
"links": [
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
},
|
||||
{
|
||||
"href": "href6",
|
||||
"rel": "rel0",
|
||||
"method": "HEAD"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
27
doc/models/exchange-rate.md
Normal file
27
doc/models/exchange-rate.md
Normal file
@@ -0,0 +1,27 @@
|
||||
|
||||
# Exchange Rate
|
||||
|
||||
The exchange rate that determines the amount to convert from one currency to another currency.
|
||||
|
||||
## Structure
|
||||
|
||||
`ExchangeRate`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `sourceCurrency` | `?string` | Optional | The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.<br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `3` | getSourceCurrency(): ?string | setSourceCurrency(?string sourceCurrency): void |
|
||||
| `targetCurrency` | `?string` | Optional | The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.<br>**Constraints**: *Minimum Length*: `3`, *Maximum Length*: `3` | getTargetCurrency(): ?string | setTargetCurrency(?string targetCurrency): void |
|
||||
| `value` | `?string` | Optional | The target currency amount. Equivalent to one unit of the source currency. Formatted as integer or decimal value with one to 15 digits to the right of the decimal point. | getValue(): ?string | setValue(?string value): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"source_currency": "source_currency0",
|
||||
"target_currency": "target_currency2",
|
||||
"value": "value2"
|
||||
}
|
||||
```
|
||||
|
||||
31
doc/models/experience-context.md
Normal file
31
doc/models/experience-context.md
Normal file
@@ -0,0 +1,31 @@
|
||||
|
||||
# Experience Context
|
||||
|
||||
Customizes the payer experience during the approval process for the payment.
|
||||
|
||||
## Structure
|
||||
|
||||
`ExperienceContext`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `brandName` | `?string` | Optional | The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode.<br>**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `127`, *Pattern*: `^.*$` | getBrandName(): ?string | setBrandName(?string brandName): void |
|
||||
| `locale` | `?string` | Optional | The [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/).<br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `10`, *Pattern*: `^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}\|[0-9]{3}))?$` | getLocale(): ?string | setLocale(?string locale): 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 |
|
||||
| `cancelUrl` | `?string` | Optional | Describes the URL. | getCancelUrl(): ?string | setCancelUrl(?string cancelUrl): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"shipping_preference": "GET_FROM_FILE",
|
||||
"brand_name": "brand_name0",
|
||||
"locale": "locale4",
|
||||
"return_url": "return_url2",
|
||||
"cancel_url": "cancel_url4"
|
||||
}
|
||||
```
|
||||
|
||||
18
doc/models/fullfillment-type.md
Normal file
18
doc/models/fullfillment-type.md
Normal file
@@ -0,0 +1,18 @@
|
||||
|
||||
# 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.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`FullfillmentType`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `SHIPPING` |
|
||||
| `PICKUP_IN_PERSON` |
|
||||
| `PICKUP_IN_STORE` |
|
||||
| `PICKUP_FROM_PERSON` |
|
||||
|
||||
27
doc/models/giropay-payment-object.md
Normal file
27
doc/models/giropay-payment-object.md
Normal file
@@ -0,0 +1,27 @@
|
||||
|
||||
# Giropay Payment Object
|
||||
|
||||
Information needed to pay using giropay.
|
||||
|
||||
## Structure
|
||||
|
||||
`GiropayPaymentObject`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `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 |
|
||||
| `bic` | `?string` | Optional | The business identification code (BIC). In payments systems, a BIC is used to identify a specific business, most commonly a bank.<br>**Constraints**: *Minimum Length*: `8`, *Maximum Length*: `11`, *Pattern*: `^[A-Z-a-z0-9]{4}[A-Z-a-z]{2}[A-Z-a-z0-9]{2}([A-Z-a-z0-9]{3})?$` | getBic(): ?string | setBic(?string bic): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name6",
|
||||
"country_code": "country_code6",
|
||||
"bic": "bic8"
|
||||
}
|
||||
```
|
||||
|
||||
33
doc/models/giropay-payment-request.md
Normal file
33
doc/models/giropay-payment-request.md
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
# Giropay Payment Request
|
||||
|
||||
Information needed to pay using giropay.
|
||||
|
||||
## Structure
|
||||
|
||||
`GiropayPaymentRequest`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `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 |
|
||||
| `experienceContext` | [`?ExperienceContext`](../../doc/models/experience-context.md) | Optional | Customizes the payer experience during the approval process for the payment. | getExperienceContext(): ?ExperienceContext | setExperienceContext(?ExperienceContext experienceContext): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "name8",
|
||||
"country_code": "country_code8",
|
||||
"experience_context": {
|
||||
"brand_name": "brand_name2",
|
||||
"locale": "locale6",
|
||||
"shipping_preference": "NO_SHIPPING",
|
||||
"return_url": "return_url4",
|
||||
"cancel_url": "cancel_url6"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
16
doc/models/google-pay-authentication-method.md
Normal file
16
doc/models/google-pay-authentication-method.md
Normal file
@@ -0,0 +1,16 @@
|
||||
|
||||
# Google Pay Authentication Method
|
||||
|
||||
Authentication Method which is used for the card transaction.
|
||||
|
||||
## Enumeration
|
||||
|
||||
`GooglePayAuthenticationMethod`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name |
|
||||
| --- |
|
||||
| `PAN_ONLY` |
|
||||
| `CRYPTOGRAM_3DS` |
|
||||
|
||||
25
doc/models/google-pay-card-attributes.md
Normal file
25
doc/models/google-pay-card-attributes.md
Normal file
@@ -0,0 +1,25 @@
|
||||
|
||||
# Google Pay Card Attributes
|
||||
|
||||
Additional attributes associated with the use of this card.
|
||||
|
||||
## Structure
|
||||
|
||||
`GooglePayCardAttributes`
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Tags | Description | Getter | Setter |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `verification` | [`?CardVerification`](../../doc/models/card-verification.md) | Optional | The API caller can opt in to verify the card through PayPal offered verification services (e.g. Smart Dollar Auth, 3DS). | getVerification(): ?CardVerification | setVerification(?CardVerification verification): void |
|
||||
|
||||
## Example (as JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"verification": {
|
||||
"method": "3D_SECURE"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user