Private API Reference

Transaction Monitoring Results

Transaction Monitoring Result helps you demonstrate that your program is compliant with the bank’s expectations for transaction monitoring. After you submit a transaction to your transaction monitoring system or it triggers alerts, you should create a result record in Increase.

The Transaction Monitoring Result object

{
  "alert": null,
  "category": "monitor",
  "created_at": "2020-01-31T23:59:59Z",
  "declined_transaction_id": null,
  "id": "transaction_monitoring_result_2xw97hvcep0qzbihasv",
  "idempotency_key": null,
  "monitor": {
    "monitored_at": "2020-01-31T23:59:59Z",
    "reference": "1234567890"
  },
  "suspicious_activity": null,
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "transaction_monitoring_result",
  "vendor": "oscilar"
}

Attributes

alert

dictionary

Nullable

Details of the alert to create. Required if category is equal to alert.

category

enum

The category of the result your monitoring system produced.

created_at

string

When this information record was submitted to Increase.

declined_transaction_id

string

Nullable

The identifier of the Declined Transaction that was submitted to your monitoring system.

More about Transactions.

string

The unique identifier for the Transaction Monitoring Result.

idempotency_key

string

Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

monitor

dictionary

Nullable

Details of the monitor to create. Required if category is equal to monitor.

suspicious_activity

dictionary

Nullable

Details of the suspicious activity to create. Required if category is equal to suspicious_activity.

transaction_id

string

Nullable

The identifier of the Transaction that was submitted to your monitoring system.

More about Transactions.

type

string

A constant representing the object’s type. For this resource it will always be transaction_monitoring_result.

vendor

enum

The monitoring system that you used for transaction monitoring.

List Transaction Monitoring Results

curl \
  --url "${INCREASE_URL}/transaction_monitoring_results" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Transaction Monitoring Result object */ },
    { /* Transaction Monitoring Result object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Between 1 and 200 characters

More parameters

cursor

string

limit

integer

Create a Transaction Monitoring Result

Call this endpoint to create a Transaction Monitoring Result for each relevant transaction. The evidence records will be correlated against processed transactions to ensure that your monitoring system is working as expected.

curl -X "POST" \
  --url "${INCREASE_URL}/transaction_monitoring_results" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "alert": null,
    "category": "monitor",
    "declined_transaction_id": null,
    "monitor": {
      "monitored_at": "2020-01-31T23:59:59Z",
      "reference": "1234567890"
    },
    "suspicious_activity": null,
    "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
    "vendor": "oscilar"
  }'

Parameters

alert

dictionary

Details of the alert to create. Required if category is equal to alert.

category

enum

Required

The category of the result your monitoring system produced.

declined_transaction_id

string

The Transaction that was submitted to your monitoring system.

More about Transactions.

monitor

dictionary

Details of the monitor to create. Required if category is equal to monitor.

suspicious_activity

dictionary

Details of the suspicious activity to create. Required if category is equal to suspicious_activity.

transaction_id

string

The Transaction that was submitted to your monitoring system.

More about Transactions.

vendor

enum

Required

The vendor of your monitoring system.

Retrieve a Transaction Monitoring Result

curl \
  --url "${INCREASE_URL}/transaction_monitoring_results/transaction_monitoring_result_2xw97hvcep0qzbihasv" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

transaction_monitoring_result_id

string

Required

The identifier of the Transaction Monitoring Result to retrieve.