Documentatie/API-referentie

API REFERENCE

Een douaneaangifte indienen

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

Een douaneaangifte indienen

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.

Tip

Opmerking:

  1. Per bestelling is er maximaal één record zonder splitsing en kunnen er meerdere records voor gesplitste bestellingen zijn. Records van gesplitste bestellingen met hetzelfde sub_order_no (subordernummer van de merchant) worden als hetzelfde record beschouwd.
  1. Stel action_type in op MODIFY om aangiftegegevens te wijzigen. Alleen het registratienummer van de merchant, de geregistreerde naam, de douanecode en het bedrag, en de identiteitsdocumentgegevens van de gebruiker kunnen worden gewijzigd. Geef bij gesplitste bestellingen sub_order_no mee om het te wijzigen record aan te duiden.
  1. Als een transactie voor douaneaangifte is ingediend maar de elektronische douanepoort de bestelling kwijt is, gebruikt u de API om de aangifte opnieuw te verzenden. Gebruik daarbij hetzelfde referentienummer voor de douaneaangifte als in de oorspronkelijke aanvraag.
  1. Bedragen in de douaneaangifte-API worden uitgedrukt in fen.
  1. De valuta voor de douaneaangifte is CNY (het door de gebruiker in CNY betaalde bedrag). U kunt deze ophalen via Order opvragen.

API-URL:https://mapi.yabandpay.com/Payments

Methode:POST

POST gegevenstype:Json

ParameterTypeBeschrijvingVerplicht
userStringUID van het kassier- of superbeheerderaccountVerplicht
signStringSignatureVerplicht
methodStringv3.CustomDeclareOrderVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
trade_idStringYabandPay-transactie-IDVerplicht
customsStringNaam van de douane-instantieVerplicht
mch_customs_noStringDouaneregistratienummer van de merchantVerplicht
mch_nameStringBij de douane geregistreerde naam van de merchantVerplicht
dutyIntDouanerecht in fen; niet ingediend bij de douaneOptioneel
action_typeStringAangiftehandeling: ADD om toe te voegen, MODIFY om te wijzigen; standaardwaarde is ADDOptioneel
sub_order_noStringSubordernummer van de merchantOptioneel (verplicht voor gesplitste bestellingen)
currencyStringValuta van de aangifte; CNY wordt aanbevolenOptioneel (verplicht voor gesplitste bestellingen)
order_feeIntBedrag van de suborder (haal het totale orderbedrag amount_cny op via QueryOrder), order_fee=transport_fee+product_feeOptioneel (verplicht voor gesplitste bestellingen)
transport_feeIntVerzendkosten van de suborder in fenOptioneel (verplicht voor gesplitste bestellingen)
product_feeIntProductprijs van de suborder in fenOptioneel (verplicht voor gesplitste bestellingen)
cert_typeStringType identiteitsdocument; geef de vaste waarde IDCARD door. Momenteel worden alleen Chinese identiteitskaarten van het Chinese vasteland ondersteund.Optioneel
cert_idStringNummer van het identiteitsdocument: het nummer van de Chinese identiteitskaart van de gebruiker. Eindigt het nummer op X, gebruik dan een hoofdletter X.Optioneel
nameStringNaam van de gebruikerOptioneel

Waarden voor douanevelden:

Douaneaangiftewaarden voor WeChat Pay

VeldBeschrijving
GUANGZHOU_ZSGuangzhou (versie van de Algemene Administratie van de Douane)
GUANGZHOU_HP_GJInspectie en quarantaine van Guangzhou Huangpu
GUANGZHOU_NS_GJInspectie en quarantaine van Guangzhou Nansha
HANGZHOU_ZSHangzhou (versie van de Algemene Administratie van de Douane)
NINGBONingbo
ZHENGZHOU_BSZhengzhou (douanelogistiekcentrum)
CHONGQINGChongqing
SHANGHAI_ZSShanghai (versie van de Algemene Administratie van de Douane)
SHENZHENShenzhen
ZHENGZHOU_ZH_ZSUitgebreide douanezone Zhengzhou (versie van de Algemene Administratie van de Douane)
TIANJINTianjin

TIANJIN (Als u een bestelling bij de douane van Tianjin wilt indienen, configureert u zowel de registratiegegevens bij de douane van Tianjin als die bij de inspectie- en quarantainedienst van Tianjin in het merchantbeheerportaal. Richt bij het aanroepen van de douaneaangifte-API één API-aanvraag uitsluitend aan de douane van Tianjin.)

Douaneaangiftewaarden voor Alipay

VeldBeschrijving
ZONGSHUAlgemene Administratie van de Douane van China
ZHENGZHOUZhengzhou
NINGBONingbo
SHANGHAI_CBTShanghai

Voorbeeld van een handtekening:

Parameters op volgorde samengevoegd tot een querystring in URL-stijl

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

Onderteken stringA met secret_key

De gegenereerde handtekening is:

"YOUR_SIGNATURE"

Voorbeeld van een aanvraag:

{
	"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": "宁波保税区嘉里大通物流有限公司"
	}
}

Voorbeeld van een antwoord op een douaneaangifte:

{
    "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": ""
}

Statussen:

StatusBeschrijving
UNDECLAREDNiet aangegeven (de aangifte is ingediend en wacht op douaneafhandeling; opnieuw indienen is niet nodig)
SUBMITTEDAangifte ingediend (deze status wordt geregistreerd nadat de bestelling naar de douane is verzonden, de merchant een nieuwe aangifte indient en de douane een wijzigings-API beschikbaar stelt)
PROCESSINGAangifte wordt verwerkt
SUCCESSAangifte geslaagd
FAILAangifte mislukt
EXCEPTFout in de douane-API