curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/installments \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/installments"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/installments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/installments';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"message": "<string>",
"code": "<string>",
"data": [
{
"installmentId": "<string>",
"subMerchantId": "<string>",
"customerId": "<string>",
"status": "<string>",
"totalAmount": 123,
"deposit": {
"amount": 123
},
"payments": {
"startDate": "<string>",
"frequency": "<string>",
"amount": 123,
"qty": 123
},
"executions": [
{
"executionId": "<string>",
"date": "2023-11-07T05:31:56Z",
"amount": 123,
"transactionId": "<string>",
"status": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"count": 123,
"query": {
"criteria": {}
}
}List installment plans
Returns installment plans, both active and inactive, including payment schedules and statuses.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/installments \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/installments"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/installments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/installments';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"message": "<string>",
"code": "<string>",
"data": [
{
"installmentId": "<string>",
"subMerchantId": "<string>",
"customerId": "<string>",
"status": "<string>",
"totalAmount": 123,
"deposit": {
"amount": 123
},
"payments": {
"startDate": "<string>",
"frequency": "<string>",
"amount": 123,
"qty": 123
},
"executions": [
{
"executionId": "<string>",
"date": "2023-11-07T05:31:56Z",
"amount": 123,
"transactionId": "<string>",
"status": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"count": 123,
"query": {
"criteria": {}
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
The body is of type object.
Response
Find Installments
Whether the request was processed successfully. Declines return HTTP 200 with success: false.
Human-readable result message.
Machine-readable result code. See the Error Codes reference.
The response payload.
Hide child attributes
Hide child attributes
Unique identifier of the installment plan.
Unique identifier of the submerchant.
Unique identifier of the customer.
Current status.
The total amount.
Recurring payment schedule configuration.
Hide child attributes
Hide child attributes
Optional first payment date (YYYY-MM-DD). If omitted, payments start immediately.
How often installment payments are charged.
Amount charged per installment payment.
Number of installment payments.
Billing executions for this subscription.
Hide child attributes
Hide child attributes
Identifier of the billing execution.
Invoice issue date (ISO 8601).
The amount of the transaction.
Unique identifier of the original transaction.
Current status.
Timestamp when the object was created (ISO 8601).
Timestamp when the object was last updated (ISO 8601).
Number of records.
Was this page helpful?

