com.cardinity

Class CardinityClient

java.lang.Object

com.cardinity.CardinityClient

public class CardinityClient
extends Object

Constructor Summary

Constructors

Constructor and Description
CardinityClient(String consumerKey, String consumerSecret) Constructs a CardinityClient object.

Method Summary

Modifier and Type	Method and Description
Result<Chargeback>	createChargeback(UUID paymentId, Chargeback chargeback) Creates a new chargeback.
Result<Payment>	createPayment(Payment payment) Creates a new payment.
Result<Refund>	createRefund(UUID paymentId, Refund refund) Refunds an approved payment.
Result<Settlement>	createSettlement(UUID paymentId, Settlement settlement) Settles an authorized payment.
Result<Void>	createVoid(UUID paymentId, Void voidP) Voids an authorized payment.
Result<Payment>	finalizePayment(UUID paymentId, String authorizeData) Finalizes a pending payment using 3D Secure V1 flow.
Result<Payment>	finalizePaymentV2(UUID paymentId, String cRes) Finalizes a pending payment using 3D Secure V2 flow.
Result<Chargeback>	getChargeback(UUID paymentId, UUID chargebackId) Finds and returns a chargeback specified by a paymentId and a chargebackId.
Result<List<Chargeback>>	getChargebacks(UUID paymentId) Returns a list of chargebacks for a specified payment.
Result<Payment>	getPayment(UUID paymentId) Finds and returns a payment specified by a paymentId.
Result<List<Payment>>	getPayments() Returns a list of last 10 payments.
Result<List<Payment>>	getPayments(int limit) Returns a list of last payments size of which is specified by a limit parameter.
Result<Refund>	getRefund(UUID paymentId, UUID refundId) Finds and returns a refund specified by a paymentId and a refundId.
Result<List<Refund>>	getRefunds(UUID paymentId) Returns a list of refunds for a specified payment.
Result<Settlement>	getSettlement(UUID paymentId, UUID settlementId) Finds and returns a settlement specified by a paymentId and a settlementId.
Result<List<Settlement>>	getSettlements(UUID paymentId) Returns a list of settlements for a specified payment.
Result<Void>	getVoid(UUID paymentId, UUID voidId) Finds and returns a void specified by a paymentId and a voidId.
Result<List<Void>>	getVoids(UUID paymentId) Returns a list of voids for a specified payment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CardinityClient

public CardinityClient(String consumerKey,
                       String consumerSecret)

Constructs a CardinityClient object.

Parameters:

consumerKey - live or testing consumer key provided by cardinity

consumerSecret - live or testing consumer secret provided by cardinity

Method Detail

createPayment

public Result<Payment> createPayment(Payment payment)

Creates a new payment.

Parameters:

payment - Payment object.

Returns:

a Result wrapper containing either a result Payment object or a CardinityError object.

Throws:

ValidationException - if payment object contains validation errors.

CardinityException - if internal client error occurs.

finalizePayment

public Result<Payment> finalizePayment(UUID paymentId,
                                       String authorizeData)

Finalizes a pending payment using 3D Secure V1 flow.

Parameters:

paymentId - id of a payment to be finalized.

authorizeData - PaRes data received from ACS server.

Returns:

a Result wrapper containing either a result Payment object or a CardinityError object.

Throws:

ValidationException - if paymentId is null or authorizeDate is empty.

CardinityException - if internal client error occurs.

finalizePaymentV2

public Result<Payment> finalizePaymentV2(UUID paymentId,
                                         String cRes)

Finalizes a pending payment using 3D Secure V2 flow.

Parameters:

paymentId - id of a payment to be finalized.

cRes - cRes parameter received from ACS server.

Returns:

a Result wrapper containing either a result Payment object or a CardinityError object.

Throws:

ValidationException - if data for payment finalization is missing.

CardinityException - if internal client error occurs.

getPayment

public Result<Payment> getPayment(UUID paymentId)

Finds and returns a payment specified by a paymentId.

Parameters:

paymentId - id of a payment to be found.

Returns:

a Result wrapper containing either a found Payment object or a CardinityError object.

Throws:

ValidationException - if paymentId is null.

CardinityException - if internal client error occurs.

getPayments

public Result<List<Payment>> getPayments()

Returns a list of last 10 payments.

Returns:

a Result wrapper containing either a list of Payment objects or a CardinityError object.

Throws:

CardinityException - if internal client error occurs.

getPayments

public Result<List<Payment>> getPayments(int limit)

Returns a list of last payments size of which is specified by a limit parameter.

Parameters:

limit - number of last payment to be returned. Value must be between 1 and 100.

Returns:

a Result wrapper containing either a list of Payment objects or a CardinityError object.

Throws:

ValidationException - if limit is less than 1 or larger than 100.

CardinityException - if internal client error occurs.

createRefund

public Result<Refund> createRefund(UUID paymentId,
                                   Refund refund)

Refunds an approved payment.

Parameters:

paymentId - id of a payment to be refunded.

refund - Refund object containing amount to be refunded.

Returns:

a Result wrapper containing either a result Refund object or a CardinityError object.

Throws:

ValidationException - if refund object contains validation errors or paymentId is null.

CardinityException - if internal client error occurs.

getRefund

public Result<Refund> getRefund(UUID paymentId,
                                UUID refundId)

Finds and returns a refund specified by a paymentId and a refundId.

Parameters:

paymentId - id of payment which was refunded.

refundId - id of a refund to be found.

Returns:

a Result wrapper containing either a found Refund object or a CardinityError object.

Throws:

ValidationException - if paymentId or refundId are null.

CardinityException - if internal client error occurs.

getRefunds

public Result<List<Refund>> getRefunds(UUID paymentId)

Returns a list of refunds for a specified payment.

Parameters:

paymentId - id of a payment refunds of which will be returned.

Returns:

a Result wrapper containing a list of Refund objects or a CardinityError object.

Throws:

ValidationException - if paymentId is null.

CardinityException - if internal client error occurs.

createSettlement

public Result<Settlement> createSettlement(UUID paymentId,
                                           Settlement settlement)

Settles an authorized payment.

Parameters:

paymentId - id of a payment to be settled.

settlement - Settlement object containing amount to be settled.

Returns:

a Result wrapper containing either a result Settlement object or a CardinityError object.

Throws:

ValidationException - if settlement object contains validation errors or paymentId is null.

CardinityException - if internal client error occurs.

getSettlement

public Result<Settlement> getSettlement(UUID paymentId,
                                        UUID settlementId)

Finds and returns a settlement specified by a paymentId and a settlementId.

Parameters:

paymentId - id of a payment which was settled.

settlementId - id of settlement to be found.

Returns:

a Result wrapper containing either a found Settlement object or a CardinityError object.

Throws:

ValidationException - if paymentId or settlementId are null.

CardinityException - if internal client error occurs.

getSettlements

public Result<List<Settlement>> getSettlements(UUID paymentId)

Returns a list of settlements for a specified payment.

Parameters:

paymentId - id of a payment settlements of which will be returned.

Returns:

a Result wrapper containing a list of Settlement objects or a CardinityError object.

Throws:

ValidationException - if paymentId is null.

CardinityException - if internal client error occurs.

createVoid

public Result<Void> createVoid(UUID paymentId,
                               Void voidP)

Voids an authorized payment.

Parameters:

paymentId - id of a payment to be voided.

voidP - Void object.

Returns:

a Result wrapper containing either a result Void object or a CardinityError object.

Throws:

ValidationException - if void object contains validation errors or paymentId is null.

CardinityException - if internal client error occurs.

getVoid

public Result<Void> getVoid(UUID paymentId,
                            UUID voidId)

Finds and returns a void specified by a paymentId and a voidId.

Parameters:

paymentId - id of a payment which was voided.

voidId - id of a void to be found.

Returns:

a Result wrapper containing either a found Void object or a CardinityError object.

Throws:

ValidationException - if paymentId or voidId are null.

CardinityException - if internal client error occurs.

getVoids

public Result<List<Void>> getVoids(UUID paymentId)

Returns a list of voids for a specified payment.

Parameters:

paymentId - id of a payment voids of which will be returned.

Returns:

a Result wrapper containing a list of Void objects or a CardinityError object.

Throws:

ValidationException - if paymentId is null.

CardinityException - if internal client error occurs.

createChargeback

public Result<Chargeback> createChargeback(UUID paymentId,
                                           Chargeback chargeback)

Creates a new chargeback.

Parameters:

paymentId - id of a payment to be chargebacked.

chargeback - Chargeback object.

Returns:

a Result wrapper containing either a result Chargeback object or a CardinityError object.

Throws:

ValidationException - if chargeback object contains validation errors or paymentId is null.

CardinityException - if internal client error occurs.

getChargeback

public Result<Chargeback> getChargeback(UUID paymentId,
                                        UUID chargebackId)

Finds and returns a chargeback specified by a paymentId and a chargebackId.

Parameters:

paymentId - id of payment which was chargebacked.

chargebackId - id of a chargeback to be found.

Returns:

a Result wrapper containing either a found Chargeback object or a CardinityError object.

Throws:

ValidationException - if paymentId or chargebackId are null.

CardinityException - if internal client error occurs.

getChargebacks

public Result<List<Chargeback>> getChargebacks(UUID paymentId)

Returns a list of chargebacks for a specified payment.

Parameters:

paymentId - id of a payment chargebacks of which will be returned.

Returns:

a Result wrapper containing a list of Chargeback objects or a CardinityError object.

Throws:

ValidationException - if paymentId is null.

CardinityException - if internal client error occurs.