Record Quote Deposit Payment

POST 
/api/quotes/:quote/deposit-payment

Record a deposit payment against the quote — used for manual/offline payments taken by staff. Payment gateway webhooks record their own payments through the same mechanism.

Required scope: orders:write

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

Body fields:

• amount (optional, numeric, min 0) — payment amount; defaults to the quote's calculated deposit amount.
• reference (optional, string, max 255) — external payment reference.
• provider (optional, string, max 64) — payment provider label; defaults to manual.

Returns 201 with the recorded payment's id, amount, and status.

Authentication: Requires Bearer token.

Request

Responses

201

Created

Response Headers

Content-Type

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.