Transaction Data API

Request a new access token to authenticate requests to the API. The token will expire after the specified time. To request an access token you must use the refresh / auth token provided to you by Cable. You cannot request a new token with an existing access token.

Request a new access token

Authentication

Check if a transaction exists

Add a new transaction

Update an existing transaction

Add transactions in batch

Update transactions in batch

Transactions

The unique identifier of the transaction check

Check if a transaction check exists

Add new transaction check(s)

Update an existing transaction check

Checks

The unique identifier of the transaction alert

Check if a transaction alert exists

Add new transaction alert(s)

Update an existing transaction alert

Alerts

Transaction suspicious activity does not exist

The unique identifier of the transaction suspicious activity

Check if a transaction suspicious activity exists

Invalid transaction suspicious activity data

Transaction suspicious activity already exists

Add new transaction suspicious activities

Transaction suspicious activity not found

Update an existing transaction suspicious activity

Suspicious Activities

The unique identifier of the transaction screening

Check if a transaction screening exists

Add new transaction screening(s)

Update an existing transaction screening

Screening

AccessTokenScope

The organization ID for which the token is requested. This is required.

The list of scopes that the token should have. For transaction data, the scope should be 'transactions:write'.

Additional metadata that can be added to a payload, such as transaction checks, alerts, and suspicious activities.

AdditionalProperties

The key of the additional property. This should be unique within the additional properties array.

The type of the additional property value, for example "string", "number", "boolean", "object", "array".

A description of the additional property. This should provide context for the value.

AdditionalPropertiesType

BatchNewTransactionRequest

BatchUpdateTransactionRequest

GeneralError

Detailed information about errors in specific fields.

GeneralErrorErrorsItem

NewAccessTokenResponse

The organization ID for which the token was requested.

The name of the organization for which the token was requested.

NewTransactionAlertRequest

NewTransactionCheckRequest

NewTransactionRequest

NewTransactionScreeningRequest

NewTransactionSuspiciousActivity

Transaction

The time of the transaction. This should be in ISO 8601 format. When adding a new transaction, this field represents the creation time. When updating a transaction, this field represents the time the transaction was updated.

Unique identifier for the transaction. This is the primary key for the transaction record and should be unique across all transactions. Updates to a transaction should be made using this identifier.

Identifier of the sender, this could be an account number, customer id, or any other unique identifier. If you are sending customer data to Cable, this ID should be able to be referenced in that dataset.

Identifier of the receiver, this could be an account number, customer id, or any other unique identifier.

TransactionAlert

Unique identifier for a alert belonging to a transaction. This is the primary key for a transaction alert and should be unique across all transaction alerts. Updates to a transaction alert should be made using this identifier.

The type of monitoring check that triggered the alert.

Unique identifier for a transaction check for which the alert belongs to.

Additional metadata that relates to a transaction alert.

The time of the transaction alert. This should be in ISO 8601 format. When adding a new transaction alert, this field represents the creation time. When updating a transaction alert, this represents the time of the update.

TransactionAlertCheckType

TransactionAlertStatus

TransactionCheck

Unique identifier for a monitoring check belonging to a transaction. This is the primary key for a transaction check and should be unique across all transaction checks. Updates to a transaction check should be made using this identifier.

The type of monitoring check that is being performed.

Unique identifier for the transaction for which the check is related to.

Additional metadata that relates to a transaction check.

The time of the transaction check. This should be in ISO 8601 format. When adding a new transaction check, this field represents the creation time. When updating a transaction check, this represents the time of the update.

TransactionCheckStatus

TransactionCheckType

TransactionMethod

TransactionScreening

Unique identifier for a transaction screening. This is the primary key for a screening and should be unique across all transaction screenings. Updates to a transaction screening should be made using this identifier.

The provider that provided the screening check.

The list(s) that the transaction was screened against.

Unique identifier for a transaction as it relates to the transaction screening.

Additional metadata that relates to a transaction screening.

The time of the transaction screening. This should be in ISO 8601 format. When adding a new transaction screening, this field represents the creation time. When updating a transaction screening, this represents the time of the update.

TransactionStatus

TransactionSuspiciousActivity

Unique identifier for a suspicious activity belonging to a transaction. This is the primary key for a transaction suspicious activity and should be unique across all transaction suspicious activities. Updates to a transaction suspicious activity should be made using this identifier.

Timestamp at which suspicious activity was detected on a transaction. This should be in the ISO 8601 format.

Unique identifier for a transaction suspicious activity report for which the suspicious activity belongs to.

The time of the transaction suspicious activity report was filed. This should be in ISO 8601 format.

Unique identifiers for transactions for which the suspicious activity relates to.

Unique identifier for a transaction alert for which the suspicious activity relates to.

Additional metadata that relates to a transaction suspicious activity.

The time of the transaction suspicious activity. This should be in ISO 8601 format. When adding a new transaction suspicious activity, this field represents the detection time. When updating a transaction suspicious activity, this represents the time of the update.

TransactionType

UpdateTransactionAlertRequest

UpdateTransactionCheckRequest

UpdateTransactionRequest

UpdateTransactionScreeningRequest

UpdateTransactionSuspiciousActivity

WriteOperationResponse

Indicates if the write operation was successful.

The number of records written to the database.

Provides additional information about the operation result.

The organization ID for which the operation was performed.

CheckTransactionAlertResponse

This represents the earliest timestamp associated with the transaction alert

This represents the latest timestamp associated with the transaction alert

The organization ID for which the transaction alert was found

CheckTransactionCheckResponse

This represents the earliest timestamp associated with the transaction check

This represents the latest timestamp associated with the transaction check

The organization ID for which the transaction check was found

CheckTransactionScreeningResponse

This represents the earliest timestamp associated with the transaction screening

This represents the latest timestamp associated with the transaction screening

The organization ID for which the transaction screening was found

CheckTransactionSuspiciousActivityResponse

This represents the earliest timestamp associated with the transaction suspicious activity

This represents the latest timestamp associated with the transaction suspicious activity

The organization ID for which the transaction suspicious activity was found

CheckTransactionResponse

This represents the earliest timestamp associated with the transaction

This represents the latest timestamp associated with the transaction

The organization ID for which the transaction was found