Create payout

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 create a payout for

Body

application/json

external_id

string

required

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

Example:

"payout-1234"

paid_out_amount

integer<int64>

required

The amount of the payout, in cents. This amount can be negative if refunds and fees exceed payments.

fee

integer<int64>

required

The platform fee associated with the payout. Should be expressed as a positive value.

completed_at

string<date-time>

required

Timestamp of when the payout was completed

payments

(Reference existing payment · object | Create new payment and invoice · object)[]

required

List of invoice payments to associate with the payout. Can refer to existing payments by ID or external ID. Alternatively, you can create new payments by specifying the payment amount and payment external ID.

Reference existing payment
Create new payment and invoice

Show child attributes

payments.invoice_payment_id

string

ID of the invoice payment to reference for the payout details. Either this or invoice_payment_external_id must be specified.

Example:

"efc07679-58fb-4509-9b69-05559f29b669"

payments.invoice_payment_external_id

string

External ID of the invoice payment to reference for the payout details. Either this or invoice_payment_id must be specified.

Example:

"payment-31415"

additional_refunds_amount

integer<int64>

default:0

The amount of additional refunds associated with the payout, in cents. This should only be used when refunds cannot be individually itemized in the refunds array. Should be expressed as a positive value.

processor

enum<string> | null

Processor used to make the payment. 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"

refunds

(Reference existing refund payment · object | Create new refund with payment · object)[]

List of refund payments to associate with the payout. Can refer to existing payments by ID or external ID, or by their refund's ID or external ID (so long as said refund has exactly one payment). Alternatively, you can create new refund payments by specifying the refund amount and refund external ID.

Reference existing refund payment
Create new refund with payment

Show child attributes

refunds.refund_id

string<uuid>

The ID of the refund to reference. Must have exactly one payment.

refunds.refund_external_id

string

The external ID of the refund to reference. Must have exactly one payment.

refunds.refund_payment_id

string<uuid>

The ID of the refund payment to reference.

refunds.refund_payment_external_id

string

The external ID of the refund payment to reference.

other_transactions

object[]

A list of other transactions associated with the payout

Show child attributes

other_transactions.amount

integer<int64>

required

Amount of the transaction, in cents. This amount must be a positive value.

other_transactions.direction

enum<string>

required

Direction of the transaction.

Available options:

CREDIT,

DEBIT

other_transactions.account

Account ID · object

required

Account identifier for the transaction.

Account ID
Account Stable Name

Show child attributes

other_transactions.account.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

other_transactions.account.id

string<uuid>

ID of the account

other_transactions.description

string

required

Description of the transaction.

other_transactions.external_id

string | null

External ID of the transaction in your system for linking purposes. Idempotency key.

Response

Payout has been successfully updated or unchanged.

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

Show child attributes

match.id

string<uuid>

Layer's UUID for the match

match.match_type

enum<string>

Type of the object to match

Available options:

TRANSFER,

INVOICE_PAYMENT,

PAYOUT

match.bank_transaction

object

Show child attributes

match.bank_transaction.id

string<uuid>

required

Layer's UUID for the bank transaction

match.bank_transaction.date

string<date-time>

required

Timestamp when the transaction was created.

match.bank_transaction.amount

integer<int64>

required

Amount of the transaction, in cents.

match.bank_transaction.business_id

string<uuid>

UUID of the business the transaction is for

match.bank_transaction.source

enum<string>

Source of the bank transaction.

Available options:

UNIT,

PLAID,

API,

STRIPE,

CUSTOM

match.bank_transaction.source_transaction_id

string

External transaction ID from the source platform (e.g, Plaid transaction ID)

Example:

"g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko"

match.bank_transaction.source_account_id

string

External account ID from the source platform (e.g, Plaid account ID)

Example:

"Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG"

match.bank_transaction.imported_at

string<date-time>

Timestamp when the transaction was imported.

match.bank_transaction.direction

enum<string>

Direction of the transaction.

Available options:

CREDIT,

DEBIT

match.bank_transaction.counterparty_name

string | null

Name of the transaction counterparty

Example:

"WeWork"

match.bank_transaction.description

string | null

Description of the transaction.

Example:

"WeWork monthly rent payment"

match.bank_transaction.account_name

string | null

Name of the bank account

Example:

"Plaid Checking"

match.bank_transaction.categorizationStatus

enum<string>

The status of the transaction’s categorization in Layer’s systems.

Available options:

PENDING,

READY_FOR_INPUT,

CATEGORIZED,

SPLIT,

LAYER_REVIEW,

JOURNALING,

MATCHED

match.bank_transaction.memo

string | null

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

match.bank_transaction.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": [] }
}

match.bank_transaction.reference_number

string | null

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

match.details

object

Show child attributes

match.details.id

string<uuid>

required

Layer's ID for the match

match.details.amount

integer<int64>

required

Monetary amount of the matched transaction, in cents

match.details.date

string<date-time>

required

Date that the matched transaction occurred

match.details.description

string | null

Description of the match

Example:

"Transfer from SavingsAccount to CheckingAccount"

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

Show child attributes

payments.id

string<uuid>

Unique identifier for the payment.

payments.external_id

string | null

Unique ID of the invoice payment in an external system for linking and idempotency.

Example:

"payment-1"

payments.at

string<date-time>

Timestamp when the payment was completed.

payments.method

enum<string>

Payment method.

Available options:

CASH,

CHECK,

CREDIT_CARD,

ACH,

CREDIT_BALANCE,

OTHER

payments.fee

integer<int64>

Fee paid by business for processing of payment in positive cents.

payments.prepayment_account

Account ID · object

Identifier for the ledger account to use if this is a prepayment.

Account ID
Account Stable Name

Show child attributes

payments.prepayment_account.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

payments.prepayment_account.id

string<uuid>

ID of the account

payments.payment_clearing_account

object

The the ledger account to use for the payment (overrides the default determined by the payment method), if specified.

Show child attributes

payments.payment_clearing_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

payments.payment_clearing_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

payments.payment_clearing_account.id.id

string<uuid>

ID of the account

payments.payment_clearing_account.name

string

Name of the account

Example:

"Current Assets"

payments.payment_clearing_account.account_number

string | null

Account number if configured

Example:

"4000"

payments.payment_clearing_account.stable_name

object

Show child attributes

payments.payment_clearing_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

payments.payment_clearing_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

payments.payment_clearing_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

payments.payment_clearing_account.account_type

object

Show child attributes

payments.payment_clearing_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

payments.payment_clearing_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

payments.payment_clearing_account.account_subtype

object

Show child attributes

payments.payment_clearing_account.account_subtype.value

enum<string>

Available options:

BANK_ACCOUNTS,

ACCOUNTS_RECEIVABLE,

INVENTORY,

PAYMENT_PROCESSOR_CLEARING_ACCOUNT,

FIXED_ASSET,

ACCUMULATED_DEPRECIATION,

CASH,

UNDEPOSITED_FUNDS,

CURRENT_ASSET,

NON_CURRENT_ASSET,

PREPAID_EXPENSES,

DEVELOPMENT_COSTS,

LOANS_RECEIVABLE,

INTANGIBLE_ASSET,

ACCOUNTS_PAYABLE,

CREDIT_CARD,

TAXES_PAYABLE,

INCOME_TAXES_PAYABLE,

SALES_TAXES_PAYABLE,

OTHER_TAXES_PAYABLE,

PAYROLL_TAXES_PAYABLE,

UNEARNED_REVENUE,

PAYROLL_LIABILITY,

PAYROLL_CLEARING,

LINE_OF_CREDIT,

TIPS,

REFUND_LIABILITIES,

UNDEPOSITED_OUTFLOWS,

OUTGOING_PAYMENT_CLEARING_ACCOUNT,

OTHER_CURRENT_LIABILITY,

LOANS_PAYABLE,

NOTES_PAYABLE,

SHAREHOLDER_LOAN,

NON_CURRENT_LIABILITY,

CONTRIBUTIONS,

DISTRIBUTIONS,

COMMON_STOCK,

PREFERRED_STOCK,

ADDITIONAL_PAID_IN_CAPITAL,

RETAINED_EARNINGS,

ACCUMULATED_ADJUSTMENTS,

OPENING_BALANCE_EQUITY,

OTHER_EQUITY,

SALES,

UNCATEGORIZED_REVENUE,

RETURNS_ALLOWANCES,

DIVIDEND_INCOME,

INTEREST_INCOME,

OTHER_INCOME,

COGS,

OPERATING_EXPENSES,

PAYROLL,

TAXES_LICENSES,

UNCATEGORIZED_EXPENSE,

CHARITABLE_CONTRIBUTIONS,

LOAN_EXPENSES,

FINANCE_COSTS,

INTEREST_EXPENSES,

DEPRECIATION,

AMORTIZATION,

BAD_DEBT,

OTHER_EXPENSES

payments.payment_clearing_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

payments.additional_fees

object[]

List of additional fees associated with this payment.

Show child attributes

payments.additional_fees.fee_amount

integer<int64>

Amount of the fee in cents.

payments.additional_fees.description

string

Description of the fee.

payments.additional_fees.account

Account ID · object

Account to which the fee should be allocated.

Account ID
Account Stable Name

Show child attributes

payments.additional_fees.account.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

payments.additional_fees.account.id

string<uuid>

ID of the account

payments.additional_fees.is_passed_to_customer

boolean

Whether or not the fee is passed to the customer. It is paid by the business otherwise.

payments.amount

integer<int64>

Customer payment amount, in cents.

payments.processor

string | null

Processor used to make the payment, if any. Any processor name can be provided and will be tracked.

Example:

"STRIPE"

payments.imported_at

string<date-time>

Timestamp when the payment was imported into Layer.

payments.allocations

object[]

List of payment allocations associated with this payment.

Show child attributes

payments.allocations.invoice_id

string<uuid>

ID of the invoice.

payments.allocations.payment_id

string<uuid>

ID of the payment.

payments.allocations.amount

integer<int64>

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.

payments.allocations.transaction_tags

object[]

List of tags on the transaction associated with the payment allocation

Show child attributes

payments.allocations.transaction_tags.id

string<uuid>

required

ID for the tag

payments.allocations.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

payments.allocations.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

payments.allocations.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

payments.allocations.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

payments.allocations.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

payments.allocations.transaction_tags.value_display_name

string | null

Display name for the tag value definition

payments.allocations.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

payments.allocations.memo

string | null

Memo for any text you would like to associate with the invoice payment allocation (for example, to display to end users).

payments.allocations.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": [] }
}

payments.allocations.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the invoice payment allocation.

payments.refund_allocations

object[]

Refund allocations associated with this invoice payment

Show child attributes

payments.refund_allocations.id

string<uuid>

Unique identifier for the refund allocation.

payments.refund_allocations.invoice_id

string<uuid> | null

ID of the invoice this allocation is associated with.

payments.refund_allocations.amount

integer<int64>

Amount of the allocation in cents.

payments.refund_allocations.account_identifier

Account ID · object

Identifier of the ledger account for the refund allocation to apply to

Account ID
Account Stable Name

Show child attributes

payments.refund_allocations.account_identifier.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

payments.refund_allocations.account_identifier.id

string<uuid>

ID of the account

payments.refund_allocations.invoice_external_id

string | null

External ID of the invoice this allocation is associated with.

payments.refund_allocations.invoice_line_item_id

string<uuid> | null

ID of the invoice line item this allocation is associated with. If specified, must not refer to a different invoice invoice_external or invoice_id.

payments.refund_allocations.invoice_line_item_external_id

string | null

The external ID of the invoice line item to refund. If specified alongside invoice_line_item_id, they must refer to the same invoice line item.

payments.refund_allocations.invoice_payment_id

string<uuid> | null

ID of the invoice payment this allocation is associated with.

payments.refund_allocations.invoice_payment_external_id

string | null

External ID of the invoice payment this allocation is associated with.

payments.refund_allocations.customer

object

Show child attributes

payments.refund_allocations.customer.id

string<uuid>

Unique identifier for the customer.

payments.refund_allocations.customer.external_id

string

Unique ID of the customer in your system for linking purposes. Idempotency key.

Example:

"31415926535"

payments.refund_allocations.customer.individual_name

string | null

Full name of the individual customer or contact at a corporate customer.

payments.refund_allocations.customer.company_name

string | null

Name of the company customer.

payments.refund_allocations.customer.email

string | null

Email address of the customer.

payments.refund_allocations.customer.mobile_phone

string | null

Mobile phone number of the customer.

payments.refund_allocations.customer.office_phone

string | null

Office phone number of the customer.

payments.refund_allocations.customer.address_string

string | null

Address of the customer.

payments.refund_allocations.customer.memo

string | null

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

payments.refund_allocations.customer.status

string

Status of the customer. Possible values: ACTIVE, ARCHIVED.

Example:

"ACTIVE"

payments.refund_allocations.customer.transaction_tags

object[]

Show child attributes

payments.refund_allocations.customer.transaction_tags.id

string<uuid>

required

ID for the tag

payments.refund_allocations.customer.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

payments.refund_allocations.customer.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

payments.refund_allocations.customer.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

payments.refund_allocations.customer.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

payments.refund_allocations.customer.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

payments.refund_allocations.customer.transaction_tags.value_display_name

string | null

Display name for the tag value definition

payments.refund_allocations.customer.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

payments.refund_allocations.transaction_tags

object[]

Show child attributes

payments.refund_allocations.transaction_tags.id

string<uuid>

required

ID for the tag

payments.refund_allocations.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

payments.refund_allocations.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

payments.refund_allocations.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

payments.refund_allocations.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

payments.refund_allocations.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

payments.refund_allocations.transaction_tags.value_display_name

string | null

Display name for the tag value definition

payments.refund_allocations.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

payments.refund_allocations.memo

string | null

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

payments.refund_allocations.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": [] }
}

payments.refund_allocations.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the refund allocation.

Example:

[]

payments.payouts

object[]

Payouts associated with this payment.

Show child attributes

payments.payouts.id

string<uuid>

Unique ID for the Payout. Idempotency key.

payments.payouts.external_id

string | null

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

Example:

"payout-1234"

payments.payouts.business_id

string<uuid>

ID of the Business that generated the payout.

payments.payouts.paid_out_amount

integer<int64>

The amount of the payout, in cents

payments.payouts.fee

integer<int64>

The platform fee associated with the payout

payments.payouts.processor

enum<string>

Processor used to make the payment, if any. Any processor name can be provided and will be tracked.

Available options:

STRIPE,

PAYPAL,

SHOPIFY,

ADYEN,

RAINFOREST

Example:

"STRIPE"

payments.payouts.imported_at

string<date-time>

Timestamp of when the payout was imported

payments.payouts.completed_at

string<date-time>

Timestamp of when the payout was completed

payments.payouts.match

object

The transaction match associated with the payout

Show child attributes

payments.payouts.match.id

string<uuid>

Layer's UUID for the match

payments.payouts.match.match_type

enum<string>

Type of the object to match

Available options:

TRANSFER,

INVOICE_PAYMENT,

PAYOUT

payments.payouts.match.bank_transaction

object

Show child attributes

payments.payouts.match.bank_transaction.id

string<uuid>

required

Layer's UUID for the bank transaction

payments.payouts.match.bank_transaction.date

string<date-time>

required

Timestamp when the transaction was created.

payments.payouts.match.bank_transaction.amount

integer<int64>

required

Amount of the transaction, in cents.

payments.payouts.match.bank_transaction.business_id

string<uuid>

UUID of the business the transaction is for

payments.payouts.match.bank_transaction.source

enum<string>

Source of the bank transaction.

Available options:

UNIT,

PLAID,

API,

STRIPE,

CUSTOM

payments.payouts.match.bank_transaction.source_transaction_id

string

External transaction ID from the source platform (e.g, Plaid transaction ID)

Example:

"g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko"

payments.payouts.match.bank_transaction.source_account_id

string

External account ID from the source platform (e.g, Plaid account ID)

Example:

"Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG"

payments.payouts.match.bank_transaction.imported_at

string<date-time>

Timestamp when the transaction was imported.

payments.payouts.match.bank_transaction.direction

enum<string>

Direction of the transaction.

Available options:

CREDIT,

DEBIT

payments.payouts.match.bank_transaction.counterparty_name

string | null

Name of the transaction counterparty

Example:

"WeWork"

payments.payouts.match.bank_transaction.description

string | null

Description of the transaction.

Example:

"WeWork monthly rent payment"

payments.payouts.match.bank_transaction.account_name

string | null

Name of the bank account

Example:

"Plaid Checking"

payments.payouts.match.bank_transaction.categorizationStatus

enum<string>

The status of the transaction’s categorization in Layer’s systems.

Available options:

PENDING,

READY_FOR_INPUT,

CATEGORIZED,

SPLIT,

LAYER_REVIEW,

JOURNALING,

MATCHED

payments.payouts.match.bank_transaction.memo

string | null

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

payments.payouts.match.bank_transaction.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": [] }
}

payments.payouts.match.bank_transaction.reference_number

string | null

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

payments.payouts.match.details

object

Show child attributes

payments.payouts.match.details.id

string<uuid>

required

Layer's ID for the match

payments.payouts.match.details.amount

integer<int64>

required

Monetary amount of the matched transaction, in cents

payments.payouts.match.details.date

string<date-time>

required

Date that the matched transaction occurred

payments.payouts.match.details.description

string | null

Description of the match

Example:

"Transfer from SavingsAccount to CheckingAccount"

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.payouts.transaction_tags

object[]

A list of tags associated with the payout

Show child attributes

payments.payouts.transaction_tags.id

string<uuid>

required

ID for the tag

payments.payouts.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

payments.payouts.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

payments.payouts.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

payments.payouts.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

payments.payouts.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

payments.payouts.transaction_tags.value_display_name

string | null

Display name for the tag value definition

payments.payouts.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

payments.payouts.memo

string | null

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

payments.payouts.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": [] }
}

payments.payouts.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.

payments.transaction_tags

object[]

List of tags associated with this transaction

Show child attributes

payments.transaction_tags.id

string<uuid>

required

ID for the tag

payments.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

payments.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

payments.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

payments.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

payments.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

payments.transaction_tags.value_display_name

string | null

Display name for the tag value definition

payments.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

Example:

[]

payments.memo

string | null

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

payments.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": [] }
}

payments.reference_number

string | null

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

refunds

object[]

A list of refunds associated with the payout

Show child attributes

refunds.id

string<uuid>

Unique identifier for the refund.

refunds.external_id

string

Unique ID of the refund in your system for linking purposes. Idempotency key.

Example:

"31415926535"

refunds.refunded_amount

integer<int64>

Amount refunded to the customer in cents.

refunds.status

string

Status of the refund.

Example:

"PAID"

refunds.completed_at

string<date-time>

Time when the refund was completed.

refunds.is_dedicated

boolean

Whether this refund is dedicated or not. Dedicated refunds can only have one allocation and one payment.

Example:

true

refunds.allocations

object[]

Allocations associated with this refund.

Show child attributes

refunds.allocations.id

string<uuid>

Unique identifier for the refund allocation.

refunds.allocations.invoice_id

string<uuid> | null

ID of the invoice this allocation is associated with.

refunds.allocations.amount

integer<int64>

Amount of the allocation in cents.

refunds.allocations.account_identifier

Account ID · object

Identifier of the ledger account for the refund allocation to apply to

Account ID
Account Stable Name

Show child attributes

refunds.allocations.account_identifier.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

refunds.allocations.account_identifier.id

string<uuid>

ID of the account

refunds.allocations.invoice_external_id

string | null

External ID of the invoice this allocation is associated with.

refunds.allocations.invoice_line_item_id

string<uuid> | null

ID of the invoice line item this allocation is associated with. If specified, must not refer to a different invoice invoice_external or invoice_id.

refunds.allocations.invoice_line_item_external_id

string | null

The external ID of the invoice line item to refund. If specified alongside invoice_line_item_id, they must refer to the same invoice line item.

refunds.allocations.invoice_payment_id

string<uuid> | null

ID of the invoice payment this allocation is associated with.

refunds.allocations.invoice_payment_external_id

string | null

External ID of the invoice payment this allocation is associated with.

refunds.allocations.customer

object

Show child attributes

refunds.allocations.customer.id

string<uuid>

Unique identifier for the customer.

refunds.allocations.customer.external_id

string

Unique ID of the customer in your system for linking purposes. Idempotency key.

Example:

"31415926535"

refunds.allocations.customer.individual_name

string | null

Full name of the individual customer or contact at a corporate customer.

refunds.allocations.customer.company_name

string | null

Name of the company customer.

refunds.allocations.customer.email

string | null

Email address of the customer.

refunds.allocations.customer.mobile_phone

string | null

Mobile phone number of the customer.

refunds.allocations.customer.office_phone

string | null

Office phone number of the customer.

refunds.allocations.customer.address_string

string | null

Address of the customer.

refunds.allocations.customer.memo

string | null

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

refunds.allocations.customer.status

string

Status of the customer. Possible values: ACTIVE, ARCHIVED.

Example:

"ACTIVE"

refunds.allocations.customer.transaction_tags

object[]

Show child attributes

refunds.allocations.customer.transaction_tags.id

string<uuid>

required

ID for the tag

refunds.allocations.customer.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

refunds.allocations.customer.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

refunds.allocations.customer.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

refunds.allocations.customer.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

refunds.allocations.customer.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

refunds.allocations.customer.transaction_tags.value_display_name

string | null

Display name for the tag value definition

refunds.allocations.customer.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

refunds.allocations.transaction_tags

object[]

Show child attributes

refunds.allocations.transaction_tags.id

string<uuid>

required

ID for the tag

refunds.allocations.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

refunds.allocations.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

refunds.allocations.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

refunds.allocations.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

refunds.allocations.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

refunds.allocations.transaction_tags.value_display_name

string | null

Display name for the tag value definition

refunds.allocations.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

refunds.allocations.memo

string | null

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

refunds.allocations.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": [] }
}

refunds.allocations.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the refund allocation.

refunds.payments

object[]

Payments associated with this refund.

Show child attributes

refunds.payments.id

string<uuid>

Unique identifier for the payment.

refunds.payments.external_id

string

Unique ID of the payment in your system for linking purposes. Idempotency key.

Example:

"31415926535"

refunds.payments.refunded_amount

integer<int64>

Amount refunded to the customer in cents.

refunds.payments.fee

integer<int64> | null

Fee charged for the refund in cents.

refunds.payments.completed_at

string<date-time>

Time when the payment was completed.

refunds.payments.method

string

Method of the payment.

Example:

"CREDIT_CARD"

refunds.payments.processor

string | null

Processor used for the payment.

Example:

"STRIPE"

refunds.payments.payment_clearing_account

object

The the ledger account to use for the payment (overrides the default determined by the payment method), if specified.

Show child attributes

refunds.payments.payment_clearing_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

refunds.payments.payment_clearing_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

refunds.payments.payment_clearing_account.id.id

string<uuid>

ID of the account

refunds.payments.payment_clearing_account.name

string

Name of the account

Example:

"Current Assets"

refunds.payments.payment_clearing_account.account_number

string | null

Account number if configured

Example:

"4000"

refunds.payments.payment_clearing_account.stable_name

object

Show child attributes

refunds.payments.payment_clearing_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

refunds.payments.payment_clearing_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

refunds.payments.payment_clearing_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

refunds.payments.payment_clearing_account.account_type

object

Show child attributes

refunds.payments.payment_clearing_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

refunds.payments.payment_clearing_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

refunds.payments.payment_clearing_account.account_subtype

object

Show child attributes

refunds.payments.payment_clearing_account.account_subtype.value

enum<string>

Available options:

BANK_ACCOUNTS,

ACCOUNTS_RECEIVABLE,

INVENTORY,

PAYMENT_PROCESSOR_CLEARING_ACCOUNT,

FIXED_ASSET,

ACCUMULATED_DEPRECIATION,

CASH,

UNDEPOSITED_FUNDS,

CURRENT_ASSET,

NON_CURRENT_ASSET,

PREPAID_EXPENSES,

DEVELOPMENT_COSTS,

LOANS_RECEIVABLE,

INTANGIBLE_ASSET,

ACCOUNTS_PAYABLE,

CREDIT_CARD,

TAXES_PAYABLE,

INCOME_TAXES_PAYABLE,

SALES_TAXES_PAYABLE,

OTHER_TAXES_PAYABLE,

PAYROLL_TAXES_PAYABLE,

UNEARNED_REVENUE,

PAYROLL_LIABILITY,

PAYROLL_CLEARING,

LINE_OF_CREDIT,

TIPS,

REFUND_LIABILITIES,

UNDEPOSITED_OUTFLOWS,

OUTGOING_PAYMENT_CLEARING_ACCOUNT,

OTHER_CURRENT_LIABILITY,

LOANS_PAYABLE,

NOTES_PAYABLE,

SHAREHOLDER_LOAN,

NON_CURRENT_LIABILITY,

CONTRIBUTIONS,

DISTRIBUTIONS,

COMMON_STOCK,

PREFERRED_STOCK,

ADDITIONAL_PAID_IN_CAPITAL,

RETAINED_EARNINGS,

ACCUMULATED_ADJUSTMENTS,

OPENING_BALANCE_EQUITY,

OTHER_EQUITY,

SALES,

UNCATEGORIZED_REVENUE,

RETURNS_ALLOWANCES,

DIVIDEND_INCOME,

INTEREST_INCOME,

OTHER_INCOME,

COGS,

OPERATING_EXPENSES,

PAYROLL,

TAXES_LICENSES,

UNCATEGORIZED_EXPENSE,

CHARITABLE_CONTRIBUTIONS,

LOAN_EXPENSES,

FINANCE_COSTS,

INTEREST_EXPENSES,

DEPRECIATION,

AMORTIZATION,

BAD_DEBT,

OTHER_EXPENSES

refunds.payments.payment_clearing_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

refunds.payments.refunded_payment_fees

object[]

Refunded payment fees associated with the refund payment

Show child attributes

refunds.payments.refunded_payment_fees.account

Account ID · object

Identifier of the ledger account for the refunded payment fee

Account ID
Account Stable Name

Show child attributes

refunds.payments.refunded_payment_fees.account.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

refunds.payments.refunded_payment_fees.account.id

string<uuid>

ID of the account

refunds.payments.refunded_payment_fees.description

string | null

Description of the fee that the refunded payment fee refunds

refunds.payments.refunded_payment_fees.fee_amount

integer<int64>

Amount of the fee refund in cents

refunds.payments.transaction_tags

object[]

Show child attributes

refunds.payments.transaction_tags.id

string<uuid>

required

ID for the tag

refunds.payments.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

refunds.payments.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

refunds.payments.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

refunds.payments.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

refunds.payments.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

refunds.payments.transaction_tags.value_display_name

string | null

Display name for the tag value definition

refunds.payments.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

refunds.payments.memo

string | null

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

refunds.payments.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": [] }
}

refunds.payments.reference_number

string | null

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

refunds.payouts

object[]

Payouts associated with this refund.

Show child attributes

refunds.payouts.id

string<uuid>

Unique ID for the Payout. Idempotency key.

refunds.payouts.external_id

string | null

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

Example:

"payout-1234"

refunds.payouts.business_id

string<uuid>

ID of the Business that generated the payout.

refunds.payouts.paid_out_amount

integer<int64>

The amount of the payout, in cents

refunds.payouts.fee

integer<int64>

The platform fee associated with the payout

refunds.payouts.processor

enum<string>

Processor used to make the payment, if any. Any processor name can be provided and will be tracked.

Available options:

STRIPE,

PAYPAL,

SHOPIFY,

ADYEN,

RAINFOREST

Example:

"STRIPE"

refunds.payouts.imported_at

string<date-time>

Timestamp of when the payout was imported

refunds.payouts.completed_at

string<date-time>

Timestamp of when the payout was completed

refunds.payouts.match

object

The transaction match associated with the payout

Show child attributes

refunds.payouts.match.id

string<uuid>

Layer's UUID for the match

refunds.payouts.match.match_type

enum<string>

Type of the object to match

Available options:

TRANSFER,

INVOICE_PAYMENT,

PAYOUT

refunds.payouts.match.bank_transaction

object

Show child attributes

refunds.payouts.match.bank_transaction.id

string<uuid>

required

Layer's UUID for the bank transaction

refunds.payouts.match.bank_transaction.date

string<date-time>

required

Timestamp when the transaction was created.

refunds.payouts.match.bank_transaction.amount

integer<int64>

required

Amount of the transaction, in cents.

refunds.payouts.match.bank_transaction.business_id

string<uuid>

UUID of the business the transaction is for

refunds.payouts.match.bank_transaction.source

enum<string>

Source of the bank transaction.

Available options:

UNIT,

PLAID,

API,

STRIPE,

CUSTOM

refunds.payouts.match.bank_transaction.source_transaction_id

string

External transaction ID from the source platform (e.g, Plaid transaction ID)

Example:

"g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko"

refunds.payouts.match.bank_transaction.source_account_id

string

External account ID from the source platform (e.g, Plaid account ID)

Example:

"Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG"

refunds.payouts.match.bank_transaction.imported_at

string<date-time>

Timestamp when the transaction was imported.

refunds.payouts.match.bank_transaction.direction

enum<string>

Direction of the transaction.

Available options:

CREDIT,

DEBIT

refunds.payouts.match.bank_transaction.counterparty_name

string | null

Name of the transaction counterparty

Example:

"WeWork"

refunds.payouts.match.bank_transaction.description

string | null

Description of the transaction.

Example:

"WeWork monthly rent payment"

refunds.payouts.match.bank_transaction.account_name

string | null

Name of the bank account

Example:

"Plaid Checking"

refunds.payouts.match.bank_transaction.categorizationStatus

enum<string>

The status of the transaction’s categorization in Layer’s systems.

Available options:

PENDING,

READY_FOR_INPUT,

CATEGORIZED,

SPLIT,

LAYER_REVIEW,

JOURNALING,

MATCHED

refunds.payouts.match.bank_transaction.memo

string | null

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

refunds.payouts.match.bank_transaction.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": [] }
}

refunds.payouts.match.bank_transaction.reference_number

string | null

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

refunds.payouts.match.details

object

Show child attributes

refunds.payouts.match.details.id

string<uuid>

required

Layer's ID for the match

refunds.payouts.match.details.amount

integer<int64>

required

Monetary amount of the matched transaction, in cents

refunds.payouts.match.details.date

string<date-time>

required

Date that the matched transaction occurred

refunds.payouts.match.details.description

string | null

Description of the match

Example:

"Transfer from SavingsAccount to CheckingAccount"

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
  }
}

refunds.payouts.transaction_tags

object[]

A list of tags associated with the payout

Show child attributes

refunds.payouts.transaction_tags.id

string<uuid>

required

ID for the tag

refunds.payouts.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

refunds.payouts.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

refunds.payouts.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

refunds.payouts.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

refunds.payouts.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

refunds.payouts.transaction_tags.value_display_name

string | null

Display name for the tag value definition

refunds.payouts.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

refunds.payouts.memo

string | null

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

refunds.payouts.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": [] }
}

refunds.payouts.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.

refunds.transaction_tags

object[]

Show child attributes

refunds.transaction_tags.id

string<uuid>

required

ID for the tag

refunds.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

refunds.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

refunds.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

refunds.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

refunds.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

refunds.transaction_tags.value_display_name

string | null

Display name for the tag value definition

refunds.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

refunds.memo

string | null

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

refunds.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": [] }
}

refunds.reference_number

string | null

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

transaction_tags

object[]

A list of tags associated with the payout

Show child attributes

transaction_tags.id

string<uuid>

required

ID for the tag

transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

transaction_tags.value_display_name

string | null

Display name for the tag value definition

transaction_tags.archived_at

string<date-time> | null

When the tag was archived

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.

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

Create payout

Authorizations

Headers

Path Parameters

Body

Response