Class PaymentRefundParams
-
- All Implemented Interfaces:
-
com.bennyapi.core.Params
public final class PaymentRefundParams implements Params
Allows a payment to be fully or partially refunded based on the refund intent parameters. A refunded payment will appear on a customer's EBT account.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classPaymentRefundParams.BuilderA builder for PaymentRefundParams.
public final classPaymentRefundParams.Bodypublic final classPaymentRefundParams.PaymentType
-
Method Summary
Modifier and Type Method Description final Optional<String>idempotencyKey()final Longamount()final StringpaymentMethodId()final PaymentRefundParams.PaymentTypepaymentType()final Optional<String>orderId()final Optional<String>paymentIntentId()final JsonField<Long>_amount()Returns the raw JSON value of amount. final JsonField<String>_paymentMethodId()Returns the raw JSON value of paymentMethodId. final JsonField<PaymentRefundParams.PaymentType>_paymentType()Returns the raw JSON value of paymentType. final JsonField<String>_orderId()Returns the raw JSON value of orderId. final JsonField<String>_paymentIntentId()Returns the raw JSON value of paymentIntentId. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final PaymentRefundParams.BuildertoBuilder()final PaymentRefundParams.Body_body()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static PaymentRefundParams.Builderbuilder()Returns a mutable builder for constructing an instance of PaymentRefundParams. -
-
Method Detail
-
idempotencyKey
final Optional<String> idempotencyKey()
-
paymentMethodId
final String paymentMethodId()
-
paymentType
final PaymentRefundParams.PaymentType paymentType()
-
paymentIntentId
final Optional<String> paymentIntentId()
-
_amount
final JsonField<Long> _amount()
Returns the raw JSON value of amount.
Unlike amount, this method doesn't throw if the JSON field has an unexpected type.
-
_paymentMethodId
final JsonField<String> _paymentMethodId()
Returns the raw JSON value of paymentMethodId.
Unlike paymentMethodId, this method doesn't throw if the JSON field has an unexpected type.
-
_paymentType
final JsonField<PaymentRefundParams.PaymentType> _paymentType()
Returns the raw JSON value of paymentType.
Unlike paymentType, this method doesn't throw if the JSON field has an unexpected type.
-
_orderId
final JsonField<String> _orderId()
Returns the raw JSON value of orderId.
Unlike orderId, this method doesn't throw if the JSON field has an unexpected type.
-
_paymentIntentId
final JsonField<String> _paymentIntentId()
Returns the raw JSON value of paymentIntentId.
Unlike paymentIntentId, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final PaymentRefundParams.Builder toBuilder()
-
_body
final PaymentRefundParams.Body _body()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static PaymentRefundParams.Builder builder()
Returns a mutable builder for constructing an instance of PaymentRefundParams.
The following fields are required:
.amount() .paymentMethodId() .paymentType()
-
-
-
-