This API is used to retrieve seller payouts and monetary transaction details related to those payouts.

1.4.0 2021-11-16 18:52 UTC

This package is auto-updated.

Last update: 2024-05-17 01:35:08 UTC


This API is used to retrieve seller payouts and monetary transaction details related to those payouts.

Installation & Usage


PHP 7.3 and later. Should also work with PHP 8.0 but has not been tested.


To install the bindings via Composer, add the following to composer.json:

  "repositories": [
      "type": "vcs",
      "url": ""
  "require": {
    "macropage/sdk-ebay-rest-finance": "*@dev"

Then run composer install

Manual Installation

Download the files and include autoload.php:


Getting Started

Please follow the installation procedure and then run the following:

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

// Configure OAuth2 access token for authorization: api_auth
$config = macropage\SDKs\ebay\rest\finance\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new macropage\SDKs\ebay\rest\finance\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(),
$payoutId = 'payoutId_example'; // string | The unique identfier of the payout is passed in as a path parameter at the end of the call URI. <br/><br/>The <b>getPayouts</b> 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($payoutId);
} catch (Exception $e) {
    echo 'Exception when calling PayoutApi->getPayout: ', $e->getMessage(), PHP_EOL;

API Endpoints

All URIs are relative to

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}




  • Type: OAuth
  • Flow: accessCode
  • Authorization URL:
  • Scopes:


To run the tests, use:

composer install


About this package

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

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