Blocklists

Your blocklists contains values of customerIds, email addresses, ipAddresses, bank identification numbers, countries or payment cards that you do NOT want to do business with. They are a good tool for managing risk. A blocklist entry that expires after a period of time we call a greylist.

Retrieve a list of blocklists

Retrieve a list of blocklists.

Authorizations:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

q
string

The partial search of the text fields.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array ()
id
string <= 50 characters

The blocklist identifier string.

type
required
string
Enum: "payment-card" "bank-account" "customer-id" "email" "email-domain" "ip-address" "country" "fingerprint" "bin" "address"

The blocklist type.

value
required
string

The blocklist value.

expirationTime
string <date-time>

The blocklist expiration time.

createdTime
string <date-time>

The blocklist created time.

updatedTime
string <date-time>

The blocklist updated time.

Array of objects (SelfLink) non-empty

The links related to resource.

Request samples

$blocklists = $client->blocklists()->search([
    'filter' => 'value:testValue',
]);

Response samples

Content type
application/json
[
  • {
    }
]

Create a blocklist

Create a blocklist.

Authorizations:
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Request Body schema: application/json

Blocklist resource.

type
required
string
Enum: "payment-card" "bank-account" "customer-id" "email" "email-domain" "ip-address" "country" "fingerprint" "bin" "address"

The blocklist type.

value
required
string

The blocklist value.

expirationTime
string <date-time>

The blocklist expiration time.

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The blocklist identifier string.

type
required
string
Enum: "payment-card" "bank-account" "customer-id" "email" "email-domain" "ip-address" "country" "fingerprint" "bin" "address"

The blocklist type.

value
required
string

The blocklist value.

expirationTime
string <date-time>

The blocklist expiration time.

createdTime
string <date-time>

The blocklist created time.

updatedTime
string <date-time>

The blocklist updated time.

Array of objects (SelfLink) non-empty

The links related to resource.

Request samples

Content type
application/json
{
  • "type": "payment-card",
  • "value": "string",
  • "expirationTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "payment-card",
  • "value": "string",
  • "expirationTime": "2019-08-24T14:15:22Z",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Retrieve a blocklist

Retrieve a blocklist with specified identifier string.

Authorizations:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The blocklist identifier string.

type
required
string
Enum: "payment-card" "bank-account" "customer-id" "email" "email-domain" "ip-address" "country" "fingerprint" "bin" "address"

The blocklist type.

value
required
string

The blocklist value.

expirationTime
string <date-time>

The blocklist expiration time.

createdTime
string <date-time>

The blocklist created time.

updatedTime
string <date-time>

The blocklist updated time.

Array of objects (SelfLink) non-empty

The links related to resource.

Request samples

$blocklist = $client->blocklists()->load('blocklistId');

Response samples

Content type
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "payment-card",
  • "value": "string",
  • "expirationTime": "2019-08-24T14:15:22Z",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Create a blocklist with predefined ID

Create a blocklist with predefined identifier string.

Authorizations:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Request Body schema: application/json

Blocklist resource.

type
required
string
Enum: "payment-card" "bank-account" "customer-id" "email" "email-domain" "ip-address" "country" "fingerprint" "bin" "address"

The blocklist type.

value
required
string

The blocklist value.

expirationTime
string <date-time>

The blocklist expiration time.

Responses

Response Headers
Rate-Limit-Limit
integer

The number of allowed requests in the current period.

Rate-Limit-Remaining
integer

The number of remaining requests in the current period.

Rate-Limit-Reset
string

The date in format defined by RFC 822 when the current period will reset.

Response Schema: application/json
id
string <= 50 characters

The blocklist identifier string.

type
required
string
Enum: "payment-card" "bank-account" "customer-id" "email" "email-domain" "ip-address" "country" "fingerprint" "bin" "address"

The blocklist type.

value
required
string

The blocklist value.

expirationTime
string <date-time>

The blocklist expiration time.

createdTime
string <date-time>

The blocklist created time.

updatedTime
string <date-time>

The blocklist updated time.

Array of objects (SelfLink) non-empty

The links related to resource.

Request samples

Content type
application/json
{
  • "type": "payment-card",
  • "value": "string",
  • "expirationTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "payment-card",
  • "value": "string",
  • "expirationTime": "2019-08-24T14:15:22Z",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Delete a blocklist

Delete a blocklist with predefined identifier string.

Authorizations:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

Responses

Request samples

$client->blocklists()->delete('blocklistId');

Response samples

Content type
application/json
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string"
}