GOgocardless
Block

List multiple blocks

Returns a cursor-paginated list of your blocks.

get/blocks

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Query parameters

beforestring nullable

Cursor pointing to the end of the desired set.

afterstring nullable

Cursor pointing to the start of the desired set.

integer
OR
string

Number of records to return.

gtstring date-time

Limit to records created after the specified date-time.

ltstring date-time

Limit to records created before the specified date-time.

gtestring date-time

Limit to records created on or after the specified date-time.

ltestring date-time

Limit to records created on or before the specified date-time.

block_type'email' | 'email_domain' | 'bank_account' | 'bank_name'

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'.

reason_type'identity_fraud' | 'no_intent_to_pay' | 'unfair_chargeback' | 'other'

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.

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "blocks": [
    {
      "id": "BLC123",
      "resource_reference": "example@example.com",
      "active": true,
      "created_at": "2014-01-01T12:00:00.000Z",
      "updated_at": "2014-01-01T12:00:00.000Z"
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.