Documentação/Referência da API

API REFERENCE

Consultar uma declaração aduaneira

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

Consultar uma declaração aduaneira

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

ParameterTypeDescriçãoObrigatório
data.trade_idstringYabandPay交易ID✓
data.customsstring海关名称✓

Os estabelecimentos consultam as informações de declarações aduaneiras enviadas usando o número do pedido.

ParâmetroTipoDescriçãoObrigatório
userStringUID da conta de caixa ou de superadministradorObrigatório
signStringSignatureObrigatório
methodStringv3.CustomDeclareQueryObrigatório
timeLongTimestampObrigatório
  • Parameters
ParâmetroTipoDescriçãoObrigatório
trade_idStringID da transação YabandPayObrigatório
customsStringNome da alfândegaObrigatório

Signature example:

Parâmetros ordenados concatenados em uma cadeia de consulta no formato de URL

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

Sign stringA using secret_key

A assinatura resultante é:

"YOUR_SIGNATURE"

Request example:

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

Response example:

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

StatusDescrição
UNDECLAREDNão declarada (a declaração foi enviada e aguarda o processamento aduaneiro; não é necessário reenviá-la)
SUBMITTEDDeclaração enviada (este status é registrado quando o pedido foi enviado à alfândega, o estabelecimento envia uma nova declaração e a alfândega disponibiliza uma API de alteração)
PROCESSINGDeclaração em andamento
SUCCESSDeclaração concluída com sucesso
FAILFalha na declaração
EXCEPTErro na API aduaneira