Fetch 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 fetch the payout for

payoutId

string

required

The UUID of the payout to fetch

Response

200 - application/json

business_id

string

ID of the Business that generated the payout.

completed_at

string

Timestamp of when the payout was completed

external_id

string | null

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

fee

integer

The platform fee associated with the payout

string

Unique ID for the Payout. Idempotency key.

imported_at

string

Timestamp of when the payout was imported

match

object

The transaction match associated with the payout

paid_out_amount

integer

The amount of the payout, in cents

payments

object[]

A list of invoice payments associated with the payout

payments.additional_fees

object[]

List of additional fees associated with this payment.

payments.allocations

object[]

List of payment allocations associated with this payment.

payments.amount

integer

Customer payment amount, in cents.

payments.at

string

Timestamp when the payment was completed.

payments.external_id

string | null

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

payments.fee

integer

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

payments.id

string

Unique identifier for the payment.

payments.imported_at

string

Timestamp when the payment was imported into Layer.

payments.method

enum<string>

Payment method.

Available options:

CASH,

CHECK,

CREDIT_CARD,

ACH,

REDEEMED_PREPAYMENT,

OTHER

payments.processor

string | null

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.

payments.transaction_tags

object[]

List of tags associated with this transaction

processor

enum<string>

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.

Available options:

STRIPE,

PAYPAL

transaction_tags

object[]

A list of tags associated with the payout

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Fetch payout

Authorizations

Headers

Path Parameters

Response