Customs declaration
The customs declaration is a resource used to collect information related to cross-border physical goods purchases for submission to the relevant customs authorities for faster and seamless processing.
The customs declaration object
Fields | |
id | string (UUID) The ID of the customs declaration object |
charge_id | string (UUID) The ID of the associated charge |
merchant_id | string (UUID) The ID of the associated merchant |
store_id | string (UUID) The ID of the associated store |
mode | string The mode of the associated charge |
gateway | string The gateway of the associated charge |
declaration | object The information provided by the merchant to be submitted to the customs authorities. Depending on the brand of the payment method used, the fields of the declaration object varies, but will be same as the fields passed in during creation. See the CREATE route for more details.The following brands are supported: – we_chat_online |
declaration_result | object The result of the declaration submitted to the customs authorities. |
declaration_result.approving_authority | string [Optional] The name of the approving customs authority. |
declaration_result.trade_id | string [Optional] The reference ID returned by the approving customs authority. |
declaration_result.transaction_id | string [Optional] The reference ID returned by the payments provider for the customs declaration transaction. |
declaration_result.charge_transaction_id | string [Optional] The reference ID returned by the payments provider for the charge transaction. |
status | string The status of the result of the declaration submitted to the customs authorities. One of: – pending – successful – failed – error |
created_on | string (ISO-8601) The date the customs declaration was created on |
error | object [Optional] Error details of the submission if any |
error.code | number The error code |
error.message | string The error message key |
error.details | object or null Short description of the error message |