Skip to main content
PUT
Update payment by ID
Body raw (json)

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Body

application/json
method
enum<string>
required
Available options:
cash,
check,
card,
square,
bank_transfer,
other
invoice_id
integer

Existing invoice id.

payment_date
integer

Unix timestamp.

amount
string

A number, sent as a string.

payment_method_id
integer | null

Existing payment method id.

notes
string
Maximum string length: 4000
square_transaction_id
string
Maximum string length: 255

Response

Successful response

error
boolean

false when the request succeeds.

Example:

false

response
object

The updated record.