Last Updated: 15 July 2025 | Change Log
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
}
}
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.
- Try
https://try.access.worldpay.com/api/payments
- Live
https://access.worldpay.com/api/payments
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
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 } } }
In most cases you will need to add some additional features such as 3DS, auto settlement or a risk assessment
Risk Assessment
We assess the payment for fraud before proceeding with authorization.
Auto Settlement
Automatically settle a payment following the authorization.
Account Funding Transactions (AFT)
Transfer funds from a card account to another destination, rather than for the provision of goods or services.
Financial Service (MCC 6012/6051)
For domestic Financial Services providers (MCC 6012) based in the Visa Europe Region, you must supply this additional data.
Latin America Installments
Fulfill a one-time installment charge, to allow the customer's acquirer bank collecting the payments over time.
Payment Facilitator
Facilitate transactions on behalf of your sub-merchants.
Account Updater
Automatically update card details to prevent declines due to expired or changed cards.
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 besentForCancellation
automatically by default but can be disabled.
- If any of the AVS/CVC response riskFactors are marked as
- Try
https://try.access.worldpay.com/api/payments
- Live
https://access.worldpay.com/api/payments
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
No response example