GET /v1/blocklist #
Your blocklist, newest first
The e-mail addresses, tax ids and external customer ids that a new customer, or a customer's new e-mail address or tax id, may not match (error key plans.customer.blocklisted, on creating a customer and on changing the contact details or the tax data). At most 1000 entries, so the list is not paged. Customers that exist when an entry is added are not touched: block them from the customer list. The operator keeps a platform-wide list of its own that holds the same gates for every app; it is not shown here and a refusal does not say which list it was. Needs customers:read.
Responses
Example response
{
"entries": [
{
"id": "0192f0b4-6f6e-7c3a-9a3e-6a1f2b3c4d5e",
"kind": "email",
"value": "string",
"note": "string",
"created_by": "string",
"create_time": "2026-11-03T10:15:00Z"
}
]
}
curl
curl -X GET https://YOUR-API-ADDRESS/v1/blocklist \
-H "Authorization: Bearer $PAYRUDDER_API_KEY"
POST /v1/blocklist #
Put an e-mail address, a tax id or an external customer id on your blocklist
The value is normalised: an e-mail address in lower case, a tax id without spaces and dashes in capitals, an external id as it is. An entry that is there is returned as it is. The note is yours and is never shown to the person the entry is about. Recorded in the audit log without the value. Error key plans.blocklist.full at 1000 entries. Needs customers:write.
Request body
| Field | Type | Description |
|---|
kind required | email | tax_id | external_id | |
value required | string | |
note | string | |
Example
{
"kind": "email",
"value": "string"
}
Responses
Example response
{
"id": "0192f0b4-6f6e-7c3a-9a3e-6a1f2b3c4d5e",
"kind": "email",
"value": "string",
"note": "string",
"created_by": "string",
"create_time": "2026-11-03T10:15:00Z"
}
curl
curl -X POST https://YOUR-API-ADDRESS/v1/blocklist \
-H "Authorization: Bearer $PAYRUDDER_API_KEY" \
-H "Content-Type: application/json" \
-d '{"kind":"email","value":"string"}'
DELETE /v1/blocklist/{id} #
Take an entry off your blocklist
Parameters
| Name | In | Type | Description |
|---|
id required | path | string · uuid | |
Responses
| Status | Meaning | Body |
|---|
204 | Removed | |
404 | Error envelope | Error |
curl
curl -X DELETE https://YOUR-API-ADDRESS/v1/blocklist/<id> \
-H "Authorization: Bearer $PAYRUDDER_API_KEY"