GoCardless API API Documentation
List Blocks
GET {{url}}/blocks
Returns a cursor-paginated list of your blocks. https://developer.gocardless.com/api-reference/#blocks-list-multiple-blocks
Body
PARAM
| Key | Datatype | Required | Description |
after
|
null | Cursor pointing to the start of the desired set. | |
before
|
null | Cursor pointing to the end of the desired set. | |
limit
|
null | Number of records to return. | |
block
|
null | ID of a Block. | |
block_type
|
null | Type of entity we will seek to match against when blocking the mandate. This can currently be one of ‘email’, ‘email_domain’, ‘bank_account’, or ‘bank_name’. | |
created_at
|
null | Fixed timestamp, recording when this resource was created. | |
reason_type
|
null | The reason you wish to block this payer, can currently be one of ‘identity_fraud’, ‘no_intent_to_pay’, ‘unfair_chargeback’. If the reason isn’t captured by one of the above then ‘other’ can be selected but you must provide a reason description. | |
updated_at
|
null | Fixed timestamp, recording when this resource was updated. |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"blocks": [
{
"id": "BLC0000198BHCM5",
"block_type": "email",
"reason_type": "no_intent_to_pay",
"created_at": "2024-03-22T20:47:33.769Z",
"updated_at": "2024-03-22T20:48:12.358Z",
"reason_description": "test",
"resource_reference": "example123459@example.com",
"active": true
},
{
"id": "BLC0000198AZ6S7",
"block_type": "email",
"reason_type": "no_intent_to_pay",
"created_at": "2024-03-22T20:46:16.519Z",
"updated_at": "2024-03-22T20:46:16.519Z",
"reason_description": "test",
"resource_reference": "robb_homenick25@example.com",
"active": true
},
{
"id": "BLC000019891MTD",
"block_type": "email",
"reason_type": "no_intent_to_pay",
"created_at": "2024-03-22T20:45:43.725Z",
"updated_at": "2024-03-22T20:45:43.725Z",
"reason_description": "test",
"resource_reference": "example123457@example.com",
"active": true
},
{
"id": "BLC000018BA2S2T",
"block_type": "email",
"reason_type": "no_intent_to_pay",
"created_at": "2023-11-29T03:46:48.726Z",
"updated_at": "2023-11-29T03:46:48.726Z",
"reason_description": "test",
"resource_reference": "annabelle.bartell33@example.com",
"active": true
},
{
"id": "BLC000018B2GQDX",
"block_type": "email_domain",
"reason_type": "no_intent_to_pay",
"created_at": "2023-10-09T19:49:40.086Z",
"updated_at": "2023-10-09T19:49:40.086Z",
"reason_description": null,
"resource_reference": "block.com",
"active": true
},
{
"id": "BLC000017AYW7KF",
"block_type": "bank_account",
"reason_type": "no_intent_to_pay",
"created_at": "2023-08-14T16:04:55.699Z",
"updated_at": "2023-08-14T16:04:55.699Z",
"reason_description": "test",
"resource_reference": "BA000VHFSAKFC6",
"active": true
},
{
"id": "BLC000017AX5BWB",
"block_type": "email",
"reason_type": "no_intent_to_pay",
"created_at": "2023-08-14T16:04:55.679Z",
"updated_at": "2023-08-14T16:04:55.679Z",
"reason_description": "test",
"resource_reference": "rose_johnston45@example.net",
"active": true
}
],
"meta": {
"cursors": {
"before": null,
"after": null
},
"limit": 50
}
} |
Curl
curl -X GET 'https://api-sandbox.gocardless.com/blocks?after=&before=&limit=&block=&block_type=&created_at=&reason_type=&updated_at='
ENDPOINTS