Documentation/Référence API

API REFERENCE

Soumettre une déclaration en douane

POSThttps://mapi.yabandpay.com/Payments
Live API
API PLAYGROUND · Live API

Soumettre une déclaration en douane

POSThttps://mapi.yabandpay.com/Payments
Automatically signed with your credentials

Request parameters14

Required fields first

海关申报提交

trade_idRequiredstringdata.trade_idYabandPay交易ID
customsRequiredstringdata.customs海关名称
mch_customs_noRequiredstringdata.mch_customs_no商户海关备案号
mch_nameRequiredstringdata.mch_name商户海关备案名称
Optional parameters 10
dutyOptionalintegerdata.duty关税,单位(分),不会提交给海关
action_typeOptionalstringdata.action_type报关类型,ADD 新增 MODIFY 修改,默认ADD 新增
sub_order_noComplete groupstringdata.sub_order_no商户子订单号选填(拆单时必传)
currencyComplete groupstringdata.currency报关的币种建议CNY选填(拆单时必传)
order_feeComplete groupintegerdata.order_fee子订单金额(通过QueryOrder获取订单总金额amount_cny),order_fee=transport_fee+product_fee选填(拆单时必传)
transport_feeComplete groupintegerdata.transport_fee子订单物流金额,单位(分)选填(拆单时必传)
product_feeComplete groupintegerdata.product_fee子订单商品价格,单位(分)选填(拆单时必传)
cert_typeOptionalstringdata.cert_type证件类型,请传固定值IDCARD,暂只支持大陆身份证
cert_idOptionalstringdata.cert_id证件号码,用户大陆身份证号,尾号为字母X的身份证号,请大写字母X
nameOptionalstringdata.name用户姓名

Credentials stay on this page. Your secret key is never stored or sent to the documentation server.

Paramètres

ParameterTypeDescriptionObligatoire
data.trade_idstringYabandPay交易ID✓
data.customsstring海关名称✓
data.mch_customs_nostring商户海关备案号✓
data.mch_namestring商户海关备案名称✓
data.dutyinteger关税,单位(分),不会提交给海关—
data.action_typestring报关类型,ADD 新增 MODIFY 修改,默认ADD 新增—
data.sub_order_nostring商户子订单号—
data.currencystring报关的币种建议CNY—
data.order_feeinteger子订单金额(通过QueryOrder获取订单总金额amount_cny),order_fee=transport_fee+product_fee—
data.transport_feeinteger子订单物流金额,单位(分)—
data.product_feeinteger子订单商品价格,单位(分)—
data.cert_typestring证件类型,请传固定值IDCARD,暂只支持大陆身份证—
data.cert_idstring证件号码,用户大陆身份证号,尾号为字母X的身份证号,请大写字母X—
data.namestring用户姓名—

Conseil

Remarque :

  1. Une commande ne peut comporter qu’un seul enregistrement de commande non fractionnée et plusieurs enregistrements de commandes fractionnées. Les enregistrements de commandes fractionnées ayant le même sub_order_no (numéro de sous-commande du marchand) sont considérés comme un seul et même enregistrement.
  1. Pour modifier les informations de déclaration en douane, définissez action_type sur MODIFY. Seules les informations suivantes peuvent être modifiées : le numéro d’enregistrement en douane du marchand, sa raison sociale enregistrée, le code des douanes et le montant, ainsi que les informations du document d’identité de l’utilisateur. Pour les commandes fractionnées, transmettez sub_order_no afin d’identifier l’enregistrement à modifier.
  1. Si une transaction a été soumise pour déclaration en douane, mais que le portail électronique a perdu la commande, utilisez l’API de renvoi. Lors du renvoi, conservez le même numéro de référence de déclaration en douane que dans la requête initiale.
  1. Les montants de l’API de déclaration en douane sont exprimés en fen.
  1. La devise de déclaration en douane est le CNY (montant payé par l’utilisateur en CNY), que vous pouvez obtenir via Consultation de commande.
ParamètreTypeDescriptionObligatoire
userStringUID du compte caissier ou super administrateurObligatoire
signStringSignatureObligatoire
methodStringv3.CustomDeclareOrderObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:--- |:--- |:--- |:--- | | trade_id | String | ID de transaction YabandPay | Obligatoire | | customs | String | Nom des douanes | Obligatoire | | mch_customs_no | String | Numéro d’enregistrement en douane du marchand | Obligatoire | | mch_name | String | Raison sociale du marchand enregistrée auprès des douanes | Obligatoire | | duty | Int | Droits de douane en fen ; non soumis aux douanes | Facultatif | | action_type | String | Action de déclaration : ADD pour ajouter, MODIFY pour modifier ; ADD par défaut | Facultatif | | sub_order_no | String | Numéro de sous-commande du marchand | Facultatif (obligatoire pour les commandes fractionnées) | | currency | String | Devise de déclaration ; CNY recommandé | Facultatif (obligatoire pour les commandes fractionnées) | | order_fee | Int | Montant de la sous-commande (récupérez le montant total de la commande amount_cny via QueryOrder), order_fee=transport_fee+product_fee | Facultatif (obligatoire pour les commandes fractionnées) | | transport_fee | Int | Frais d’expédition de la sous-commande en fen | Facultatif (obligatoire pour les commandes fractionnées) | | product_fee | Int | Prix des produits de la sous-commande en fen | Facultatif (obligatoire pour les commandes fractionnées) | | cert_type | String | Type de document d’identité ; transmettez la valeur fixe IDCARD. Seules les cartes d’identité de Chine continentale sont actuellement prises en charge. | Facultatif | | cert_id | String | Numéro du document d’identité : numéro de la carte d’identité de Chine continentale de l’utilisateur. Si le numéro se termine par X, utilisez un X majuscule. | Facultatif | | name | String | Nom de l’utilisateur | Facultatif |

Valeurs des champs douaniers :

Valeurs de déclaration en douane pour WeChat Pay

ChampDescription
GUANGZHOU_ZSGuangzhou (version de l’Administration générale)
GUANGZHOU_HP_GJInspection et quarantaine de Guangzhou Huangpu
GUANGZHOU_NS_GJInspection et quarantaine de Guangzhou Nansha
HANGZHOU_ZSHangzhou (version de l’Administration générale)
NINGBONingbo
ZHENGZHOU_BSZhengzhou (centre logistique sous douane)
CHONGQINGChongqing
SHANGHAI_ZSShanghai (version de l’Administration générale)
SHENZHENShenzhen
ZHENGZHOU_ZH_ZSZone franche intégrée de Zhengzhou (version de l’Administration générale)
TIANJINTianjin

TIANJIN (Pour envoyer une commande aux douanes de Tianjin, configurez les informations d’enregistrement des douanes et de l’inspection et quarantaine de Tianjin dans le portail de gestion des marchands. Lors de l’appel à l’API de déclaration en douane, envoyez la déclaration uniquement aux douanes de Tianjin, en une seule requête API.)

Valeurs de déclaration en douane pour Alipay

ChampDescription
ZONGSHUAdministration générale des douanes de Chine
ZHENGZHOUZhengzhou
NINGBONingbo
SHANGHAI_CBTShanghai

Exemple de signature :

Paramètres triés et concaténés dans une chaîne de requête au format URL

"customs=NINGBO&mch_customs_no=3302462090&mch_name=宁波保税区嘉里大通物流有限公司&method=v3.CustomDeclareOrder&time=1560499094&trade_id=4760a968-4c5d-1e7e-3b88-89641af6e041&user=YOUR_CASHIER_UID"

Signer stringA avec secret_key

La signature obtenue est :

"YOUR_SIGNATURE"

Exemple de requête :

{
	"user": "YOUR_CASHIER_UID",
	"sign": "YOUR_SIGNATURE",
	"method": "v3.CustomDeclareOrder",
	"time": 1560499094,
	"data": {
		"trade_id": "4760a968-4c5d-1e7e-3b88-89641af6e041",
		"customs": "NINGBO",
        "mch_customs_no": "3302462090",
        "mch_name": "宁波保税区嘉里大通物流有限公司"
	}
}

Exemple de réponse de déclaration en douane :

{
    "status": true,
    "code": "200",
    "data": {
        "appid": "",
        "return_code":"SUCCESS",
        "result_code":"SUCCESS",
        "mchid": "3302462090",
        "out_trade_no": "4434a6e235e81cde4aee954c0031ad96",
        "state": "SUCCESS",
        "sub_order_id": "e0721a7f957e8e55dfbb5c7bcb4441d6",
        "sub_order_no": "1234567890",
        "transaction_id": "2024061922001467961423939655",
        "verify_department": "OTHERS",
        "verify_department_trade_id": "2024061922001467961423939655",
        "cert_check_result": "SAME", //Identity comparison between the purchaser and payer (UNCHECKED: purchaser identity not uploaded; SAME: uploaded purchaser identity matches payer identity; DIFFERENT: uploaded purchaser identity differs from payer identity)
        "transId": "20240619161756813048",
        "customs_declarations_id": "e0721a7f957e8e55dfbb5c7bcb4441d6"
    },
    "message": ""
}

États :

StatusDescription
UNDECLAREDNon déclarée (la déclaration a été soumise et attend son traitement par les douanes ; aucune nouvelle soumission n’est nécessaire)
SUBMITTEDDéclaration soumise (cet état est enregistré lorsque la commande a été envoyée aux douanes, que le marchand soumet une nouvelle déclaration et que les douanes fournissent une API de modification)
PROCESSINGDéclaration en cours de traitement
SUCCESSDéclaration effectuée avec succès
FAILÉchec de la déclaration
EXCEPTErreur de l’API des douanes