Card
You can retrieve the card information from the APIs below.
Query Cards
Query card list, sorted in reverse order of creation time. To retrieve the card balance and pending top-up information, please use Get Card API.
Request
Path:
/merchant/card{?skip,limit}Method:
GETQuery Strings
Name Type Required Description skip String Quantity to skip default: 0limit String Quantity to query default: 25
Response
200
Name Type Required Description items [Card] v Array of card start Integer v Start position of the query count Integer v Quantity of items total Integer v Quantity of queries 400
Name Type Required Description message String v Error message
Get Card
Use a specified card ID to retrieve the card balance and pending top-up amount.
Request
Path:
/merchant/card/{cardId}Method:
GETPath Parameters
Name Type Required Description cardId String v Specify a card ID.
Response
200
Name Type Required Description id String v Card ID createdAt String v Creation timestamp status String v Card status: active,suspended,expiredbalance String v Card balance pendingTopup String v The amount is pending to be credited to the card. Once the card balance is lower than the maximum limit, the pending balance will be automatically credited into the card. number String v Card number (showing only the first and last 4 digits) balanceUpper String v Maximum limit of card balance productId String Product ID associated with the card 400
Name Type Required Description message String v Error message
Get Card Detail
Obtain complete card information (card number, expiry, CVV).
Request
Path:
/merchant/card/{cardId}/detailsMethod:
POSTPath Parameters
Name Type Required Description cardId String v Specify card ID Request Body
Name Type Required Description key String v RSA public key
Response
200
Name Type Required Description data String v Encrypted string
Decrypt the data using the private key corresponding to the requested RSA public key.
Decrypted data
Name Type Required Description id String v Card ID createdAt String v Creation timestamp number String v Card number cvv String v Validation code expiry String v Expiry 400
Name Type Required Description message String v Error message
Query Authorized Transaction
Query authorized transactions in 30 days by a specified card ID. The final settled amount is based on the amount in the Query Settled Transaction.
Request
Path:
/merchant/card/{cardId}/transaction/auth{?skip,limit}Method:
GETPath Parameters
Name Type Required Description cardId String v Specify card ID Query Strings
Name Type Required Description skip String Quantity to skip default: 0limit String Quantity to query default: 25
Response
200
Name Type Required Description items [AuthorizedTransaction] v Array of authorized transaction start Integer v Start position of the query count Integer v Quantity of items total Integer v Quantity of queries 400
Name Type Required Description message String v Error message
Query Settled Transaction
Query settled transactions in 30 days by a specified card ID.
Request
Path:
/merchant/card/{cardId}/transaction/settlement{?skip,limit}Method:
GETPath Parameters
Name Type Required Description cardId String v Specify card ID Query Strings
Name Type Required Description skip String Quantity to skip default: 0limit String Quantity to query default: 25
Response
200
Name Type Required Description items [SettledTransaction] v Array of settled transaction start Number/Integer v Start position of the query count Number/Integer v Quantity of items total Number/Integer v Quantity of queries 400
Name Type Required Description message String v Error message
Get 3DS Code
Obtain the newest one-time password (OTP) code.
Request
Path:
/merchant/card/{cardId}/3dsMethod:
GetPath Parameters
Name Type Required Description cardId String v Specify card ID
Response
200
Name Type Required Description otp String One-time password amount String Transaction amount currency String Transaction currency merchantName String The merchant name associated with the transaction. 400
Name Type Required Description message String v Error message