https://{your-domain}.fincode.software/api/v1/services/user/check-transfer-status/{transactionReference}
{
"status": "<string>",
"data": {
"transactionReference": "<string>",
"transferStatus": "<string>",
"amount": 123,
"initiatedDate": "<string>",
"completedDate": "<string>",
"failureReason": "<string>",
"settlementDetails": {}
}
}API Endpoints
Transfer Status
Checks the settlement status of a fund transfer transaction.
GET
/
api
/
v1
/
services
/
user
/
check-transfer-status
/
{transactionReference}
https://{your-domain}.fincode.software/api/v1/services/user/check-transfer-status/{transactionReference}
{
"status": "<string>",
"data": {
"transactionReference": "<string>",
"transferStatus": "<string>",
"amount": 123,
"initiatedDate": "<string>",
"completedDate": "<string>",
"failureReason": "<string>",
"settlementDetails": {}
}
}Allows customers to check the current status of a fund transfer transaction, including whether it has been completed, is still processing, or has failed.
https://{your-domain}.fincode.software/api/v1/services/user/check-transfer-status/{transactionReference}
Request Headers
string
required
The JWT Access Token obtained from the
/login or /refresh-token endpoint.string
required
The date and time at which the request was initiated (ISO 8601 format).
string
required
The IP address of the customer making the request.
string
required
Unique identifier for the interaction/session.
Path Parameters
string
required
The transaction reference number of the transfer to check.
Response
Returns the current status of the transfer transaction.string
default:"SUCCESS"
Overall status of the API request.
object
Transfer status details.
Show data object
Show data object
string
Transaction reference number.
string
Current status of the transfer (e.g.,
PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED).number
Amount of the transfer.
string
Date and time when the transfer was initiated.
string
Date and time when the transfer was completed (if completed).
string
Reason for failure (if status is
FAILED).object
Details about the settlement process.
Code Examples
curl --location 'https://{your-domain}.fincode.software/api/v1/services/user/check-transfer-status/TXN-20240115-001234' \
--header 'X-Auth-Token: YOUR_JWT_ACCESS_TOKEN' \
--header 'x-fapi-auth-date: 2024-01-15T10:30:00Z' \
--header 'x-fapi-customer-ip-address: 192.168.1.1' \
--header 'x-fapi-interaction-id: interaction-12345'
const axios = require('axios');
const BASE_URL = 'https://{your-domain}.fincode.software/api/v1/services/user';
async function checkTransferStatus(accessToken, transactionReference) {
try {
const response = await axios.get(
`${BASE_URL}/check-transfer-status/${transactionReference}`,
{
headers: {
'X-Auth-Token': accessToken,
'x-fapi-auth-date': new Date().toISOString(),
'x-fapi-customer-ip-address': '192.168.1.1',
'x-fapi-interaction-id': `interaction-${Date.now()}`,
},
}
);
if (status.completedDate) {
console.log(`Completed: ${status.completedDate}`);
}
if (status.failureReason) {
console.log(`Failure Reason: ${status.failureReason}`);
}
return status;
} catch (error) {
console.error(
'Failed to check transfer status:',
error.response?.data || error.message
);
throw error;
}
}
// Usage Example
const accessToken = 'YOUR_JWT_ACCESS_TOKEN';
checkTransferStatus(accessToken, 'TXN-20240115-001234');