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 update the vendor payout for
The UUID of the vendor payout to update
Body
The amount of the vendor payout, in cents.
Processor used to make the payment, if any. Any processor name can be provided and will be tracked.
STRIPE
, PAYPAL
, SHOPIFY
, ADYEN
, RAINFOREST
Timestamp of when the vendor payout was completed
A list of bill payments associated with the vendor payout
A list of vendor refund payments associated with the vendor payout
A list of tags associated with the vendor payout
A list of other transactions associated with the vendor payout
Memo for any text you would like to associate with the vendor payout (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 10KB
{
"custom_field": "value",
"any valid json": "below 10kb",
"nested": { "meaning of life": 42, "array": [] }
}
Any (typically user-visible) identifier you would like to associate with the vendor payout. Can be used to filter when listing vendor payouts.
Response
Unique ID for the Vendor Payout. Idempotency key.
Unique ID of the vendor payout in your system for linking purposes.
"vendor-payout-1234"
ID of the Business that generated the vendor payout.
The amount of the vendor payout, in cents
Processor used to make the payment, if any. If not null, every bill payment or vendor refund payment associated with the vendor payout must have the same processor
STRIPE
, PAYPAL
, SHOPIFY
, ADYEN
, RAINFOREST
Timestamp of when the vendor payout was imported
Timestamp of when the vendor payout was completed
A list of bill payments associated with the vendor payout
A list of vendor refund payments associated with the vendor payout
A list of other transactions associated with the vendor payout
A list of tags associated with the vendor payout
The transaction match associated with the vendor payout
A list of suggested matches for the vendor payout
Memo for any text you would like to associate with the vendor payout (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 10KB
{
"custom_field": "value",
"any valid json": "below 10kb",
"nested": { "meaning of life": 42, "array": [] }
}
Any (typically user-visible) identifier you would like to associate with the vendor payout. Can be used to filter when listing vendor payouts.