API REFERENCE
Enviar uma declaração aduaneira
Parâmetros
| Parameter | Type | Descrição | Obrigatório |
|---|---|---|---|
| data.trade_id | string | YabandPay交易ID | ✓ |
| data.customs | string | 海关名称 | ✓ |
| data.mch_customs_no | string | 商户海关备案号 | ✓ |
| data.mch_name | string | 商户海关备案名称 | ✓ |
| data.duty | integer | 关税,单位(分),不会提交给海关 | — |
| data.action_type | string | 报关类型,ADD 新增 MODIFY 修改,默认ADD 新增 | — |
| data.sub_order_no | string | 商户子订单号 | — |
| data.currency | string | 报关的币种建议CNY | — |
| data.order_fee | integer | 子订单金额(通过QueryOrder获取订单总金额amount_cny),order_fee=transport_fee+product_fee | — |
| data.transport_fee | integer | 子订单物流金额,单位(分) | — |
| data.product_fee | integer | 子订单商品价格,单位(分) | — |
| data.cert_type | string | 证件类型,请传固定值IDCARD,暂只支持大陆身份证 | — |
| data.cert_id | string | 证件号码,用户大陆身份证号,尾号为字母X的身份证号,请大写字母X | — |
| data.name | string | 用户姓名 | — |
Dica
Observação:
- 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.
- 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.
- 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.
- Os valores na API de declaração aduaneira são expressos em fen.
- 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âmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| user | String | UID da conta de caixa ou de superadministrador | Obrigatório |
| sign | String | Signature | Obrigatório |
| method | String | v3.CustomDeclareOrder | Obrigatório |
| time | Long | Timestamp | Obrigatório |
- Parameters
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| trade_id | String | ID da transação YabandPay | Obrigatório |
| customs | String | Nome da alfândega | Obrigatório |
| mch_customs_no | String | Número de registro aduaneiro do estabelecimento | Obrigatório |
| mch_name | String | Nome do estabelecimento registrado na alfândega | Obrigatório |
| duty | Int | Imposto aduaneiro em fen; não enviado à alfândega | Opcional |
| action_type | String | Ação da declaração: ADD para adicionar, MODIFY para modificar; o padrão é ADD | Opcional |
| sub_order_no | String | Número de subpedido do estabelecimento | Opcional (obrigatório para pedidos divididos) |
| currency | String | Moeda da declaração; recomenda-se CNY | Opcional (obrigatório para pedidos divididos) |
| order_fee | Int | Valor do subpedido (obtenha o valor total do pedido amount_cny por meio de QueryOrder), order_fee=transport_fee+product_fee | Opcional (obrigatório para pedidos divididos) |
| transport_fee | Int | Valor do frete do subpedido em fen | Opcional (obrigatório para pedidos divididos) |
| product_fee | Int | Preço dos produtos do subpedido em fen | Opcional (obrigatório para pedidos divididos) |
| cert_type | String | Tipo de documento de identidade; informe o valor fixo IDCARD. Atualmente, são aceitos apenas documentos de identidade da China continental. | Opcional |
| cert_id | String | Nú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 |
| name | String | Nome do usuário | Opcional |
customs field values:
WeChat Pay customs declaration values
| Campo | Descrição |
|---|---|
| GUANGZHOU_ZS | Guangzhou (General Administration version) |
| GUANGZHOU_HP_GJ | Guangzhou Huangpu Inspection and Quarantine |
| GUANGZHOU_NS_GJ | Guangzhou Nansha Inspection and Quarantine |
| HANGZHOU_ZS | Hangzhou (General Administration version) |
| NINGBO | Ningbo |
| ZHENGZHOU_BS | Zhengzhou (Bonded Logistics Center) |
| CHONGQING | Chongqing |
| SHANGHAI_ZS | Shanghai (General Administration version) |
| SHENZHEN | Shenzhen |
| ZHENGZHOU_ZH_ZS | Zhengzhou Comprehensive Bonded Zone (General Administration version) |
| TIANJIN | Tianjin |
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
| Campo | Descrição |
|---|---|
| ZONGSHU | General Administration of Customs of China |
| ZHENGZHOU | Zhengzhou |
| NINGBO | Ningbo |
| SHANGHAI_CBT | Shanghai |
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:
| Status | Descrição |
|---|---|
| UNDECLARED | Não declarada (a declaração foi enviada e aguarda o processamento aduaneiro; não é necessário reenviá-la) |
| SUBMITTED | Declaraçã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) |
| PROCESSING | Declaração em andamento |
| SUCCESS | Declaração concluída com sucesso |
| FAIL | Falha na declaração |
| EXCEPT | Erro na API aduaneira |
