Update Vendor Credit Refund Payment
PUT/api/vendor-credits/:vendor_credit/payments/:payment
Update a refund payment previously recorded on a vendor credit. All fields are optional on update: payment_type_id, amount, payment_date, external_reference, currency_id. The updated amount cannot exceed the credit's remaining balance (the current payment's amount is excluded from that check), and currency_id must match the credit's currency.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
The credit's payment status is recalculated after the update. Returns an error when the payment does not belong to the vendor credit.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
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.