v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB

Payments

Update payment

Updates the synchronization status, error message, registration status or additional info of a payment identified by customId. If none of the provided fields change the existing payment, the update is a no-op. Note that updating a customId that does not match any payment also returns 200 without applying any change — no 404 is raised. Setting error without sync marks the payment as synchronized with the error recorded.

patch/payments/{companyId}/{customId}

Path parameters

customIdstring required

companyIdstring required

Request body

syncboolean nullable

Marks the payment as synchronized with the accounting system.

additionalInfoobject nullable

Free-form key/value metadata to attach to the payment.

errorstring nullable

Error message to record against the payment. Sending an empty string clears a previously set error.

registeredboolean nullable

Marks the payment as registered in the accounting system.

Example request

{
  "error": "Missing account"
}

Response

Successful Response

idstring required

Embat payment ID