Transfer Status

Checks the settlement status of a fund transfer transaction.

GET /api/v1/services/user/check-transfer-status/{transactionReference}

cURL GET

[https://finlend.fincode.software/api/v1/services/user/check-transfer-status/{transactionReference}](https://finlend.fincode.software/api/v1/services/user/check-transfer-status/{transactionReference})

200

{
  "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.

cURL GET

[https://finlend.fincode.software/api/v1/services/user/check-transfer-status/{transactionReference}](https://finlend.fincode.software/api/v1/services/user/check-transfer-status/{transactionReference})

Request Headers

X-Auth-Token · string · required

The JWT Access Token obtained from the /login or /refresh-token endpoint.

x-fapi-auth-date · string · required

The date and time at which the request was initiated (ISO 8601 format).

x-fapi-customer-ip-address · string · required

The IP address of the customer making the request.

x-fapi-interaction-id · string · required

Unique identifier for the interaction/session.

Path Parameters

transactionReference · string · required

The transaction reference number of the transfer to check.

Response

Returns the current status of the transfer transaction.

status · string · default: "SUCCESS"

Overall status of the API request.

data · object

Transfer status details.

Show data object

transactionReference · string

Transaction reference number.

transferStatus · string

Current status of the transfer (e.g., PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED).

amount · number

Amount of the transfer.

initiatedDate · string

Date and time when the transfer was initiated.

completedDate · string

Date and time when the transfer was completed (if completed).

failureReason · string

Reason for failure (if status is FAILED).

settlementDetails · object

Details about the settlement process.

Code Examples

cURL

curl --location 'https://finlend.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'