logo

Create a blocklist with specified ID

Creates a blocklist with a specified ID.

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

ID of the resource.

Request Body schema: application/json

Blocklist resource.

type
required
string

Type of blocklist.

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

Value of the blocklist.

expirationTime
string <date-time>

Date and time when the blocklist expires.

Responses
200

Blocklist updated.

Response Schema: application/json
type
required
string

Type of blocklist.

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

Value of the blocklist.

id
string <= 50 characters

Blocklist ID.

expirationTime
string <date-time>

Date and time when the blocklist expires.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
201

Blocklist created.

Response Headers
Location
string <uri>

Location of the related resource.

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

Type of blocklist.

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

Value of the blocklist.

id
string <= 50 characters

Blocklist ID.

expirationTime
string <date-time>

Date and time when the blocklist expires.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

409

Conflict.

422

Invalid data 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