Payment Refund

Overview

Payment Refund will refund an amount to a previous Payment Authorization Capture transaction.

Prerequisites

There is one prerequisite resource that must be created before requesting a payment refund.

Object	Definition
Chargent Transaction	Transactions record the results of the requests made to the payment gateway on the Chargent Order. Transactions are also used to make additional requests in the payments lifecycle.

Refund Types

There are two types of payment refunds.

Type	Definition
Full Refund	Input up to the full charge amount to perform a full refund.
Partial Refund	Input a lesser value than the charge amount to perform a partial refund

Create Payment Refund

Flow Action

Action Name	Label	Category
apex-ChargentBase_FlowPaymentsRefunds	Chargent Payments Refunds	Chargent Payments

Flow Method

Method Name	Input	Input Type	Output	Output Type
refund()	RefundInput	List<RefundInput>	RefundOutput	List<RefundOutput>

RefundInput Properties

Property	Type	Description
transactionId	String	The transaction ID associated with the Chargent Order to refund.
amount	Double	The amount to refund to the Chargent Order. Input lesser value than the charge amount for a partial refund, and up to the full charge amount for a full refund.

RefundOutput Properties

Property	Type	Description
status	Boolean	Success or failure status for the payment refund action.
message	String	The detailed message for the result of the payment refund action.
transactionId	String	The transaction ID associated with refund to the Chargent Order.

Learn More

Learn more about Payment Refunds.