Skip to main content

  • Important: Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.

  • OpenAPI Specification - Version 2.0 for all of our RESTful APIs will no longer be available starting April 5, 2023. We will continue leveraging OpenAPI Specification - Version 3.0 for new features in our RESTful APIs.

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

payout

Method NameHTTP MethodPathSummarySamples
getPayoutGET/payout/{payout_Id}Retrieve details of a specific seller payout.View getPayout - /payout/{payout_Id}
getPayoutsGET/payoutSearch for and retrieve the details of multiple payouts.View getPayouts - /payout
getPayoutSummaryGET/payout_summarySearch for and retrieve the details of multiple payouts.View getPayoutSummary - /payout_summary

seller_funds_summary

Method NameHTTP MethodPathSummarySamples
getSellerFundsSummaryGET/seller_funds_summaryRetrieve all pending funds that have not yet been distibuted through a seller payout.View getSellerFundsSummary - /seller_funds_summary

transaction

Method NameHTTP MethodPathSummarySamples
getTransactionsGET/transactionRetrieve details of one or more monetary transactions.View getTransactions - /transaction
getTransactionSummaryGET/transaction_summaryRetrieve total counts and values of the seller's order sales, seller credits, buyer refunds, and payment holds.View getTransactionSummary - /transaction_summary

transfer

Method NameHTTP MethodPathSummarySamples
getTransferGET/transfer/{transfer_Id}Retrieve detailed information on a TRANSFER transaction type.View getTransfer - /transfer/{transfer_Id}