Create an accept list

Prev Next
Post
/v1/workflows

POST creates a temporary accept list (whitelist) using the `validUntil` field and additional criteria. 

All matching future transaction cases will be automatically accepted.


Security
API Key: API_KEY
Header parameter nameapi-key
Body parameters

workflowRequest

Expand All
object
acceptList
object (AcceptListRequest)
caseId
string (uuid) Required

Anchor point to identify original case that the account was whitelisted for tenantTransactionId

Example25721f57-038b-4b71-884a-e18f85c01288
criteria
Array of object (Criteria) Required

List of criteria to be met for the transaction to be considered as accepted. If multiple criteria are provided, at least one must be met by transaction. Otherwise, transaction is considered as not temporary accepted and normal processing is happening for it.

Example[ { "type": "accountId", "id": "25721f57-038b-4b71-884a-e18f85c01288" } ]
object
id
string Required

Value

Example25721f57-038b-4b71-884a-e18f85c01288
type
string Required

Type of the value. Currently supported values are accountId and accountNumber.

Valid values[ "ACCOUNT_ID", "ACCOUNT_NUMBER" ]
ExampleaccountId
tenantTransactionId
string Required

Unique identifier for the transaction

Example25721f57-038b-4b71-884a-e18f85c01288
validUntil
string (date-time) Required

Date and time the accept list is valid until in UTC time zone.

Example2024-06-16T14:38:47.812Z
Responses
200

Successfully processed Workflow

Expand All
object
acceptList
object (AcceptListRequest)
caseId
string (uuid)

Anchor point to identify original case that the account was whitelisted for tenantTransactionId

Example25721f57-038b-4b71-884a-e18f85c01288
criteria
Array of object (Criteria)

List of criteria to be met for the transaction to be considered as accepted. If multiple criteria are provided, at least one must be met by transaction. Otherwise, transaction is considered as not temporary accepted and normal processing is happening for it.

Example[ { "type": "accountId", "id": "25721f57-038b-4b71-884a-e18f85c01288" } ]
object
id
string

Value

Example25721f57-038b-4b71-884a-e18f85c01288
type
string

Type of the value. Currently supported values are accountId and accountNumber.

Valid values[ "ACCOUNT_ID", "ACCOUNT_NUMBER" ]
ExampleaccountId
tenantTransactionId
string

Unique identifier for the transaction

Example25721f57-038b-4b71-884a-e18f85c01288
validUntil
string (date-time)

Date and time the accept list is valid until in UTC time zone.

Example2024-06-16T14:38:47.812Z
400

Bad request

401

Unauthorized

403

Forbidden

429

Too many requests. Please retry later