Documentação/Referência da API

API REFERENCE

Enviar uma declaração aduaneira

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

Enviar uma declaração aduaneira

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.

Parâmetros

ParameterTypeDescriçãoObrigatório
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用户姓名—

Dica

Observação:

  1. Cada pedido pode ter apenas um registro de pedido não dividido e vários registros de pedidos divididos. Registros de pedidos divididos com o mesmo sub_order_no (número de subpedido do estabelecimento) são tratados como o mesmo registro.
  1. Para modificar as informações da declaração aduaneira, defina action_type como MODIFY. Só é possível modificar o número de registro do estabelecimento, o nome registrado, o código e o valor aduaneiros e as informações do documento de identidade do usuário. Para registros de pedidos divididos, envie sub_order_no para identificar o registro a modificar.
  1. Se uma transação já tiver sido enviada para declaração aduaneira, mas o portal eletrônico perder o pedido, use a API de reenvio. Ao reenviar, mantenha igual ao pedido original o número de referência da declaração aduaneira.
  1. Os valores na API de declaração aduaneira são expressos em fen.
  1. A moeda da declaração aduaneira é CNY (o valor pago pelo usuário em CNY), que pode ser obtida por meio de Order query.
ParâmetroTipoDescriçãoObrigatório
userStringUID da conta de caixa ou de superadministradorObrigatório
signStringSignatureObrigatório
methodStringv3.CustomDeclareOrderObrigatório
timeLongTimestampObrigatório
  • Parameters
ParâmetroTipoDescriçãoObrigatório
trade_idStringID da transação YabandPayObrigatório
customsStringNome da alfândegaObrigatório
mch_customs_noStringNúmero de registro aduaneiro do estabelecimentoObrigatório
mch_nameStringNome do estabelecimento registrado na alfândegaObrigatório
dutyIntImposto aduaneiro em fen; não enviado à alfândegaOpcional
action_typeStringAção da declaração: ADD para adicionar, MODIFY para modificar; o padrão é ADDOpcional
sub_order_noStringNúmero de subpedido do estabelecimentoOpcional (obrigatório para pedidos divididos)
currencyStringMoeda da declaração; recomenda-se CNYOpcional (obrigatório para pedidos divididos)
order_feeIntValor do subpedido (obtenha o valor total do pedido amount_cny por meio de QueryOrder), order_fee=transport_fee+product_feeOpcional (obrigatório para pedidos divididos)
transport_feeIntValor do frete do subpedido em fenOpcional (obrigatório para pedidos divididos)
product_feeIntPreço dos produtos do subpedido em fenOpcional (obrigatório para pedidos divididos)
cert_typeStringTipo de documento de identidade; informe o valor fixo IDCARD. Atualmente, são aceitos apenas documentos de identidade da China continental.Opcional
cert_idStringNúmero do documento de identidade: número do documento de identidade do usuário da China continental. Se o número terminar em X, use X maiúsculo.Opcional
nameStringNome do usuárioOpcional

customs field values:

WeChat Pay customs declaration values

CampoDescrição
GUANGZHOU_ZSGuangzhou (General Administration version)
GUANGZHOU_HP_GJGuangzhou Huangpu Inspection and Quarantine
GUANGZHOU_NS_GJGuangzhou Nansha Inspection and Quarantine
HANGZHOU_ZSHangzhou (General Administration version)
NINGBONingbo
ZHENGZHOU_BSZhengzhou (Bonded Logistics Center)
CHONGQINGChongqing
SHANGHAI_ZSShanghai (General Administration version)
SHENZHENShenzhen
ZHENGZHOU_ZH_ZSZhengzhou Comprehensive Bonded Zone (General Administration version)
TIANJINTianjin

TIANJIN (Para enviar um pedido à alfândega de Tianjin, configure no portal de gestão do estabelecimento as informações de registro da alfândega de Tianjin e da inspeção e quarentena de Tianjin. Ao chamar a API de declaração aduaneira, envie apenas para a alfândega de Tianjin, usando uma única solicitação de API.)

Alipay customs declaration values

CampoDescrição
ZONGSHUGeneral Administration of Customs of China
ZHENGZHOUZhengzhou
NINGBONingbo
SHANGHAI_CBTShanghai

Signature example:

Parâmetros ordenados concatenados em uma cadeia de consulta no formato de 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"

Sign stringA using secret_key

A assinatura resultante é:

"YOUR_SIGNATURE"

Request example:

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

Customs declaration response example:

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

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