Documentatie/API-referentie

API REFERENCE

Een douaneaangifte opvragen

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

Een douaneaangifte opvragen

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

Request parameters2

Required fields first

海关申报查询

trade_idRequiredstringdata.trade_idYabandPay交易ID
customsRequiredstringdata.customs海关名称

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

Merchants kunnen met het ordernummer de ingediende douaneaangiftegegevens opvragen.

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

Methode:POST

POST gegevenstype:Json

ParameterTypeBeschrijvingVerplicht
userStringUID van het kassier- of superbeheerderaccountVerplicht
signStringSignatureVerplicht
methodStringv3.CustomDeclareQueryVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
trade_idStringYabandPay-transactie-IDVerplicht
customsStringNaam van de douane-instantieVerplicht

Voorbeeld van een handtekening:

Parameters op volgorde samengevoegd tot een querystring in URL-stijl

"customs=NINGBO&method=v3.CustomDeclareQuery&time=1560499094&trade_id=dd11d082-810d-c8b7-3669-b784c466759b&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.CustomDeclareQuery",
	"time": 1560753647,
	"data": {
		"trade_id": "847b175e-f8f4-d362-d078-52092b412b1c",   
		"customs": "NINGBO"	
	            }
}

Voorbeeld van een antwoord:

{
    "status": true,
    "code": "200",
    "data": {
        "data": [
            {
                "customs": "NINGBO",
                "duty": "",
                "fee_type": "EUR",
                "mch_customs_no": "31222699S7",
                "modify_time": "2024-06-19T08:21:18Z",
                "order_fee": "10",
                "product_fee": "10",
                "state": "SUCCESS",
                "sub_order_id": "e0721a7f957e8e55dfbb5c7bcb4441d6",
                "sub_order_no": "1234567890",
                "transport_fee": "0",
                "cert_check_result": "SAME"
            },
            {
                "customs": "NINGBO",
                "duty": "",
                "fee_type": "EUR",
                "mch_customs_no": "31222699S7",
                "modify_time": "2024-06-19T08:20:53Z",
                "order_fee": "10",
                "product_fee": "10",
                "state": "SUCCESS",
                "sub_order_id": "05cbd13d104bb4ea542cc66550d16ac8",
                "sub_order_no": "123456789",
                "transport_fee": "0",
                "cert_check_result": "SAME"
            }
        ]
    },
    "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