Skip to content

Create A Tax Proposal

To create a tax proposal, first you need to contact Liquido to create a tax plan and you’ll get a Plan ID offline. Then you need to use this plan ID to create a tax proposal to get a proposal ID. Keep in mind that when you need to include other proposals together with tax proposal, you’ll need to Create A Proposal with Multiple Intentions.

HTTP Request

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 Details

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

Request Body Parameters

Parameter Required Type Description
amount Long The transfer amount, The minimum settlement granularity of the current currency, such as 100=1BRL
country String The country code.
currency String The transaction currency code, which can be USD, BRL, MXN, COP, PEN or CLP.
taxPlanId String The tax plan ID.

Response Body Parameters

Parameter Type Description
id String The proposal ID.
submitTime String The proposal submit time.
expirationTime String The proposal expiration time.
paymentIntent JSON The payment intention.
planDetails JSON The plan details.
proposalDetails JSON The proposal details.

Object Parameters

paymentIntent
Parameter Type Description
amount Long The transfer amount, The minimum settlement granularity of the current currency, such as 100=1BRL
country String The country code.
currency String The base currency code.
taxPlanId String The tax plan ID.
planDetails
Parameter Type Description
tax JSON Array Tax plan details.
tax
Parameter Type Description
modifierType String Modifier type. RATE
rate Positive Float Tax rate.
type String Type of tax fee.
proposalDetails
Parameter Type Description
taxProposalDetails JSON Array The tax proposal details.
taxProposalDetails
Parameter Type Description
taxRate JSON The foreign exchange rate details.
amount Long The tax amount.
taxRate
Parameter Type Description
modifierType String Modifier type. RATE
rate Positive Float Tax rate.
type String Type of tax fee.
Back to top