Delete Vendor Credit Refund Payment

DELETE 
/api/vendor-credits/:vendor_credit/payments/:payment

Delete a refund payment from a vendor credit. The deleted amount becomes available on the credit again and the credit's payment status is recalculated.

Required scope: accounting:write

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

Returns the updated vendor credit. Returns an error when the payment does not belong to the vendor credit.

Request

Responses

200

OK

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.

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.