List Payout Type Mappings
GET/api/ebay/:integrationInstance/payout-type-mappings
Returns the resolved payout type mappings for the integration instance: per-instance override rows plus the global default rows they have not overridden. Each row maps a financial code (a normalized transaction type, expanded with its memo for non-sale charges) to a general-ledger account and an optional mapping group; is_override indicates an instance-specific row. eBay payout transactions carry no separate source type, so source_type is typically empty and the reason is taken from the transaction memo. Before listing, any financial codes newly seen in the instance's synced payout transactions are registered as unmapped global rows so they can be configured.
Authentication: Requires Bearer token.
Filterable columns: type, source_type, reason, financial_code, typical_amount_sign, mapping_status (mapped/unmapped), group_status (assigned/unassigned) (text), created_at, updated_at (datetime). filter[search] matches type, source type, reason, and financial code.
Filtering: pass filter[column]=value for an exact match, or filter[column.operator]=value with operators such as contains, does_not_contain, is, is_not, is_one_of, starts_with, ends_with, is_empty, is_not_empty (text), greater_than, less_than, greater_than_or_equal, less_than_or_equal, between (numeric), and is, is_not, before, after, on_or_before, on_or_after, between, today, yesterday, past_week, past_month, past_year, days_ago, past_days (date/datetime). Complex AND/OR trees can be sent as a base64-encoded JSON tree in the filter_groups parameter.
Allowed sorts: type, source_type, financial_code, created_at (prefix with - for descending; default financial_code). Pagination defaults to 10 per page.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.