Skip to content

Installments

Making a credit card installment purchase is similar to making a regular card payment. End users can choose to pay the total transaction amount in periodically scheduled separated payments. The first installment is charged to the shopper's credit card immediately, and the following installments are charged automatically.

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. Depending on the payment flow, the Plan ID is used in two different ways: Direct and Redirect.

Create A Direct Flow Credit Card Payment With Installments

You need to use the installment 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.

With a Proposal ID(proposalId) and the number of installments(installments), you can go ahead to create a credit card installment payment.

HTTP Request

POST /v1/payments/charges/card

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "62cc10c8-baba-4c92-b6da-935cbd422dcd",
    "amount": 100000,
    "currency": "USD",
    "country": "BR",
    "paymentMethod": "CREDIT_CARD",
    ...  # other basic request fields
    "paymentProposalInfo": {
        "proposalId": "beb199db-fb9c-481b-a951-73b905d5ce43"
    },
    "installments": 12,
    ...  # other basic request fields
}
Response
{
    "transferStatusCode": 200,
    "idempotencyKey": "62cc10c8-baba-4c92-b6da-935cbd422dcd",
    "referenceId": "62cc10c8-baba-4c92-b6da-935cbd422dcd",
    "paymentMethod": "CREDIT_CARD",
    "amount": 100000,
    "currency": "USD",
    "finalAmount": 551093,
    "finalCurrency": "BRL",
    "country": "BR",
    ...  # other basic response fields
    "amountDetails": {
        "fxAmountDetails": {
            "fxRate": {
                "modifierType": "RATE",
                "base": "USD",
                "target": "BRL",
                "timestamp": 1664443743,
                "exchangeRate": 5.4835098
            },
            "baseAmount": 100000,
            "targetAmount": 548351
        },
        "installmentAmountDetails": {
            "installmentAmount": 45924,
            "installments": 12,
            "totalAmount": 551093
        }
    },
    ...  # other basic response fields
}

HTTP Headers Details

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

Request Body Parameters

Parameter Required Type Description
paymentProposalInfo JSON The payment installment proposal info. Required if create a payment with installments.
installments Integer Number of installments. Required for Redirect flow.

Response Body Parameters

Parameter Type Description
amountDetails JSON The payment installments amount details.

Create A Redirect Flow Credit Card Payment With Installments

In your payment request for the Redirect flow, you need to include the Plan ID for the installment plan. This allows the payer to choose installment options configured in the plan.

HTTP Request

POST /v1/payments/charges/card

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "7fd3ab68-1aa3-4e8f-852d-592b7250f296",
    "amount": 100000,
    "currency": "BRL",
    "country": "BR",
    "paymentMethod": "CREDIT_CARD",
    "paymentFlow": "REDIRECT",
    "callbackUrl": "https://api.client.com/callback/",
    "merchantRedirectInfo": {
        "merchantPageUrl": "https://www.merchantpageexample.com/123456"
    },
    ...  # other basic request fields
    "paymentProposalInfo": {
        "paymentIntentInfo": {
            "installmentPlanId": "2b87300c-2f1e-48c1-9f73-5722661d7c15"
        }
    },
    ...  # other basic request fields
}
Response
{
    "transferStatusCode": 200,
    "idempotencyKey": "7fd3ab68-1aa3-4e8f-852d-592b7250f296",
    "referenceId": "7fd3ab68-1aa3-4e8f-852d-592b7250f296",
    "paymentMethod": "CREDIT_CARD",
    "paymentFlow": "REDIRECT",
    "amount": 100000,
    "currency": "BRL",
    "finalAmount": 100000,
    "finalCurrency": "BRL",
    ...  # other basic response fields
    "redirectUrl": "https://www.redirect-qa.liquido.com?uid=aa2b2a03-70d2-4ce9-b6e5-4d17ff912f89",
    ...  # other basic response fields
}

HTTP Headers Details

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

Request Body Parameters

Parameter Required Type Description
paymentProposalInfo JSON The payment installment proposal info. Required if create a payment with installments.

Object Parameters

paymentProposalInfo
Parameter Required Type Description
proposalId String The installment proposal ID. Required for Direct flow.
paymentIntentInfo JSON The payment Intent info. Required for Redirect flow.
paymentIntentInfo
Parameter Required Type Description
installmentPlanId String The installment plan ID.
amountDetails
Parameter Type Description
taxAmountDetails JSON The tax amount details.
fxAmountDetails JSON The fx amount details.
installmentAmountDetails JSON The installment amount details.
taxAmountDetails
Parameter Type Description
taxRate JSON The tax rate details.
amount Long The tax amount.
fxAmountDetails
Parameter Type Description
fxRate JSON The foreign exchange rate details.
baseAmount Long The amount of base currency.
targetAmount Long The amount of target currency.
installmentAmountDetails
Parameter Type Description
installmentAmount Long Installment amount.
installments Integer Number of installments.
totalAmount Long Installments total amount.
taxRate
Parameter Type Description
rate Positive Float Tax rate.
type String Tax type.
fxRate
Parameter Type Description
base String Base currency, e.g. USD
target String Target currency, e.g. BRL
timestamp Long The timestamp when exchanging currency.
exchangeRate Positive Float The exchange rate.
Back to top