GET
/
v1
/
businesses
/
{businessId}
/
invoices
/
payments

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 invoice payments for

Query Parameters

method
string

Filter payments by status. Supported values are CASH, CHECK, CREDIT_CARD, ACH, REDEEMED_PREPAYMENT, OTHER.

paid_at_start
string

Filter payments by payment date. Payments made on or after this date will be included. ISO 8601 date format.

paid_at_end
string

Filter payments by payment date. Payments made on or before this date will be included. ISO 8601 date format.

Response

200 - application/json
additional_fees
object[]

List of additional fees associated with this payment.

allocations
object[]

List of payment allocations associated with this payment.

amount
integer

Customer payment amount, in cents.

at
string

Timestamp when the payment was completed.

external_id
string | null

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

fee
integer

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

id
string

Unique identifier for the payment.

imported_at
string

Timestamp when the payment was imported into Layer.

method
enum<string>

Payment method.

Available options:
CASH,
CHECK,
CREDIT_CARD,
ACH,
REDEEMED_PREPAYMENT,
OTHER
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.

transaction_tags
object[]

List of tags associated with this transaction