Skip to content

Create An Installment Proposal

To create a payment with installments, first you need to contact Liquido to create an Installments Plan and you’ll get a Plan ID offline. Then you need to use this plan ID to Create an Installments Proposal to get a proposal ID. Keep in mind that when you need to include other proposals together with Installments 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",
    "installmentPlanId": "2daac1cf-40f0-4311-9114-fb7e10e5f682"
}
Response
{
    "id": "beb199db-fb9c-481b-a951-73b905d5ce43",
    "submitTime": "2022-11-14T05:49:57Z",
    "expirationTime": "2022-11-14T06:49:57Z",
    "paymentIntent":{
        "amount":100000,
        "country":"BR",
        "currency":"BRL",
        "installmentPlanId":"2daac1cf-40f0-4311-9114-fb7e10e5f682"
    },
    "planDetails": {
        "installment": [
            {
                "modifierType": "RATE",
                "rate": 0.02,
                "installments": 3
            },
            {
                "modifierType": "RATE",
                "rate": 0.05,
                "installments": 6
            },
            {
                "modifierType": "RATE",
                "rate": 0.1,
                "installments": 12
            }
        ]
    },
    "proposalDetails": {
        "installmentProposalDetails": [
            {
                "installmentAmount": 183478,
                "installments": 3,
                "totalAmount": 550435
            },
            {
                "installmentAmount": 94437,
                "installments": 6,
                "totalAmount": 566624
            },
            {
                "installmentAmount": 49467,
                "installments": 12,
                "totalAmount": 593606
            }
        ]
    }
}

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.
installmentPlanId String The installment 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 transaction currency code.
installmentPlanId String The installment plan ID.
planDetails
Parameter Type Description
installment JSON Array Installments plan details.
installment
Parameter Type Description
modifierType String Modifier type. RATE
rate Positive Float Surcharge rate.
installments Integer Number of installments.
proposalDetails
Parameter Type Description
installmentProposalDetails JSON Array The installment proposal details.
installmentProposalDetails
Parameter Type Description
installmentAmount Long Installment amount.
installments Integer Number of installments.
totalAmount Long Installments total amount.
Back to top