customs_declare
Declare payments to customs or update existing declarations with order details, merchant codes, and split options.
Instructions
The tool is used by the Acquiring Service Provider (ACQP) to declare a payment to customs or update an existing declaration.
Args:
payment_request_id: The unique ID that is assigned by the ACQP to identify a payment request for the order.Maximum length: 64 characters
customs_declaration_request_id: The unique ID that is assigned by the merchant to identify a customs declaration request. This parameter is not provided for the customs. Maximum length: 64 characters
declaration_amount_value: The customs declaration amount as a natural number.Value range: 1 - unlimited
customs_code: The customs code (in either uppercase or lowercase). Maximum length: 128 characters
merchant_customs_code: The merchant code that is registered in the customs system. Maximum length: 128 characters
merchant_customs_name: The merchant name that is registered in the customs system. Maximum length: 256 characters
is_split: This parameter indicates whether the payment order needs to be split for declaration. Valid values are:
true: indicates that order splitting is needed.
false: indicates that order splitting is not needed.
reference_order_id: The unique ID that is assigned by the merchant to identify an order that needs to be declared to the customs. Maximum length: 64 characters
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| is_split | Yes | ||
| customs_code | Yes | ||
| payment_request_id | Yes | ||
| reference_order_id | Yes | ||
| merchant_customs_code | Yes | ||
| merchant_customs_name | Yes | ||
| declaration_amount_value | Yes | ||
| customs_declaration_request_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |