Create a blocklist

Request

Creates a blocklist.
Security
SecretApiKey or JWT
Bodyapplication/jsonrequired
Blocklist resource.
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.
curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/blocklists \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "type": "payment-card",
    "value": "string",
    "expirationTime": "2019-08-24T14:15:22Z"
  }'

Responses

Blocklist created.
Headers
Locationstring, (uri)
Location of the related resource.
Example:"https://api.rebilly.com/example"
Rate-Limit-Limitinteger

Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.

Example:500
Rate-Limit-Remaininginteger

Number of requests still available for this rate limit. For more information, see Rate limits.

Example:499
Bodyapplication/json
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.
_linksArray of objects(SelfLink)read-only
Related links.
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": [
    { … }
  ]
}