{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "payout-1234",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paid_out_amount": 123,
  "fee": 123,
  "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": "PAYOUT",
        "bank_transaction": {
            "type": "Bank_Transaction_Data",
            "id": "a703c8d6-cfe8-453d-a275-b92eacc6fc6e",
            "business_id": "738ec216-e8e5-48f2-b7f2-cdc89c96b3d4",
            "source": "STRIPE",
            "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": "CREDIT",
            "amount": 87459,
            "counterparty_name": null,
            "description": "Payout (po_1OqnTHISISFAKEiTVBkCiyAERwm)",
            "account_name": "Layer Banking",
            "categorization_status": "MATCHED"
        },
        "details": {
            "type": "Payout_Match",
            "id": "d224508b-b05e-41da-89de-0fbd8a573507",
            "amount": 87459,
            "date": "2024-03-06T00:00:00Z",
            "description": "Payout from STRIPE",
            "adjustment": null
        }
      },
    "suggested_matches": [
        {
            "id": "f81ca739-7931-475e-b88f-c2b324523f3a",
            "matchType": "PAYOUT",
            "details": {
                "type": "Payout_Match",
                "id": "d224508b-b05e-41da-89de-0fbd8a573507",
                "amount": 87459,
                "date": "2024-03-06T00:00:00Z",
                "description": "Payout from STRIPE",
                "adjustment": null
            }
        }
    ]
  "payments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "payment-1",
      "at": "2023-11-07T05:31:56Z",
      "method": "CASH",
      "fee": 123,
      "additional_fees": [
        {
          "fee_amount": 123,
          "description": "<string>",
          "account": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      ],
      "amount": 123,
      "processor": "STRIPE",
      "imported_at": "2023-11-07T05:31:56Z",
      "allocations": [
        {
          "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 123,
          "transaction_tags": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "key": "ExampleTagKey",
              "value": "ExampleTagValue",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ],
      "transaction_tags": []
    }
  ],
  "transaction_tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "ExampleTagKey",
      "value": "ExampleTagValue",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {}
}
A Payout represents a transfer of funds from a payment processor or platform to a Business. Payouts typically include the net amount of payments collected on behalf of the business, minus any fees, and are used to reconcile platform balances with bank deposits.

Attributes

id
string
required
Unique identifier for the payout.
external_id
string
Unique ID of the payout in your system for linking purposes and idempotency.
business_id
string
required
ID of the Business that received the payout.
paid_out_amount
integer
required
The amount of the payout, in cents.
fee
integer
required
The platform fee associated with the payout, in cents.
processor
string
Processor used to make the payment. Any processor name can be provided and will be tracked. If not null, every payment or refund associated with the payout must have the same processor.
imported_at
ISO8601 timestamp
required
Timestamp of when the payout was imported into Layer.
completed_at
ISO8601 timestamp
required
Timestamp of when the payout was completed.
match
Match object
The transaction match associated with the payout, if any.
payments
array of InvoicePayment objects
A list of Invoice Payments associated with the payout.
refunds
array of Refund objects
List of Refunds associated with this payout.
transaction_tags
Array of Tags
Tags associated with the payout.
memo
string
Memo for any text you would like to associate with the payout (for example, to display to end users).
metadata
object
Arbitrary custom metadata in JSON format with a size limit of 10KB.
reference_number
string
Any (typically user-visible) identifier you would like to associate with the payout. Can be used to filter when listing payouts.
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "payout-1234",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paid_out_amount": 123,
  "fee": 123,
  "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": "PAYOUT",
        "bank_transaction": {
            "type": "Bank_Transaction_Data",
            "id": "a703c8d6-cfe8-453d-a275-b92eacc6fc6e",
            "business_id": "738ec216-e8e5-48f2-b7f2-cdc89c96b3d4",
            "source": "STRIPE",
            "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": "CREDIT",
            "amount": 87459,
            "counterparty_name": null,
            "description": "Payout (po_1OqnTHISISFAKEiTVBkCiyAERwm)",
            "account_name": "Layer Banking",
            "categorization_status": "MATCHED"
        },
        "details": {
            "type": "Payout_Match",
            "id": "d224508b-b05e-41da-89de-0fbd8a573507",
            "amount": 87459,
            "date": "2024-03-06T00:00:00Z",
            "description": "Payout from STRIPE",
            "adjustment": null
        }
      },
    "suggested_matches": [
        {
            "id": "f81ca739-7931-475e-b88f-c2b324523f3a",
            "matchType": "PAYOUT",
            "details": {
                "type": "Payout_Match",
                "id": "d224508b-b05e-41da-89de-0fbd8a573507",
                "amount": 87459,
                "date": "2024-03-06T00:00:00Z",
                "description": "Payout from STRIPE",
                "adjustment": null
            }
        }
    ]
  "payments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "payment-1",
      "at": "2023-11-07T05:31:56Z",
      "method": "CASH",
      "fee": 123,
      "additional_fees": [
        {
          "fee_amount": 123,
          "description": "<string>",
          "account": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      ],
      "amount": 123,
      "processor": "STRIPE",
      "imported_at": "2023-11-07T05:31:56Z",
      "allocations": [
        {
          "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 123,
          "transaction_tags": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "key": "ExampleTagKey",
              "value": "ExampleTagValue",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ],
      "transaction_tags": []
    }
  ],
  "transaction_tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "ExampleTagKey",
      "value": "ExampleTagValue",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {}
}