Skip to main content
POST
Create a payment
Body raw (json)

Authorizations

x-api-key
string
header
required

Body

application/json
invoice_id
integer
required

Existing invoice id.

payment_date
integer
required

Unix timestamp.

amount
string
required

A number, sent as a string.

method
enum<string>
required
Available options:
cash,
check,
card,
square,
bank_transfer,
other
payment_method_id
integer | null

Existing payment method id.

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

Response

Created

error
boolean

false when the request succeeds.

Example:

false

response
object

The created record.