Sign in

v1

latestOpenAPI 3.1.02026-07-26490301.4 KB
Consumer

Block user identifier (email, card, etc.)

post/blacklist/block

Request body

name'email' | 'card' | 'accountNumber' | 'consumer' | 'ip' | 'phone' required

Type of identifier to block

valuestring required

Identifier value (e.g., email). Must match the <b>name</b> parameter type (e.g., if <b>name</b> is 'email', provide an email address here)

expiredAtstring date-time nullable

Optional expiration time for the block

blockRelatedItemsboolean

Block all related data associated with the provided identifier under the <b>value</b> parameter

messagestring required

Note or reason for the block

authorstring required

Author of the block request

systemIdstring

Merchant system ID

binstring

Bank Identification Number (for card blocks)

last4string

Last four card digits (for card blocks)

Example request

{
  "name": "email",
  "value": "jonnysonny@example.com",
  "expiredAt": "2025-12-31T23:59:59Z",
  "message": "Suspicious activity",
  "author": "admin_user",
  "bin": "411111",
  "last4": "1111"
}

Response

OK

name'email' | 'card' | 'accountNumber' | 'consumer' | 'ip' | 'phone'

Identifier type

valuestring

The actual value of the identifier (e.g., email address)

systemIdinteger

Merchant system ID

blockedboolean

Whether the identifier is currently blocked

messagestring

Note or reason for the block

timestampinteger

Unix timestamp when the block was applied

Example response

{
  "name": "email",
  "value": "jonnysonny@example.com",
  "systemId": 193,
  "blocked": true,
  "message": "Suspicious activity",
  "timestamp": 1746457103
}