Refund to Store Credit

You can now issue a specified amount as new store credit when processing refunds. This can be done in addition to refunding amounts to the original payment methods. If a customer requests a refund to their original payment method after already receiving a refund to new store credit, you can accomplish this by specifying a parameter that allows over-refunding. Note that this parameter is disabled by default.

To use this feature, ensure the following prerequisites are met:

• New customer accounts must be enabled in the store.
• The order must be associated with a customer.

This feature integrates with the standard refund API process as follows:

• Use the Order.suggestedRefund field to create a suggested set of transactions and refund methods. You can now use the refundMethodAllocation parameter to define this set.
• Pass the transactions and other refund components (e.g. refundLineItems), as before, to the refundCreate mutation. Additionally, you can now use the refundMethods parameter to pass in any refunds to new store credit.

You can also refund to store credit using new return processing APIs:

• Use the Return.suggestedFinancialOutcome field to query for suggested refund amounts. Specify STORE_CREDIT as the refundMethodAllocation parameter to retrieve a suggested store credit refund amount.
• Use the financialTransfer.issueRefund.refundMethods parameter of the returnProcess mutation to specify the storeCreditRefund amount and complete the refund.