Payments

Record a payment on an event

Records a payment the business collected outside Check Cherry, such as cash, check, or Venmo. This does not charge a card.

Provide amount, tip_amount, or both. The payment is added to the booking's balance and logged in its change history.

No receipt is sent unless send_receipt is true.

Required permission: assigned_event_write or unassigned_event_write, plus the matching pricing permission (assigned_event_read_pricing or unassigned_event_read_pricing).

post/api/v1/events/{event_id}/event_payments

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/events/{event_id}/event_payments
  • Auth: none declared. Required headers: Api-Key

Path parameters

event_idinteger required

The ID of the event the payment is for

Headers

Api-Keystring required

Your Integration Key

Request body

payment_methodstring required

How the payment was made (e.g., "Cash", "Check", "Venmo")

paid_atstring required

Date the payment was received (YYYY-MM-DD)

amountnumber

Payment amount, excluding tip. In whole currency units, so 250.00 means $250.00

tip_amountnumber

Tip amount, in whole currency units

referencestring

Reference such as a check number

send_receiptboolean

Email the client a receipt (default: false)

Response

payment recorded

Changes

No recorded changes to this operation across all 2 revisions of this API.