Cancel a single funding source identified by id.
The identifier of the funding source to cancel.
The funding source that was cancelled.
FundingSourceNotFoundError No funding source matching the specified ID could be found.
Cancel a virtual card.
Parameters used to cancel a virtual card.
The identifier of the card that was just cancelled.
CardNotFoundError No virtual card matching the ID specified could be found
Complete provisioning of a funding source.
Parameters used to complete the funding source.
The funding source to be provisioned.
DuplicateFundingSourceError User already has an active funding source matching the funding source being created.
FundingSourceCompletionDataInvalidError Completion data provided does not match provisional funding source specified.
IdentityVerificationNotVerifiedError Identity information associated with funding source does not sufficiently match identity information provided during identity verification.
ProvisionalFundingSourceNotFoundError No provisional funding source with the ID specified could be found.
UnacceptableFundingSourceError The funding source provided is not acceptable for use to fund virtual card transactions.
FundingSourceRequiresUserInteractionError The funding source requires additional user interaction for provisioning can complete. The error's provisioningData property contains provider specific data to be used in this process.
Create key pair and secret key for use by the Virtual Cards Client if they have not already been created.
The key pair is used to register a public key with the service for the encryption of virtual card and transaction details.
The secret key is used for client side encryption of user specific card metadata.
Get a funding source identified by id.
Parameters used to retrieve a funding source.
The funding source identified by id or undefined if the funding source cannot be found.
FundingSourceNotFoundError No funding source matching the specified ID could be found.
The configuration of the client funding source data.
Use getVirtualCardsConfig instead to retrieve the FundingSourceClientConfiguration.
Get the funding source client configuration.
Get a provisional card.
Parameters used to get a provisional card.
The card that is being queried, or undefined if not found.
Get a transaction.
Parameters used to get a transaction.
The transaction that is being queried, or undefined if not found.
Get a virtual card.
Parameters used to get a virtual card.
The card that is being queried, or undefined if not found.
Get the configuration data for the virtual cards service.
The configuration data for the virtual cards service.
Get a list of all created funding sources for the signed in user.
Optional input: ListFundingSourcesInputParameters used to retrieve a list of created funding sources.
An array of funding sources or an empty array if no matching funding sources can be found.
List provisional cards.
Parameters used to list provisional cards.
Result of the provisional card list.
List all of a user's transactions.
Parameters used for listing transactions for a user.
Results of the transaction list.
List transactions for a virtual card.
Parameters used for listing a virtual card's transactions.
Results of the transaction list.
List transactions for a virtual card and transaction type.
Parameters used for listing a virtual card's transactions.
Results of the transaction list.
List virtual cards.
Parameters used to list virtual cards.
Result of the virtual card list.
Provision a virtual card.
Parameters used to provision a virtual card.
The card that is being provisioned. Please poll the card via the list methods to access the card.
FundingSourceNotFoundError No funding source matching the specified ID could be found.
FundingSourceNotActiveError The funding source matching the specified ID is not active.
InsufficientEntitlementsError User has insufficient entitlements to setup a new virtual card.
VelocityExceededError Configured maximum rate of attempts to add a virtual card has been exceeded. Wait before retrying.
Refresh a funding source.
Parameters used to refresh the funding source.
The funding source which has been refreshed.
FundingSourceNotFoundError No funding source with the ID specified could be found.
FundingSourceStateError Funding source cannot be refreshed as it is in an invalid state.
UnacceptableFundingSourceError Funding source cannot be refreshed as the provider has prevented it.
FundingSourceRequiresUserInteractionError The funding source requires additional user interaction before refresh can complete. The error's interactionData property contains provider specific data to be used in this process.
Request a review of an unfunded funding source, identified by id. Note that reviewing a funding source which is not unfunded will be a no-op but is not an error.
The identifier of the funding source to review.
The funding source that was reviewed.
FundingSourceNotFoundError No funding source matching the specified ID could be found.
Sandbox API to obtain data normally returned by full Plaid Link flow. Useful for testing ahead of full Plaid Link integration during application development.
Sandbox Plaid data for provisioning new funding source at requested institution and user
Sandbox API to set a funding source to refresh state to facilitate testing
The funding source in refresh state
Initiate provisioning of a new funding source.
Parameters used to setup the provisional funding source.
The provisional funding source.
InsufficientEntitlementsError User has insufficient entitlements to setup a new funding source.
VelocityExceededError Configured maximum rate of attempts to add a funding source has been exceeded or too many failed attempts have recently been made. Wait before retrying.
Subscribe to changes to funding sources
unique identifier to differentiate subscriptions; note that specifying a duplicate subscription id will replace the previous subscription.
implementation of callback to be invoked when funding source change occurs
Update a virtual card.
Parameters used to update a virtual card.
The virtual card that was updated.
CardNotFoundError No virtual card matching the ID specified could be found
CardStateError Card not in ISSUED state. It must be in ISSUED state in order to update.
Generated using TypeDoc
Sudo Platform Virtual Cards client API
All methods should be expected to be able to throw the following errors defined in
@sudoplatform/sudo-common:Throws
NotSignedInError User not signed in. Sign in before performing the operation.
Throws
AccountLockedError Account has been locked. Contact support.
Throws
ServiceError Transient error at the service. Try the operation again