Mark payment as paid

Mark a payment as paid with the specified payment form.

gigstack Connect: Mark other teams' payments as paid using the team parameter.

Required Information

payment_form (required): SAT-compliant payment form code (01–31, 99)

date (optional): when the payment was received, in Unix epoch milliseconds
(13 digits). The handler passes the value straight to Luxon.fromMillis() and
compares it against Luxon.now().toMillis(); a seconds-based timestamp resolves to
1970 and is silently accepted. Defaults to now. A future date returns 400.

send_email / ignore_emails (optional): ignore_emails takes precedence —
the handler resolves ignore_emails ?? (send_email === false), so ignore_emails: true
suppresses notifications even when send_email: true.

amount_received (optional): cumulative amount received so far, in the payment's
currency. Omit it, or send the full payment amount, to mark the payment succeeded
(unchanged default behavior). Send less than the full amount to record a partial
top-up: the payment is set to partially_paid instead, triggering a partial payment
complement on the related PPD invoice. Requires the team's
automatePartialPaymentComplements default to be on and a payment_complement
automation already present on the payment. Sending more than the payment amount
returns 400.

application/json

Payment marked as paid successfully. When amount_received was less than the
payment amount, the returned payment has status: partially_paid instead of
succeeded.

Bodyapplication/json

curl --location 'https://api.gigstack.io/v2/payments/payment_1234567890/paid?team=undefined' \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "payment_form": "03", "date": 1767225600000, "ignore_emails": false }'

Required Information

Request

Responses

Mark payment as paid

Required Information#

Request

Responses

Required Information