Documentación/Referencia de API

API REFERENCE

Consultar una declaración aduanera

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

Consultar una declaración aduanera

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.

Parámetros

ParameterTypeDescripciónObligatorio
data.trade_idstringYabandPay交易ID✓
data.customsstring海关名称✓

Los comercios consultan la información de una declaración aduanera presentada mediante el número de pedido.

ParámetroTipoDescripciónObligatorio
userStringUID de la cuenta de cajero o superadminestradorObligatorio
signStringSignatureObligatorio
methodStringv3.CustomDeclareQueryObligatorio
timeLongTimestampObligatorio
  • Parámetros
ParámetroTipoDescripciónObligatorio
trade_idStringID de transacción de YabandPayObligatorio
customsStringNombre de la aduanaObligatorio

Ejemplo de firma:

Parámetros ordenados y concatenados en una cadena de consulta con formato de URL

"customs=NINGBO&method=v3.CustomDeclareQuery&time=1560499094&trade_id=dd11d082-810d-c8b7-3669-b784c466759b&user=YOUR_CASHIER_UID"

Firme la cadena A con secret_key

La firma resultante es:

"YOUR_SIGNATURE"

Ejemplo de solicitud:

{
	"user": "YOUR_CASHIER_UID",
	"sign": "YOUR_SIGNATURE",
	"method": "v3.CustomDeclareQuery",
	"time": 1560753647,
	"data": {
		"trade_id": "847b175e-f8f4-d362-d078-52092b412b1c",   
		"customs": "NINGBO"	
	            }
}

Ejemplo de respuesta:

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

State estados:

StatusDescripción
UNDECLAREDUndeclared (the declaration has been submitted and is awaiting customs processing; no resubmission is needed)
SUBMITTEDDeclaration submitted (this status is recorded when the order has been sent to customs, the merchant submits a new declaration, and customs provides a modification API)
PROCESSINGDeclaration in progress
SUCCESSDeclaration successful
FAILDeclaration failed
EXCEPTCustoms API error