com.mangopay.core.APIs

Interface CardApi

All Known Implementing Classes:

CardApiImpl

public interface CardApi

Created by thepa on 18-Jan-17.

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

Method Detail

get

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

Gets card.

Parameters:

cardId - Card identifier.

Returns:

Card instance returned from API.

Throws:

java.lang.Exception

getByFingerprint

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

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

Parameters:

fingerprint - The fingerprint hash

Returns:

List of Cards corresponding to provided fingerprint

Throws:

java.lang.Exception

update

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

Saves card.

Parameters:

card - Card entity instance to be updated.

Returns:

Card object returned from API.

Throws:

java.lang.Exception

disable

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

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

Parameters:

card - Card entity instance to be updated.

Returns:

Card object returned from API.

Throws:

java.lang.Exception

getTransactions

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

Get first page of card's transactions

Parameters:

cardId - Card identifier

Returns:

Collection of transactions

Throws:

java.lang.Exception

getTransactions

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

Get page of card's transactions

Parameters:

cardId -

pagination -

sorting -

Returns:

Throws:

java.lang.Exception

getCardPreAuthorizations

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

Get a list of card's preAuthorizations

Parameters:

cardId - Card identifier

Returns:

List of card preAuthorizations

Throws:

java.lang.Exception

validate

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

Validate a card

Parameters:

cardId, - cardValidation to be created

Returns:

CardValidation

Throws:

java.lang.Exception