Businesses
- Business
- Financial Accounts
- Documents
- Scoped Authentication
- Configuration
- Tasks & Notifications
Financial Activity
- Accounts Receivable
- Customers
- Invoices
- Invoice Payments
- Payouts
- Refunds
- Write Offs
- Accounts Payable
- Bank Transactions
- General Ledger
Accounting Reports
- Profit and Loss
- Balance Sheet
- Cash Flow Statement
Platform Configuration
- Plaid
- SMS
Activity Metrics
- Platform wide activity
- Business Activity
Fetch payout
Fetches a payout for a business.
curl --request GET \
--url https://sandbox.layerfi.com/v1/businesses/{businessId}/payouts/{payoutId} \
--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": "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"
},
"details": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"date": "2023-11-07T05:31:56Z",
"description": "Transfer from SavingsAccount to CheckingAccount"
}
},
"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"
}
]
}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 fetch the payout for
The UUID of the payout to fetch
Response
Unique ID for the Payout. Idempotency key.
Unique ID of the payout in your system for linking purposes.
"payout-1234"
ID of the Business that generated the payout.
The amount of the payout, in cents
The platform fee associated with the payout
Processor used to make the payment, if any. Any processor name can be provided and will be tracked. Supported processors (STRIPE, SHOPIFY) will have additional asset balance tracking.
STRIPE, PAYPAL Timestamp of when the payout was imported
Timestamp of when the payout was completed
The transaction match associated with the payout
Layer's UUID for the match
Type of the object to match
TRANSFER, INVOICE_PAYMENT, PAYOUT Layer's UUID for the bank transaction
Timestamp when the transaction was created.
Amount of the transaction, in cents.
UUID of the business the transaction is for
Source of the bank transaction.
UNIT, PLAID, API, STRIPE, CUSTOM External transaction ID from the source platform (e.g, Plaid transaction ID)
"g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko"
External account ID from the source platform (e.g, Plaid account ID)
"Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG"
Timestamp when the transaction was imported.
Direction of the transaction.
CREDIT, DEBIT Name of the transaction counterparty
"WeWork"
Description of the transaction.
"WeWork monthly rent payment"
Name of the bank account
"Plaid Checking"
The status of the transaction’s categorization in Layer’s systems.
PENDING, READY_FOR_INPUT, CATEGORIZED, SPLIT, LAYER_REVIEW, JOURNALING, MATCHED Layer's ID for the match
Monetary amount of the matched transaction, in cents
Date that the matched transaction occurred
Description of the match
"Transfer from SavingsAccount to CheckingAccount"
A list of invoice payments associated with the payout
Unique identifier for the payment.
Unique ID of the invoice payment in an external system for linking and idempotency.
"payment-1"
Timestamp when the payment was completed.
Payment method.
CASH, CHECK, CREDIT_CARD, ACH, CREDIT_BALANCE, OTHER Fee paid by business for processing of payment in positive cents.
List of additional fees associated with this payment.
Amount of the fee in cents.
Description of the fee.
Customer payment amount, in cents.
Processor used to make the payment, if any. Any processor name can be provided and will be tracked. Supported processors (STRIPE, SHOPIFY) will have additional asset balance tracking.
"STRIPE"
Timestamp when the payment was imported into Layer.
List of payment allocations associated with this payment.
ID of the invoice.
ID of the payment.
Amount of the payment allocated towards this invoice. If this amount is the full payment amount, this payment was fully allocated towards this invoice. The amount cannot exceed the invoice total.
List of tags on the transaction associated with the payment allocation
ID for the tag
Key for the tag
"ExampleTagKey"
Value for the tag
"ExampleTagValue"
When the tag was created
When the tag was last updated
When the tag was deleted
List of tags associated with this transaction
ID for the tag
Key for the tag
"ExampleTagKey"
Value for the tag
"ExampleTagValue"
When the tag was created
When the tag was last updated
When the tag was deleted
[]
A list of tags associated with the payout
ID for the tag
Key for the tag
"ExampleTagKey"
Value for the tag
"ExampleTagValue"
When the tag was created
When the tag was last updated
When the tag was deleted
curl --request GET \
--url https://sandbox.layerfi.com/v1/businesses/{businessId}/payouts/{payoutId} \
--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": "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"
},
"details": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"date": "2023-11-07T05:31:56Z",
"description": "Transfer from SavingsAccount to CheckingAccount"
}
},
"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"
}
]
}