Cardholder Management

Cardholder-Occupation

POST /merchant/core/mcb/card/holder/occupations

Request

Param
Type
Required
Remark

Response

Param
Type
Required
Remark

occupationCode

String

True

Occupation code

description

String

True

Occupation

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    [
        {
            "occupationCode": "11-1011",
            "description": "Chief Executives"
        }
    ]
}

Cardholder-Create-v1

POST /merchant/core/mcb/card/holder/create

Request

Param
Type
Required
Remark

merchantOrderNo

String

false

Merchant order number. length[20...35]

cardTypeId

Long

true

Card type ID

areaCode

String

true

Mobile phone area code. length[2...5].

Get Support Card Bin Interface Parameter supportHolderAreaCode

mobile

String

true

Mobile phone number. length[5...20]

email

String

true

Email. Receive verification code. length[5...50]

firstName

String

true

First Name. Only English characters are supported. length[2...30] The total length of firstName and lastName cannot exceed 30 characters (including spaces)

lastName

String

true

Last name. Only English characters are supported. length[2...60]. The total length of firstName and lastName cannot exceed 30 characters (including spaces)

birthday

String

true

Date of birth. yyyy-MM-dd

country

String

true

Country/Region Code. ISO 3166-1 alpha-2 Get Support Card Bin Interface Parameter supportHolderRegin

town

String

true

City Code. Get City List Interface Parameter code

address

String

true

Address. length[2...40]. Can only contain letters, numbers, hyphens and spaces. regex: ^[A-Za-z0-9\- ]+$

postCode

String

true

Postal code. length[2...10]

Response

Param
Type
Required
Remark

holderId

Long

true

Cardholder ID

merchantOrderNo

String

false

Merchant order number

cardTypeId

Long

true

Card type ID

statusFlowLocation

String

true

Review flow location. Update cardholders are supported only when statusFlowLocation=admin and status=reject admin: platform review; channel: bank review

status

String

true

Status. wait_audit: pending audit; pass_audit: passed audit; under_review: under review; reject: reject

statusStr

String

false

Status description

respMsg

String

false

remark

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    {
        "holderId": 124024,
        "cardTypeId": 124024,
        "statusFlowLocation": "admin",
        "status": "pass_audit",
        "statusStr": "Audit Pass",
        "respMsg": "SUCCESS"
    }
}

Cardholder-Update-v1

POST /merchant/core/mcb/card/holder/update

Request

Param
Type
Required
Remark

holderId

Long

true

Cardholder ID

cardTypeId

Long

true

Card type ID

areaCode

String

true

Mobile phone area code. length[2...5].

Get Support Card Bin Interface Parameter supportHolderAreaCode

mobile

String

true

Mobile phone number. length[5...20]

email

String

true

Email. Receive verification code. length[5...50]

firstName

String

true

First Name. Only English characters are supported. length[2...30] The total length of firstName and lastName cannot exceed 30 characters (including spaces)

lastName

String

true

Last name. Only English characters are supported. length[2...60]. The total length of firstName and lastName cannot exceed 30 characters (including spaces)

birthday

String

true

Date of birth. yyyy-MM-dd

country

String

true

Country/Region Code. ISO 3166-1 alpha-2 Get Support Card Bin Interface Parameter supportHolderRegin

town

String

true

City Code. Get City List Interface Parameter code

address

String

true

Address. length[2...40]. Can only contain letters, numbers, hyphens and spaces. regex: ^[A-Za-z0-9\- ]+$

postCode

String

true

Postal code. length[2...10]

Response

Param
Type
Required
Remark

holderId

Long

true

Cardholder ID

merchantOrderNo

String

false

Merchant order number

cardTypeId

Long

true

Card type ID

statusFlowLocation

String

true

Review flow location. Update cardholders are supported only when statusFlowLocation=admin and status=reject admin: platform review; channel: bank review

status

String

true

Status. wait_audit: pending audit; pass_audit: passed audit; under_review: under review; reject: reject

statusStr

String

false

Status description

respMsg

String

false

remark

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    {
        "holderId": 124024,
        "cardTypeId": 124024,
        "statusFlowLocation": "admin",
        "status": "pass_audit",
        "statusStr": "Audit Pass",
        "respMsg": "SUCCESS"
    }
}

Cardholder-Create-v2

Please fill in the cardholder information truthfully. The cardholder cannot modify any information after submitting it to the bank. And the email address and ID number are globally unique under the same card type (cardTypeId). For example, if a user submits the email address test@gmail.com from channel A, the same email address will be rejected when submitted from channel B.

POST /merchant/core/mcb/card/holder/v2/create

Request

Param
Type
Required
Remark

merchantOrderNo

String

true

Merchant order number. length[20...35]

cardTypeId

Long

true

Card type ID

areaCode

String

true

Mobile phone area code. length[2...5].

Get Support Card Bin Interface Parameter supportHolderAreaCode

mobile

String

true

Mobile phone number. length[5...20]

email

String

true

Email. Receive verification code. length[5...50]

firstName

String

true

First Name. Only English characters are supported. length[2...30] The total length of firstName and lastName cannot exceed 30 characters (including spaces)

lastName

String

true

Last name. Only English characters are supported. length[2...60]. The total length of firstName and lastName cannot exceed 30 characters (including spaces)

birthday

String

true

Date of birth. yyyy-MM-dd

nationality

String

true

Nationality Code. ISO 3166-1 alpha-2 Get Support Card Bin Interface Parameter supportHolderRegin

country

String

true

Country/Region Code for bill address. ISO 3166-1 alpha-2 Get Support Card Bin Interface Parameter supportHolderRegin

town

String

true

City Code for bill address. Get City List Interface Parameter code

address

String

true

Address for bill. length[2...40]. Can only contain letters, numbers, hyphens and spaces. regex: ^[A-Za-z0-9\- ]+$

postCode

String

true

Postal code for bill address. length[2...10]

gender

String

true

Gender. M: male; F: female

occupation

String

true

Occupation. Get cardholder's occupation parameter occupationCode

annualSalary

String

true

Annual salary. eg: 10000000 USD

accountPurpose

String

true

Account purpose. Only supports English. eg: Living Expense

expectedMonthlyVolume

String

true

Expected monthly trading volume. eg: 100000 USD

idType

String

true

Id type. PASSPORT: Passport HK_HKID: Hong Kong Identity Card DLN: DLN (only support US) GOVERNMENT_ISSUED_ID_CARD: Government-issued ID Card

idNumber

String

true

Id number. length[2...50]

ssn

String

false

Social Security Number. If the nationality is the US, 9-digit SSN is required

issueDate

String

true

ID document issuance date. format: yyyy-MM-dd

idNoExpiryDate

String

true

The certificate expiration date. format: yyyy-MM-dd

idFrontId

String

true

Front photo of ID card File ID. Call upload file interface to get

idBackId

String

true

Back photo of ID card File ID. Call upload file interface to get

idHoldId

String

true

User holding ID photo File ID. Call the upload file interface to obtain

ipAddress

String

true

IPV4 address.

Response

Param
Type
Required
Remark

holderId

Long

true

Cardholder ID

merchantOrderNo

String

false

Merchant order number

cardTypeId

Long

true

Card type ID

statusFlowLocation

String

true

Review flow location. Process: Platform review first, then bank review. Update cardholders are supported only when statusFlowLocation=admin and status=reject admin: platform review; channel: bank review

status

String

true

Status. wait_audit: pending audit; pass_audit: passed audit; under_review: under review; reject: reject

statusStr

String

false

Status description

respMsg

String

false

remark

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    {
        "holderId": 124024,
        "cardTypeId": 124024,
        "statusFlowLocation": "admin",
        "status": "pass_audit",
        "statusStr": "Audit Pass",
        "respMsg": "SUCCESS"
    }
}

Cardholder-Update-v2

Updating the cardholder is supported only when statusFlowLocation=admin and status=reject

POST /merchant/core/mcb/card/holder/v2/update

Request

Param
Type
Required
Remark

holderId

Long

true

Holder Id

areaCode

String

true

Mobile phone area code. length[2...5].

Get Support Card Bin Interface Parameter supportHolderAreaCode

mobile

String

true

Mobile phone number. length[5...20]

email

String

true

Email. Receive verification code length[5...50]

firstName

String

true

First Name. Only English characters are supported. length[2...30] The total length of firstName and lastName cannot exceed 30 characters (including spaces)

lastName

String

true

Last name. Only English characters are supported. length[2...60]. The total length of firstName and lastName cannot exceed 30 characters (including spaces)

birthday

String

true

Date of birth. yyyy-MM-dd

nationality

String

true

Nationality Code. ISO 3166-1 alpha-2 Get Support Card Bin Interface Parameter supportHolderRegin

country

String

true

Country/Region Code for bill address. ISO 3166-1 alpha-2 Get Support Card Bin Interface Parameter supportHolderRegin

town

String

true

City Code for bill address. Get City List Interface Parameter code

address

String

true

Address for bill. length[2...40]. Can only contain letters, numbers, hyphens and spaces. regex: ^[A-Za-z0-9\- ]+$

postCode

String

true

Postal code for bill address. length[2...10]

gender

String

true

Gender. M: male; F: female

occupation

String

true

Occupation. Get cardholder's occupation parameter occupationCode

annualSalary

String

true

Annual salary. eg: 10000000 USD

accountPurpose

String

true

Account purpose. Only supports English. eg: Living Expense

expectedMonthlyVolume

String

true

Expected monthly trading volume. eg: 100000 USD

idType

String

true

Id type. PASSPORT: Passport HK_HKID: Hong Kong Identity Card DLN: DLN (only support US) GOVERNMENT_ISSUED_ID_CARD: Government-issued ID Card

idNumber

String

true

Id number. length[2...50]

ssn

String

false

Social Security Number. If the nationality is the US, 9-digit SSN is required

issueDate

String

true

ID document issuance date. format: yyyy-MM-dd

idNoExpiryDate

String

true

The certificate expiration date. format: yyyy-MM-dd

idFrontId

String

true

Front photo of ID card File ID. Call upload file interface to get

idBackId

String

true

Back photo of ID card File ID. Call upload file interface to get

idHoldId

String

true

User holding ID photo File ID. Call the upload file interface to obtain

ipAddress

String

true

IPV4 address.

Response

Param
Type
Required
Remark

holderId

Long

true

Cardholder ID

merchantOrderNo

String

false

Merchant order number

cardTypeId

Long

true

Card type ID

statusFlowLocation

String

true

Review flow location. Process: Platform review first, then bank review. Update cardholders are supported only when statusFlowLocation=admin and status=reject admin: platform review; channel: bank review

status

String

true

Status. wait_audit: pending audit; pass_audit: passed audit; under_review: under review; reject: reject

statusStr

String

false

Status description

respMsg

String

false

remark

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    {
        "holderId": 124024,
        "cardTypeId": 124024,
        "statusFlowLocation": "admin",
        "status": "pass_audit",
        "statusStr": "Audit Pass",
        "respMsg": "SUCCESS"
    }
}

Cardholder-Create-sumsub

RESTRICTED COUNTRIESConsumer Cardholders

Cuba; DPRK; Egypt; Iran; Myanmar; Nigeria; Russia; South Africa; Syria; Ukraine; Venezuela

POST /merchant/core/mcb/card/holder/v2/create/sumsub

Request

Param
Type
Required
Remark

merchantOrderNo

String

true

Merchant order number. length[20...35]

cardTypeId

Long

true

Card type ID

areaCode

String

true

Mobile phone area code. length[2...5].

Get Support Card Bin Interface Parameter supportHolderAreaCode

mobile

String

true

Mobile phone number. length[5...20]

email

String

true

Email. Receive verification code. length[5...50]

firstName

String

true

First Name. Only English characters are supported. length[2...30] The total length of firstName and lastName cannot exceed 30 characters (including spaces)

lastName

String

true

Last name. Only English characters are supported. length[2...60]. The total length of firstName and lastName cannot exceed 30 characters (including spaces)

occupation

String

true

Occupation. Get cardholder's occupation parameter occupationCode

annualSalary

String

true

Annual salary. eg: 10000000 USD

accountPurpose

String

true

Account purpose. Only supports English. eg: Living Expense

expectedMonthlyVolume

String

true

Expected monthly trading volume. eg: 100000 USD

sumSubShareToken

String

true

sumsub share token

ipAddress

String

true

IPV4 address.

Response

Param
Type
Required
Remark

holderId

Long

true

Cardholder ID

merchantOrderNo

String

false

Merchant order number

cardTypeId

Long

true

Card type ID

statusFlowLocation

String

true

Review flow location. Process: Platform review first, then bank review. Update cardholders are supported only when statusFlowLocation=admin and status=reject admin: platform review; channel: bank review

status

String

true

Status. wait_audit: pending audit; pass_audit: passed audit; under_review: under review; reject: reject

statusStr

String

false

Status description

respMsg

String

false

remark

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    {
        "holderId": 124024,
        "cardTypeId": 124024,
        "statusFlowLocation": "admin",
        "status": "pass_audit",
        "statusStr": "Audit Pass",
        "respMsg": "SUCCESS"
    }
}

Cardholder-Update-sumsub

POST /merchant/core/mcb/card/holder/v2/update/sumsub

Request

Param
Type
Required
Remark

holderId

Long

true

holder id

areaCode

String

true

Mobile phone area code. length[2...5].

Get Support Card Bin Interface Parameter supportHolderAreaCode

mobile

String

true

Mobile phone number. length[5...20]

email

String

true

Email. Receive verification code. length[5...50]

firstName

String

true

First Name. Only English characters are supported. length[2...30] The total length of firstName and lastName cannot exceed 30 characters (including spaces)

lastName

String

true

Last name. Only English characters are supported. length[2...60]. The total length of firstName and lastName cannot exceed 30 characters (including spaces)

occupation

String

true

Occupation. Get cardholder's occupation parameter occupationCode

annualSalary

String

true

Annual salary. eg: 10000000 USD

accountPurpose

String

true

Account purpose. Only supports English. eg: Living Expense

expectedMonthlyVolume

String

true

Expected monthly trading volume. eg: 100000 USD

sumSubShareToken

String

true

sumsub share token

ipAddress

String

true

IPV4 address.

Response

Param
Type
Required
Remark

holderId

Long

true

Cardholder ID

merchantOrderNo

String

false

Merchant order number

cardTypeId

Long

true

Card type ID

statusFlowLocation

String

true

Review flow location. Process: Platform review first, then bank review. Update cardholders are supported only when statusFlowLocation=admin and status=reject admin: platform review; channel: bank review

status

String

true

Status. wait_audit: pending audit; pass_audit: passed audit; under_review: under review; reject: reject

statusStr

String

false

Status description

respMsg

String

false

remark

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    {
        "holderId": 124024,
        "cardTypeId": 124024,
        "statusFlowLocation": "admin",
        "status": "pass_audit",
        "statusStr": "Audit Pass",
        "respMsg": "SUCCESS"
    }
}

Cardholder-Query

POST /merchant/core/mcb/card/holder/query

Request

Param
Type
Required
Remark

pageNum

Integer

true

Current page. Default is 1

pageSize

Integer

true

Number of pages per page. Maximum 100, default 10

holderId

Long

false

Holder Id

areaCode

String

false

Mobile phone area code areaCode and mobile are passed at the same time or not

mobile

String

false

Mobile phone number

email

String

false

Email addres

merchantOrderNo

String

false

Merchant order number

Response

Param
Type
Required
Remark

holderId

String

true

Cardholder ID

merchantOrderNo

String

false

Merchant order number

cardTypeId

String

true

Card type ID

areaCode

String

true

Mobile phone area code

mobile

String

true

Mobile phone number

email

String

true

Email address

firstName

String

true

First Name

lastName

String

true

Last name

birthday

String

true

Date of birth. yyyy-MM-dd

country

String

true

Country/Region Code. ISO 3166-1 alpha-2

town

String

true

City Code

address

String

true

address

postCode

String

true

Postal code

statusFlowLocation

String

true

Review flow location. Update cardholders are supported only when statusFlowLocation=admin and status=reject admin: platform review; channel: bank review

status

String

true

Status. wait_audit: pending audit; pass_audit: passed audit; under_review: under review; reject: rejected

statusStr

String

true

Status description

respMsg

String

false

remark

createTime

Long

true

Creation time. Milliseconds

updateTime

Long

true

Update time. Millisecond timestamp

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    {
        "total": 11,
        "records":
        [
            {
                "holderId": 102424,
                "merchantOrderNo": "24353647ksglsan3535",
                "cardTypeId": 102424,
                "areaCode": "+852",
                "mobile": "875692311",
                "email": "test@test.com",
                "firstName": "elly",
                "lastName": "tom",
                "birthday": "1990-10-10",
                "country": "HK",
                "countryStr": "香港",
                "town": "HK_KKC_1",
                "townStr": "九龙城区",
                "address": "To Kwa Wan, Kowloon, Hong Kong",
                "postCode": "999077",
                "statusFlowLocation": "admin",
                "status": "pass_audit",
                "statusStr": "审核通过",
                "respMsg": null,
                "createTime": 232413142131,
                "updateTime": 232413142131
            }
        ]
    }
}

PreviousCard ManagementNextNotification Subscription

Last updated