/
Retrieve blocklists

Retrieve blocklists

Request

Retrieves a list of all blocklists.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

qstring

Use this field to perform a partial search of text fields.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/blocklists?limit=0&offset=0&sort=string&filter=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of blocklists retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the blocklist.

Example:"blkl_0YV8XTSH9MD578386XQDWSEBNF"
typestringrequired

Type of blocklist.

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

Value of the blocklist.

expirationTimestring or null, (date-time)

Date and time when the blocklist expires.

sourcestring or nullread-only

Source that triggered the creation of the blocklist.

Enum:"automated-blocklists""manual-blocklists""risk-score-rules"
Example:"manual-blocklists"
entityIdstring or nullread-only

ID of the user, transaction or dispute that triggered the creation of the blocklist.

Example:"txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "id": "blkl_0YV8XTSH9MD578386XQDWSEBNF",
    "type": "payment-card",
    "value": "string",
    "expirationTime": "2019-08-24T14:15:22Z",
    "source": "manual-blocklists",
    "entityId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]