Skip to main content
This configuration is required only if you plan to use the CSV Upload method for creating reports. If you only use Select Transactions from existing transaction monitoring data or create SAR reports, this setup is not needed.
Your API endpoint will be called by Sigma to retrieve transaction details when you upload a CSV file with transaction IDs. Configure your endpoint as follows: Endpoint: 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: 
{
  "data": [
    {
      "transactionNumber": "TXN-NG-2025-061101-456789",
      "transactionDate": "2025-06-11T09:45:00.000Z",
      "transactionMode": "C",
      "type": "TRANS",
      "amount": 5750000,
      "narration": "personal",
      "sender": {
        "country": "NG",
        "fundsCode": "K",
        "account": {
          "institutionName": "Access Bank Plc",
          "institutionCode": 21222,
          "accountNumber": "012345"
        }
      },
      "receiver": {
        "country": "NG",
        "fundsCode": "K",
        "account": {
          "institutionName": "Bank PHB Plc",
          "institutionCode": 129393,
          "accountNumber": "067890"
        }
      }
    }
  ]
}
FieldTypeDescription
transactionNumberStringUnique identifier for the transaction
transactionDateStringISO 8601 formatted date and time
transactionModeStringTransaction mode (e.g., “C” for credit)
typeStringTransaction type (e.g., “TRANS”)
amountNumberTransaction amount in the smallest currency unit
narrationStringTransaction description or purpose
sender.countryStringISO country code of sender
sender.fundsCodeStringFunds source code
sender.account.institutionNameStringName of the sending financial institution
sender.account.institutionCodeNumberInstitution code
sender.account.accountNumberStringSender’s account number
receiver.countryStringISO country code of receiver
receiver.fundsCodeStringFunds destination code
receiver.account.institutionNameStringName of the receiving financial institution
receiver.account.institutionCodeNumberInstitution code
receiver.account.accountNumberStringReceiver’s account number

​
How to Configure

  1. Navigate to Reporting → Preferences in your Sigma dashboard
  2. In the Manual API Connection section, enter your API endpoint URL
  3. Test the connection to ensure it’s working properly
  4. Save your configuration

​
Implementation Requirements

  1. Rate Limiting: Ensure your endpoint can handle up to 5 requests per second
  2. Batch Processing: Be prepared to process requests with up to 100 transaction IDs each
  3. Error Handling: Implement proper error responses for invalid transaction IDs
  4. Data Validation: Ensure all required fields are present and properly formatted
  5. Response Time: Aim for response times under 2 seconds for optimal performance
  6. CSV Format: Your CSV should have one column titled “transaction id” containing the IDs to fetch
⌘I