Common API

Country/Region List

This interface is updated very infrequently, so please localize the data before calling it.

POST /merchant/core/mcb/common/region

Request

param	Type	Required	Remark

Response

Param	Type	Required	Remark
code	String	true	Country/Region code ISO 3166-1 alpha-2
standardCode	String	true	Country/Region code ISO 3166-1 alpha-3
name	String	true	Country/Region name

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    [
        {
            "code": "AU",
            "standardCode": "AUS",
            "name": "Australia"
        },
        {
            "code": "BD",
            "standardCode": "BGD",
            "name": "Bangladesh"
        }
    ]
}

City List

This interface is updated very infrequently, so please localize the data before calling it.

POST /merchant/core/mcb/common/city

Request

param	Type	Required	Remark
regionCode	String	false	Country/Region code ISO 3166-1 alpha-2

Response

Param	Type	Required	Remark
code	String	true	city code
name	String	true	city name
country	String	true	Country/Region code ISO 3166-1 alpha-2
countryStandardCode	String	true	Country/Region code ISO 3166-1 alpha-3

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    [
        {
            "code": "AU_01",
            "name": "test",
            "country": "AU",
            "countryStandardCode": "AUS"
        }
    ]
}

City List-v2

It includes two levels: province/state/region and city.

This interface is updated very infrequently, so please localize the data before calling it.

POST /merchant/core/mcb/common/v2/city

Request

param	Type	Required	Remark
regionCode	String	false	Country/Region code ISO 3166-1 alpha-2

Response

Param	Type	Required	Remark
code	String	true	city code
name	String	true	city name
country	String	true	Country/Region code ISO 3166-1 alpha-2
countryStandardCode	String	true	Country/Region code ISO 3166-1 alpha-3
parentCode	String	true	Parent code
children	List	true	children city list
children[0].code	String	true	city code
children[0].name	String	true	city name
children[0].country	String	true	Country/Region code ISO 3166-1 alpha-2
children[0].countryStandardCode	String	true	Country/Region code ISO 3166-1 alpha-3
children[0].parentCode	String	true	Parent code
children[0].children	String	true	children city list

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    [
        {
            "code": "AU-ACT",
            "name": "Australian Capital Territory",
            "parentCode": "0",
            "country": "AU",
            "countryStandardCode": "AUS",
            "children":
            [
                {
                    "code": "AU-ACT-80100",
                    "name": "Australian Capital Territory (Canberra)",
                    "parentCode": "AU-ACT",
                    "country": "AU",
                    "countryStandardCode": "AUS",
                    "children":
                    []
                }
            ]
        }
    ]
}

Mobile Code List

This interface is updated very infrequently, so please localize the data before calling it.

POST /merchant/core/mcb/common/mobileAreaCode

Request

param	Type	Required	Remark

Response

Param	Type	Required	Remark
code	String	true	Mobile code. eg: +1
name	String	true	Region Name
areaCode	String	true	Region Code ISO 3166-1 alpha-2
language	String	true	Region Lanuage
enableGlobalTransfer	Boolean	true	Is Global Transfer Available

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    [
        {
            "code": "+1",
            "name": "Canada",
            "areaCode": "CA",
            "language": "en_US",
            "enableGlobalTransfer": true
        }
    ]
}

Upload File

content-type=multipart/form-data; please generate an empty object for signature for this interface Only jpg, png, and pdf formats are supported; the file size cannot exceed 2M

POST /merchant/core/mcb/common/file/upload

Request

param	Type	Required	Remark
category	String	true	Please use the value: card
file	File	true	File

Response

Param	Type	Required	Remark
fileId	String	true	File Id

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    {
        "fileId": "c7bf3c1b-25d1-4b75-b519-1e6bf383d0a7"
    }
}

Submit Work Order

POST /merchant/core/mcb/work/submit

Request

param	Type	Required	Remark
merchantOrderNo	String	true	Merchant order number. length[20...40]
title	String	true	title. length[1...255]
target	String	true	Target. length[1...255] eg CardNumer
content	String	false	Content. length[0...1000]
files	List	false	File ID. Call upload file interface to get
tradeType	String	true	Type. CARD_ACTIVE: Card activation; OTHER: Other

Response

Param	Type	Required	Remark
merchantOrderNo	String	true	Merchant order number
orderNo	String	true	Platform order number
title	String	true	title
target	String	true	Target
content	String	false	Content
tradeType	String	true	Type. CARD_ACTIVE: Card activation; OTHER: Other
tradeStatus	String	true	Status. wait_process: pending; processing: processing; success: success; fail: failure
remark	String	false	Remark
createTime	Long	true	Millisecond timestamp
updateTime	Long	true	Millisecond timestamp

Example Response

{
  "merchantOrderNo": "13243897979979797999008085",
  "orderNo": "WORK-202508071953472304731676672",
  "title": "ApplePay",
  "target": "5533700042831234",
  "content": "Active",
  "tradeType": "CARD_ACTIVE",
  "tradeStatus": "processing",
  "remark": null,
  "createTime": 1754607865000,
  "updateTime": 1754648044000
}

Work Order List

POST /merchant/core/mcb/work/list

Request

param	Type	Required	Remark
merchantOrderNo	String	false	Merchant order number
orderNo	String	false	Platform order number
target	String	false	Target
tradeType	String	false	Type. CARD_ACTIVE: Card activation; OTHER: Other
tradeStatus	String	false	Status. wait_process: pending; processing: processing; success: success; fail: failure

Response

Param	Type	Required	Remark
merchantOrderNo	String	true	Merchant order number
orderNo	String	true	Platform order number
title	String	true	title
target	String	true	Target
content	String	false	Content
tradeType	String	true	Type. CARD_ACTIVE: Card activation; OTHER: Other
tradeStatus	String	true	Status. wait_process: pending; processing: processing; success: success; fail: failure
remark	String	false	Remark
createTime	Long	true	Millisecond timestamp
updateTime	Long	true	Millisecond timestamp

Example Response

{
  "success": true,
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "total": 1,
    "records": [
      {
        "merchantOrderNo": "13243897979979797999008085",
        "orderNo": "WORK-202508071953472304731676672",
        "title": "ApplePay",
        "target": "5533700042831234",
        "content": "Active",
        "tradeType": "CARD_ACTIVE",
        "tradeStatus": "processing",
        "remark": null,
        "createTime": 1754607865000,
        "updateTime": 1754648044000
      }
    ]
  }
}