PATCH
/
v1
/
businesses
/
{businessId}
/
invoices
/
payments
/
{paymentId}

Authorizations

Authorization
string
headerrequired

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.

paid_at
string | null

Timestamp when the payment was completed.

amount
integer | null

Customer payment amount, in cents.

fee
integer | null

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

additional_fees
object[] | null

List of additional fees associated with this payment.

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.

Response

200 - application/json
id
string

Unique identifier for the payment.

external_id
string | null

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

at
string

Timestamp when the payment was completed.

method
enum<string>

Payment method.

Available options:
CASH,
CHECK,
CREDIT_CARD,
ACH,
REDEEMED_PREPAYMENT,
OTHER
fee
integer

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

additional_fees
object[]

List of additional fees associated with this payment.

amount
integer

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. Supported processors (STRIPE, SHOPIFY) will have additional asset balance tracking.

imported_at
string

Timestamp when the payment was imported into Layer.

allocations
object[]

List of payment allocations associated with this payment.

transaction_tags
object[]

List of tags associated with this transaction