Update Payment
PUT/api/sales-credits/:salesCredit/payments/:payment
Updates an existing payment on a sales credit. All fields are optional (uses sometimes validation).
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Fields:
- payment_date (optional, date): Updated payment date
- amount (optional, numeric, > 0): Updated payment amount
- external_reference (optional, max 255): External reference number
- currency_id (optional): Currency ID
Returns 422 (payment error) for a refund recorded from PayPal (reference paypal:…). external_reference may not start with paypal:.
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.
Refund cap: the amount may not exceed what is still available on the credit — its total less every amount applied to invoices or orders (including the invoice the credit was raised against) and every earlier refund. Exceeding it returns 422 on amount; when the credit's application is recorded in Xero or QuickBooks Online, the message names that system. A credit created for an overpayment is fully available to refund. After the change, the balances of the invoices the credit belongs to are recalculated.
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
Response Headers
Unprocessable Content
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.