CustomVersion 1.0.0

Create Declare ID

PUThttps://pay.globepay.co/api/v1.0/customs/partners/{partner_code}/declare/report/{client_report_id}

Used to submit the attachment information of the order required by the merchant. WeChat and Alipay are only supported. WeChat only supports payment orders within one month for customs declaration.

FieldDescription
Accept

application/json

Content-Type

application/json

Path Variable

FieldTypeDescription
partner_codeString

Required, Partner code

client_report_idString

Required, Client declare ID

JSON keys

FieldTypeDescription
order_idString

Required, Partner order id

customString

Required, Customs No. * Customs No.

mch_custom_idString

Required, Customs record id

mch_custom_nameString

Required, Customs record name

consumer_encrypt_idString

Optional,System encrypted keyid, View Get Encrypt Public Key

consumer_encrypt_infoJSONObject

Optional,Consumer user information encryption information

sub_orderJSON[]

Child orders

consumer_encrypt_info

FieldTypeDescription
consumer_nameString
consumer_id_noString

SUB_JSON

FieldTypeDescription
sub_order_noString

Child order ID

fee_typeString

Currency

Default value: CNY

Allowed values: CNY

order_feeDouble

Child Order Amount

transport_feeDouble

Child Order Logistics Amount

product_feeDouble

Child Order Product Amount

Query Params

FieldTypeDescription
timeLong

Required, UTC timestamp in milliseconds

nonce_strString

Required, Random string

signString

Required, Sign

Success 200

FieldTypeDescription
report_idString

GlobePay declare ID

client_report_idString

Client declare ID

report_statusString

Result status: PROCCESSING,SUBMITED,FAILED,SUCCESS

channelString

Channel

customString

Customs No.

mch_custom_noString

Customs record ID

mch_custom_nameString

Customs record name

order_idString

GlobePay Order ID

transaction_idString

Channel Order ID

order_currencyString

Currency

order_amountDouble

Order Amount

report_timeString

Declare Time

creation_dateString

Create Time

last_update_dateString

Update Time

error_codeString

Error Code

error_msgString

Error Description

Error Code

NameDescription
ORDER_MISMATCH

Order is not belong to this partner

SYSTEMERROR

Exception inside system

INVALID_SHORT_ID

Partner code is invalid or there is no partner associated with this code

SIGN_TIMEOUT

Sign expired, the difference between time and the server time is more than 5 minutes

INVALID_SIGN

Invalid sign

PARAM_INVALID

Parameters are invalid. See return_msg for more details.

NOT_PERMITTED

Gateway payment permission has not been enabled for this partner

INVALID_CHANNEL

Channel name is not available, check the Capitalize

ERROR

NameDescription
return_code

Error Code

return_msg

Error Description

PCI DSS Compliant

Security & Compliance

  • PCI DSSPayment Card Industry Data Security Standard compliant
  • TLS 1.2+API accepts TLS 1.2 / 1.3 encrypted connections only
  • SHA-256Every API request must carry a SHA-256 signature

On this page