Card Management APIs

Create a Single Virtual Card Synchronously (card information returned synchronously)

POST /abc/v1/card/create

Create a Single Virtual Card Synchronously (Card Information Returned Synchronously)

Request Headers

X-API-Key

string

Description

example

{apiKey}

X-Timestamp

integer

Description

example

{{Timestamp}}

X-Nonce

string

Description

example

{{Nonce}}

X-Signature

string

Description

example

{{Signature}}

Content-Type

string

Description

example

application/json

Request Body

Data model: OpenCardSyncCreateRequest

budgetId

stringRequired

Description

budget ID

Example / Default

BUD_20260101_001

cardName

stringRequired

Description

card name

Example / Default

RD-Test-Card

cardHolderName

stringRequired

Description

cardholder name

Example / Default

Zhang San

cardBinCode

stringRequired

Description

Card BIN (the first 6-8 digits of the card number), such as 622202

Example / Default

440299

isSharedCard

integer

Description

card type: 1=shared limit card (default), 2=dedicated limit card

Example / Default

cardSpendLimit

number

Description

Single-card limit (unit: cents, integer). Required for dedicated limit cards and must not be provided for shared limit cards; minimum -9999999999; maximum 9999999999

Successful Response

Data model: CommonResultOpenCardResponse

code

integer

Description

Error code

msg

string

Description

Human-readable error message

message

string

Description

data

object (OpenCardResponse)

Description

data structure (OpenCardResponse)

cardInfoId

string

Description

virtual cardunique ID

cardName

string

Description

card name

cardBinCode

string

Description

card BIN

cardNo

string

Description

Masked card number (BIN + + last four digits)

lastFour

string

Description

last four digits

expirationYear

string

Description

expiration year

expirationMonth

string

Description

expiration month

cvvNum

string

Description

encrypted CVV

cardScheme

string

Description

card scheme: VISA、MASTERCARD、UnionPay、JCB

cardHolderName

string

Description

cardholder

currency

string

Description

currency ISO 4217

Example / Default

USD

cardStatus

integer

Description

card status: 0=disable, 1=active, 2=lost, 3=deleted

isSharedCard

integer

Description

Whether the card is shared: 1=yes (shared budget pool), 2=no (dedicated limit card)

cardSpendLimit

number

Description

Card spend limit (for dedicated limit cards only; 0 for shared cards)

totalSpendAmount

number

Description

total card spend

serviceFeeAmount

number

Description

card issuance fee

budgetId

string

Description

linked budget ID

budgetName

string

Description

linked budget name

subAccountId

string

Description

linked sub account ID

subAccountName

string

Description

linked sub account name

createTime

string

Description

creation time

updateTime

string

Description

update time

Query Card List

POST /abc/v1/card/query

Query Card List

Request Headers

X-API-Key

string

Description

example

{apiKey}

X-Timestamp

integer

Description

example

{{Timestamp}}

X-Nonce

string

Description

example

{{Nonce}}

X-Signature

string

Description

example

{{Signature}}

Content-Type

string

Description

example

application/json

Request Body

Data model: OpenCardQueryRequest

pageNo

integerRequired

Description

Page number, starting from 1; minimum 1

Example / Default

pageSize

integerRequired

Description

Items per page, maximum 200; minimum 1

Example / Default

cardName

string

Description

card name

Successful Response

Data model: CommonResultPageResultOpenCardResponse

code

integer

Description

Error code

msg

string

Description

Human-readable error message

message

string

Description

data

object (PageResultOpenCardResponse)

Description

data structure (PageResultOpenCardResponse)

total

integer (int64)

Description

Total

list

array<object (OpenCardResponse)>

Description

Data

Update Card (card name / card type / limit)

POST /abc/v1/card/edit

Update Card (Name / Type / Limit)

Request Headers

X-API-Key

string

Description

example

{apiKey}

X-Timestamp

integer

Description

example

{{Timestamp}}

X-Nonce

string

Description

example

{{Nonce}}

X-Signature

string

Description

example

{{Signature}}

Content-Type

string

Description

example

application/json

Request Body

Data model: OpenCardEditRequest

cardInfoId

stringRequired

Description

virtual cardunique ID

Example / Default

29364

cardName

string

Description

Card name; omit to leave unchanged

isSharedCard

integerRequired

Description

whether the card is shared: 1=shared limit card, 2=dedicated limit card

Example / Default

cardSpendLimit

number

Description

Card spend limit (unit: cents); required when the target type is a dedicated limit card and must be omitted when converting to a shared card; minimum -9999999999; maximum 9999999999

Successful Response

Data model: CommonResultOpenCardResponse

code

integer

Description

Error code

msg

string

Description

Human-readable error message

message

string

Description

data

object (OpenCardResponse)

Description

data structure (OpenCardResponse)

cardInfoId

string

Description

virtual cardunique ID

cardName

string

Description

card name

cardBinCode

string

Description

card BIN

cardNo

string

Description

Masked card number (BIN + + last four digits)

lastFour

string

Description

last four digits

expirationYear

string

Description

expiration year

expirationMonth

string

Description

expiration month

cvvNum

string

Description

encrypted CVV

cardScheme

string

Description

card scheme: VISA、MASTERCARD、UnionPay、JCB

cardHolderName

string

Description

cardholder

currency

string

Description

currency ISO 4217

Example / Default

USD

cardStatus

integer

Description

card status: 0=disable, 1=active, 2=lost, 3=deleted

isSharedCard

integer

Description

Whether the card is shared: 1=yes (shared budget pool), 2=no (dedicated limit card)

cardSpendLimit

number

Description

Card spend limit (for dedicated limit cards only; 0 for shared cards)

totalSpendAmount

number

Description

total card spend

serviceFeeAmount

number

Description

card issuance fee

budgetId

string

Description

linked budget ID

budgetName

string

Description

linked budget name

subAccountId

string

Description

linked sub account ID

subAccountName

string

Description

linked sub account name

createTime

string

Description

creation time

updateTime

string

Description

update time

Update Virtual Card Status (enable / disable)

POST /abc/v1/card/update-status

Update Virtual Card Status (Enable / Disable)

Request Headers

X-API-Key

string

Description

example

{apiKey}

X-Timestamp

integer

Description

example

{{Timestamp}}

X-Nonce

string

Description

example

{{Nonce}}

X-Signature

string

Description

example

{{Signature}}

Content-Type

string

Description

example

application/json

Request Body

Data model: OpenCardUpdateStatusRequest

cardInfoId

stringRequired

Description

virtual cardunique ID

Example / Default

29364

cardStatus

integerRequired

Description

card status: 1=active, 2=disable

Example / Default

Successful Response

Data model: CommonResultOpenCardResponse

code

integer

Description

Error code

msg

string

Description

Human-readable error message

message

string

Description

data

object (OpenCardResponse)

Description

data structure (OpenCardResponse)

cardInfoId

string

Description

virtual cardunique ID

cardName

string

Description

card name

cardBinCode

string

Description

card BIN

cardNo

string

Description

Masked card number (BIN + + last four digits)

lastFour

string

Description

last four digits

expirationYear

string

Description

expiration year

expirationMonth

string

Description

expiration month

cvvNum

string

Description

encrypted CVV

cardScheme

string

Description

card scheme: VISA、MASTERCARD、UnionPay、JCB

cardHolderName

string

Description

cardholder

currency

string

Description

currency ISO 4217

Example / Default

USD

cardStatus

integer

Description

card status: 0=disable, 1=active, 2=lost, 3=deleted

isSharedCard

integer

Description

Whether the card is shared: 1=yes (shared budget pool), 2=no (dedicated limit card)

cardSpendLimit

number

Description

Card spend limit (for dedicated limit cards only; 0 for shared cards)

totalSpendAmount

number

Description

total card spend

serviceFeeAmount

number

Description

card issuance fee

budgetId

string

Description

linked budget ID

budgetName

string

Description

linked budget name

subAccountId

string

Description

linked sub account ID

subAccountName

string

Description

linked sub account name

createTime

string

Description

creation time

updateTime

string

Description

update time

Get Card Details

POST /abc/v1/card/detail

Get Card Details

Request Headers

X-API-Key

string

Description

example

{apiKey}

X-Timestamp

integer

Description

example

{{Timestamp}}

X-Nonce

string

Description

example

{{Nonce}}

X-Signature

string

Description

example

{{Signature}}

Content-Type

string

Description

example

application/json

Request Body

Data model: OpenCardDetailRequest

cardInfoId

stringRequired

Description

Card primary key ID

Example / Default

1024

Successful Response

Data model: CommonResultOpenCardResponse

code

integer

Description

Error code

msg

string

Description

Human-readable error message

message

string

Description

data

object (OpenCardResponse)

Description

data structure (OpenCardResponse)

cardInfoId

string

Description

virtual cardunique ID

cardName

string

Description

card name

cardBinCode

string

Description

card BIN

cardNo

string

Description

Masked card number (BIN + + last four digits)

lastFour

string

Description

last four digits

expirationYear

string

Description

expiration year

expirationMonth

string

Description

expiration month

cvvNum

string

Description

encrypted CVV

cardScheme

string

Description

card scheme: VISA、MASTERCARD、UnionPay、JCB

cardHolderName

string

Description

cardholder

currency

string

Description

currency ISO 4217

Example / Default

USD

cardStatus

integer

Description

card status: 0=disable, 1=active, 2=lost, 3=deleted

isSharedCard

integer

Description

Whether the card is shared: 1=yes (shared budget pool), 2=no (dedicated limit card)

cardSpendLimit

number

Description

Card spend limit (for dedicated limit cards only; 0 for shared cards)

totalSpendAmount

number

Description

total card spend

serviceFeeAmount

number

Description

card issuance fee

budgetId

string

Description

linked budget ID

budgetName

string

Description

linked budget name

subAccountId

string

Description

linked sub account ID

subAccountName

string

Description

linked sub account name

createTime

string

Description

creation time

updateTime

string

Description

update time

Card Management: Delete Card

POST /abc/v1/card/cancel

Card Management: Delete Card

Request Headers

X-API-Key

string

Description

example

{apiKey}

X-Timestamp

integer

Description

example

{{Timestamp}}

X-Nonce

string

Description

example

{{Nonce}}

X-Signature

string

Description

example

{{Signature}}

Content-Type

string

Description

example

application/json

Request Body

Data model: OpenCardCancelRequest

cardId

stringRequired

Description

Successful Response

Data model: CommonResultBoolean

code

integer

Description

Error code

msg

string

Description

Human-readable error message

message

string

Description

data

boolean

Description

Response data

Query Card BIN

Query Card BIN.

Request URL: POST https://open.orbsis.com/abc/v1/card/bin/query

request headers

X-API-Key

Header

Example or Description

{APIKey}

X-Timestamp

Header

Example or Description

{{Timestamp}}

X-Nonce

Header

Example or Description

{{Nonce}}

X-Signature

Header

Example or Description

{{Signature}}

Content-Type

Header

Example or Description

application/json

request parameters

pageNo

integerRequired

Description and Constraints

Page number, starting from 1; minimum 1.

Example or Default

default: 1; example: 1

pageSize

integerRequired

Description and Constraints

Items per page, maximum 200; minimum 1.

Example or Default

default: 10; example: 10

merchantId

string

Description and Constraints

merchant ID.

Example or Default

4416

cardBinCode

string

Description and Constraints

card BIN.

Example or Default

448213

status

integer

Description and Constraints

status.

currency

string

Description and Constraints

currency.

Example or Default

USD

country

string

Description and Constraints

country.

Example or Default

cardGroup

string

Description and Constraints

card scheme.

Example or Default

VISA

cURL Example:

curl --request POST 'https://open.orbsis.com/abc/v1/card/bin/query' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: api-key' \
  --header 'X-Timestamp: unix-seconds' \
  --header 'X-Nonce: unique-nonce' \
  --header 'X-Signature: base64-signature' \
  --data '{"pageNo":1,"pageSize":10,"merchantId":"4416","cardBinCode":"448213","status":1,"currency":"USD","country":"US","cardGroup":"VISA"}'

Request Body Example:

{ "pageNo": 1, "pageSize": 10, "merchantId": "4416", "cardBinCode": "448213", "status": 1, "currency": "USD", "country": "US", "cardGroup": "VISA" }

Response Fields

code

integer

Description

Error code

msg

string

Description

Human-readable error message

message

string

Description

Message field

data

object

Description

Response data

data.total

integer(int64)

Description

Total

data.list

array

Description

Data list

data.list[].id

integer(int64)

Description

primary key ID; example: 7163

data.list[].parameterId

string

Description

product ID; example: 22597

data.list[].cardBin

string

Description

card BIN

data.list[].issuer

string

Description

issuer

data.list[].cardFee

number

Description

card issuance fee

data.list[].maxCardNum

integer

Description

maximum card issuance count

data.list[].status

integer

Description

Status: 0 - unavailable, 1 - available; example: 1

data.list[].effectiveTime

string

Description

effective time

data.list[].failureTime

string

Description

expiration time

data.list[].createTime

string

Description

creation time

data.list[].currency

string

Description

currency

data.list[].country

string

Description

country

data.list[].cardGroup

string

Description

card scheme

data.list[].totalIssuedCount

integer(int64)

Description

issued card count

Successful Response Example:

{ "code": 0, "msg": "success", "message": "success", "data": { "total": 1, "list": [ { "id": 7163, "parameterId": "22597", "cardBin": "448213", "issuer": "string", "cardFee": 100, "maxCardNum": 1, "status": 1, "effectiveTime": "string", "failureTime": "string", "createTime": "string", "currency": "USD", "country": "US", "cardGroup": "VISA", "totalIssuedCount": 1 } ] } }

Create a Single Virtual Card Synchronously (card information returned synchronously)​

Query Card List​

Update Card (card name / card type / limit)​

Update Virtual Card Status (enable / disable)​

Get Card Details​

Card Management: Delete Card​

Query Card BIN​

Create a Single Virtual Card Synchronously (card information returned synchronously)

Query Card List

Update Card (card name / card type / limit)

Update Virtual Card Status (enable / disable)

Get Card Details

Card Management: Delete Card

Query Card BIN