5進件接口
請求 url 請諮詢 SwiftPass 技術支持([email protected])
5.1 商戶(大商戶,普通商戶)新增接口
5.1.1 服務名稱
服務名稱:mch_add_gateway
5.1.2 請求參數
商戶基本資訊(Merchant 對象)
字段名 | 變數名 | 必填 | 類型 | 說明 |
---|---|---|---|---|
商戶名稱 | merchantName | 是 | String(128) | UTF-8 編碼後最長允許 128 位 |
外商戶號 | outMerchantId | 是 | String(64) | 合作夥伴系統內部的商戶號,確保唯一 |
幣種 | feeType | 是 | String(12) | CNY:人民幣;USD:美元; EUR:歐元;HKD:港幣; |
結算規則 | settlementRule | 是 | String(1) | 1-按週期 2 按起結點 |
起結金額 | startPoint | 是 | String(20) | 結算規則為 2,則必填(起結金額為整數) |
所屬管道 | channelId | 是 | String(32) | |
商戶類型 | merchantType | 是 | String(4) | 11:大商戶 12:普通商戶 |
商戶詳情 | merchantDetail | 是 | MerchantDetail | 具體值請參看商戶詳情對象 |
銀行帳戶 | bankAccount | 是 | BankAccount | 具體值請參看銀行帳戶對象 |
商戶支付類型資訊 | mchPayConfSwitchs | 是 | List<MchPayConfSwitch> | 具體值請參看商戶支付類型對象 |
商戶詳情資訊(MerchantDetail 對象)
字段名 | 變數名 | 必填 | 類型 | 說明 |
---|---|---|---|---|
商戶簡稱 | merchantShortName | 是 | String(128) | UTF-8 編碼後最長允許 128 位 |
行業類別 | industrId | 是 | Int | |
客服電話 | customerPhone | 是 | String(128) | |
所在地 | address | 是 | String(128) | |
聯繫人郵箱 | 是 | String(64) | 不能有-等特殊字元 | |
聯繫人姓名 | principal | 是 | String(32) | |
聯繫人電話 | principalMobile | 是 | String(11) | |
證件類型 | cardType | 是 | String(1) | 證件類型:默認為 1 (1-身份證 2-護照.) |
商戶支付類型資訊(MchPayConfSwitch 對象)
字段名 | 變數名 | 必填 | 類型 | 說明 |
---|---|---|---|---|
支付開關 | isClose | 是 | String(1) | 是否開啟 0 關閉 1 開啟() |
支付費率 | payRateFt | 是 | Float | 商戶結算費率,參數單位為‰,如商戶費率為 6‰,則報文值為 6。 |
支付商戶號 | payMerchant | 是 | String(32) | 第三方交易識別碼 |
所屬支付類型 | payCenterId | 是 | String(10) |
銀行帳戶資訊(BankAccount 對象)
字段名 | 變數名 | 必填 | 類型 | 說明 |
---|---|---|---|---|
銀行卡號 | accountCode | 是 | String | 必須是數字 |
開戶銀行 | bankId | 是 | Int | 值請參考銀行編號附件 |
開戶人 | accountName | 是 | String | |
帳戶類型 | accountType | 是 | Int | 1:企業 ;2:個人 |
開戶支行名稱 | bankName | 是 | String(32) | |
SWIFT CODE | swiftCode | 否 | String(64) |
5.1.3 請求格式
XML 請求格式
<?xml version="1.0" encoding="UTF-8"?>
<merchant>
<merchantName>測試商戶001</merchantName>
<outMerchantId>10000001</outMerchantId>
<feeType>CNY</feeType>
<settlementRule>1</settlementRule>
<merchantType>11</merchantType>
<channelId>11</channelId>
<merchantDetail>
<merchantShortName>大商戶001</merchantShortName>
<industrId>11</industrId>
<address>測試地址</address>
<email>[email protected]</email>
<customerPhone>13434726544</customerPhone>
<cardType>1</cardType>
<principal>張三</principal>
<principalMobile>13434726531</principalMobile>
</merchantDetail>
<bankAccount>
<bankId>1</bankId>
<accountCode>123455678</accountCode>
<accountName>張三</accountName>
<accountType>2</accountType>
<bankName>工商銀行</bankName>
<swiftCode>123</swiftCode>
</bankAccount>
<mchPayConfSwitchs>
<mchPayConfSwitch>
<payCenterId>197</payCenterId>
<isClose>1</isClose>
<payRateFt>6</payRateFt>
<payMerchant>2333</payMerchant>
</mchPayConfSwitch>
<mchPayConfSwitch>
<payCenterId>888</payCenterId>
<isClose>1</isClose>
<payRateFt>6</payRateFt>
<payMerchant>2334</payMerchant>
</mchPayConfSwitch>
</mchPayConfSwitchs>
</merchant>
5.1.4 返回參數
字段名 | 變數名 | 必填 | 類型 | 說明 |
---|---|---|---|---|
威 富 通 商 戶號 | merchantId | 是 | String(32) |
5.1.5 返回格式
Xml 返回格式
<?xml version="1.0" encoding="UTF-8"?>
<response>
<isSuccess>T</isSuccess>
<merchant> <merchantId>113530000187</merchantId>
</merchant>
</response>
5.2 商戶(大商戶,普通商戶)編輯接口
5.2.1 服務名稱
服務名稱:mch_edit_gateway
5.2.2 請求參數
商戶基本資訊(Merchant 對象)
字段名 | 變數名 | 必填 | 類型 | 說明 |
---|---|---|---|---|
威 富 通 商 戶號 | merchantId | 是 | String(32) | |
商戶名稱 | merchantName | 否 | String(128) | UTF-8 編碼後最長允許 128 位 |
外商戶號 | outMerchantId | 否 | String(64) | 合作夥伴系統內部的商戶號,確保唯一 |
結算規則 | settlementRule | 否 | String(1) | 1-按週期 2 按起結點 |
起結金額 | startPoint | 否 | String(20) | 結算規則為 2,則必填(起結金額為整數) |
商戶詳情 | merchantDetail | 否 | MerchantDetail | 具體值請參看商戶詳情對象 |
銀行帳戶 | bankAccount | 否 | BankAccount | 具體值請參看銀行帳戶對象 |
商戶支付類型資訊 | mchPayConfSwitchs | 否 | Listt<MchPayConfSwitch> | 具體值請參看商戶支付類型對象 |
商戶詳情資訊(MerchantDetail 對象)只能修改自己的,不能修改繼承的
字段名 | 變數名 | 必填 | 類型 | 說明 |
---|---|---|---|---|
商戶簡稱 | merchantShortName | 否 | String(128) | UTF-8 編碼後最長允許 128 位 |
行業類別 | industrId | 否 | Int | |
客服電話 | customerPhone | 否 | String(128) | |
所在地 | address | 否 | String(128) | |
聯繫人郵箱 | 否 | String(64) | ||
聯繫人姓名 | principal | 否 | String(32) | |
聯繫人電話 | principalMobile | 否 | String(11) | |
證件類型 | cardType | 否 | String(1) | 證件類型:默認為 1 (1-身份證 2-護照.) |
商戶支付類型資訊(MchPayConfSwitch 對象)
字段名 | 變數名 | 必填 | 類型 | 說明 |
---|---|---|---|---|
支付開關 | isClose | 否 | String(1) | 是否開啟 0 關閉 1 開啟 |
支付費率 | payRateFt | 否 | Float | 商戶結算費率,參數單位為‰,如商戶費 率為 6‰,則報文值為 6。 |
支付商戶號 | payMerchant | 否 | String(32) | 第三方交易識別碼 |
所屬支付類型 | payCenterId | 否 | String(10) |
銀行帳戶資訊(BankAccount 對象)
字段名 | 變數名 | 必填 | 類型 | 說明 |
---|---|---|---|---|
銀行卡號 | accountCode | 否 | String(32) | 必須是數字 |
開戶銀行 | bankId | 否 | Int | 值請參考銀行編號附件 |
開戶人 | accountName | 否 | String(128) | |
帳戶類型 | accountType | 否 | Int | 1:企業 ;2:個人 |
開戶支行名稱 | bankName | 否 | String(32) | |
SWIFTCODE | swiftCode | 否 | String(64) |
5.2.3 請求格式
XML 請求格式
<?xml version="1.0" encoding="UTF-8"?>
<merchant>
<merchantId>113530000187</merchantId>
<merchantName>測試商戶001</merchantName>
<outMerchantId>10000001</outMerchantId>
<feeType>CNY</feeType>
<settlementRule>1</settlementRule>
<merchantType>11</merchantType>
<channelId>11</channelId>
<merchantDetail>
<merchantShortName>大商戶001</merchantShortName>
<industrId>11</industrId>
<address>測試地址</address>
<email>[email protected]</email>
<customerPhone>13434726544</customerPhone>
<cardType>1</cardType>
<principal>張三</principal>
<principalMobile>13434726531</principalMobile>
</merchantDetail>
<bankAccount>
<bankId>1</bankId>
<accountCode>123455678</accountCode>
<accountName>張三</accountName>
<accountType>2</accountType>
<bankName>工商銀行</bankName>
<swiftCode>123</swiftCode>
</bankAccount>
<mchPayConfSwitchs>
<mchPayConfSwitch>
<payCenterId>197</payCenterId>
<isClose>1</isClose>
<payRateFt>6</payRateFt>
<payMerchant>2333</payMerchant>
</mchPayConfSwitch>
<mchPayConfSwitch>
<payCenterId>888</payCenterId>
<isClose>1</isClose>
<payRateFt>6</payRateFt><payMerchant>2334</payMerchant>
</mchPayConfSwitch>
</mchPayConfSwitchs>
</merchant>
5.2.4 返回格式
Xml 返回格式
<?xml version="1.0" encoding="UTF-8"?>
<response>
<isSuccess>T</isSuccess>
</response>
5.3 門店新增接口
5.3.1 服務名稱
服務名稱:store_mch_add_gateway
5.3.2 請求參數
商戶基本資訊(Merchant 對象)
字段名 | 變數名 | 必填 | 類型 | 說明 |
---|---|---|---|---|
商戶名稱 | merchantName | 是 | String(128) | UTF-8 編碼後最長允許 128 位 |
父商戶號 | parentMerchant | 是 | String(32) | |
外商戶號 | outMerchantId | 是 | String(64) | 合作夥伴系統內部的商戶號,確保唯一 |
銀行帳戶 | bankAccount | 是 | String(32) | 具體值請參看銀行帳戶對象 |
銀行帳戶資訊(BankAccount 對象)
字段名 | 變數名 | 必填 | 類型 | 說明 |
---|---|---|---|---|
銀行卡號 | accountCode | 是 | String(32) | 必須是數字 |
開戶銀行 | bankId | 是 | Int | 值請參考銀行編號附件 |
開戶人 | accountName | 是 | String(128) | |
帳戶類型 | accountType | 是 | Int 1:企業 ;2: | |
個人開戶支行名稱 | bankName | 是 | String(32) | |
SWIFT CODE | swiftCode | 否 | String(64) |
5.3.3 請求格式
XML請求格式
<?xml version="1.0" encoding="UTF-8"?>
<merchant>
<merchantName>測試商戶001</merchantName>
<outMerchantId>10000001</outMerchantId>
<parentMerchant>157540000001</parentMerchant>
<bankAccount>
<bankId>1</bankId>
<accountCode>123455678</accountCode>
<accountName>張三</accountName>
<accountType>2</accountType>
<bankName>工商銀行</bankName>
<swiftCode>123</swiftCode>
</bankAccount> </merchant>
5.3.4 返回參數
字段名 | 變數名 | 必填 | 類型 | 說明 |
---|---|---|---|---|
威富通商戶號 | merchantId | 是 | String(32) |
5.3.5 返回格式
XML 返回格式
<?xml version="1.0" encoding="UTF-8"?>
<response>
<isSuccess>T</isSuccess>
<merchant>
<merchantId>113550000206</merchantId>
</merchant>
</response>
5.4 門店編輯接口
5.4.1 服務名稱
服務名稱:store_mch_edit_gateway
5.4.2 請求參數
商戶基本資訊(Merchant 對象)
字段名 | 變數名 | 必填 | 類型 | 說明 |
---|---|---|---|---|
威富通商戶號 | merchantId | 是 | String(32) | |
商戶名稱 | merchantName | 是 | String(128) | UTF-8 編碼後最長允許 128 位 |
父商戶號 | parentMerchant | 是 | String(32) | |
外商戶號 | outMerchantId | 是 | String(64) | 合作夥伴系統內部的商戶號,確保唯一 |
銀行帳戶 | bankAccount | 是 | BankAccount | 具體值請參看銀行帳戶對象 |
銀行帳戶資訊(BankAccount 對象)
字段名 | 變數名 | 必填 | 類型 | 說明 |
---|---|---|---|---|
銀行卡號 | accountCode | 否 | String(32) | 必須是數字 |
開戶銀行 | bankId | 否 | Int | 值請參考銀行編號附件 |
開戶人 | accountName | 否 | String(128) | |
帳戶類型 | accountType | 否 | Int | 1:企業 ;2:個人 |
開戶支行名稱 | bankName | 否 | String(32) | |
SWIFTCODE | swiftCode | 否 | String(64) |
5.4.3 請求格式
XML 請求格式
<?xml version="1.0" encoding="UTF-8"?>
<merchant>
<merchantId>101530000076</merchantId>
<merchantName>測試商戶001</merchantName>
<outMerchantId>10000001</outMerchantId>
<parentMerchant>157540000001</parentMerchant>
<bankAccount>
<bankId>1</bankId>
<accountCode>123455678</accountCode>
<accountName>張三</accountName>
<accountType>2</accountType>
<bankName>工商銀行</bankName>
<swiftCode>123</swiftCode>
</bankAccount>
</merchant>
5.4.4 返回格式
XML返回格式
<?xml version="1.0" encoding="UTF-8"?>
<response>
<isSuccess>T</isSuccess>
</response>
5.5 商戶、門店查詢接口
5.5.1 服務名稱
服務名稱:mch_find_gateway
5.5.2 請求參數
商戶基本資訊(Merchant 對象)
字段名 | 變數名 | 必填 | 類型 | 說明 |
---|---|---|---|---|
威富通商戶號 | merchantId | 否 | String(32) | |
外商戶號 | outMerchantId | 是 | String(64) | 合作夥伴系統內部的商戶號,確保唯一 |
5.5.3 請求格式
XML請求格式
<?xml version="1.0" encoding="UTF-8"?>
<merchant>
<merchantId>101530000076</merchantId>
<outMerchantId>10000001</outMerchantId>
</merchant>
5.5.4 返回格式
XML返回格式
<?xml version="1.0" encoding="UTF-8"?>
<response>
<isSuccess>T</isSuccess>
</response>