API Documentation
- Admin Api Keys
- Admin Campaigns
- Admin Claims
- Admin Collections
- Admin Currencies
- Admin Customer Groups
- Admin Customers
- Admin Draft Orders
- Admin Exchanges
- Admin Fulfillment Providers
- Admin Fulfillment Sets
- Admin Fulfillments
- Admin Gift Cards
- Admin Inventory Items
- Admin Invites
- Admin Notifications
- Admin Order Edits
- Admin Orders
- Admin Payment Collections
- Admin Payments
- Admin Plugins
- Admin Price Lists
- Admin Price Preferences
- Admin Product Categories
- Admin Product Tags
- Admin Product Types
- Admin Product Variants
- Admin Products
- Admin Promotions
- Admin Refund Reasons
- Admin Regions
- Admin Reservations
- Admin Return Reasons
- Admin Returns
- Admin Sales Channels
- Admin Shipping Options
- Admin Shipping Profiles
- Admin Stock Locations
- Admin Store Credit Accounts
- Admin Stores
- Admin Tax Providers
- Admin Tax Rates
- Admin Tax Regions
- Admin Transaction Groups
- Admin Uploads
- Admin Users
- Admin Workflows Executions
- Store Auth
- Admin Auth
- Store Carts
- Store Collections
- Store Currencies
- Store Customers
- Store Gift Cards
- Store Orders
- Store Payment Collections
- Store Payment Providers
- Store Product Categories
- Store Product Tags
- Store Product Types
- Store Products
- Store Regions
- Store Return Reasons
- Store
- Store Shipping Options
- Store Store Credit Accounts
- Admin Algolia
- Admin Attributes
- Admin Commission
- Admin Configuration
- Admin Order Sets
- Admin Requests
- Admin Return Request
- Admin Reviews
- Admin Sellers
- Auth
- Store Return Request
- Store Reviews
- Store Sellers
- Store Wishlist
- Vendor Attributes
- Vendor Campaigns
- Vendor Commission
- Vendor Configuration
- Vendor Customer Groups
- Vendor Customers
- Vendor Fulfillment Providers
- Vendor Fulfillment Sets
- Vendor Inventory Items
- Vendor Invites
- Vendor Current Member
- Vendor Members
- Vendor Notifications
- Vendor Orders
- Vendor Payout Account
- Vendor Payouts
- Vendor Price Lists
- Vendor Price Preferences
- Vendor Product Categories
- Vendor Product Collections
- Vendor Product Tags
- Vendor Product Types
- Vendor Products
- Vendor Promotions
- Vendor Regions
- Vendor Requests
- Vendor Reservations
- Vendor Return Requests
- Vendor Returns
- Vendor Sales Channels
- Vendor Sellers
- Vendor Onboarding
- Vendor Reviews
- Vendor Shipping Options
- Vendor Shipping Profiles
- Vendor Statistics
- Vendor Stock Locations
- Vendor Stores
Vendor Payout Account
Get Payout Account
Retrieves the payout account for the authenticated vendor.
GET
/
vendor
/
payout-account
Copy
{
"payout_account": {
"id": "<string>",
"status": "pending",
"reference_id": "<string>",
"data": {},
"context": {},
"onboarding": {
"id": "<string>",
"data": {},
"context": {},
"payout_account": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"payouts": [
{
"id": "<string>",
"currency_code": "<string>",
"amount": 123,
"data": {},
"payout_account": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Comma-separated fields that should be included in the returned data.
Response
200 - application/json
OK
The response is of type object
.
Copy
{
"payout_account": {
"id": "<string>",
"status": "pending",
"reference_id": "<string>",
"data": {},
"context": {},
"onboarding": {
"id": "<string>",
"data": {},
"context": {},
"payout_account": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"payouts": [
{
"id": "<string>",
"currency_code": "<string>",
"amount": 123,
"data": {},
"payout_account": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
Assistant
Responses are generated using AI and may contain mistakes.