计算税费

用于根据指定国家/地区计算适用税费，并返回税费明细及更新后的价格。

前置条件

在接入 Codapay 的 API 时，请确保遵循以下规范：

• 使用 HTTPS 协议

• 使用 TLS 1.2 或更高版本

参考信息

环境	接口基本网址
沙盒环境	https://tc-api-card-sandbox.codapayments.com/v1/
正式环境	https://api-tc.codapayments.com/v1/

接口：

POST {基本网址}/tax-calculations

当前环境可用性：

环境	是否可用
沙盒环境	是
正式环境	是

Codapay 的 API 支持 REST 网页服务。默认情况下，显示的端点均为 RESTful 格式。

请求参数说明

参数名称	数据类型	描述	限制条件	必填 (?)
amount_value	Integer	扣款金额	无	是
amount_currency	String	扣款币种	仅限指定国家的币种	是
country_code	String	用于计算税费的国家代码	必须为有效的 ISO 3166-1 alpha-2 国家代码	是
tax_code	String	商品的税码	当前支持的税码：CD010001 - 数字商品：游戏 / 串流 / 电子下载	是
address	JSON 对象	用于税费计算的邮政编码信息	当 country_code 为 US 或 CA 时必填	否
is_exclusive	Boolean	是否为未含税金额，默认为未含税	无	否

address

参数名称	数据类型	描述	限制条件	必填 (?)
zip_code	String	用于计算税费的邮政编码	必须为有效的邮政编码	否
province_code	String	用于计算税费的省份代码（仅限加拿大）	必须为两位字母的省份代码	否

响应参数说明

参数名称	数据类型	描述
id	String	税费计算的唯一标识符
amount_value	Integer	扣款金额
amount_currency	String	扣款币种
country_code	String	用于税费计算的国家代码
tax_code	String	用于税费计算的税码
address	JSON 对象	用于税费计算的地址详情
is_exclusive	Boolean	表示发送的金额是否为未含税，默认认为是未含税
calculation	JSON 对象	税费计算的结果
status_code	String	税费计算的状态码

address

参数名称	数据类型	描述
zip_code	String	用于税费计算的邮政编码

calculation

参数名称	数据类型	描述
taxable_amount	String	应税金额
tax_amount	String	计算出的税额
total_amount	String	应税金额与税额的总和
tax_rate	String	所应用的税率