GET https://your-api-endpoint
Request Details
- Method: GET
- Purpose: Retrieve transaction details for reporting
- Processing: Called for all transaction IDs provided in the uploaded CSV file
- Batch Size: Maximum 500 transaction IDs per upload
- Processing Rate: 5 requests of 100 transaction IDs each
- Rate Limit: Your endpoint should handle a maximum of 5 requests per second
Expected Response Format
Your API should return transaction details in the following JSON structure:Field | Type | Description |
---|---|---|
transactionNumber | String | Unique identifier for the transaction |
transactionDate | String | ISO 8601 formatted date and time |
transactionMode | String | Transaction mode (e.g., “C” for credit) |
type | String | Transaction type (e.g., “TRANS”) |
amount | Number | Transaction amount in the smallest currency unit |
narration | String | Transaction description or purpose |
sender.country | String | ISO country code of sender |
sender.fundsCode | String | Funds source code |
sender.account.institutionName | String | Name of the sending financial institution |
sender.account.institutionCode | Number | Institution code |
sender.account.accountNumber | String | Sender’s account number |
receiver.country | String | ISO country code of receiver |
receiver.fundsCode | String | Funds destination code |
receiver.account.institutionName | String | Name of the receiving financial institution |
receiver.account.institutionCode | Number | Institution code |
receiver.account.accountNumber | String | Receiver’s account number |
Implementation Requirements
- Rate Limiting: Ensure your endpoint can handle up to 5 requests per second
- Batch Processing: Be prepared to process requests with up to 100 transaction IDs each
- Error Handling: Implement proper error responses for invalid transaction IDs
- Data Validation: Ensure all required fields are present and properly formatted
- Response Time: Aim for response times under 2 seconds for optimal performance