com.mangopay.core.APIs.implementation

Class CardApiImpl

java.lang.Object

com.mangopay.core.APIs.ApiBase

com.mangopay.core.APIs.implementation.CardApiImpl

All Implemented Interfaces:

CardApi

public class CardApiImpl
extends ApiBase
implements CardApi

API for cards.

Field Summary

Fields inherited from class com.mangopay.core.APIs.ApiBase

root

Constructor Summary

Constructors

Constructor and Description
CardApiImpl(MangoPayApi root) Instantiates new CardApiImpl object.

Method Summary

Modifier and Type	Method and Description
Card	disable(Card card) Disables card (sets { INVALID } as the value of Validity field).
Card	get(java.lang.String cardId) Gets card.
java.util.List<Card>	getByFingerprint(java.lang.String fingerprint) Gets a list of cards having the same fingerprint.
java.util.List<CardPreAuthorization>	getCardPreAuthorizations(java.lang.String cardId) Get a list of card's preAuthorizations
java.util.List<Transaction>	getTransactions(java.lang.String cardId) Get first page of card's transactions
java.util.List<Transaction>	getTransactions(java.lang.String cardId, Pagination pagination, Sorting sorting) Get page of card's transactions
Card	update(Card card) Saves card.
CardValidation	validate(java.lang.String cardId, CardValidation cardValidation) Validate a card

Methods inherited from class com.mangopay.core.APIs.ApiBase

createObject, createObject, createObject, getList, getList, getList, getList, getList, getList, getListNoClientId, getObject, getObjectNoClientId, getRequestType, getRequestUrl, getRoot, updateObject, updateObject, updateObject, updateObject

Methods inherited from class java.lang.Object

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

Constructor Detail

CardApiImpl

public CardApiImpl(MangoPayApi root)

Instantiates new CardApiImpl object.

Parameters:

root - Root/parent instance that holds the OAuthToken and Configuration instance

Method Detail

get

public Card get(java.lang.String cardId)
         throws java.lang.Exception

Description copied from interface: CardApi

Gets card.

Specified by:

get in interface CardApi

Parameters:

cardId - Card identifier.

Returns:

Card instance returned from API.

Throws:

java.lang.Exception

getByFingerprint

public java.util.List<Card> getByFingerprint(java.lang.String fingerprint)
                                      throws java.lang.Exception

Description copied from interface: CardApi

Gets a list of cards having the same fingerprint. The fingerprint is a hash uniquely generated per 16-digit card number.

Specified by:

getByFingerprint in interface CardApi

Parameters:

fingerprint - The fingerprint hash

Returns:

List of Cards corresponding to provided fingerprint

Throws:

java.lang.Exception

update

public Card update(Card card)
            throws java.lang.Exception

Description copied from interface: CardApi

Saves card.

Specified by:

update in interface CardApi

Parameters:

card - Card entity instance to be updated.

Returns:

Card object returned from API.

Throws:

java.lang.Exception

disable

public Card disable(Card card)
             throws java.lang.Exception

Description copied from interface: CardApi

Disables card (sets { INVALID } as the value of Validity field).

Specified by:

disable in interface CardApi

Parameters:

card - Card entity instance to be updated.

Returns:

Card object returned from API.

Throws:

java.lang.Exception

getTransactions

public java.util.List<Transaction> getTransactions(java.lang.String cardId)
                                            throws java.lang.Exception

Description copied from interface: CardApi

Get first page of card's transactions

Specified by:

getTransactions in interface CardApi

Parameters:

cardId - Card identifier

Returns:

Collection of transactions

Throws:

java.lang.Exception

getTransactions

public java.util.List<Transaction> getTransactions(java.lang.String cardId,
                                                   Pagination pagination,
                                                   Sorting sorting)
                                            throws java.lang.Exception

Description copied from interface: CardApi

Get page of card's transactions

Specified by:

getTransactions in interface CardApi

Returns:

Throws:

java.lang.Exception

getCardPreAuthorizations

public java.util.List<CardPreAuthorization> getCardPreAuthorizations(java.lang.String cardId)
                                                              throws java.lang.Exception

Description copied from interface: CardApi

Get a list of card's preAuthorizations

Specified by:

getCardPreAuthorizations in interface CardApi

Parameters:

cardId - Card identifier

Returns:

List of card preAuthorizations

Throws:

java.lang.Exception

validate

public CardValidation validate(java.lang.String cardId,
                               CardValidation cardValidation)
                        throws java.lang.Exception

Description copied from interface: CardApi

Validate a card

Specified by:

validate in interface CardApi

Returns:

CardValidation

Throws:

java.lang.Exception