Create vendor payout
Creates a new vendor payout for a business or updates existing vendor 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.
Documentation Index
Fetch the complete documentation index at: https://docs.layerfi.com/llms.txt
Use this file to discover all available pages before exploring further.
Rate Limiting
This endpoint has a custom rate limit policy. Rate Limit Details:| Environment | Limit | Refill Period | Initial Size |
|---|---|---|---|
| Sandbox | 20 requests | 1 second | 40 requests |
| Production | 20 requests | 1 second | 40 requests |
- X-RateLimit-Limit: The rate limit bucket capacity
- X-RateLimit-Remaining: The number of tokens remaining in the bucket
- X-RateLimit-Reset: UTC timestamp (in seconds) when the bucket will be refilled
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 vendor payout for.
Body
Unique ID of the vendor payout in your system for linking purposes.
"vendor-payout-1234"
The amount of the vendor payout, in cents. This amount can be negative if vendor refunds exceed bill payments.
Processor used to make the payment. 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 "STRIPE"
Timestamp of when the vendor payout was completed.
List of bill payments to associate with the vendor payout.
List of vendor refund payments to associate 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 1KB.
{
"custom_field": "value",
"any valid json": "below 1kb",
"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
Vendor payout has been successfully updated or unchanged.
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 "STRIPE"
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 1KB.
{
"custom_field": "value",
"any valid json": "below 1kb",
"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.