Record Payment

POST 
/api/vendor-deposits/:vendorDepositId/payments

Record a payment against a vendor deposit (full or partial), with the payment date, currency rate, and optional reference.

Required scope: accounting:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Payments can also be recorded on a draft deposit — useful for capturing a payment that was already made in the past. The deposit then moves directly to Partially Paid / Paid without a payment request or approval step.

The payment amount cannot exceed the deposit's outstanding balance (deposit amount minus payments already recorded). Deposits whose payee bank details differ from the supplier profile must have those details verified before payments can be recorded. Payments cannot be recorded against cancelled, void, refunded, or written-off deposits.

Request

Responses

200

Successful response

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.