Skip to main content
cURL
curl --request POST \
  --url https://sigmaprod.sabipay.com/api/v1/transaction-monitoring/instant \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --header 'apiSecret: <api-key>' \
  --data '
{
  "transactionData": {
    "reference": "<string>",
    "amount": 123,
    "isExternalPayment": true,
    "type": "debit",
    "channel": "card payment",
    "transactionDate": "2023-11-07T05:31:56Z",
    "status": true,
    "currency": "<string>",
    "receiverAccount": "<string>",
    "senderAccount": "<string>",
    "balanceBefore": 123,
    "email": "jsmith@example.com",
    "narration": "<string>",
    "refund": true,
    "isCheque": true,
    "vasReceiver": "<string>",
    "isInternalAccount": true,
    "isStaffAccount": true,
    "sessionId": "<string>",
    "isDormantAccount": true
  },
  "anonymizedUserData": {
    "uniqueId": "<string>",
    "isBanned": true,
    "isIdentityVerified": true,
    "email": "jsmith@example.com",
    "accountType": "individual",
    "businessCategory": "<string>",
    "isPhoneNumberVerified": true,
    "dateJoined": "2023-11-07T05:31:56Z",
    "age": 123,
    "state": "<string>",
    "city": "<string>",
    "country": "<string>"
  },
  "location": {
    "latitude": "<string>",
    "longitude": "<string>",
    "country": "<string>"
  },
  "limits": {
    "dailyLimit": 123,
    "overdraftLimit": 123,
    "individualTransactionLimit": 123
  },
  "screeningData": {
    "senderName": "<string>",
    "receiverName": "<string>"
  },
  "ipAddress": "127.0.0.1"
}
'
{
  "message": "Transaction processed",
  "data": {
    "transactionId": "<string>",
    "riskScore": "<string>",
    "action": {
      "result": "approved",
      "code": 0
    },
    "ruleResult": "<string>",
    "reason": {
      "code": "<string>",
      "message": "<string>",
      "severity": "high",
      "rule": {
        "id": "<string>",
        "name": "<string>"
      }
    },
    "screening": {
      "sender": {
        "pep": "<string>",
        "sanction": "<string>"
      },
      "receiver": {
        "pep": "<string>",
        "sanction": "<string>"
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://sigma-docs.pastel.africa/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

apiKey
string
header
required
apiSecret
string
header
required

Body

application/json

Transaction payload to be screened and monitored

transactionData
object
required
anonymizedUserData
object
required
device
object
location
object
thirdPartyUserData
object
limits
object
screeningData
object
beneficiary
object
ipAddress
string<ipv4>

IP address associated with the transaction

Response

Transaction monitoring result

message
string
required

Processing status message

Example:

"Transaction processed"

data
object
required

Transaction result payload. Can be null for reporting-only processing mode.