Submit Transaction

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": "[email protected]",
    "narration": "<string>",
    "refund": true,
    "isCheque": true,
    "vasReceiver": "<string>",
    "isInternalAccount": true,
    "isStaffAccount": true,
    "sessionId": "<string>",
    "isDormantAccount": true
  },
  "anonymizedUserData": {
    "uniqueId": "<string>",
    "isBanned": true,
    "isIdentityVerified": true,
    "email": "[email protected]",
    "accountType": "individual",
    "businessCategory": "<string>",
    "isPhoneNumberVerified": true,
    "dateJoined": "2023-11-07T05:31:56Z",
    "age": 123,
    "state": "<string>",
    "city": "<string>",
    "country": "<string>"
  },
  "device": {
    "deviceId": "<string>",
    "manufacturer": "<string>",
    "name": "<string>",
    "osName": "<string>",
    "osVersion": "<string>"
  },
  "location": {
    "latitude": "<string>",
    "longitude": "<string>",
    "country": "<string>"
  },
  "thirdPartyUserData": {
    "uniqueId": "<string>",
    "cardPan": "<string>",
    "email": "[email protected]"
  },
  "limits": {
    "dailyLimit": 123,
    "overdraftLimit": 123,
    "individualTransactionLimit": 123
  },
  "screeningData": {
    "senderName": "<string>",
    "receiverName": "<string>"
  },
  "beneficiary": {
    "isRegisteredBeneficiary": true,
    "isNewBeneficiary": true
  },
  "ipAddress": "127.0.0.1"
}
'

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

POST

transaction-monitoring

instant

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": "[email protected]",
    "narration": "<string>",
    "refund": true,
    "isCheque": true,
    "vasReceiver": "<string>",
    "isInternalAccount": true,
    "isStaffAccount": true,
    "sessionId": "<string>",
    "isDormantAccount": true
  },
  "anonymizedUserData": {
    "uniqueId": "<string>",
    "isBanned": true,
    "isIdentityVerified": true,
    "email": "[email protected]",
    "accountType": "individual",
    "businessCategory": "<string>",
    "isPhoneNumberVerified": true,
    "dateJoined": "2023-11-07T05:31:56Z",
    "age": 123,
    "state": "<string>",
    "city": "<string>",
    "country": "<string>"
  },
  "device": {
    "deviceId": "<string>",
    "manufacturer": "<string>",
    "name": "<string>",
    "osName": "<string>",
    "osVersion": "<string>"
  },
  "location": {
    "latitude": "<string>",
    "longitude": "<string>",
    "country": "<string>"
  },
  "thirdPartyUserData": {
    "uniqueId": "<string>",
    "cardPan": "<string>",
    "email": "[email protected]"
  },
  "limits": {
    "dailyLimit": 123,
    "overdraftLimit": 123,
    "individualTransactionLimit": 123
  },
  "screeningData": {
    "senderName": "<string>",
    "receiverName": "<string>"
  },
  "beneficiary": {
    "isRegisteredBeneficiary": true,
    "isNewBeneficiary": true
  },
  "ipAddress": "127.0.0.1"
}
'

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

Authorizations

apiKey

string

header

required

apiSecret

string

header

required

Body

application/json

Transaction payload to be screened and monitored

transactionData

object

required

Show child attributes

transactionData.reference

string

required

Unique identifier for the transaction

transactionData.amount

number

required

Amount involved in the transaction

transactionData.isExternalPayment

boolean

required

True if payment is made to an external institution or bank

transactionData.type

enum<string>

required

Type of transaction

Available options:

debit,

credit

transactionData.channel

enum<string>

required

Payment channel used for transaction

Available options:

card payment,

web transfer,

bank transfer,

mobile transfer,

cash payment,

cash withdrawal,

airtime,

cable,

sports betting,

electricity,

internet,

data purchase,

atm,

pos

transactionData.transactionDate

string<date-time>

required

ISO 8601 formatted timestamp of the transaction

transactionData.status

boolean

required

Status of the transaction

transactionData.currency

string

required

Currency code (ISO 4217 standard)

transactionData.receiverAccount

string

Receiver's account number

transactionData.senderAccount

string

Sender's account number

transactionData.balanceBefore

number

Account balance before the transaction

transactionData.email

string<email>

Email address associated with the transaction

transactionData.narration

string

Transaction narration or description

transactionData.refund

boolean

True if this is a refund transaction

transactionData.isCheque

boolean

True if transaction involves a cheque

transactionData.vasReceiver

string

Phone number of VAS recipient (for airtime/data)

transactionData.isInternalAccount

boolean

True if account belongs to the institution

transactionData.isStaffAccount

boolean

True if user is a staff member

transactionData.sessionId

string

Unique session identifier

transactionData.isDormantAccount

boolean

True if account is inactive

anonymizedUserData

object

required

Show child attributes

anonymizedUserData.uniqueId

string

required

user ID or reference from your database

anonymizedUserData.isBanned

boolean

required

Indicates if user is banned

anonymizedUserData.isIdentityVerified

boolean

required

Whether user's identity is verified

anonymizedUserData.email

string<email>

User's email address

anonymizedUserData.accountType

enum<string>

User account type

Available options:

individual,

corporate

anonymizedUserData.businessCategory

string

Type of business, if applicable

anonymizedUserData.isPhoneNumberVerified

boolean

Whether the user's phone number is verified

anonymizedUserData.dateJoined

string<date-time>

Date user joined the platform

anonymizedUserData.age

integer

User's age

anonymizedUserData.state

string

State where the user created their account

anonymizedUserData.city

string

City where the user created their account

anonymizedUserData.country

string

Country where the user created their account

device

object

Show child attributes

device.deviceId

string

required

Unique identifier of the device

device.manufacturer

string

Device manufacturer (e.g., Apple, Samsung)

device.name

string

Device name as recognized by the user

device.osName

string

Operating system name

device.osVersion

string

Operating system version

location

object

Show child attributes

location.latitude

string

Latitude coordinate

location.longitude

string

Longitude coordinate

location.country

string

Country where transaction was performed

thirdPartyUserData

object

Show child attributes

thirdPartyUserData.uniqueId

string

required

Unique identifier for third party user

thirdPartyUserData.cardPan

string

required

Masked card number

thirdPartyUserData.email

string<email>

Email of third-party user

limits

object

Show child attributes

limits.dailyLimit

number

User's daily transaction limit

limits.overdraftLimit

number

User's approved overdraft limit

limits.individualTransactionLimit

number

User's individual transaction limit

screeningData

object

Show child attributes

screeningData.senderName

string

Full name of the sender

screeningData.receiverName

string

Full name of the receiver

beneficiary

object

Show child attributes

beneficiary.isRegisteredBeneficiary

boolean

required

Whether the beneficiary is already registered

beneficiary.isNewBeneficiary

boolean

required

Whether this is a newly added beneficiary

ipAddress

string<ipv4>

IP address associated with the transaction

Response

Transaction monitoring result

transactionId

string

The ID of the transaction that was checked for fraud

riskScore

string

A score indicating the level of risk associated with the transaction

action

object

Object providing info about the final decision taken on the transaction. Only returned when a final decision is taken

Show child attributes

action.result

enum<string>

Final result of the transaction check - either approved or rejected

Available options:

approved,

rejected

action.code

enum<integer>

Numerical code representation of the result. 1 = Approved, 0 = Rejected

Available options:

0,

1

ruleResult

string

Result after the rules set have been executed (e.g., 'looks safe', 'needs review')

reason

object

Provides more detailed information about why the transaction is considered fraudulent

Show child attributes

reason.code

string

Unique code that identifies the reason for the transaction being considered fraudulent

reason.message

string

Human-readable description of the reason for the transaction being considered fraudulent

reason.severity

enum<string>

Severity of the reason for the transaction being considered fraudulent

Available options:

high,

medium,

low

reason.rule

object

If the transaction was flagged, rejected or approved by a rule, info about the rule that took effect

Show child attributes

reason.rule.id

string

Unique identifier for the rule

reason.rule.name

string

Name of the rule that took effect on the transaction

screening

object

Results of screening checks performed on transaction parties (Only returned when transaction screening module is enabled)

Show child attributes

screening.sender

object

Show child attributes

screening.sender.pep

string

Results of politically exposed person check for sender

screening.sender.sanction

string

Results of sanctions check for sender

screening.receiver

object

Show child attributes

screening.receiver.pep

string

Results of politically exposed person check for receiver

screening.receiver.sanction

string

Results of sanctions check for receiver

Webhook Signature Save User Device

⌘I

Getting Started

API

Authorizations

Body

Response