{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "vendor-payout-1234",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paid_out_amount": 15000,
  "processor": "STRIPE",
  "imported_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "match": {
    "id": "6b0a3734-f4ef-4fb0-9fc1-3f59b0c1cf99",
    "match_type": "VENDOR_PAYOUT",
    "bank_transaction": {
      "type": "Bank_Transaction_Data",
      "id": "a703c8d6-cfe8-453d-a275-b92eacc6fc6e",
      "business_id": "738ec216-e8e5-48f2-b7f2-cdc89c96b3d4",
      "source": "PLAID",
      "source_transaction_id": "trxn_1sdOeLQiFAKE2LQBkcvrJw95f",
      "source_account_id": "738ec216-e154-48f2-1111-cdc89c96b3d4",
      "imported_at": "2024-03-19T22:09:53.290591Z",
      "date": "2024-03-06T06:06:40Z",
      "direction": "DEBIT",
      "amount": 15000,
      "counterparty_name": "Stripe",
      "description": "Stripe Payment",
      "account_name": "Layer Banking",
      "categorization_status": "MATCHED"
    },
    "details": {
      "type": "Vendor_Payout_Match",
      "id": "d224508b-b05e-41da-89de-0fbd8a573507",
      "amount": 15000,
      "date": "2024-03-06T00:00:00Z",
      "description": "Vendor payout via STRIPE",
      "adjustment": null
    }
  },
  "suggested_matches": [
    {
      "id": "f81ca739-7931-475e-b88f-c2b324523f3a",
      "matchType": "VENDOR_PAYOUT",
      "details": {
        "type": "Vendor_Payout_Match",
        "id": "d224508b-b05e-41da-89de-0fbd8a573507",
        "amount": 15000,
        "date": "2024-03-06T00:00:00Z",
        "description": "Vendor payout via STRIPE",
        "adjustment": null
      }
    }
  ],
  "payments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "bill-payment-1",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "paid_to_vendor_amount": 10000,
      "platform_fee": 50,
      "processor": "STRIPE",
      "paid_at": "2023-11-07T05:31:56Z",
      "imported_at": "2023-11-07T05:31:56Z",
      "allocations": [
        {
          "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 10000,
          "transaction_tags": []
        }
      ],
      "transaction_tags": []
    },
    {
      "id": "4d91d4dd-1e55-5c61-9999-9ee36847163b",
      "external_id": "bill-payment-2",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vendor_id": "4d91d4dd-1e55-5c61-9999-9ee36847163b",
      "paid_to_vendor_amount": 5000,
      "platform_fee": 25,
      "processor": "STRIPE",
      "paid_at": "2023-11-07T05:31:56Z",
      "imported_at": "2023-11-07T05:31:56Z",
      "allocations": [
        {
          "bill_id": "4d91d4dd-1e55-5c61-9999-9ee36847163b",
          "payment_id": "4d91d4dd-1e55-5c61-9999-9ee36847163b",
          "amount": 5000,
          "transaction_tags": []
        }
      ],
      "transaction_tags": []
    }
  ],
  "refunds": [],
  "other_transactions": [],
  "transaction_tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "Department",
      "value": "Operations",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": null
    }
  ],
  "memo": "Weekly vendor payments batch",
  "metadata": {
    "batch_id": "batch-789",
    "approval_code": "MGR-456"
  }
}
A Vendor Payout represents a transfer of funds from a Business to vendors through a payment processor or platform. Vendor payouts typically include the total amount of bill payments made to vendors, minus any vendor refunds received, and are the AP equivalent of Customer Payouts.

​
Attributes

​
id
string
required
Unique identifier for the vendor payout.
​
external_id
string
Unique ID of the vendor payout in your system for linking purposes and idempotency.
​
business_id
string
required
ID of the Business that made the vendor payout.
​
paid_out_amount
integer
required
The amount of the vendor payout, in cents. This amount can be negative if vendor refunds exceed bill payments.
​
processor
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.
​
imported_at
ISO8601 timestamp
required
Timestamp of when the vendor payout was imported into Layer.
​
completed_at
ISO8601 timestamp
required
Timestamp of when the vendor payout was completed.
​
match
Match object
The transaction match associated with the vendor payout, if any.
​
payments
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.
​
refunds
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.
​
other_transactions
array of OtherVendorPayoutTransaction objects
A list of other transactions associated with the vendor payout for adjustments or fees.
​
suggested_matches
array of SuggestedMatch objects
List of suggested bank transaction matches for the vendor payout.
​
transaction_tags
Array of Tags
Tags associated with the vendor payout.
​
memo
string
Memo for any text you would like to associate with the vendor payout (for example, to display to end users).
​
metadata
json object
Arbitrary metadata you can include with the vendor payout
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "vendor-payout-1234",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paid_out_amount": 15000,
  "processor": "STRIPE",
  "imported_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "match": {
    "id": "6b0a3734-f4ef-4fb0-9fc1-3f59b0c1cf99",
    "match_type": "VENDOR_PAYOUT",
    "bank_transaction": {
      "type": "Bank_Transaction_Data",
      "id": "a703c8d6-cfe8-453d-a275-b92eacc6fc6e",
      "business_id": "738ec216-e8e5-48f2-b7f2-cdc89c96b3d4",
      "source": "PLAID",
      "source_transaction_id": "trxn_1sdOeLQiFAKE2LQBkcvrJw95f",
      "source_account_id": "738ec216-e154-48f2-1111-cdc89c96b3d4",
      "imported_at": "2024-03-19T22:09:53.290591Z",
      "date": "2024-03-06T06:06:40Z",
      "direction": "DEBIT",
      "amount": 15000,
      "counterparty_name": "Stripe",
      "description": "Stripe Payment",
      "account_name": "Layer Banking",
      "categorization_status": "MATCHED"
    },
    "details": {
      "type": "Vendor_Payout_Match",
      "id": "d224508b-b05e-41da-89de-0fbd8a573507",
      "amount": 15000,
      "date": "2024-03-06T00:00:00Z",
      "description": "Vendor payout via STRIPE",
      "adjustment": null
    }
  },
  "suggested_matches": [
    {
      "id": "f81ca739-7931-475e-b88f-c2b324523f3a",
      "matchType": "VENDOR_PAYOUT",
      "details": {
        "type": "Vendor_Payout_Match",
        "id": "d224508b-b05e-41da-89de-0fbd8a573507",
        "amount": 15000,
        "date": "2024-03-06T00:00:00Z",
        "description": "Vendor payout via STRIPE",
        "adjustment": null
      }
    }
  ],
  "payments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "bill-payment-1",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "paid_to_vendor_amount": 10000,
      "platform_fee": 50,
      "processor": "STRIPE",
      "paid_at": "2023-11-07T05:31:56Z",
      "imported_at": "2023-11-07T05:31:56Z",
      "allocations": [
        {
          "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 10000,
          "transaction_tags": []
        }
      ],
      "transaction_tags": []
    },
    {
      "id": "4d91d4dd-1e55-5c61-9999-9ee36847163b",
      "external_id": "bill-payment-2",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vendor_id": "4d91d4dd-1e55-5c61-9999-9ee36847163b",
      "paid_to_vendor_amount": 5000,
      "platform_fee": 25,
      "processor": "STRIPE",
      "paid_at": "2023-11-07T05:31:56Z",
      "imported_at": "2023-11-07T05:31:56Z",
      "allocations": [
        {
          "bill_id": "4d91d4dd-1e55-5c61-9999-9ee36847163b",
          "payment_id": "4d91d4dd-1e55-5c61-9999-9ee36847163b",
          "amount": 5000,
          "transaction_tags": []
        }
      ],
      "transaction_tags": []
    }
  ],
  "refunds": [],
  "other_transactions": [],
  "transaction_tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "Department",
      "value": "Operations",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": null
    }
  ],
  "memo": "Weekly vendor payments batch",
  "metadata": {
    "batch_id": "batch-789",
    "approval_code": "MGR-456"
  }
}