apiz.ebay.com – sell-finances

Tools (9)

Extracted live via the executor SDK.

• payout.getPayout

  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/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.

  
  This method retrieves details on a specific seller payout. 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.
• payout.getPayouts

  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/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.

  
  This method is used to retrieve the details of one or more seller payouts. By using the filter query parameter, users can retrieve payouts processed within a specific date range, and/or they can retrieve payouts in a specific state.
  
  There are also pagination and sort query parameters that allow users to control the payouts that are returned in the response.
  
  If no payouts match the input criteria, an empty payload is returned.
• payout.getPayoutSummary

  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/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.

  
  This method is used to retrieve cumulative values for payouts in a particular state, or all states. The metadata in the response includes total payouts, the total number of monetary transactions (sales, refunds, credits) associated with those payouts, and the total dollar value of all payouts.
  
  If the filter query parameter is used to filter by payout status, only one payout status value may be used. If the filter query parameter is not used to filter by a specific payout status, cumulative values for payouts in all states are returned.
  
  The user can also use the filter query parameter to specify a date range, and then only payouts that were processed within that date range are considered.
• sellerFundsSummary.getSellerFundsSummary

  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/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.

  
  This method retrieves all pending funds that have not yet been distibuted through a seller payout.
  
  There are no input parameters for this method. The response payload includes available funds, funds being processed, funds on hold, and also an aggregate count of all three of these categories.
  
  If there are no funds that are pending, on hold, or being processed for the seller's account, no response payload is returned, and an http status code of 204 - No Content is returned instead.
• transaction.getTransactions

  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/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.

  
  The getTransactions method allows a seller to retrieve information about one or more of their monetary transactions.
  
  Note: For a complete list of transaction types, refer to TransactionTypeEnum.
  Numerous input filters are available which can be used individualy or combined to refine the data that are returned. For example:

  • SALE transactions for August 15, 2022;
  • RETURN transactions for the month of January, 2021;
  • Transactions currently in a transactionStatus equal to FUNDS_ON_HOLD.

  Refer to the filter [blocked] field for additional information about each filter and its use.
  
  Pagination and sort query parameters are also provided that allow users to further control how monetary transactions are displayed in the response.
  
  If no monetary transactions match the input criteria, an http status code of 204 No Content is returned with no response payload.
• transaction.getTransactionSummary

  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/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.

  
  The getTransactionSummary method retrieves cumulative information for monetary transactions. If applicable, the number of payments with a transactionStatus equal to FUNDS_ON_HOLD and the total monetary amount of these on-hold payments are also returned.
  
  Note: For a complete list of transaction types, refer to TransactionTypeEnum.
  Refer to the filter [blocked] field for additional information about each filter and its use.
  
  Note: Unless a transactionType filter is used to retrieve a specific type of transaction (e.g., SALE, REFUND, etc.,) the creditCount and creditAmount response fields both include order sales and seller credits information. That is, the count and value fields do not distinguish between these two types monetary transactions.
• transfer.getTransfer

  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/UK sellers, including all Finances API methods. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signatures to be included in the HTTP payload.

  
  This method retrieves detailed information regarding a TRANSFER transaction type. A TRANSFER is a monetary transaction type that involves a seller transferring money to eBay for reimbursement of one or more charges. For example, when a seller reimburses eBay for a buyer refund.
  
  If an ID is passed into the URI that is an identifier for another transaction type, this call will return an http status code of 404 Not found.
• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools