Surcharge

Description

The Surcharge object represents a surcharge applied to various transaction-related entities such as payments, invoices and sales orders.

Properties

TypeNameDescription
stringSurchargeInternalIdInternal ID automatically assigned by EBizCharge.
stringAuthCodeAuthorization code assigned by the issuing bank for the payment method.
stringRefNumReference number assigned by the gateway, returned in the runTransaction response.
stringLast4Last 4 digits of the card number or bank account.
stringPaymentMethodTypePayment method used to pay the surcharge.
stringDatePaidDate the surcharge was paid.
stringTotalSurchargeAmountTotal surcharge amount.
stringPaymentInternalIDInternal identifier for the associated Payment object (automatically assigned by EBizCharge).
stringDescriptionDescription of the surcharge.
stringSurchargePercentageSurcharge percentage amount.
stringTotalPaidAmountTotal amount paid.
stringCurrencyThree-character ISO 4217 currency code.
PaidDocument[]PaidDocumentsList of paid documents the surcharge was applied to.
booleanIsAppliedWhether the surcharge was applied.
stringDateAppliedDate the surcharge was applied.
stringSurchargeCountryIdSpecifies which country’s surcharge rules apply for the transaction. This determines whether surcharging is allowed and what regulations or limits must be followed.
stringSurchargeTypeIdSpecifies the type of surcharge being applied.
EbizCustomField[]SurchargeCustomFieldsList of custom fields.