Skip to main content
POST
Block an email, IP address or range, card or card range

Authorizations

Authorization
string
header
required

Secret, platform or publishable API key. Platform keys require Payments-Account.

Headers

payments-account
string
payments-version
enum<string>
Available options:
2026-11-01
idempotency-key
string
required
Required string length: 1 - 255

Body

application/json
kind
enum<string>
required
Available options:
email
reason
string
required
Required string length: 1 - 200
value
string
required
Required string length: 3 - 254
stores
string[]
Required array length: 1 - 100 elements
Pattern: ^store_[a-f0-9]{12}$
until
string<date-time>

Response

Block list entry; values are hashed except card ranges.

created_at
string<date-time>
required
id
string
required
Pattern: ^be_[a-f0-9]{12}$
kind
enum<string>
required
Available options:
email,
ip,
card,
card_range,
other
managed_by
enum<string>
required

payments_api: an entry of this API, lifted here. v2: a V2 block rule, shown read-only; lift it in V2.

Available options:
payments_api,
v2
object
enum<string>
required
Available options:
block_list_entry
reason
string
required
source
enum<string>
required
Available options:
merchant,
abuse_detection
stores
string[] | null
required
Pattern: ^store_[a-f0-9]{12}$
until
string<date-time> | null
required
value
string | null
required