{ "opencollection": "1.0.0", "info": { "name": "eBay Account Advertising_eligibility Payout API", "version": "v1.9.2" }, "items": [ { "info": { "name": "Payout", "type": "folder" }, "items": [ { "info": { "name": "getPayout", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/payout/:payout_Id", "headers": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "value": "" } ], "params": [ { "name": "payout_Id", "value": "", "type": "path", "description": "This path parameter is used to specify the unique identifier of the payout being retrieved.

Use the getPayouts method to retrieve payout IDs, or check Seller Hub to get the payout ID. " } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "

Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU" }, { "info": { "name": "getPayouts", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/payout", "headers": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "The filter types that can be used here are discussed below. If none of these filters are used, all recent payouts in all states are returned:


If both the payoutDate and payoutStatus filters are used, payouts must satisfy both criteria to be returned. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField" }, { "name": "limit", "value": "", "type": "query", "description": "The number of payouts to return per page of the result set. Use this parameter in conjunction with the offset parameter to control the pagination of the output.

For example, if offset is set to 10 and limit is set to 10, the method retrieves payouts 11 thru 20 from the result set.

Note: This feature employs a zero-based list, where the first payout in the results set has an offset value of 0.

Maximum: 200
Default: 20" }, { "name": "offset", "value": "", "type": "query", "description": "This integer value indicates the actual position that the first payout returned on the current page has in the results set. So, if you wanted to view the 11th payout of the result set, you would set the offset value in the request to 10.

In the request, you can use the offset parameter in conjunction with the limit parameter to control the pagination of the output. For example, if offset is set to 30 and limit is set to 10, the method retrieves payouts 31 thru 40 from the resulting collection of payouts.

Note: This feature employs a zero-based list, where the first payout in the results set has an offset value of 0.

Default: 0 (zero)" }, { "name": "sort", "value": "", "type": "query", "description": "By default, payouts or failed payouts that match the input criteria are sorted in descending order according to the payout date/last attempted payout date (i.e., most recent payouts returned first).

To view payouts in ascending order instead (i.e., oldest payouts/attempted payouts first,) you would include the sort query parameter, and then set the value of its field parameter to payoutDate or lastAttemptedPayoutDate (if searching for failed, retryable payouts). Below is the proper syntax to use if filtering by a payout date range in ascending order:

https://apiz.ebay.com/sell/finances/v1/payout?filter=payoutDate:[2018-12-17T00:00:01.000Z..2018-12-24T00:00:01.000Z]&sort=payoutDate

Payouts can only be sorted according to payout date, and can not be sorted by payout status. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:SortField" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "

Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU" }, { "info": { "name": "getPayoutSummary", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/payout_summary", "headers": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "The two filter types that can be used here are discussed below. One or both of these filter types can be used. If none of these filters are used, the data returned in the response will reflect all previous payouts in all states:


If both the payoutDate and payoutStatus filters are used, only the payouts that satisfy both criteria are considered in the results. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/finances/types/cos:FilterField" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "

Important! Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made on behalf of EU" } ] } ], "bundled": true }