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>",
    "transactionDate": "2023-11-07T05:31:56Z",
    "type": "debit",
    "currency": "<string>",
    "balanceBefore": 123,
    "accountCurrency": "<string>",
    "accountCurrencyBalanceBefore": 123,
    "amount": 123,
    "narration": "<string>",
    "transactionScheme": "<string>",
    "isExternalPayment": true,
    "sessionId": "<string>",
    "status": true,
    "channel": "card payment",
    "exchangeRate": 123,
    "usdExchangeRate": 123,
    "senderAccount": "<string>",
    "receiverAccount": "<string>",
    "email": "jsmith@example.com",
    "vasReceiver": "<string>",
    "refund": true,
    "isInternalAccount": true,
    "isStaffAccount": true,
    "isDormantAccount": true,
    "isCheque": true
  },
  "anonymizedUserData": {
    "uniqueId": "<string>",
    "country": "<string>",
    "state": "<string>",
    "city": "<string>",
    "accountType": "individual",
    "age": 123,
    "dateJoined": "2023-11-07T05:31:56Z",
    "isBanned": true,
    "isIdentityVerified": true,
    "businessCategory": "<string>",
    "isPhoneNumberVerified": true,
    "bankCode": "<string>",
    "bankName": "<string>",
    "name": "<string>",
    "iban": "<string>",
    "userRisk": "low",
    "sortCode": "<string>",
    "bankCountry": "<string>",
    "dob": "<string>",
    "email": "jsmith@example.com",
    "pepStatus": true,
    "sow": "<string>"
  },
  "counterpartyData": {
    "accountNumber": "<string>",
    "country": "<string>",
    "accountType": "<string>",
    "bankCode": "<string>",
    "name": "<string>",
    "iban": "<string>",
    "sortCode": "<string>",
    "bankCountry": "<string>",
    "bankName": "<string>",
    "email": "jsmith@example.com"
  },
  "thirdPartyUserData": {
    "uniqueId": "<string>",
    "cardPan": "<string>",
    "email": "jsmith@example.com"
  },
  "device": {
    "deviceId": "<string>",
    "manufacturer": "<string>",
    "name": "<string>",
    "osName": "<string>",
    "osVersion": "<string>"
  },
  "location": {
    "latitude": "<string>",
    "longitude": "<string>",
    "country": "<string>"
  },
  "screeningData": {
    "senderName": "<string>",
    "receiverName": "<string>"
  },
  "limits": {
    "dailyLimit": 123,
    "overdraftLimit": 123,
    "individualTransactionLimit": 123
  },
  "beneficiary": {
    "isRegisteredBeneficiary": true,
    "isNewBeneficiary": true
  },
  "ipAddress": "127.0.0.1"
}'
{
  "message": "Transaction submitted successfully"
}

Authorizations

apiKey
string
header
required
apiSecret
string
header
required

Body

application/json

Transaction payload for reporting

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

IP address associated with the transaction

Response

Transaction submitted successfully

message
string

Success message after transaction is submitted

Example:

"Transaction submitted successfully"