Create payout
Creates a new payout for a business or updates existing payout. This endpoint is idempotent using the external_id field as the idempotency key, so subsequent requests with the same external_id will update or no-op.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Content-Type must be set to application/json
Path Parameters
The UUID of the business to create a payout for
Body
Unique ID of the payout in your system for linking purposes.
The platform fee associated with the payout
Processor used to make the payment, if any. Any processor name can be provided and will be tracked. Supported processors (STRIPE, SHOPIFY) will have additional asset balance tracking.
STRIPE, PAYPAL The amount of the payout, in cents.
Timestamp of when the payout was completed
List of payments to associate with the payout
The amount of refunds associated with the payout, in cents.
Whether to overwrite payment fees or not upon creation
Response
Unique ID for the Payout. Idempotency key.
Unique ID of the payout in your system for linking purposes.
ID of the Business that generated the payout.
The amount of the payout, in cents
The platform fee associated with the payout
Processor used to make the payment, if any. Any processor name can be provided and will be tracked. Supported processors (STRIPE, SHOPIFY) will have additional asset balance tracking.
STRIPE, PAYPAL Timestamp of when the payout was imported
Timestamp of when the payout was completed
The transaction match associated with the payout
A list of invoice payments associated with the payout
A list of tags associated with the payout