v1
latestOpenAPI 3.1.02026-07-24102785.8 KBGet Available Installment Plans
Retrieves valid installment options for a transaction based on the credit card BIN, amount, and other input parameters. Performs validation for the "Meses Sin Intereses" program in Mexico.
🚧 Installments Authorization
The Installments feature from PagSeguro International Payin uses a different authorization method.
To authorize your requests to the Get Available Installment Plans endpoint, you have to use the authorization method described by the Payout Authorization documentation.
Query parameters
Payment method. Only CREDIT_CARD is supported.
Original transaction amount in the specified currency.
Maximum number of installments the merchant wants to offer.
- For Brazil (BR), the maximum allowed is 12.
- For Mexico (MX), the maximum allowed is 18.
First 8 digits of the credit card (BIN).
Country code (ISO 3166-1 alpha-2).
Currency code (ISO 4217 alpha-3).
Headers
Store identifier.
Response
Successful response with available installment plans.
Example response
{
"payment_methods": {
"credit_card": {
"mastercard": {
"installment_plans": [
{
"amount": {
"currency": "BRL"
}
}
]
}
}
}
}