Skip to main content

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 TransactionTransactions 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.

TypeDefinition
Full RefundInput up to the full charge amount to perform a full refund.
Partial RefundInput a lesser value than the charge amount to perform a partial refund

Create Payment Refund

Flow Action

Action NameLabelCategory
apex-ChargentBase_FlowPaymentsRefundsChargent Payments RefundsChargent Payments

Flow Method

Method NameInputInput TypeOutputOutput Type
refund()RefundInputList<RefundInput>RefundOutputList<RefundOutput>

RefundInput Properties

PropertyTypeDescription
transactionIdStringThe transaction ID associated with the Chargent Order to refund.
amountDoubleThe 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

PropertyTypeDescription
statusBooleanSuccess or failure status for the payment refund action.
messageStringThe detailed message for the result of the payment refund action.
transactionIdStringThe transaction ID associated with refund to the Chargent Order.

Learn More

Learn more about Payment Refunds.