Create Payments with Installments and Plans

This guide walks you through processing credit card payments with installments using the Getnet Payment App. You can choose to let the terminal handle interest calculations (Manual Mode) or send the final calculated amount from your own system (Calculated Mode).

Before you begin

Before following the steps, you need to:

• Getnet Payment App installed on the terminal.
• Use a credit card as the payment method (paymentMethod="1").
• The merchant must be authorized for specific installment plans via their tax engine configuration.

How it works

When a credit card is detected, the terminal validates the requested plan against the merchant’s authorized configurations via a Tax Engine. Understanding this validation process helps you anticipate the terminal behavior:

Step 1: Choose the operation mode

Before initiating the transaction, define the operationMode. This parameter controls how transaction values are calculated:

If operationMode is not specified, the terminal defaults to manual mode ("0").

Step 2: Create the payment with installments

To process a payment with installments, you need to create an Intent with the payment operation and include the installment-specific parameters.

How Plan and Installment Validation Works

The terminal performs a two-step validation process against the Tax Engine:

1. Plan Validation: If the planId you send matches the merchant’s authorized plans returned by the Tax Engine, the terminal skips the plan selection screen.

2. Installment Validation: After validating the plan, if the installments value is compatible with the Tax Engine response for that plan, the terminal also skips the installment selection screen.

Only when both validations pass does the terminal proceed directly to the confirmation screen. If either validation fails, the terminal prompts the user to manually select a valid and authorized option.

The table below lists the parameters you can send in the Intent:

The following code block shows an example of how to create a payment with installments:

private val REQUEST_CODE = 1001

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    val intent = Intent(Intent.ACTION_VIEW, Uri.parse("getnet://payment/v1/payment"))
    
    // Mandatory for Payment
    intent.putExtra("amount", "10000") // $100.00
    intent.putExtra("originalAmount", "10000")
    intent.putExtra("callerId", "123456")
    intent.putExtra("receiptCode", "654321")
    
    // Specific for Installments and Plans
    intent.putExtra("installments", 5) 
    intent.putExtra("planId", "plan_emisor")
    intent.putExtra("interest", "false")
    intent.putExtra("operationMode", "1") // Calculated mode
    intent.putExtra("skipConfirmation", "false")
    
    startActivityForResult(intent, REQUEST_CODE)
}

Step 3: Handle the response

After the customer completes the transaction, the Getnet Payment App returns the final confirmed plan details to your application via onActivityResult.

Response Parameters

The following table lists the response parameters you will receive:

The following code block shows an example of handling the response:

override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
    super.onActivityResult(requestCode, resultCode, data)
    
    if (requestCode == REQUEST_CODE && resultCode == RESULT_OK) {
        val extras = data?.extras
        val result = extras?.getString("result")
        
        if (result == "0") {
            // SUCCESS: Extract transaction details
            val installments = extras?.getString("installments")
            val planId = extras?.getString("planId")
            val interest = extras?.getString("interest")
            val nsu = extras?.getString("nsu")
            val authCode = extras?.getString("authorizationCode")
            val amount = extras?.getString("amount")
            
            Log.d("Payment", "Payment approved with $installments installments")
            Log.d("Payment", "Plan: $planId, Interest: $interest")
            Log.d("Payment", "NSU: $nsu, Auth Code: $authCode")
        } else {
            // FAILURE: Handle error
            val errorDetails = extras?.getString("resultDetails")
            Log.e("Payment", "Payment failed: $errorDetails (Code: $result)")
        }
    }
}

Example of a successful response:

{
  "result": "0",
  "resultDetails": "APPROVED",
  "amount": "10000",
  "installments": "5",
  "planId": "plan_emisor",
  "interest": "false",
  "callerId": "123456",
  "nsu": "57003",
  "authorizationCode": "004433"
}

Next steps

• Installment rules by country - the plan IDs and payment method restrictions per country.
• Interest calculation strategy - decide whether the terminal or your app computes interest.