Create cardholder

Request

Header Params

Content-Type

string

optional

Example:

application/json

Body Params application/json

request_id

string

optional

Unique identifier

<= 100 characters

billing_address

string

required

Street address in the billing address
This parameter is required for tangible goods

<= 100 characters

billing_city

string

required

City in the billing address
This parameter is required for tangible goods

<= 50 characters

billing_postal

string

required

Postal code in the billing address
This parameter is required for tangible goods

<= 6 characters

billing_state

string

required

State in the billing address
This parameter is required for tangible goods and when the country is United States or Canada

<= 20 characters

birth_date

string

required

Cardholder’s birthdate (YYYY-MM-DD)

<= 10 characters

billing_country

string

required

2 digits ISO Country Code; Refer to ISO 3166-2 country code
This parameter is required for tangible goods

<= 3 characters

email

string

required

Cardholder email address

<= 100 characters

first_name

string

required

Cardholder first name

<= 50 characters

last_name

string

required

Cardholder last name

<= 50 characters

mobile

string

required

Mobile number

<= 13 characters

mobile_prefix

string

required

Mobile prefix

<= 4 characters

remark

string

optional

Remarks (if any）

<= 500 characters

company_id

number

required

Merchant Code or Merchant ID or Merchant Number

sign

string

required

Digital signatures information
Encryption Rule: touppercase(SHA256(company_id + email + first_name + last_name + api_key))
All encryption parameters need to remove spaces before encryption.

<= 100 characters

Example

{
    "request_id": "",
    "billing_address": "1600 Amphitheatre Parkway",
    "billing_city": "New York",
    "billing_postal": "94043",
    "billing_state": "NY",
    "birth_date": "1996-07-02",
    "billing_country": "US",
    "email": "test1811@email.com",
    "first_name": "Jon",
    "last_name": "Doe",
    "mobile": "9521325",
    "mobile_prefix": "+1",
    "remark": "test",
    "company_id": "4101",
    "sign": "14DC174549C80FF4C62113CB7A08BF03846DED0D37F7985E6C5CAD845C823861"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://sandbox.vcc.top/api/cardholder/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request_id": "",
    "billing_address": "1600 Amphitheatre Parkway",
    "billing_city": "New York",
    "billing_postal": "94043",
    "billing_state": "NY",
    "birth_date": "1996-07-02",
    "billing_country": "US",
    "email": "test1811@email.com",
    "first_name": "Jon",
    "last_name": "Doe",
    "mobile": "9521325",
    "mobile_prefix": "+1",
    "remark": "test",
    "company_id": "4101",
    "sign": "14DC174549C80FF4C62113CB7A08BF03846DED0D37F7985E6C5CAD845C823861"
}'

Responses

🟢200OK

application/json

Body

code

integer

required

msg

object

required

zh-CN

string

required

en-US

string

required

data

object

required

billingAddress

string

required

billingCity

string

required

billingPostal

string

required

billingState

string

required

birthDate

string

required

companyId

integer

required

countryCode

string

required

email

string

required

firstName

string

required

lastName

string

required

mobile

string

required

mobilePrefix

string

required

remark

string

required

cardholderId

integer

required

isStatus

string

required

status

string

required

Example

{
    "code": 0,
    "msg": {
        "zh-CN": "成功",
        "en-US": "Success"
    },
    "data": {
        "billingAddress": "1600 Amphitheatre Parkway",
        "billingCity": "New York",
        "billingPostal": "94043",
        "billingState": "NY",
        "birthDate": "1996-07-02 08:00:00",
        "companyId": 4101,
        "countryCode": "US",
        "email": "test1811@email.com",
        "firstName": "Jon",
        "lastName": "Doe",
        "mobile": "9521325",
        "mobilePrefix": "+1",
        "remark": "test",
        "cardholderId": 8101,
        "isStatus": "1",
        "status": "1"
    }
}