Get a settlement
curl --request GET \
--url https://{host}/v1/settlements/{transactionId} \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://{host}/v1/settlements/{transactionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v1/settlements/{transactionId}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_number": "<string>",
"settlement_account_number": "<string>",
"amount_minor": 2500000,
"currency": "NGN",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"failure_reason": "<string>"
},
"code": "13"
}{
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": null,
"code": "13"
}Settlements
Get a settlement
A settlement, as it stands: queued, processing, settled or failed.
Required permission: feature:SETTLEMENTS, accounts:read
GET
/
v1
/
settlements
/
{transactionId}
Get a settlement
curl --request GET \
--url https://{host}/v1/settlements/{transactionId} \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://{host}/v1/settlements/{transactionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v1/settlements/{transactionId}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_number": "<string>",
"settlement_account_number": "<string>",
"amount_minor": 2500000,
"currency": "NGN",
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"failure_reason": "<string>"
},
"code": "13"
}{
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": null,
"code": "13"
}