UpdateRefundCommandRequestInput
Changes a refund. Fields that are omitted stay as they are. Before the refund is sent, the amount, the payment reference, the internal note and, for a bank transfer, the recipient can be changed; a new amount changes the payout the refund booked as well, and a smaller payout can make the sales order or the corrected invoice fully paid and start its workflows. Once the refund is sent or confirmed, only ‘internalNote’ can be changed. Errors: REFUND_NOT_FOUND (the refund was not found); REFUND_ALREADY_SENT (the refund was sent or confirmed, only ‘internalNote’ can be changed); RECIPIENT_NOT_CHANGEABLE (the recipient of a refund of a payment transaction is its payer); AMOUNT_NOT_POSITIVE (the amount is not greater than 0); AMOUNT_EXCEEDS_REFUNDABLE_AMOUNT (the amount is more than can be refunded); RECIPIENT_IBAN_INVALID (the IBAN of the recipient is not valid). - Request
UpdateRefundCommandRequestInputFields
The ID of the refund.
The new amount, greater than 0, with at most two decimals.
The new text for the recipient.
The new internal note; null removes it.
The new name of the recipient of a bank transfer.
The new IBAN of the recipient of a bank transfer.
The new BIC of the recipient's bank; null removes it.
Whether to suppress the workflows this call would start because a sales order or a sales invoice becomes fully paid. 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?