List collection settlements
curl --request GET \
--url https://{host}/v1/collection-settlements \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://{host}/v1/collection-settlements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v1/collection-settlements"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"virtual_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_number": "<string>",
"transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"gross_minor": 123,
"fee_minor": 123,
"vat_minor": 123,
"net_minor": 123,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"settlement_account": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_number": "<string>",
"account_name": "<string>"
},
"reference": "INV-2026-0042",
"failure_reason": "<string>",
"settled_at": "2023-11-07T05:31:56Z"
}
],
"next_cursor": "<string>"
},
"code": "13"
}{
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"fields": {}
},
"code": "13"
}Collection settlements
List collection settlements
Across all the business’s collection accounts, newest first. Filter by status and date; page with the cursor.
Required permission: virtual-accounts:read, feature:VIRTUAL_ACCOUNTS
GET
/
v1
/
collection-settlements
List collection settlements
curl --request GET \
--url https://{host}/v1/collection-settlements \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://{host}/v1/collection-settlements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v1/collection-settlements"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"virtual_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_number": "<string>",
"transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"gross_minor": 123,
"fee_minor": 123,
"vat_minor": 123,
"net_minor": 123,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"settlement_account": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_number": "<string>",
"account_name": "<string>"
},
"reference": "INV-2026-0042",
"failure_reason": "<string>",
"settled_at": "2023-11-07T05:31:56Z"
}
],
"next_cursor": "<string>"
},
"code": "13"
}{
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"fields": {}
},
"code": "13"
}