Skip to content

zVPS/ebay-sell-finances-php-client

Repository files navigation

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, add the following to composer.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
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure OAuth2 access token for authorization: Authorization Code
$config = Ebay\Sell\Finances\Configuration::getDefaultConfiguration()->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 GET /payout/{payout_Id}
PayoutApi getPayoutSummary GET /payout_summary
PayoutApi getPayouts GET /payout
SellerFundsSummaryApi getSellerFundsSummary GET /seller_funds_summary
TransactionApi getTransactionSummary GET /transaction_summary
TransactionApi getTransactions GET /transaction
TransferApi getTransfer GET /transfer/{transfer_Id}

Models

Authorization

Authorization Code

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://auth.ebay.com/oauth2/authorize
  • Scopes:

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.9.0
    • Package version: 5.0.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published