All Implemented Interfaces:


public interface CardService

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`CardService.WithRawResponse`	A view of CardService that provides access to raw HTTP responses for each method.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract CardService.WithRawResponse`	`withRawResponse()`	Returns a view of this service that provides access to raw HTTP responses for each method.
`abstract CardService`	`withOptions(Consumer<ClientOptions.Builder> modifier)`	Returns a view of this service with the given option modifications applied.
`abstract AggregateBalanceService`	`aggregateBalances()`
`abstract BalanceService`	`balances()`
`abstract FinancialTransactionService`	`financialTransactions()`
`Card`	`create(CardCreateParams params)`	Create a new virtual or physical card.
`abstract Card`	`create(CardCreateParams params, RequestOptions requestOptions)`
`Card`	`retrieve(String cardToken)`	Get card configuration such as spend limit and state.
`Card`	`retrieve(String cardToken, CardRetrieveParams params, RequestOptions requestOptions)`
`Card`	`retrieve(String cardToken, CardRetrieveParams params)`
`abstract Card`	`retrieve(CardRetrieveParams params, RequestOptions requestOptions)`
`Card`	`retrieve(CardRetrieveParams params)`
`Card`	`retrieve(String cardToken, RequestOptions requestOptions)`
`Card`	`update(String cardToken)`	Update the specified properties of the card.
`Card`	`update(String cardToken, CardUpdateParams params, RequestOptions requestOptions)`
`Card`	`update(String cardToken, CardUpdateParams params)`
`abstract Card`	`update(CardUpdateParams params, RequestOptions requestOptions)`
`Card`	`update(CardUpdateParams params)`
`Card`	`update(String cardToken, RequestOptions requestOptions)`
`CardListPage`	`list()`	List cards.
`abstract CardListPage`	`list(CardListParams params, RequestOptions requestOptions)`
`CardListPage`	`list(CardListParams params)`
`CardListPage`	`list(RequestOptions requestOptions)`
`Card`	`convertPhysical(String cardToken, CardConvertPhysicalParams params)`	Convert a virtual card into a physical card and manufacture it.
`Card`	`convertPhysical(String cardToken, CardConvertPhysicalParams params, RequestOptions requestOptions)`
`Card`	`convertPhysical(CardConvertPhysicalParams params)`
`abstract Card`	`convertPhysical(CardConvertPhysicalParams params, RequestOptions requestOptions)`
`String`	`embed(CardEmbedParams params)`	Handling full card PANs and CVV codes requires that you comply with the Payment Card Industry Data Security Standards (PCI DSS).
`abstract String`	`embed(CardEmbedParams params, RequestOptions requestOptions)`
`CardProvisionResponse`	`provision(String cardToken)`	Allow your cardholders to directly add payment cards to the device's digital wallet (e.g.
`CardProvisionResponse`	`provision(String cardToken, CardProvisionParams params, RequestOptions requestOptions)`
`CardProvisionResponse`	`provision(String cardToken, CardProvisionParams params)`
`abstract CardProvisionResponse`	`provision(CardProvisionParams params, RequestOptions requestOptions)`
`CardProvisionResponse`	`provision(CardProvisionParams params)`
`CardProvisionResponse`	`provision(String cardToken, RequestOptions requestOptions)`
`Card`	`reissue(String cardToken)`	Initiate print and shipment of a duplicate physical card (e.g.
`Card`	`reissue(String cardToken, CardReissueParams params, RequestOptions requestOptions)`
`Card`	`reissue(String cardToken, CardReissueParams params)`
`abstract Card`	`reissue(CardReissueParams params, RequestOptions requestOptions)`
`Card`	`reissue(CardReissueParams params)`
`Card`	`reissue(String cardToken, RequestOptions requestOptions)`
`Card`	`renew(String cardToken, CardRenewParams params)`	Applies to card types `PHYSICAL` and `VIRTUAL`.
`Card`	`renew(String cardToken, CardRenewParams params, RequestOptions requestOptions)`
`Card`	`renew(CardRenewParams params)`
`abstract Card`	`renew(CardRenewParams params, RequestOptions requestOptions)`
`CardSpendLimits`	`retrieveSpendLimits(String cardToken)`	Get a Card's available spend limit, which is based on the spend limit configured on the Card and the amount already spent over the spend limit's duration.
`CardSpendLimits`	`retrieveSpendLimits(String cardToken, CardRetrieveSpendLimitsParams params, RequestOptions requestOptions)`
`CardSpendLimits`	`retrieveSpendLimits(String cardToken, CardRetrieveSpendLimitsParams params)`
`abstract CardSpendLimits`	`retrieveSpendLimits(CardRetrieveSpendLimitsParams params, RequestOptions requestOptions)`
`CardSpendLimits`	`retrieveSpendLimits(CardRetrieveSpendLimitsParams params)`
`CardSpendLimits`	`retrieveSpendLimits(String cardToken, RequestOptions requestOptions)`
`Card`	`searchByPan(CardSearchByPanParams params)`	Get card configuration such as spend limit and state.
`abstract Card`	`searchByPan(CardSearchByPanParams params, RequestOptions requestOptions)`
`CardWebProvisionResponse`	`webProvision(String cardToken)`	Allow your cardholders to directly add payment cards to the device's digital wallet from a browser on the web.
`CardWebProvisionResponse`	`webProvision(String cardToken, CardWebProvisionParams params, RequestOptions requestOptions)`
`CardWebProvisionResponse`	`webProvision(String cardToken, CardWebProvisionParams params)`
`abstract CardWebProvisionResponse`	`webProvision(CardWebProvisionParams params, RequestOptions requestOptions)`
`CardWebProvisionResponse`	`webProvision(CardWebProvisionParams params)`
`CardWebProvisionResponse`	`webProvision(String cardToken, RequestOptions requestOptions)`
`abstract String`	`getEmbedHtml(CardGetEmbedHtmlParams params, RequestOptions requestOptions)`
`abstract String`	`getEmbedUrl(CardGetEmbedUrlParams params, RequestOptions requestOptions)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - withRawResponse
```
 abstract CardService.WithRawResponse withRawResponse()
```
    Returns a view of this service that provides access to raw HTTP responses for each method.
  - withOptions
```
 abstract CardService withOptions(Consumer<ClientOptions.Builder> modifier)
```
    Returns a view of this service with the given option modifications applied.
    The original service is not modified.
  - aggregateBalances
```
 abstract AggregateBalanceService aggregateBalances()
```
  - balances
```
 abstract BalanceService balances()
```
  - financialTransactions
```
 abstract FinancialTransactionService financialTransactions()
```
  - create
```
 Card create(CardCreateParams params)
```
    Create a new virtual or physical card. Parameters shipping_address and product_id only apply to physical cards.
  - create
```
 abstract Card create(CardCreateParams params, RequestOptions requestOptions)
```
  - retrieve
```
 Card retrieve(String cardToken)
```
    Get card configuration such as spend limit and state.
  - retrieve
```
 Card retrieve(String cardToken, CardRetrieveParams params, RequestOptions requestOptions)
```
  - retrieve
```
 Card retrieve(String cardToken, CardRetrieveParams params)
```
  - retrieve
```
 abstract Card retrieve(CardRetrieveParams params, RequestOptions requestOptions)
```
  - retrieve
```
 Card retrieve(CardRetrieveParams params)
```
  - retrieve
```
 Card retrieve(String cardToken, RequestOptions requestOptions)
```
  - update
```
 Card update(String cardToken)
```
    Update the specified properties of the card. Unsupplied properties will remain unchanged.
    Note: setting a card to a CLOSED state is a final action that cannot be undone.
  - update
```
 Card update(String cardToken, CardUpdateParams params, RequestOptions requestOptions)
```
  - update
```
 Card update(String cardToken, CardUpdateParams params)
```
  - update
```
 abstract Card update(CardUpdateParams params, RequestOptions requestOptions)
```
  - update
```
 Card update(CardUpdateParams params)
```
  - update
```
 Card update(String cardToken, RequestOptions requestOptions)
```
  - list
```
 CardListPage list()
```
    List cards.
  - list
```
 abstract CardListPage list(CardListParams params, RequestOptions requestOptions)
```
  - list
```
 CardListPage list(CardListParams params)
```
  - list
```
 CardListPage list(RequestOptions requestOptions)
```
  - convertPhysical
```
 Card convertPhysical(String cardToken, CardConvertPhysicalParams params)
```
    Convert a virtual card into a physical card and manufacture it. Customer must supply relevant fields for physical card creation including product_id, carrier, shipping_method, and shipping_address. The card token will be unchanged. The card's type will be altered to PHYSICAL. The card will be set to state PENDING_FULFILLMENT and fulfilled at next fulfillment cycle. Virtual cards created on card programs which do not support physical cards cannot be converted. The card program cannot be changed as part of the conversion. Cards must be in an OPEN state to be converted. Only applies to cards of type VIRTUAL (or existing cards with deprecated types of DIGITAL_WALLET and UNLOCKED).
  - convertPhysical
```
 Card convertPhysical(String cardToken, CardConvertPhysicalParams params, RequestOptions requestOptions)
```
  - convertPhysical
```
 Card convertPhysical(CardConvertPhysicalParams params)
```
  - convertPhysical
```
 abstract Card convertPhysical(CardConvertPhysicalParams params, RequestOptions requestOptions)
```
  - embed
```
 String embed(CardEmbedParams params)
```
    Handling full card PANs and CVV codes requires that you comply with the Payment Card Industry Data Security Standards (PCI DSS). Some clients choose to reduce their compliance obligations by leveraging our embedded card UI solution documented below.
    In this setup, PANs and CVV codes are presented to the end-user via a card UI that we provide, optionally styled in the customer's branding using a specified css stylesheet. A user's browser makes the request directly to api.lithic.com, so card PANs and CVVs never touch the API customer's servers while full card data is displayed to their end-users. The response contains an HTML document (see Embedded Card UI or Changelog for upcoming changes in January). This means that the url for the request can be inserted straight into the src attribute of an iframe.
    <iframe id="card-iframe" src="https://sandbox.lithic.com/v1/embed/card?embed_request=eyJjc3MiO...;hmac=r8tx1..." allow="clipboard-write" class="content"></iframe>
    You should compute the request payload on the server side. You can render it (or the whole iframe) on the server or make an ajax call from your front end code, but do not ever embed your API key into front end code, as doing so introduces a serious security vulnerability.
  - embed
```
 abstract String embed(CardEmbedParams params, RequestOptions requestOptions)
```
  - provision
```
 CardProvisionResponse provision(String cardToken)
```
    Allow your cardholders to directly add payment cards to the device's digital wallet (e.g. Apple Pay) with one touch from your app.
    This requires some additional setup and configuration. Please Contact Us or your Customer Success representative for more information.
  - provision
```
 CardProvisionResponse provision(String cardToken, CardProvisionParams params, RequestOptions requestOptions)
```
  - provision
```
 CardProvisionResponse provision(String cardToken, CardProvisionParams params)
```
  - provision
```
 abstract CardProvisionResponse provision(CardProvisionParams params, RequestOptions requestOptions)
```
  - provision
```
 CardProvisionResponse provision(CardProvisionParams params)
```
  - provision
```
 CardProvisionResponse provision(String cardToken, RequestOptions requestOptions)
```
  - reissue
```
 Card reissue(String cardToken)
```
    Initiate print and shipment of a duplicate physical card (e.g. card is physically damaged). The PAN, expiry, and CVC2 will remain the same and the original card can continue to be used until the new card is activated. Only applies to cards of type PHYSICAL. A card can be reissued or renewed a total of 8 times.
  - reissue
```
 Card reissue(String cardToken, CardReissueParams params, RequestOptions requestOptions)
```
  - reissue
```
 Card reissue(String cardToken, CardReissueParams params)
```
  - reissue
```
 abstract Card reissue(CardReissueParams params, RequestOptions requestOptions)
```
  - reissue
```
 Card reissue(CardReissueParams params)
```
  - reissue
```
 Card reissue(String cardToken, RequestOptions requestOptions)
```
  - renew
```
 Card renew(String cardToken, CardRenewParams params)
```
    Applies to card types PHYSICAL and VIRTUAL. For PHYSICAL, creates a new card with the same card token and PAN, but updated expiry and CVC2 code. The original card will keep working for card-present transactions until the new card is activated. For card-not-present transactions, the original card details (expiry, CVC2) will also keep working until the new card is activated. A PHYSICAL card can be reissued or renewed a total of 8 times. For VIRTUAL, the card will retain the same card token and PAN and receive an updated expiry and CVC2 code. product_id, shipping_method, shipping_address, carrier are only relevant for renewing PHYSICAL cards.
  - renew
```
 Card renew(String cardToken, CardRenewParams params, RequestOptions requestOptions)
```
  - renew
```
 Card renew(CardRenewParams params)
```
  - renew
```
 abstract Card renew(CardRenewParams params, RequestOptions requestOptions)
```
  - retrieveSpendLimits
```
 CardSpendLimits retrieveSpendLimits(String cardToken)
```
    Get a Card's available spend limit, which is based on the spend limit configured on the Card and the amount already spent over the spend limit's duration. For example, if the Card has a monthly spend limit of
    $1000 configured, and has spent $
    600 in the last month, the available spend limit returned would be $400.
  - retrieveSpendLimits
```
 CardSpendLimits retrieveSpendLimits(String cardToken, CardRetrieveSpendLimitsParams params, RequestOptions requestOptions)
```
  - retrieveSpendLimits
```
 CardSpendLimits retrieveSpendLimits(String cardToken, CardRetrieveSpendLimitsParams params)
```
  - retrieveSpendLimits
```
 abstract CardSpendLimits retrieveSpendLimits(CardRetrieveSpendLimitsParams params, RequestOptions requestOptions)
```
  - retrieveSpendLimits
```
 CardSpendLimits retrieveSpendLimits(CardRetrieveSpendLimitsParams params)
```
  - retrieveSpendLimits
```
 CardSpendLimits retrieveSpendLimits(String cardToken, RequestOptions requestOptions)
```
  - searchByPan
```
 Card searchByPan(CardSearchByPanParams params)
```
    Get card configuration such as spend limit and state. Customers must be PCI compliant to use this endpoint. Please contact [email protected] for questions. Note: this is a POST endpoint because it is more secure to send sensitive data in a request body than in a URL.
  - searchByPan
```
 abstract Card searchByPan(CardSearchByPanParams params, RequestOptions requestOptions)
```
  - webProvision
```
 CardWebProvisionResponse webProvision(String cardToken)
```
    Allow your cardholders to directly add payment cards to the device's digital wallet from a browser on the web. Currently only suported for Apple Pay.
    This requires some additional setup and configuration. Please Contact Us or your Customer Success representative for more information.
  - webProvision
```
 CardWebProvisionResponse webProvision(String cardToken, CardWebProvisionParams params, RequestOptions requestOptions)
```
  - webProvision
```
 CardWebProvisionResponse webProvision(String cardToken, CardWebProvisionParams params)
```
  - webProvision
```
 abstract CardWebProvisionResponse webProvision(CardWebProvisionParams params, RequestOptions requestOptions)
```
  - webProvision
```
 CardWebProvisionResponse webProvision(CardWebProvisionParams params)
```
  - webProvision
```
 CardWebProvisionResponse webProvision(String cardToken, RequestOptions requestOptions)
```
  - getEmbedHtml
```
 abstract String getEmbedHtml(CardGetEmbedHtmlParams params, RequestOptions requestOptions)
```
  - getEmbedUrl
```
 abstract String getEmbedUrl(CardGetEmbedUrlParams params, RequestOptions requestOptions)
```

Interface CardService

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

withRawResponse

withOptions

aggregateBalances

balances

financialTransactions

create

create

retrieve

retrieve

retrieve

retrieve

retrieve

retrieve

update

update

update

update

update

update

list

list

list

list

convertPhysical

convertPhysical

convertPhysical

convertPhysical

embed

embed

provision

provision

provision

provision

provision

provision

reissue

reissue

reissue

reissue

reissue

reissue

renew

renew

renew

renew

retrieveSpendLimits

retrieveSpendLimits

retrieveSpendLimits

retrieveSpendLimits

retrieveSpendLimits

retrieveSpendLimits

searchByPan

searchByPan

webProvision

webProvision

webProvision

webProvision

webProvision

webProvision

getEmbedHtml

getEmbedUrl