logo

Create a blocklist with predefined ID

Create a blocklist with predefined identifier string.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Request Body schema: application/json

Blocklist resource.

type
required
string

The blocklist type.

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

The blocklist value.

expirationTime
string <date-time>

The blocklist expiration time.

Responses
201

Blocklist was created.

Response Headers
Location
string <uri>

The location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
type
required
string

The blocklist type.

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

The blocklist value.

id
string <= 50 characters

The blocklist identifier string.

expirationTime
string <date-time>

The blocklist expiration time.

createdTime
string <date-time>

The blocklist created time.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp updates when the resource is updated.

Array of objects (Self) non-empty

The links related to resource.

Array (non-empty)
href
required
string

The link URL.

rel
required
string

The link type.

Value: "self"
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

409

Conflict.

422

Invalid data was sent.

put/blocklists/{id}
Request samples
application/json
{
  • "type": "payment-card",
  • "value": "string",
  • "expirationTime": "2019-08-24T14:15:22Z"
}
Response samples
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": [
    ]
}
➔ Next to Delete a blocklist