Skip to main content
PATCH
Update a payment

Authorizations

Authorization
string
header
required

Bearer authentication using your BookingShake API key. Retrieve your API key from Settings > Integrations in your BookingShake dashboard.

Path Parameters

id
string
required

Payment document ID (the id field carried by the payment.* webhooks).

Body

application/json

Fields that can be updated on a payment. All fields are optional (partial update): only the fields present in the body are modified. Same conventions as the response - amount in integer cents, dates as YYYY-MM-DD in the Europe/Paris timezone. At least one field must be provided.

name
string

Payment label

Maximum string length: 255
Example:

"Acompte 30%"

amount
integer

Amount in integer cents

Required range: x >= 0
Example:

90000

status
enum<string>
Available options:
waiting,
paid,
canceled
Example:

"paid"

method_id
string

Stable ID of a payment method from the venue catalog (GET /payment-methods). Must reference an active (non-archived) method; the display label stored on the payment is derived from the catalog.

Example:

"wire_transfer"

received_date
string<date> | null

Date the payment was received, YYYY-MM-DD. Pass null to clear.

Example:

"2026-06-10"

due_date
string<date> | null

Date the payment is expected, YYYY-MM-DD. Pass null to clear.

Example:

"2026-06-15"

Response

Payment updated successfully. Returns the full payment in its post-update state.

message
string
Example:

"success"

data
object

A payment. Identical to the data block of the payment.* webhooks. Amount is integer cents; dates are YYYY-MM-DD strings in the Europe/Paris timezone; timestamps are Unix milliseconds; missing values are explicit null.