Skip to main content
PUT
Update dedicated invoice payment

Authorizations

Authorization
string
header
required

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

Path Parameters

businessId
string<uuid>
required

The UUID of the business.

invoiceId
string<uuid>
required

The UUID of the invoice.

paymentId
string<uuid>
required

The UUID of the payment.

Body

application/json
method
enum<string>
required

Payment method.

Available options:
CREDIT_CARD,
CASH,
CHECK,
ACH,
CREDIT_BALANCE,
OTHER
amount
integer
required

Payment amount in cents.

external_id
string

External identifier for the payment.

paid_at
string<date-time>

The timestamp when the payment was made.

fee
integer

Fee amount in cents.

additional_fees
(Standard fee · object | Loan repayment fee · object)[]

Parameters for creating an additional fee on an invoice payment. The fee type is optional and defaults to STANDARD; use LOAN_REPAYMENT to record a loan repayment as part of the payment.

processor
string

Payment processor name.

payment_clearing_account_identifier
Account ID · object

ID of the account.

redemption_account
Account ID · object

ID of the account.

dedicated_refunds
object[]
tags
object[]
memo
string
metadata
object
reference_number
string

Response

Payment updated successfully.

data
object
required