Create group

Request

Body Params application/json

request_id

string

optional

Unique identifier

<= 100 characters

company_id

number

required

Merchant Code or Merchant ID or Merchant Number

group_name

string

required

Group name

<= 100 characters

country_code

string

required

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

<= 3 characters

currency

string

required

Order Currency Code. Please refer to ISO 4217

<= 3 characters

charge_amount

string

required

Recharge amount; Value can be digits only. Please refer to ISO 4217 for decimal values of each currency

<= 12 characters

sign

string

required

Digital signatures information
Encryption Rule: touppercase(SHA256(company_id + group_name + charge_amount + currency + api_key))
All encryption parameters need to remove spaces before encryption.

<= 100 characters

Example

{
    "request_id": "",
    "company_id": "4101",
    "group_name": "APITEST1",
    "country_code": "US",
    "currency": "USD",
    "charge_amount": "130.36",
    "sign": "9C4C2F9598F7A7334E226629914A2D7D2D4BDD63B76CA431C03101BEBDCE9B0B"
}

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/group/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request_id": "",
    "company_id": "4101",
    "group_name": "APITEST1",
    "country_code": "US",
    "currency": "USD",
    "charge_amount": "130.36",
    "sign": "9C4C2F9598F7A7334E226629914A2D7D2D4BDD63B76CA431C03101BEBDCE9B0B"
}'

Responses

🟢200OK

application/json

Body

code

integer

required

msg

object

required

zh-CN

string

required

en-US

string

required

data

object

required

chargeAmount

number

required

companyId

integer

required

countryCode

string

required

currency

string

required

groupName

string

required

groupId

integer

required

status

string

required

reqNo

integer

required

Example

{
    "code": 0,
    "msg": {
        "zh-CN": "成功",
        "en-US": "Success"
    },
    "data": {
        "chargeAmount": 130.36,
        "companyId": 4101,
        "countryCode": "US",
        "currency": "USD",
        "groupName": "APITEST1",
        "groupId": 6001,
        "status": "1",
        "reqNo": 113801
    }
}