Skip to content

Last Updated: 15 July 2025 | Change Log

Latin America installments

Request a one-time installment payment, to allow the customer's bank to collect subsequent payments automatically.

The request must contain:

"customerAgreement": {
    "type": "installment", // used to indicate the customer has agreed the processing arrangement
    "installmentType": "latinAmerica", // used to define the type of installments service
    "installmentPlan": {
        "numberOfInstallments": 4 // used to indicate the number of installments that the requested amount should be broken into by the acquirer bank
    }
}

Optionally:

If you're storing the card as a Worldpay token:

"customerAgreement": {
    "type": "installment",
    "storedCardUsage": "first", // first use of a stored card
    "installmentType": "latinAmerica", 
    "installmentPlan": {
        "numberOfInstallments": 4 
    }
},
"tokenCreation": {
    "type": "worldpay" // include if you're storing the card as a Worldpay Token
},

If you're using a previously stored card to setup the agreement:

"customerAgreement": {
    "type": "installment", 
    "storedCardUsage": "subsequent", // subsequent use of a previously stored card
    "installmentType": "latinAmerica", 
    "installmentPlan": {
        "numberOfInstallments": 4 
    }
}

Apple Pay & Google Pay are not yet supported when setting up an installment.

Important: You must have agreement from your customer to store their card details.

Collect the card details and send an API request with these details to the Payments resource.

Request

application/json

Set up a Latin America installment payment. This is a customer initiated transaction (CIT)

{ "transactionReference": "Memory265-13/08/1876", "merchant": { "entity": "default" }, "instruction": { "method": "card", "paymentInstrument": { "type": "plain", "cardHolderName": "Sherlock Holmes", "cardNumber": "4000000000001091", "expiryDate": { "month": 5, "year": 2035 }, "cvc": "123" }, "customerAgreement": { "type": "installment", "installmentType": "latinAmerica", "installmentPlan": { "numberOfInstallments": 4 } }, "narrative": { "line1": "trading name" }, "value": { "currency": "GBP", "amount": 42 } } }

3. Add additional features

In most cases you will need to add some additional features such as 3DS, auto settlement or a risk assessment

4. Response

Features that change the API flow

Certain features add additional requests and responses:

  • 3DS - you will receive a 201 - 3dsDeviceDataRequired as well as the possibility of an issuer challenge
  • FraudSight - you may receive a 201 - fraudHighRisk outcome, stopping the payment
  • Auto Settlement - automatic 202 - sentForSettlement following authorization.
    • If any of the AVS/CVC response riskFactors are marked as notMatched the payment will be sentForCancellation automatically by default but can be disabled.
application/json
No response example