Create one list (BlackWhiteList) in company

post

https://api.embermind.ch/api/v1/client/bw-lists/create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

title

string

required

length ≥ 1

type

string

enum

required

Allowed:

matchMode

string

enum

Match mode for WHITE lists: OR - match any condition (default), AND - all condition types must match. Ignored for BLACK lists (always OR).

Allowed:

requirementMode

string

enum

WHITE lists only. REQUIRED - the customer must satisfy this list, otherwise the gate is blocked regardless of other white lists in scope. ANY_OF - "any of is enough" (default). Requesting REQUIRED for a BLACK list is a validation error.

Allowed:

isGrayListTolerable

boolean

Optional, BLACK and WHITE lists. true - the list is not checked on gates whose gate item in transaction/process carries isGrayListTolerance=true: its black entries do not match there, and a white list drops out of such a gate scope. Other gates check it as usual. Absent means false.

bwItemList

array of objects

required

bwItemList*

transactionTypeFilter

string

enum

Sets the applicability of EVERY attribute of the list at once, including attribute types the list does not contain yet: ALL - pay-in and pay-out, PAYMENT - pay-in only, WITHDRAW - pay-out only. Omit to follow the company default for every attribute. Applies to BLACK and WHITE lists. A combined value (several attribute types in one entry) has its own setting: bw-lists/attribute-transaction-type/update.

Allowed:

cascadeTarget

required

Per-dimension target: ALL/DIRECT/NONE. ALL = all entities, DIRECT = only listed, NONE = dimension disabled.

gateTarget

required

Per-dimension target: ALL/DIRECT/NONE. ALL = all entities, DIRECT = only listed, NONE = dimension disabled.

merchantTarget

required

Per-dimension target: ALL/DIRECT/NONE. ALL = all entities, DIRECT = only listed, NONE = dimension disabled.

bankTarget

required

Per-dimension target: ALL/DIRECT/NONE. ALL = all entities, DIRECT = only listed, NONE = dimension disabled.

merchantAccountTarget

Optional. Absent means ALL -- matches the column default given to every list created before this dimension existed.

Headers

x-api-key

string

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Response

400Response

500Response