Delete Payment

DELETE 
/api/sales-credits/:salesCredit/payments/:payment

Deletes a payment from a sales credit and recalculates the payment status.

Required scope: orders:write

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

Authentication: Requires Bearer token.

Returns 422 for a refund recorded by the PayPal integration.

Returns 422 (sales_credit error) for any payment on a credit that records a refund made through PayPal (is_paypal_refund: true).

The payment must belong to the sales credit in the URL; otherwise 404.

The deleted amount becomes available on the credit again, and the balances of the invoices the credit belongs to are recalculated.

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

Response Headers

Content-Type

422

Unprocessable Content

Response Headers

Content-Type

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.