UnassignPaymentTransactionCommandRequestInput
Removes one payment from a payment transaction: the payment is deleted, also when it existed before and was only linked, for example a payment from the shop. The fees of the transaction booked as order costs are removed with it, also when other payments of the transaction remain. The payment status of the document can change; a payout that is removed can make it fully paid and start its workflows. Only payments of sales documents can be removed here; payments of incoming invoices are changed there. Errors: PAYMENT_TRANSACTION_NOT_FOUND (the payment transaction was not found); PAYMENT_ACCOUNT_HIDDEN (the payment account is hidden; show it with ‘ShowPaymentAccount’ first); PAYMENT_NOT_FOUND (the payment was not found); PAYMENT_NOT_ASSIGNED_TO_TRANSACTION (the payment does not belong to the transaction); PAYMENT_NOT_UNASSIGNABLE (the payment is not a payment of a sales document, for example a payment of an incoming invoice); PAYMENT_CANNOT_BE_DELETED (the payment cannot be deleted. The error lists the blocker codes, the same as for ‘DeletePayment’: PAYMENT_BOOKED_BY_REFUND, PAYMENT_IS_VOUCHER_REDEMPTION). - Request
UnassignPaymentTransactionCommandRequestInputFields
The ID of the payment transaction.
The ID of the payment to remove (see 'QueryPaymentTransactionAssignmentsByPaymentTransactionId').
Whether to suppress the automatic workflows this call would start: the events of the payment transaction and, when a sales order or a sales invoice becomes fully paid, its workflows. Events for other systems are still published. Defaults to false when omitted.
Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.
Was this page helpful?