API For Creating Virtual Card
Description
Create virtual card
Request URL
/open/api/card/create
Request Method
POST
Request Parameter
vid
Y
string
Card range ID
+cardHolder
N
object
Cardholder
âfirstName
Y
string
Cardholder's surname [a-zA-Z] {3,}
âlastName
Y
string
Cardholder Name [a-zA-Z] {3,}
deposit
Y
string
Recharge amount (USD), 1000 represents $10.00
orderNo
Y
string
Custom customer transaction flow ID
callbackUrl
Y
string
Callback Url
Notice:
In the system, the currency denomination follows a rule where the deposit amount for virtual card recharge (initial deposit) is represented using cents. For example, 1 means 1 cent, and 1000 represents $10.00. This rule applies to all monetary amounts in the system, including balance and consumption values.
The system allows for a single recharge amount from 5 USD to 5000 USD. This means that the minimum amount for a single recharge is 5 USD, and the maximum is 5000 USD.
The "vid" is the card range ID, which can be queried from API to fetch usable card range.
To enhance user experience, the creation of virtual cards can be performed as an asynchronous operation. After creating a virtual card, typically, the card will go through the following stages: Opening Card -> Creating Cardholder -> Creating Virtual Card -> Activating Card -> Activated
Request Example
Response Parameter
+cardHolder
object
Cardholder Information
âfirstName
string
Cardholder's surname
âlastName
string
Cardholder Name
âstreet
string
Street
âcity
string
City
âstate
string
State
âcountry
string
Country
âzipCode
string
Zipcode
+card
object
Card information
âuserId
string
User ID
âcardHolderId
string
Cardholder ID
âcardId
string
Card ID
âcustomerId
string
Custom Customer ID
âcardSeqNo
string
CARD series number
âdeposit
integer
Deposit, 1000 represents $10.00
âconsume
integer
Consumption, 1000 represents $10.00
âbalance
integer
Balance, 1000 represents $10.00
âcvc
string
Cvc virtual card verification code, also known as cvv in VISA cards
ânumber
string
Card number
âcardBin
string
Card section (top 6 digits of card number)
âlast4
string
Last four digits
âstatus
string
INIT: Card opening INIT CREATE CARD: Create Virtual Card INIT CREATE CARD HOLDER: Create Cardholder INIT ACTIVE CARD: Activate Card CREATE CARD FAILED REFUND: Card creation failed, full refund ACTIVE: Activated FREEZE: Frozen CANCELLING: Deleting card CANCELED: Deleted DELETED: Permanently delete EXPIRED: Expired
âstatusText
string
Card Status Text
âexpYear
integer
Card expiration year
âexpMonth
integer
Card Expiration Month
âgmtCreate
string
Card opening time
tags
array
Card Label List
â
string
Card Label
Response Example
Last updated