updatePayoutPercentage: eBay Account API

POST/payout_settings/update_percentage

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 allows sellers in mainland China to configure the split-payout percentage for two payout instruments available for seller payouts. For example, a seller can split payouts to have 70% of the payout go to a bank account and 30% go to a Payoneer account.

Note: The split-payout percentage must always add up to 100%. If the values do not equal 100, the call will fail. Instruments cannot be added/removed using Finance and Account APIs.
Users can specify the payout instruments being updated by using the instrumentId associated with each payment instrument in the request payload. This value is returned by using the getPayoutSettings method. Users can specify the percentage of the payout allocated to each instrument using the payoutPercentage request field. This value must be a whole number and cannot exceed 100.

For more details on configuring split-payout percentages, see Mainland China Split Payout Playbook.

Input

Resource URI

POST https://api.ebay.com/sell/account/v2/payout_settings/update_percentage

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

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.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

Header	Type	Description
Content-Type	string	This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required

Header

Type

Description

Content-Type

string

This header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.

Occurrence: Required

OAuth scope

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):

https://api.ebay.com/oauth/api_scope/sell.finances

See OAuth access tokens for more information.

Request payload

Copy complete valid JSON to clipboard

{ /* UpdatePayoutPercentageRequest */

"payoutInstruments" : [

{ /* UpdatePayoutPercentage */

"instrumentId" : "string",

"payoutPercentage" : "string"

}

]

}

Request fields

Input container/field Type Description

Input container/field	Type	Description
payoutInstruments	array of UpdatePayoutPercentage	This array allows the seller to set the payout split percentages for two accounts enabled to receive payouts. Occurrence: Required
payoutInstruments.instrumentId	string	The unique reference identifier for a payout instrument. This value is returned in the getPayoutSettings response and is needed to change split-payout percentages through an updatePayoutPercentage request. Occurrence: Required
payoutInstruments.payoutPercentage	string	The user-defined payout percentage allocated to this instrument. For example, `50` indicates that 50% of the payout goes to this instrument. The split-payout percentage must be a positive integer value from 0-100. The values of two instruments must always add up to 100%. If the values do not equal 100, the call will fail. Occurrence: Required

payoutInstruments

array of UpdatePayoutPercentage

This array allows the seller to set the payout split percentages for two accounts enabled to receive payouts.

Occurrence: Required

payoutInstruments.instrumentId

string

The unique reference identifier for a payout instrument. This value is returned in the getPayoutSettings response and is needed to change split-payout percentages through an updatePayoutPercentage request.

Occurrence: Required

payoutInstruments.payoutPercentage

string

The user-defined payout percentage allocated to this instrument. For example, 50 indicates that 50% of the payout goes to this instrument.

The split-payout percentage must be a positive integer value from 0-100. The values of two instruments must always add up to 100%. If the values do not equal 100, the call will fail.

Occurrence: Required

Output

HTTP response headers

This call has no response headers.

Response payload

This call has no payload.

Response fields

This call has no field definitions.

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.

Status	Meaning
204	No Content
400	Bad Request
500	Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

Code	Domain	Category	Meaning
394100	API_ACCOUNT	REQUEST	The seller is not eligible to set split-payout percentage.
394101	API_ACCOUNT	REQUEST	Missing instrumentId in request.
394102	API_ACCOUNT	REQUEST	Missing payoutPercentage in request.
394103	API_ACCOUNT	REQUEST	The 'payoutPercentage' {payoutPercentage} is not valid. The payout percentage should be an integer value. Minimum value: {0}, Maximum value: {100}.
394104	API_ACCOUNT	REQUEST	Duplicate instrumentId in request.
394105	API_ACCOUNT	REQUEST	Sum up of 'payoutPercentage' in request must be equal to 100, current value {payoutPercentage}.
394106	API_ACCOUNT	REQUEST	Instrument 'instrumentId' {instrumentId} not found.
394107	API_ACCOUNT	REQUEST	Instrument 'instrumentId' {instrumentId} missing in request.
395000	API_ACCOUNT	APPLICATION	There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
395100	API_ACCOUNT	APPLICATION	There was an internal error, please try again after sometime.

Warnings

This call has no warnings.

Samples

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: Update Split-Payout Percentage

Sample 2: Set Payout to One Instrument Only

Sample 1: Update Split-Payout Percentage

This call allows a seller to update the split-payout percentage on two payout instruments.

Input

The input requires the instrumentID and payoutPercentage fields for each payout instrument. In this example, the payout-split is set to 60/40 between the two instruments, where 60% of the payment goes to one instrument and 40% goes to the other.

POSThttps://api.ebay.com/sell/account/v2/payout_settings/update_percentage

Output

A successful call returns an HTTP status code of 204 No Content and has no response payload.

Sample 2: Set Payout to One Instrument Only

This call allows a seller to update the split-payout percentage on two payout instruments. In this example, the seller sets the payoutPercentage so that the entire payout goes to a single instrument.

Input

The input requires the instrumentID and payoutPercentage fields for each payout instrument. In this example, the payout-split is set to 100/0 between the two instruments, where 100% of the payment goes to one instrument and 0% goes to the other.

POSThttps://api.ebay.com/sell/account/v2/payout_settings/update_percentage

Output

A successful call returns an HTTP status code of 204 No Content and has no response payload.