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
Timestamp of when the payout was completed
Unique ID of the payout in your system for linking purposes.
The platform fee associated with the payout. Should be expressed as a positive value.
The amount of the payout, in cents. This amount can be negative if refunds and fees exceed payments.
List of payments to associate with the payout
Processor used to make the payment.
STRIPE, PAYPAL The amount of additional refunds associated with the payout, in cents. This should only be used when refunds cannot be individually itemized in the refunds array. Should be expressed as a positive value.
List of refunds to associate with the payout
Response
ID of the Business that generated the payout.
Timestamp of when the payout was completed
Unique ID of the payout in your system for linking purposes.
The platform fee associated with the payout
Unique ID for the Payout. Idempotency key.
Timestamp of when the payout was imported
The transaction match associated with the payout
The amount of the payout, in cents
A list of invoice payments 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 A list of tags associated with the payout