GET
/
v1
/
businesses
/
{businessId}
/
vendor-payouts
List vendor payouts
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/vendor-payouts \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "vendor-payout-1234",
    "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "paid_out_amount": 123,
    "processor": "STRIPE",
    "imported_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "payments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "<string>",
        "at": "2023-11-07T05:31:56Z",
        "method": "CASH",
        "amount": 123,
        "processor": "<string>",
        "payment_clearing_account": {
          "id": {
            "type": "<any>",
            "id": "<any>"
          },
          "name": "Current Assets",
          "stable_name": {
            "type": "<any>",
            "stable_name": "<any>"
          },
          "normality": "CREDIT",
          "account_type": {
            "value": "<any>",
            "display_name": "<any>"
          },
          "account_subtype": {
            "value": "<any>",
            "display_name": "<any>"
          }
        },
        "imported_at": "2023-11-07T05:31:56Z",
        "allocations": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "bill_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",
                "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z"
              }
            ],
            "memo": "<string>",
            "metadata": {
              "custom_field": "value",
              "any valid json": "below 10kb",
              "nested": {
                "meaning of life": 42,
                "array": []
              }
            },
            "reference_number": "<string>"
          }
        ],
        "transaction_tags": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "key": "ExampleTagKey",
            "value": "ExampleTagValue",
            "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ],
        "memo": "<string>",
        "metadata": {
          "custom_field": "value",
          "any valid json": "below 10kb",
          "nested": {
            "meaning of life": 42,
            "array": []
          }
        },
        "reference_number": "<string>"
      }
    ],
    "refunds": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "vendor-refund-123",
        "refunded_amount": 123,
        "status": "PAID",
        "completed_at": "2023-11-07T05:31:56Z",
        "allocations": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "amount": 123,
            "line_items": [
              {
                "external_id": "<string>",
                "amount": 123,
                "ledger_account": {
                  "id": {
                    "type": "<any>",
                    "id": "<any>"
                  },
                  "name": "Current Assets",
                  "stable_name": {
                    "type": "<any>",
                    "stable_name": "<any>"
                  },
                  "normality": "CREDIT",
                  "account_type": {
                    "value": "<any>",
                    "display_name": "<any>"
                  },
                  "account_subtype": {
                    "value": "<any>",
                    "display_name": "<any>"
                  }
                },
                "prepayment_account": {
                  "id": {
                    "type": "<any>",
                    "id": "<any>"
                  },
                  "name": "Current Assets",
                  "stable_name": {
                    "type": "<any>",
                    "stable_name": "<any>"
                  },
                  "normality": "CREDIT",
                  "account_type": {
                    "value": "<any>",
                    "display_name": "<any>"
                  },
                  "account_subtype": {
                    "value": "<any>",
                    "display_name": "<any>"
                  }
                },
                "transaction_tags": [
                  {
                    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "key": "ExampleTagKey",
                    "value": "ExampleTagValue",
                    "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "created_at": "2023-11-07T05:31:56Z",
                    "updated_at": "2023-11-07T05:31:56Z",
                    "deleted_at": "2023-11-07T05:31:56Z"
                  }
                ],
                "memo": "<string>",
                "metadata": {
                  "custom_field": "value",
                  "any valid json": "below 10kb",
                  "nested": {
                    "meaning of life": 42,
                    "array": []
                  }
                },
                "reference_number": "<string>"
              }
            ],
            "bill_external_id": "<string>",
            "bill_line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "bill_line_item_external_id": "<string>",
            "bill_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "bill_payment_external_id": "<string>",
            "vendor": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "external_id": "<string>",
              "individual_name": "<string>",
              "company_name": "<string>",
              "email": "<string>",
              "mobile_phone": "<string>",
              "office_phone": "<string>",
              "address_string": "<string>",
              "memo": "<string>",
              "status": "ACTIVE",
              "transaction_tags": [
                {
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "key": "ExampleTagKey",
                  "value": "ExampleTagValue",
                  "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "deleted_at": "2023-11-07T05:31:56Z"
                }
              ]
            },
            "transaction_tags": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "key": "ExampleTagKey",
                "value": "ExampleTagValue",
                "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z"
              }
            ],
            "memo": "<string>",
            "metadata": {
              "custom_field": "value",
              "any valid json": "below 10kb",
              "nested": {
                "meaning of life": 42,
                "array": []
              }
            },
            "reference_number": "<string>"
          }
        ],
        "payments": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "external_id": "payment-456",
            "refunded_amount": 123,
            "refund_processing_fee": 123,
            "completed_at": "2023-11-07T05:31:56Z",
            "method": "ACH",
            "processor": "STRIPE",
            "payment_clearing_account": {
              "id": {
                "type": "<any>",
                "id": "<any>"
              },
              "name": "Current Assets",
              "stable_name": {
                "type": "<any>",
                "stable_name": "<any>"
              },
              "normality": "CREDIT",
              "account_type": {
                "value": "<any>",
                "display_name": "<any>"
              },
              "account_subtype": {
                "value": "<any>",
                "display_name": "<any>"
              }
            },
            "transaction_tags": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "key": "ExampleTagKey",
                "value": "ExampleTagValue",
                "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z"
              }
            ],
            "memo": "<string>",
            "metadata": {
              "custom_field": "value",
              "any valid json": "below 10kb",
              "nested": {
                "meaning of life": 42,
                "array": []
              }
            },
            "reference_number": "<string>"
          }
        ],
        "transaction_tags": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "key": "ExampleTagKey",
            "value": "ExampleTagValue",
            "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ],
        "memo": "<string>",
        "metadata": {
          "custom_field": "value",
          "any valid json": "below 10kb",
          "nested": {
            "meaning of life": 42,
            "array": []
          }
        },
        "reference_number": "<string>"
      }
    ],
    "other_transactions": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "direction": "CREDIT",
        "account": {
          "type": "AccountId",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "description": "<string>",
        "external_id": "<string>"
      }
    ],
    "transaction_tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "ExampleTagKey",
        "value": "ExampleTagValue",
        "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "match": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "match_type": "TRANSFER",
      "bank_transaction": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "source": "UNIT",
        "source_transaction_id": "g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko",
        "source_account_id": "Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG",
        "imported_at": "2023-11-07T05:31:56Z",
        "date": "2023-11-07T05:31:56Z",
        "direction": "CREDIT",
        "amount": 123,
        "counterparty_name": "WeWork",
        "description": "WeWork monthly rent payment",
        "account_name": "Plaid Checking",
        "categorizationStatus": "PENDING",
        "memo": "<string>",
        "metadata": {
          "custom_field": "value",
          "any valid json": "below 10kb",
          "nested": {
            "meaning of life": 42,
            "array": []
          }
        },
        "reference_number": "<string>"
      },
      "details": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "date": "2023-11-07T05:31:56Z",
        "description": "Transfer from SavingsAccount to CheckingAccount"
      }
    },
    "suggested_matches": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "matchType": "TRANSFER",
        "details": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 123,
          "date": "2023-11-07T05:31:56Z",
          "description": "Transfer from SavingsAccount to CheckingAccount"
        }
      }
    ],
    "memo": "<string>",
    "metadata": {
      "custom_field": "value",
      "any valid json": "below 10kb",
      "nested": {
        "meaning of life": 42,
        "array": []
      }
    },
    "reference_number": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Content-Type
string

Content-Type must be set to application/json

Path Parameters

​
businessId
string
required

The UUID of the business to fetch vendor payouts for

Query Parameters

​
external_id
string

Filter vendor payouts by external ID (unique idempotency key). This will always yield zero or one result.

​
memo_contains
string

Filter vendor payouts by memo content. Returns vendor payouts where the memo contains this string (case-sensitive).

​
memo_exact
string

Filter vendor payouts by exact memo match. Returns vendor payouts where the memo exactly matches this string.

​
completed_at_start
string<date-time>

Filter vendor payouts by completion date. Vendor payouts completed on or after this date will be included. ISO 8601 date format.

​
completed_at_end
string<date-time>

Filter vendor payouts by completion date. Vendor payouts completed on or before this date will be included. ISO 8601 date format.

​
amount_min
integer

Filter vendor payouts by minimum amount. Only vendor payouts with amounts greater than or equal to this value will be included.

​
amount_max
integer

Filter vendor payouts by maximum amount. Only vendor payouts with amounts less than or equal to this value will be included.

​
reference_numbers
string

Comma-separated list of reference numbers to filter vendor payouts by. Only vendor payouts with reference numbers matching any value in this list will be returned.

​
is_matched
boolean

Filter vendor payouts by match status. If true, only matched vendor payouts will be returned. If false, only unmatched vendor payouts will be returned.

Response

200 - application/json
​
id
string<uuid>

Unique ID for the Vendor Payout. Idempotency key.

​
external_id
string | null

Unique ID of the vendor payout in your system for linking purposes.

Example:

"vendor-payout-1234"

​
business_id
string<uuid>

ID of the Business that generated the vendor payout.

​
paid_out_amount
integer

The amount of the vendor payout, in cents

​
processor
enum<string>

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

Available options:
STRIPE,
PAYPAL,
SHOPIFY,
ADYEN,
RAINFOREST
​
imported_at
string<date-time>

Timestamp of when the vendor payout was imported

​
completed_at
string<date-time>

Timestamp of when the vendor payout was completed

​
payments
object[]

A list of bill payments associated with the vendor payout

​
refunds
object[]

A list of vendor refund payments associated with the vendor payout

​
other_transactions
object[]

A list of other transactions associated with the vendor payout

​
transaction_tags
object[]

A list of tags associated with the vendor payout

​
match
object

The transaction match associated with the vendor payout

​
suggested_matches
object[]

A list of suggested matches for the vendor payout

​
memo
string | null

Memo for any text you would like to associate with the vendor payout (for example, to display to end users).

​
metadata
object

Arbitrary custom metadata in JSON format with a size limit of 10KB

Example:
{
  "custom_field": "value",
  "any valid json": "below 10kb",
  "nested": { "meaning of life": 42, "array": [] }
}
​
reference_number
string | null

Any (typically user-visible) identifier you would like to associate with the vendor payout. Can be used to filter when listing vendor payouts.