CardServiceImpl

Functions

Link copied to clipboard
Link copied to clipboard
open override fun balances(): BalanceService
Link copied to clipboard
open fun convertPhysical(cardToken: String, params: CardConvertPhysicalParams, requestOptions: RequestOptions = RequestOptions.none()): Card

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).

open override fun convertPhysical(params: CardConvertPhysicalParams, requestOptions: RequestOptions): Card
Link copied to clipboard
open override fun create(params: CardCreateParams, requestOptions: RequestOptions): Card

Create a new virtual or physical card. Parameters shipping_address and product_id only apply to physical cards.

Link copied to clipboard
open override fun embed(params: CardEmbedParams, requestOptions: RequestOptions): String

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.

Link copied to clipboard
Link copied to clipboard
open override fun getEmbedHtml(params: CardGetEmbedHtmlParams, requestOptions: RequestOptions): String
Link copied to clipboard
open override fun getEmbedUrl(params: CardGetEmbedUrlParams, requestOptions: RequestOptions): String
Link copied to clipboard
open fun list(requestOptions: RequestOptions): CardListPage

open override fun list(params: CardListParams, requestOptions: RequestOptions): CardListPage

List cards.

Link copied to clipboard
open fun provision(cardToken: String, requestOptions: RequestOptions): CardProvisionResponse
open override fun provision(params: CardProvisionParams, requestOptions: RequestOptions): CardProvisionResponse

open fun provision(cardToken: String, params: CardProvisionParams = CardProvisionParams.none(), requestOptions: RequestOptions = RequestOptions.none()): CardProvisionResponse

Allow your cardholders to directly add payment cards to the device's digital wallet (e.g. Apple Pay) with one touch from your app.

Link copied to clipboard
open fun reissue(cardToken: String, requestOptions: RequestOptions): Card
open override fun reissue(params: CardReissueParams, requestOptions: RequestOptions): Card

open fun reissue(cardToken: String, params: CardReissueParams = CardReissueParams.none(), requestOptions: RequestOptions = RequestOptions.none()): Card

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.

Link copied to clipboard
open fun renew(cardToken: String, params: CardRenewParams, requestOptions: RequestOptions = RequestOptions.none()): Card

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.

open override fun renew(params: CardRenewParams, requestOptions: RequestOptions): Card
Link copied to clipboard
open fun retrieve(cardToken: String, requestOptions: RequestOptions): Card
open override fun retrieve(params: CardRetrieveParams, requestOptions: RequestOptions): Card

open fun retrieve(cardToken: String, params: CardRetrieveParams = CardRetrieveParams.none(), requestOptions: RequestOptions = RequestOptions.none()): Card

Get card configuration such as spend limit and state.

Link copied to clipboard
open fun retrieveSpendLimits(cardToken: String, requestOptions: RequestOptions): CardSpendLimits

open fun retrieveSpendLimits(cardToken: String, params: CardRetrieveSpendLimitsParams = CardRetrieveSpendLimitsParams.none(), requestOptions: RequestOptions = RequestOptions.none()): CardSpendLimits

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.

Link copied to clipboard
open override fun searchByPan(params: CardSearchByPanParams, requestOptions: RequestOptions): Card

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.

Link copied to clipboard
open fun update(cardToken: String, requestOptions: RequestOptions): Card
open override fun update(params: CardUpdateParams, requestOptions: RequestOptions): Card

open fun update(cardToken: String, params: CardUpdateParams = CardUpdateParams.none(), requestOptions: RequestOptions = RequestOptions.none()): Card

Update the specified properties of the card. Unsupplied properties will remain unchanged.

Link copied to clipboard
open fun webProvision(cardToken: String, requestOptions: RequestOptions): CardWebProvisionResponse
open override fun webProvision(params: CardWebProvisionParams, requestOptions: RequestOptions): CardWebProvisionResponse

open fun webProvision(cardToken: String, params: CardWebProvisionParams = CardWebProvisionParams.none(), requestOptions: RequestOptions = RequestOptions.none()): CardWebProvisionResponse

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.

Link copied to clipboard
open override fun withOptions(modifier: (ClientOptions.Builder) -> Unit): CardService

Returns a view of this service with the given option modifications applied.

Link copied to clipboard

Returns a view of this service that provides access to raw HTTP responses for each method.