Update payment

Authorizations

Authorization

string

header

required

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

Path Parameters

businessId

string

required

The UUID of the business to update the invoice payment for

paymentId

string

required

The UUID of the invoice payment to update

Body

application/json

An object containing a subset of Payment object fields used to update an existing Payment

external_id

string | null

An optional external identifier for the payment.

Example:

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

paid_at

string<date-time> | null

Timestamp when the payment was completed.

amount

integer<int64> | null

Customer payment amount, in cents.

fee

integer<int64> | null

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

additional_fees

object[] | null

List of additional fees associated with this payment.

Show child attributes

additional_fees.fee_amount

integer<int64>

Amount of the fee in cents.

additional_fees.description

string

Description of the fee.

additional_fees.account

Account ID · object

Account identifier to which the fee should be allocated.

Account ID
Account Stable Name

Show child attributes

additional_fees.account.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

additional_fees.account.id

string<uuid>

ID of the account

additional_fees.is_passed_to_customer

boolean

Whether or not the fee is passed to the customer. It is paid by the business otherwise. When calculating the outstanding balance on the invoice, only the portion of each payment allocation that is applied to the invoice (excluding pass-through fees) is considered. This allows customers to pay the invoice amount plus any pass-through fees without the invoice being considered overpaid.

method

enum<string> | null

Payment method.

Available options:

CASH,

CHECK,

CREDIT_CARD,

ACH,

CREDIT_BALANCE,

OTHER

processor

string | null

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

Example:

"STRIPE"

payment_clearing_account_identifier

Account ID · object

The the ledger account to use for the payment (overrides the default determined by the payment method)

Account ID
Account Stable Name

Show child attributes

payment_clearing_account_identifier.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

payment_clearing_account_identifier.id

string<uuid>

ID of the account

invoice_payments

object[] | null

Allocations of this payment towards invoices. Setting these allocations will override any existing allocations.

Show child attributes

invoice_payments.invoice_id

string<uuid>

Layer ID of the invoice to apply payment. Either the invoice_id or invoice_external_id must be provided.

invoice_payments.invoice_external_id

string<uuid>

External ID of the invoice payment. Either the invoice_id or invoice_external_id must be provided.

invoice_payments.amount

integer<int64>

invoice_payments.tags

object[]

Show child attributes

invoice_payments.tags.key

string

required

The tag dimension key (e.g., "department", "project", "location")

Example:

"department"

invoice_payments.tags.value

string

required

The tag value (e.g., "sales", "marketing", "engineering")

Example:

"sales"

invoice_payments.tags.dimension_display_name

string | null

If the TagDimension doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagDimension.

Example:

"Department"

invoice_payments.tags.value_display_name

string | null

If the TagValueDefinition doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagValueDefinition.

Example:

"Sales Department"

invoice_payments.memo

string | null

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

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

invoice_payments.reference_number

string | null

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

dedicated_refunds

object[] | null

Dedicated refunds to associate with this invoice payment

Show child attributes

dedicated_refunds.external_id

string

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

Example:

"31415926535"

dedicated_refunds.account_identifier

Account ID · object

Optional account identifier to override what ledger account the dedicated refund comes out of.

Account ID
Account Stable Name

Show child attributes

dedicated_refunds.account_identifier.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

dedicated_refunds.account_identifier.id

string<uuid>

ID of the account

dedicated_refunds.line_items

object[] | null

Detailed line items for the refund allocation. Use this for itemized refunds where you need to specify the exact amounts and accounts.

Show child attributes

dedicated_refunds.line_items.amount

integer<int64>

required

The amount of this line item in cents.

dedicated_refunds.line_items.external_id

string | null

An external identifier for the line item.

dedicated_refunds.line_items.account_identifier

Account ID · object

Identifier of the ledger account for this line item.

Account ID
Account Stable Name

Show child attributes

dedicated_refunds.line_items.account_identifier.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

dedicated_refunds.line_items.account_identifier.id

string<uuid>

ID of the account

dedicated_refunds.line_items.prepayment_account_identifier

Account ID · object

Identifier of the prepayment ledger account for this line item.

Account ID
Account Stable Name

Show child attributes

dedicated_refunds.line_items.prepayment_account_identifier.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

dedicated_refunds.line_items.prepayment_account_identifier.id

string<uuid>

ID of the account

dedicated_refunds.line_items.tags

object[]

Tags to associate with the line item.

Show child attributes

dedicated_refunds.line_items.tags.key

string

required

The tag dimension key (e.g., "department", "project", "location")

Example:

"department"

dedicated_refunds.line_items.tags.value

string

required

The tag value (e.g., "sales", "marketing", "engineering")

Example:

"sales"

dedicated_refunds.line_items.tags.dimension_display_name

string | null

If the TagDimension doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagDimension.

Example:

"Department"

dedicated_refunds.line_items.tags.value_display_name

string | null

If the TagValueDefinition doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagValueDefinition.

Example:

"Sales Department"

dedicated_refunds.line_items.memo

string | null

Memo for any text you would like to associate with the line item.

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

dedicated_refunds.line_items.reference_number

string | null

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

dedicated_refunds.completed_at

string<date-time>

When the dedicated refund was given and paid.

dedicated_refunds.refund_processing_fee

integer<int64>

Fee charged to the business for processing the refund.

dedicated_refunds.method

enum<string>

Available options:

CASH,

CHECK,

CREDIT_CARD,

ACH,

CREDIT_BALANCE,

OTHER

dedicated_refunds.processor

string | null

dedicated_refunds.refunded_payment_fees

object[]

List of fees associated with the payment for this dedicated refund. These are refunded from the payment processor rather than the business.

Show child attributes

dedicated_refunds.refunded_payment_fees.account

Account ID · object

required

Account to which the fee should be allocated.

Account ID
Account Stable Name

Show child attributes

dedicated_refunds.refunded_payment_fees.account.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

dedicated_refunds.refunded_payment_fees.account.id

string<uuid>

ID of the account

dedicated_refunds.refunded_payment_fees.fee_amount

integer<int64>

required

Amount of the fee in cents.

dedicated_refunds.refunded_payment_fees.description

string | null

Description of the fee.

dedicated_refunds.tags

object[]

List of tags associated with this dedicated refund

Show child attributes

dedicated_refunds.tags.key

string

required

The tag dimension key (e.g., "department", "project", "location")

Example:

"department"

dedicated_refunds.tags.value

string

required

The tag value (e.g., "sales", "marketing", "engineering")

Example:

"sales"

dedicated_refunds.tags.dimension_display_name

string | null

If the TagDimension doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagDimension.

Example:

"Department"

dedicated_refunds.tags.value_display_name

string | null

If the TagValueDefinition doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagValueDefinition.

Example:

"Sales Department"

dedicated_refunds.memo

string | null

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

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

dedicated_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.

Response

string<uuid>

Unique identifier for the payment.

external_id

string | null

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

Example:

"payment-1"

string<date-time>

Timestamp when the payment was completed.

method

enum<string>

Payment method.

Available options:

CASH,

CHECK,

CREDIT_CARD,

ACH,

CREDIT_BALANCE,

OTHER

fee

integer<int64>

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

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

prepayment_account.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

prepayment_account.id

string<uuid>

ID of the account

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

payment_clearing_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

payment_clearing_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

payment_clearing_account.id.id

string<uuid>

ID of the account

payment_clearing_account.name

string

Name of the account

Example:

"Current Assets"

payment_clearing_account.account_number

string | null

Account number if configured

Example:

"4000"

payment_clearing_account.stable_name

object

Show child attributes

payment_clearing_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

payment_clearing_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

payment_clearing_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

payment_clearing_account.account_type

object

Show child attributes

payment_clearing_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

payment_clearing_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

payment_clearing_account.account_subtype

object

Show child attributes

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

payment_clearing_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

additional_fees

object[]

List of additional fees associated with this payment.

Show child attributes

additional_fees.fee_amount

integer<int64>

Amount of the fee in cents.

additional_fees.description

string

Description of the fee.

additional_fees.account

Account ID · object

Account to which the fee should be allocated.

Account ID
Account Stable Name

Show child attributes

additional_fees.account.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

additional_fees.account.id

string<uuid>

ID of the account

additional_fees.is_passed_to_customer

boolean

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

amount

integer<int64>

Customer payment amount, in cents.

processor

string | null

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

Example:

"STRIPE"

imported_at

string<date-time>

Timestamp when the payment was imported into Layer.

allocations

object[]

List of payment allocations associated with this payment.

Show child attributes

allocations.invoice_id

string<uuid>

ID of the invoice.

allocations.payment_id

string<uuid>

ID of the payment.

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.

allocations.transaction_tags

object[]

List of tags on the transaction associated with the payment allocation

Show child attributes

allocations.transaction_tags.id

string<uuid>

required

ID for the tag

allocations.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

allocations.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

allocations.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

allocations.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

allocations.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

allocations.transaction_tags.value_display_name

string | null

Display name for the tag value definition

allocations.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

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).

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

allocations.reference_number

string | null

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

refund_allocations

object[]

Refund allocations associated with this invoice payment

Show child attributes

refund_allocations.id

string<uuid>

Unique identifier for the refund allocation.

refund_allocations.invoice_id

string<uuid> | null

ID of the invoice this allocation is associated with.

refund_allocations.amount

integer<int64>

Amount of the allocation in cents.

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

refund_allocations.account_identifier.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

refund_allocations.account_identifier.id

string<uuid>

ID of the account

refund_allocations.invoice_external_id

string | null

External ID of the invoice this allocation is associated with.

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.

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.

refund_allocations.invoice_payment_id

string<uuid> | null

ID of the invoice payment this allocation is associated with.

refund_allocations.invoice_payment_external_id

string | null

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

refund_allocations.customer

object

Show child attributes

refund_allocations.customer.id

string<uuid>

Unique identifier for the customer.

refund_allocations.customer.external_id

string

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

Example:

"31415926535"

refund_allocations.customer.individual_name

string | null

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

refund_allocations.customer.company_name

string | null

Name of the company customer.

refund_allocations.customer.email

string | null

Email address of the customer.

refund_allocations.customer.mobile_phone

string | null

Mobile phone number of the customer.

refund_allocations.customer.office_phone

string | null

Office phone number of the customer.

refund_allocations.customer.address_string

string | null

Address of the customer.

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).

refund_allocations.customer.status

string

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

Example:

"ACTIVE"

refund_allocations.customer.transaction_tags

object[]

Show child attributes

refund_allocations.customer.transaction_tags.id

string<uuid>

required

ID for the tag

refund_allocations.customer.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

refund_allocations.customer.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

refund_allocations.customer.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

refund_allocations.customer.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

refund_allocations.customer.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

refund_allocations.customer.transaction_tags.value_display_name

string | null

Display name for the tag value definition

refund_allocations.customer.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

refund_allocations.transaction_tags

object[]

Show child attributes

refund_allocations.transaction_tags.id

string<uuid>

required

ID for the tag

refund_allocations.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

refund_allocations.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

refund_allocations.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

refund_allocations.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

refund_allocations.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

refund_allocations.transaction_tags.value_display_name

string | null

Display name for the tag value definition

refund_allocations.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

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).

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

refund_allocations.reference_number

string | null

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

Example:

[]

payouts

object[]

Payouts associated with this payment.

Show child attributes

payouts.id

string<uuid>

Unique ID for the Payout. Idempotency key.

payouts.external_id

string | null

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

Example:

"payout-1234"

payouts.business_id

string<uuid>

ID of the Business that generated the payout.

payouts.paid_out_amount

integer<int64>

The amount of the payout, in cents

payouts.fee

integer<int64>

The platform fee associated with the payout

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"

payouts.imported_at

string<date-time>

Timestamp of when the payout was imported

payouts.completed_at

string<date-time>

Timestamp of when the payout was completed

payouts.match

object

The transaction match associated with the payout

Show child attributes

payouts.match.id

string<uuid>

Layer's UUID for the match

payouts.match.match_type

enum<string>

Type of the object to match

Available options:

TRANSFER,

INVOICE_PAYMENT,

PAYOUT

payouts.match.bank_transaction

object

Show child attributes

payouts.match.bank_transaction.id

string<uuid>

required

Layer's UUID for the bank transaction

payouts.match.bank_transaction.date

string<date-time>

required

Timestamp when the transaction was created.

payouts.match.bank_transaction.amount

integer<int64>

required

Amount of the transaction, in cents.

payouts.match.bank_transaction.business_id

string<uuid>

UUID of the business the transaction is for

payouts.match.bank_transaction.source

enum<string>

Source of the bank transaction.

Available options:

UNIT,

PLAID,

API,

STRIPE,

CUSTOM

payouts.match.bank_transaction.source_transaction_id

string

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

Example:

"g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko"

payouts.match.bank_transaction.source_account_id

string

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

Example:

"Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG"

payouts.match.bank_transaction.imported_at

string<date-time>

Timestamp when the transaction was imported.

payouts.match.bank_transaction.direction

enum<string>

Direction of the transaction.

Available options:

CREDIT,

DEBIT

payouts.match.bank_transaction.counterparty_name

string | null

Name of the transaction counterparty

Example:

"WeWork"

payouts.match.bank_transaction.description

string | null

Description of the transaction.

Example:

"WeWork monthly rent payment"

payouts.match.bank_transaction.account_name

string | null

Name of the bank account

Example:

"Plaid Checking"

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

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).

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

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.

payouts.match.details

object

Show child attributes

payouts.match.details.id

string<uuid>

required

Layer's ID for the match

payouts.match.details.amount

integer<int64>

required

Monetary amount of the matched transaction, in cents

payouts.match.details.date

string<date-time>

required

Date that the matched transaction occurred

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

payouts.transaction_tags

object[]

A list of tags associated with the payout

Show child attributes

payouts.transaction_tags.id

string<uuid>

required

ID for the tag

payouts.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

payouts.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

payouts.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

payouts.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

payouts.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

payouts.transaction_tags.value_display_name

string | null

Display name for the tag value definition

payouts.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

payouts.memo

string | null

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

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

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.

transaction_tags

object[]

List of tags associated with this transaction

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

Example:

[]

memo

string | null

Memo for any text you would like to associate with the invoice payment (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 invoice payment. Can be used to filter when listing invoice payments.

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

Update payment

Authorizations

Path Parameters

Body

Response