Payment allocations
View as MarkdownPayment allocations assign credit from an existing payment to another balance.
DELETE
/api/v1/payment-allocations/{id}Removes a credit allocation and releases its amount back to the source payment.
Permissions
Send your API key in X-API-Key. Required permissions are Payments → Write.
Path parameters
idintegerRequired- ID of the credit allocation.
Returns
Returns confirmation that the allocation was removed.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
404- The requested record was not found.
400- The allocation ID or allocation is invalid.
409- The allocation is in use or its state prevents removal.