Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
payouts
List payouts
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/payouts \
  --header 'Authorization: Bearer <token>'
[
  {
    "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
      }
    },
    "payments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "payment-1",
        "at": "2023-11-07T05:31:56Z",
        "method": "CASH",
        "fee": 123,
        "prepayment_account": {
          "type": "AccountId",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "payment_clearing_account": {
          "id": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "name": "Current Assets",
          "account_number": "4000",
          "stable_name": {
            "type": "StableName",
            "stable_name": "CURRENT_ASSETS"
          },
          "normality": "CREDIT",
          "account_type": {
            "value": "ASSET",
            "display_name": "Asset"
          },
          "account_subtype": {
            "value": "BANK_ACCOUNTS",
            "display_name": "Current Assets"
          }
        },
        "additional_fees": [
          {
            "fee_amount": 123,
            "description": "<string>",
            "account": {
              "type": "AccountId",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            },
            "is_passed_to_customer": true
          }
        ],
        "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",
                "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "dimension_display_name": "<string>",
                "value_display_name": "<string>",
                "archived_at": "2023-11-07T05:31:56Z"
              }
            ],
            "memo": "<string>",
            "metadata": {
              "custom_field": "value",
              "any valid json": "below 1kb",
              "nested": {
                "meaning of life": 42,
                "array": []
              }
            },
            "reference_number": "<string>"
          }
        ],
        "refund_allocations": [],
        "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
              }
            },
            "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",
                "dimension_display_name": "<string>",
                "value_display_name": "<string>",
                "archived_at": "2023-11-07T05:31:56Z"
              }
            ],
            "memo": "<string>",
            "metadata": {
              "custom_field": "value",
              "any valid json": "below 1kb",
              "nested": {
                "meaning of life": 42,
                "array": []
              }
            },
            "reference_number": "<string>"
          }
        ],
        "transaction_tags": [],
        "memo": "<string>",
        "metadata": {
          "custom_field": "value",
          "any valid json": "below 1kb",
          "nested": {
            "meaning of life": 42,
            "array": []
          }
        },
        "reference_number": "<string>"
      }
    ],
    "refunds": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "31415926535",
        "refunded_amount": 123,
        "status": "PAID",
        "completed_at": "2023-11-07T05:31:56Z",
        "is_dedicated": true,
        "allocations": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "amount": 123,
            "account_identifier": {
              "type": "AccountId",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            },
            "invoice_external_id": "<string>",
            "invoice_line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "invoice_line_item_external_id": "<string>",
            "invoice_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "invoice_payment_external_id": "<string>",
            "customer": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "external_id": "31415926535",
              "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",
                  "dimension_display_name": "<string>",
                  "value_display_name": "<string>",
                  "archived_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",
                "dimension_display_name": "<string>",
                "value_display_name": "<string>",
                "archived_at": "2023-11-07T05:31:56Z"
              }
            ],
            "memo": "<string>",
            "metadata": {
              "custom_field": "value",
              "any valid json": "below 1kb",
              "nested": {
                "meaning of life": 42,
                "array": []
              }
            },
            "reference_number": "<string>"
          }
        ],
        "payments": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "external_id": "31415926535",
            "refunded_amount": 123,
            "fee": 123,
            "completed_at": "2023-11-07T05:31:56Z",
            "method": "CREDIT_CARD",
            "processor": "STRIPE",
            "payment_clearing_account": {
              "id": {
                "type": "AccountId",
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              },
              "name": "Current Assets",
              "account_number": "4000",
              "stable_name": {
                "type": "StableName",
                "stable_name": "CURRENT_ASSETS"
              },
              "normality": "CREDIT",
              "account_type": {
                "value": "ASSET",
                "display_name": "Asset"
              },
              "account_subtype": {
                "value": "BANK_ACCOUNTS",
                "display_name": "Current Assets"
              }
            },
            "refunded_payment_fees": [
              {
                "account": {
                  "type": "AccountId",
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                },
                "description": "<string>",
                "fee_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",
                "dimension_display_name": "<string>",
                "value_display_name": "<string>",
                "archived_at": "2023-11-07T05:31:56Z"
              }
            ],
            "memo": "<string>",
            "metadata": {
              "custom_field": "value",
              "any valid json": "below 1kb",
              "nested": {
                "meaning of life": 42,
                "array": []
              }
            },
            "reference_number": "<string>"
          }
        ],
        "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
              }
            },
            "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",
                "dimension_display_name": "<string>",
                "value_display_name": "<string>",
                "archived_at": "2023-11-07T05:31:56Z"
              }
            ],
            "memo": "<string>",
            "metadata": {
              "custom_field": "value",
              "any valid json": "below 1kb",
              "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",
            "dimension_display_name": "<string>",
            "value_display_name": "<string>",
            "archived_at": "2023-11-07T05:31:56Z"
          }
        ],
        "memo": "<string>",
        "metadata": {
          "custom_field": "value",
          "any valid json": "below 1kb",
          "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",
        "dimension_display_name": "<string>",
        "value_display_name": "<string>",
        "archived_at": "2023-11-07T05:31:56Z"
      }
    ],
    "memo": "<string>",
    "metadata": {
      "custom_field": "value",
      "any valid json": "below 1kb",
      "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 payouts for

Query Parameters

ā€‹
external_id
string

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

ā€‹
memo_contains
string

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

ā€‹
memo_exact
string

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

ā€‹
completed_at_start
string<date-time>

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

ā€‹
completed_at_end
string<date-time>

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

ā€‹
amount_min
integer<int64>

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

ā€‹
amount_max
integer<int64>

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

ā€‹
reference_numbers
string

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

ā€‹
is_matched
boolean

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

Response

ā€‹
id
string<uuid>

Unique ID for the Payout. Idempotency key.

ā€‹
external_id
string | null

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

Example:

"payout-1234"

ā€‹
business_id
string<uuid>

ID of the Business that generated the payout.

ā€‹
paid_out_amount
integer<int64>

The amount of the payout, in cents

ā€‹
fee
integer<int64>

The platform fee associated with the payout

ā€‹
processor
enum<string> | null

Processor used to make the payment, if any. If not null, every payment or refund associated with the payout must have the same processor

Available options:
STRIPE,
PAYPAL,
SHOPIFY,
ADYEN,
RAINFOREST
Example:

"STRIPE"

ā€‹
imported_at
string<date-time>

Timestamp of when the payout was imported

ā€‹
completed_at
string<date-time>

Timestamp of when the payout was completed

ā€‹
match
object

The transaction match associated with the payout

Example:
{
  "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
  }
}
ā€‹
payments
object[]

A list of invoice payments associated with the payout

ā€‹
refunds
object[]

A list of refunds associated with the payout

ā€‹
transaction_tags
object[]

A list of tags associated with the payout

ā€‹
memo
string | null

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 1KB

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

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