GoCardless API API Documentation
Create Blocks by Reference
POST {{url}}/blocks/block_by_ref
Retrieves the details of an existing block.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status Created
| {
"blocks": [
{
"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": "BLC000017A3SYFV",
"block_type": "bank_account",
"reason_type": "no_intent_to_pay",
"created_at": "2023-05-22T20:16:03.695Z",
"updated_at": "2024-03-22T20:46:16.534Z",
"reason_description": "test",
"resource_reference": "BA000TBEH3P6VB",
"active": true
}
],
"meta": {
"cursors": {
"before": null,
"after": null
},
"limit": 50
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/blocks/block_by_ref' -d '{"blocks":{"reference_type":"customer","reference_value":"customer","reason_type":"no_intent_to_pay","reason_description":"test"}}'
ENDPOINTS