Important! Split-payout functionality is only available to mainland China sellers, who can split payouts between their Payoneer account and bank account. Card payouts are not currently available for sellers in mainland China.
This method returns details on two payment instruments defined on a seller's account, including the ID, type, status, nickname, last four digits of the account number, and payout percentage for the instruments.
Using the instrumentId returned with this method, sellers can makes changes to the payout split of the instruments with the updatePayoutPercentage method. Note that the instrumentStatus of a payment instrument, also returned using this method, must be
ACTIVEin order to do split payouts on that payment instrument.
This method is supported in Sandbox environment. To access the endpoint, just replace the
api.ebay.com root URI with
This method has no URI parameters.
HTTP request headers
All requests made to eBay REST operations require you to provide the
Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
See OAuth access tokens for more information.
This call has no payload.
This call has no field definitions.
HTTP response headers
This call has no response headers.
|payoutInstruments||array of PayoutInstrument|
This array provides details about the seller's accounts defined for the seller's account.
The last four digits of the account that the seller uses to receive payouts. This may be the last four digits of a bank account or a payment processor account such as Payoneer.
The unique reference identifier for a payout instrument. The instrumentId is needed to change the split-payout percentages through an updatePayoutPercentage request.
The status of a payout instrument. Valid payout instrument statuses include:
See InstrumentStatusEnum for more details on each instrument status value.
Note: Payment accounts can only receive payouts if the status of a payout instrument is
The type of account that received payouts. The value returned in this field may be:
Note: Only Payoneer is currently supported for sellers in mainland China. Card payouts are not currently available for sellers in mainland China.
When instrumentType returns
The current payout percentage allocated to an instrument. For example,
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
|500||Internal Server Error|
For more on errors, plus the codes of other common errors, see Handling errors.
|395000||API_ACCOUNT||APPLICATION||There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.|
This call has no warnings.
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Get Payout Settings
This sample retrieves the information for two payout instruments for a seller.
Only the GET HTTP method and the endpoint are used for this method.
If the call is successful, the output returns the instrumentId, instrumentType, instrumentStatus, nickname, and accountLastFourDigits. If a payout percentage is set, payoutPercentage will be returned.