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.

• 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(CardRetrieveParams params)

  Get card configuration such as spend limit and state.

• retrieve

   abstract Card retrieve(CardRetrieveParams params, RequestOptions requestOptions)

• update

   Card update(CardUpdateParams params)

  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

   abstract Card update(CardUpdateParams params, 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(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

   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(CardProvisionParams params)

  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

   abstract CardProvisionResponse provision(CardProvisionParams params, RequestOptions requestOptions)

• reissue

   Card reissue(CardReissueParams params)

  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 replaced or renewed a total of 8 times.

• reissue

   abstract Card reissue(CardReissueParams params, RequestOptions requestOptions)

• renew

   Card renew(CardRenewParams params)

  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. Applies to card types PHYSICAL and VIRTUAL. A card can be replaced or renewed a total of 8 times.

• renew

   abstract Card renew(CardRenewParams params, RequestOptions requestOptions)

• retrieveSpendLimits

   CardSpendLimits retrieveSpendLimits(CardRetrieveSpendLimitsParams params)

  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

   abstract CardSpendLimits retrieveSpendLimits(CardRetrieveSpendLimitsParams params, 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)

• getEmbedHtml

   abstract String getEmbedHtml(CardGetEmbedHtmlParams params, RequestOptions requestOptions)

• getEmbedUrl

   abstract String getEmbedUrl(CardGetEmbedUrlParams params, RequestOptions requestOptions)