Attributes
string
required
Unique identifier for the vendor payout.
string
Unique ID of the vendor payout in your system for linking purposes and idempotency.
string
required
ID of the Business that made the vendor payout.
integer
required
The amount of the vendor payout, in cents. This amount can be negative if vendor refunds exceed bill payments.
string
Processor used to make the payment. Any processor name can be provided and will be tracked. If not null, every bill payment or vendor refund payment associated with the vendor payout must have the same processor.
ISO8601 timestamp
required
Timestamp of when the vendor payout was imported into Layer.
ISO8601 timestamp
required
Timestamp of when the vendor payout was completed.
Match object
The transaction match associated with the vendor payout, if any.
array of BillPayment objects
A list of Bill Payments associated with the vendor payout. Note: Unlike customer payouts, you must reference existing bill payments - new bill payments cannot be created as part of vendor payout creation.
array of VendorRefund objects
List of Vendor Refund Payments associated with this vendor payout. Note: You must reference existing vendor refund payments, not vendor refunds themselves.
array of OtherVendorPayoutTransaction objects
A list of other transactions associated with the vendor payout for adjustments or fees.
array of SuggestedMatch objects
List of suggested bank transaction matches for the vendor payout.
Array of Tags
Tags associated with the vendor payout.
string
Memo for any text you would like to associate with the vendor payout (for example, to display to end users).
json object
Arbitrary metadata you can include with the vendor payout