https://github.com/zvps/ebay-sell-finances-php-client
https://github.com/zvps/ebay-sell-finances-php-client
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zvps/ebay-sell-finances-php-client
- Owner: zVPS
- Created: 2021-07-06T11:15:02.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-30T16:32:41.000Z (almost 5 years ago)
- Last Synced: 2024-12-27T05:41:43.557Z (over 1 year ago)
- Language: PHP
- Size: 146 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OpenAPIClient-php
This API is used to retrieve seller payouts and monetary transaction details related to those payouts.
## Installation & Usage
### Requirements
PHP 7.2 and later.
### Composer
To install the bindings via [Composer](https://getcomposer.org/), add the following to `composer.json`:
```json
{
"repositories": [
{
"type": "vcs",
"url": "https://github/zvps/ebay-sell-finances-php-client.git"
}
],
"require": {
"zvps/ebay-sell-finances-php-client": "*@dev"
}
}
```
Then run `composer install`
### Manual Installation
Download the files and include `autoload.php`:
```php
setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new Ebay\Sell\Finances\Api\PayoutApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$payout_id = 'payout_id_example'; // string | The unique identfier of the payout is passed in as a path parameter at the end of the call URI. The getPayouts method can be used to retrieve the unique identifier of a payout, or the user can check Seller Hub to get the payout ID.
try {
$result = $apiInstance->getPayout($payout_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PayoutApi->getPayout: ', $e->getMessage(), PHP_EOL;
}
```
## API Endpoints
All URIs are relative to *https://apiz.ebay.com/sell/finances/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PayoutApi* | [**getPayout**](docs/Api/PayoutApi.md#getpayout) | **GET** /payout/{payout_Id} |
*PayoutApi* | [**getPayoutSummary**](docs/Api/PayoutApi.md#getpayoutsummary) | **GET** /payout_summary |
*PayoutApi* | [**getPayouts**](docs/Api/PayoutApi.md#getpayouts) | **GET** /payout |
*SellerFundsSummaryApi* | [**getSellerFundsSummary**](docs/Api/SellerFundsSummaryApi.md#getsellerfundssummary) | **GET** /seller_funds_summary |
*TransactionApi* | [**getTransactionSummary**](docs/Api/TransactionApi.md#gettransactionsummary) | **GET** /transaction_summary |
*TransactionApi* | [**getTransactions**](docs/Api/TransactionApi.md#gettransactions) | **GET** /transaction |
*TransferApi* | [**getTransfer**](docs/Api/TransferApi.md#gettransfer) | **GET** /transfer/{transfer_Id} |
## Models
- [Amount](docs/Model/Amount.md)
- [BalanceAdjustment](docs/Model/BalanceAdjustment.md)
- [Buyer](docs/Model/Buyer.md)
- [Charge](docs/Model/Charge.md)
- [Fee](docs/Model/Fee.md)
- [FundingSource](docs/Model/FundingSource.md)
- [OrderLineItem](docs/Model/OrderLineItem.md)
- [Payout](docs/Model/Payout.md)
- [PayoutInstrument](docs/Model/PayoutInstrument.md)
- [PayoutSummaryResponse](docs/Model/PayoutSummaryResponse.md)
- [Payouts](docs/Model/Payouts.md)
- [Reference](docs/Model/Reference.md)
- [SellerFundsSummaryResponse](docs/Model/SellerFundsSummaryResponse.md)
- [Transaction](docs/Model/Transaction.md)
- [TransactionSummaryResponse](docs/Model/TransactionSummaryResponse.md)
- [Transactions](docs/Model/Transactions.md)
- [Transfer](docs/Model/Transfer.md)
- [TransferDetail](docs/Model/TransferDetail.md)
## Authorization
### Authorization Code
- **Type**: `OAuth`
- **Flow**: `accessCode`
- **Authorization URL**: `https://auth.ebay.com/oauth2/authorize`
- **Scopes**:
- **https://api.ebay.com/oauth/api_scope/sell.finances**: View and manage your payment and order information to display this information to you and allow you to initiate refunds using the third party application
## Tests
To run the tests, use:
```bash
composer install
vendor/bin/phpunit
```
## Author
## About this package
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: `1.9.0`
- Package version: `5.0.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`