alt

Important information

Please be advised that there will be a scheduled downtime across our API network on November 05 and November 07, 2024. For more information, visit our platform status portal.:
- Scheduled maintenance on November 5, 2024
- Scheduled maintenance on November 7, 2024

Unzer

Additional transaction data

Additional transaction data is used for passing extra data required for a transaction.

Transactions could contain additionalTransactionData, in general these can be added to a Charge or Authorization transaction using the setAdditionalTransactionData() method when needed.

FieldDescription
cardCard transaction data
shippingShipping transaction data
riskDataRisk transaction data
paypalPaypal transaction data

Card transaction data

Java-SDK provides method for setting card data AdditionalTransactionData::setCard(CardTransactionData)

FieldDescriptionValues
recurrenceTypeRecurrence type used for recurring payment. See more at Scheduled paymentsRecurrenceType.SCHEDULED, RecurrenceType.UNSCHEDULED, RecurrenceType.ONECLICK
exemptionTypeExemption type used for low-value payment transactions. See more at Low-Value PaymentsExemptionType.LVP
liability
  read-only
Liability shift indicator. See more at Liability shiftLiability.MERCHANT, Liability.ISSUER
class AdditionalTransactionDataExample {
    void cardDataExample() {
        Authorize authorize = new Authorize();

        CardTransactionData cardData = new CardTransactionData()
                .setExemptionType(CardTransactionData.LVP)
                .setRecurrenceType(RecurrenceType.SCHEDULED);

        AdditionalTransactionData additionalTransactionData = new AdditionalTransactionData();
        additionalTransactionData.setCard(cardData);

        authorize.setAdditionalTransactionData(additionalTransactionData);
    }
}

Shipping transaction data

Java-SDK provides method for setting shipping data AdditionalTransactionData::setShipping(ShippingTransactionData)

FieldDescription
deliveryTrackingIdTracking ID from shipping from merchant to customer.
deliveryServiceDelivery service from shipment from merchant to customer.
returnTrackingIdTracking ID from shipping from merchant to customer
class AdditionalTransactionDataExample {
    void shippingDataExample() {
        Authorize authorize = new Authorize();

        ShippingTransactionData shippingData = new ShippingTransactionData()
                .setDeliveryTrackingId("random-id")
                .setDeliveryService("random-id")
                .setReturnTrackingId("random-id");

        AdditionalTransactionData additionalTransactionData = new AdditionalTransactionData();
        additionalTransactionData.setShipping(shippingData);

        authorize.setAdditionalTransactionData(additionalTransactionData);
    }
}

Risk transaction data

Java-SDK provides method for setting shipping data AdditionalTransactionData::setRiskData(RiskTransactionData). See more Provide the customer risk information

FieldDescriptionValues
threatMetrixIdThe ThreatMetrix session IDAny String
customerGroupCustomer classification for the customer.CustomerGroup.TOP, CustomerGroup.GOOD, CustomerGroup.NEUTRAL, CustomerGroup.BAD
registrationLevelCustomer registration levelRegistrationLevel.GUEST, RegistrationLevel.REGISTERED
registrationDateCustomer registration date in your shopAny java.util.Date
customerIdCustomer IDUnzer-format ID String: "s-cst-..."
confirmedOrdersThe number of successful transactions paid by the end customerPositive integer: 10
confirmedAmountThe amount/value of the successful transactions paid by the end customerDouble: 891.12
class AdditionalTransactionDataExample {
    void riskDataExample() {
        Authorize authorize = new Authorize();

        RiskTransactionData riskData = new RiskTransactionData()
                .setConfirmedAmount(2569.0)
                .setConfirmedOrders(14)
                .setRegistrationLevel(RiskData.RegistrationLevel.REGISTERED)
                .setCustomerGroup(RiskData.CustomerGroup.GOOD)
                .setRegistrationDate(new Date());

        AdditionalTransactionData additionalTransactionData = new AdditionalTransactionData();
        additionalTransactionData.setRiskData(riskData);

        authorize.setAdditionalTransactionData(additionalTransactionData);
    }
}

Paypal transaction data

Java-SDK provides method for setting Paypal data AdditionalTransactionData::setPaypal(PaypalData).

FieldDescriptionValues
checkoutTypeCheckout type for Paypal transaction. See more: Paypal ExpressCheckoutType.EXPRESS
class AdditionalTransactionDataExample {
    void paypalDataExample() {
        Authorize authorize = new Authorize();

        PaypalData paypalData = new PaypalData()
                .setCheckoutType(CheckoutType.EXPRESS);

        AdditionalTransactionData additionalTransactionData = new AdditionalTransactionData();
        additionalTransactionData.setPaypal(paypalData);

        authorize.setAdditionalTransactionData(additionalTransactionData);
    }
}