Installments

Service to quote an installment plan

Installments

POST https://api.stage.localpayment.com/api/payin/installments-plan

Headers

Name	Type	Description
Authorization*	string	Mandatory. JWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication

Request Body

Name	Type	Description
paymentMethod*	object	Mandatory. Only allowsCreditCard payment method.
paymentMethod.code*	string	Mandatory. Payment method code, which determines payment method type and brand (credit card issuer). Please take a look at available payment methods and their codes in the corresponding section. Note that only CreditCard codes are allowed.
country*	string	Mandatory. Your end user's country (i.e. country in which the payment will be processed), in ISO format. Please refer to Country Codes for a full list of supported countries.
amount*	number	Mandatory. Amount to charge to your end user.
currency*	string	Mandatory. The currency in which the amount is expressed. It could be A) the local currency of the selected country or B) the account's currency. If A), the amount will be charged to the customer's cash payment method. If B) and it differs from the local currency, the amount specified will be credited to your account and Localpayment will perform a Foreign Exchange operation to collect the amount expressed in local currency. In bimonetary countries, paymentMethod.code resolves possible ambiguity: the payment will be executed in the currency of that specific payment method network. e.i.: SPID (USD); SPEI (MXN)
accountNumber*	string	Mandatory. Your Localpayment account number in which the amount will be credited.

201: Created Installment plan quoted successfully. Response will contain an installments token that can be redeemed when a PayIn is performed.

{
    "installmentsToken": "b71a6973-ffdc-427b-b014-e03eb4462e82",
    "creationDate": "2022-03-29T23:53:52.7150456+00:00",
    "expirationDate": "2022-03-30T00:03:52.71509+00:00",
    "currency": "ARS",
    "amount": 2000.0,
    "installments": [
        {
            "installments": 2,
            "installmentAmount": 1100.0,
            "totalPaymentAmount": 2200.0,
            "amountWithInternalFee": 2200.0,
            "financingFee": 200.0
        },
        {
            "installments": 3,
            "installmentAmount": 941.7187,
            "totalPaymentAmount": 2825.156,
            "amountWithInternalFee": 2360.0,
            "financingFee": 825.156
        },
        {
            "installments": 6,
            "installmentAmount": 633.17334,
            "totalPaymentAmount": 3799.04,
            "amountWithInternalFee": 2800.0,
            "financingFee": 1799.04
        }
    ]
}

404: Not Found There are no available installment plans for the combination of payment method code, account, country and currency you specified.

 {
    "status": {
        "code": "300",
        "detail": "This Account does not have an installment plan set up"
    }
}

404: Not Found There are no available installment plans for the combination of payment method code, account, country and currency you specified.

 {
    "status": {
        "code": "300",
        "detail": "The Instalment Plan only works in local currency"
    }
}

Example: Installment request

The installmentsToken that brings the response will have a 10 minutes duration.

JSON: Body request:

{
	"paymentMethod": {
		"code": "1000"
	},
	"country": "ARG",
	"currency": "ARS",
	"amount": 1000.00,
    "accountNumber": "032.032.00000002"
}

cURL: Body request

curl --location --request POST 'https://api.stage.localpayment.com/api/payin/installments-plans' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjQ4NTk4NDcxLCJqdGkiOiJjNDFhMWZlMjIyNjc0M2Y0YWI2YjViZjVmZjk2M2E5ZSIsInVzZXJfaWQiOjg2LCJzdXBlcnVzZXIiOmZhbHNlLCJpc19zdGFmZiI6ZmFsc2UsInJvbGVzIjpbIkFMTCJdLCJjb3VudHJpZXMiOlsiQUxMIl0sImNvbXBhbnkiOiIwMDAxIiwiY2xpZW50X2NvZGUiOiIwMDAxIn0.bjGBixlUtrK-DXjPfVyO_UYGHDCJd2sDh7YG3SK7gLA' \
--header 'Content-Type: application/json' \
--data-raw '{
	"paymentMethod": {
		"code": "1000"
	},
	"country": "ARG",
	"currency": "ARS",
	"amount": 2000.00,
    "accountNumber": "032.032.00000002"
}'

Example: Installment response

JSON: Status OK

{
    "installmentsToken": "b9c83225-69b0-4cea-aafa-612b776bc311",
    "creationDate": "2022-08-12T17:36:12.1626582+00:00",
    "expirationDate": "2022-08-12T17:51:12.1627314+00:00",
    "currency": "ARS",
    "amount": 1000.0,
    "installments": [
        {
            "installments": 3,
            "installmentAmount": 448.98334,
            "totalPaymentAmount": 1346.95,
            "financingFee": 346.95
        },
        {
            "installments": 6,
            "installmentAmount": 275.68735, 
            "totalPaymentAmount": 1654.124, 
            "financingFee": 654.124
        }
    ]
}