{
"openapi": "3.0.0",
"info": {
"title": "Rate Table API",
"description": "This API allows sellers to retrieve and manage their custom shipping rate tables. In addition, this API also provides sellers in mainland China methods to configure split-payouts between two separate payment instruments.",
"contact": {
"name": "eBay Inc,"
},
"license": {
"name": "eBay API License Agreement",
"url": "https://go.developer.ebay.com/api-license-agreement"
},
"version": "2.1.0"
},
"servers": [
{
"url": "https://api.ebay.com{basePath}",
"description": "Production",
"variables": {
"basePath": {
"default": "/sell/account/v2"
}
}
}
],
"paths": {
"/rate_table/{rate_table_id}": {
"get": {
"tags": [
"rate_table"
],
"description": "This method retrieves an existing rate table identified by the rate_table_id path parameter.
getRateTable currently supports the retrieval of rate tables for the following eBay marketplace IDs:
EBAY_AU
EBAY_CA
EBAY_DE
EBAY_ES
EBAY_FR
EBAY_GB
EBAY_IT
EBAY_US
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.
ACTIVE
in order to do split payouts on that payment instrument.",
"operationId": "getPayoutSettings",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PayoutSettingsResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"x-response-codes": {
"errors": {
"395000": {
"domain": "API_ACCOUNT",
"category": "APPLICATION",
"description": "There was a problem with an eBay internal system or process. Contact eBay developer support for assistance."
}
}
}
}
},
"security": [
{
"api_auth": [
"https://api.ebay.com/oauth/api_scope/sell.finances"
]
}
]
}
},
"/payout_settings/update_percentage": {
"post": {
"tags": [
"payout_settings"
],
"description": "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.
CAD
. For implementation help, refer to eBay API documentation"
},
"value": {
"type": "string",
"description": "The monetary amount in the specified currency."
}
},
"description": "A complex type that describes the value of a monetary amount as represented by a global currency."
},
"Error": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Identifies the type of erro."
},
"domain": {
"type": "string",
"description": "Name for the primary system where the error occurred. This is relevant for application errors."
},
"errorId": {
"type": "integer",
"description": "A unique number to identify the error.",
"format": "int32"
},
"inputRefIds": {
"type": "array",
"description": "An array of request elements most closely associated to the error.",
"items": {
"type": "string"
}
},
"longMessage": {
"type": "string",
"description": "A more detailed explanation of the error."
},
"message": {
"type": "string",
"description": "Information on how to correct the problem, in the end user's terms and language where applicable."
},
"outputRefIds": {
"type": "array",
"description": "An array of request elements most closely associated to the error.",
"items": {
"type": "string"
}
},
"parameters": {
"type": "array",
"description": "An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.",
"items": {
"$ref": "#/components/schemas/ErrorParameter"
}
},
"subdomain": {
"type": "string",
"description": "Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc."
}
},
"description": "This type defines the fields that can be returned in an error."
},
"ErrorParameter": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The object of the error."
},
"value": {
"type": "string",
"description": "The value of the object."
}
}
},
"PayoutInstrument": {
"type": "object",
"properties": {
"accountLastFourDigits": {
"type": "string",
"description": "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."
},
"instrumentId": {
"type": "string",
"description": "The unique reference identifier for a payout instrument. The instrumentId is needed to change the split-payout percentages through an updatePayoutPercentage request."
},
"instrumentStatus": {
"type": "string",
"description": "The status of a payout instrument. Valid payout instrument statuses include:PENDING:
This status indicates that the account must be verified before it can be used.ACTIVE:
This status indicates that payouts are enabled on this account.VERIFICATION_FAILED:
This status indicates that verification has failed for this account and payouts are disabled.INACTIVE:
This status indicates that this account has become inactive and payouts are disabled.ACTIVE
. For implementation help, refer to eBay API documentation"
},
"instrumentType": {
"type": "string",
"description": "The type of account that received payouts. The value returned in this field may be:BANK
: Indicates that the payout was made to a seller's bank account.CARD
(Not Currently Available): Indicates that the payout went to a seller's debit card.PAYONEER
)BANK
, this value is the seller-provided nickname that the seller uses to represent the bank account that receives the payout.CARD
, this value is the debit card network for the debit card that receives the payout.PAYONEER
)50
indicates that 50% of the payout goes to the instrument."
}
},
"description": "This type is used to provide details about one or two of the seller's accounts that are enabled to receive payouts."
},
"PayoutSettingsResponse": {
"type": "object",
"properties": {
"payoutInstruments": {
"type": "array",
"description": "This array provides details about the seller's accounts defined for the seller's account.ACTIVE
.",
"items": {
"$ref": "#/components/schemas/PayoutInstrument"
}
}
},
"description": "The base response type of the getPayoutSettings method."
},
"Rate": {
"type": "object",
"properties": {
"additionalCost": {
"description": "An additional shipping cost added to the base shipping rate (i.e., shippingCost).EBAY_DE
(Germany)Worldwide
, Europe
, and Middle East
)US
(United States), CA
(Canada), and GB
(United Kingdom)NY
(New York) or SK
(Saskatchewan)AK/HI
(Alaska/Hawaii)shippingServiceDetails
."
}
},
"description": "This container details shipping rate information identified by a unique rate ID. A successful call returns the requested shipping rate information."
},
"RateTableDetails": {
"type": "object",
"properties": {
"marketplaceId": {
"type": "string",
"description": "Identifies the eBay marketplace to which the shipping rate table applies. For implementation help, refer to eBay API documentation"
},
"name": {
"type": "string",
"description": "The seller-defined name for the shipping rate table. Names must be unique for each table assigned to the same seller, shippingOptionType, and eBay marketplace.50
indicates that 50% of the payout goes to this instrument.