API for Issuing Preview Installments
This documentation describes the APIs required to list and filter installments related to purchases made with virtual cards.
List Installments
[GET] /issuing-preview-installment
Lists all installments related to purchases made with virtual cards.
Query params
| Field name | Data type | Required | Description |
|---|---|---|---|
cursor |
string | No | String used to get the next batch of results. |
limit |
int | No | Maximum number of objects to be retrieved. Max = 100. |
after |
date | No | Date filter for objects created after a specific date. Example: "2024-01-01". |
before |
date | No | Date filter for objects created before a specific date. Example: "2025-01-01". |
sort |
string | No | Sort order for the results. Options: "created", "-created", "due", and "-due". "-" indicates descending order. Default: "-created". |
ids |
array | No | List of strings to filter installments by their IDs. |
tags |
array | No | Tags to filter returned objects. Example: tags=["tony", "praag"]. |
Request Example
curl --request GET \
--url "/v2/issuing-preview-installment?limit=10" \
--header 'Authorization: Bearer {token}'
Responses
200 - Success
json
{
"cursor": null,
"installments": [
{
"amount": 18000,
"count": 3,
"created": "2024-07-22T20:00:00.000000+00:00",
"description": "Purchase with installments",
"due": "2024-07-23T20:00:00.000000+00:00",
"id": "5831294327980032",
"number": 1,
"source": "issuing-purchase/1234567812345678",
"tags": [],
"totalAmount": 6000
},
{
"amount": 18000,
"count": 3,
"created": "2024-07-22T20:00:00.000000+00:00",
"description": "Purchase with installments",
"due": "2024-08-23T20:00:00.000000+00:00",
"id": "5369625206325248",
"number": 2,
"source": "issuing-purchase/1234567812345678",
"tags": [],
"totalAmount": 6000
},
{
"amount": 18000,
"count": 3,
"created": "2024-07-22T20:00:00.000000+00:00",
"description": "Purchase with installments",
"due": "2024-09-23T20:00:00.000000+00:00",
"id": "5369625206325248",
"number": 3,
"source": "issuing-purchase/1234567812345678",
"tags": [],
"totalAmount": 6000
}
]
}
401 - Not authenticated
json
{
"error": {
"message": {
"base": ["Not authenticated"]
},
"status": 401
}
}
422 - Unprocessable
json
{
"error": {
"message": {
"base": ["Invalid parameters"]
},
"status": 422
}
}
Notes
- Replace
{token}with the provided authentication token.