Stripe Refund Transaction

Prerequisites

Before performing a Refund transaction with the Stripe gateway, you’ll first need to set up your environment as described in the Environment Setup Guide.

Executing a Refund Transaction

@RequiredArgsConstructor
public class Refund {

 private final StripeTransactionService stripeTransactionService;

 public void performRefund() {
		 CurrencyUnit currency = Monetary.getCurrency(currencyCode);
		 MonetaryAmount transactionTotal = Monetary.getDefaultAmountFactory().setCurrency(currency).setNumber(amount).create();

		 PaymentRequest paymentRequest = new PaymentRequest()
		        .transactionReferenceId(transactionReferenceId)
		        .transactionTotal(transactionTotal)
		        .additionalField("PAYMENT_INTENT_ID", paymentIntentIdToRefund); // The PaymentIntent Id from the Capture transaction.

	 	PaymentResponse paymentResponse = stripeTransactionService.refund(paymentRequest);

		paymentResponse.isSuccessful();
		paymentResponse.getGatewayResponseCode(); // The Stripe response code
		paymentResponse.getFailureType(); // Failure type in case the transaction was not successful.
	   	paymentResponse.getRawResponse(); // Stripe raw response stored as a JSON object.
        paymentResponse.getResponseMap().get("TRANSACTION_ID"); // The Stripe Charge ID.
        paymentResponse.getResponseMap().get("PAYMENT_INTENT_ID"); // The Stripe Payment Intent ID.
        paymentResponse.getResponseMap().get("ERROR_CODE"); // The Stripe error response code.
        paymentResponse.getResponseMap().get("ERROR_MESSAGE"); // The Stripe error message.
	}
}

To set additional fields in the PaymentRequest, use method

PaymentRequest.additionalField(key, value)

To get values from responseMap, use

PaymentResponse.getResponseMap().get(key, value)

To get the transaction reference ID from response:

PaymentResponse.getTransactionReferenceId()

To get the Broadleaf Payment ID from the response:

PaymentResponse.getPaymentId()