跳转至

创建税费方案

在发起包含税费方案的交易前，您需要先联系Liquido获取税费计划并拿到Plan ID。然后您需要使用这个Plan ID来创建税费方案，以获取proposal ID。 请注意，若您需要在方案里面包含除了换汇之外的其他目的方案，那么您需要通过创建多目的方案来创建方案。

HTTP请求

POST /v1/payments/proposals

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "amount": 100000,
    "country": "BR",
    "currency": "BRL",
    "taxPlanId": "f29d3d48-0806-41ca-b3ba-cdb4228d100d"
}
Response
{
    "id": "fa4dd852-2fbd-4d2d-8e71-10274885b3ea",
    "submitTime": "2023-10-07T06:32:14Z",
    "expirationTime": "2023-10-07T07:32:14Z",
    "paymentIntent": {
        "amount": 100000,
        "country": "BR",
        "currency": "BRL",
        "taxPlanId": "f29d3d48-0806-41ca-b3ba-cdb4228d100d"
    },
    "planDetails": {
        "tax": [
            {
                "modifierType": "RATE",
                "rate": 0.0038,
                "type": "BR_IOF_FX_TAX"
            }
        ]
    },
    "proposalDetails": {
        "taxProposalDetails": [
            {
                "taxRate": {
                    "modifierType": "RATE",
                    "rate": 0.0038,
                    "type": "BR_IOF_FX_TAX"
                },
                "amount": 380
            }
        ]
    }
}

HTTP Headers 字段说明

Key Value
Authorization "bearer" + " " + {{access_token}}
x-api-key {{api_key}}

Request Body 字段说明

参数 必填 类型 描述
amount Long 金额，单位是货币最小粒度。 如 1 = 0.01BRL
country String 国家编号国际缩写码，遵循ISO 3166-1 alpha-2 code标准, 如巴西BR
currency String 货币代码，如USD, BRL, MXN, COP, PEN或者CLP
taxPlanId String 税费计划ID

Response Body 字段说明

参数 类型 描述
id String 方案ID
submitTime String 方案提交时间
expirationTime String 方案过期时间
paymentIntent JSON 方案内容
planDetails JSON 计划详情
proposalDetails JSON 方案详情

对象字段说明

paymentIntent
参数 类型 描述
amount Long 金额，单位是货币最小粒度。 如 1 = 0.01BRL
country String 国家编号国际缩写码，遵循ISO 3166-1 alpha-2 code标准, 如巴西BR
currency String 货币代码
taxPlanId String 税费计划ID
planDetails
参数 类型 描述
tax JSON Array 税费计划详情
tax
参数 类型 描述
modifierType String 类型，RATE
rate Positive Float 税率
type String 税率类型
proposalDetails
参数 类型 描述
taxProposalDetails JSON Array 税费方案详情
taxProposalDetails
参数 类型 描述
taxRate JSON 汇率详情
amount Long 税费金额。
taxRate
参数 类型 描述
modifierType String 类型，RATE
rate Positive Float 税率
type String 税率类型
回到页面顶部