GOgocardless
Block

Create blocks by reference

Creates new blocks for a given reference. By default blocks will be active. Returns 201 if at least one block was created. Returns 200 if there were no new blocks created.

post/blocks/block_by_ref

Request

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

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "blocks": {
    "reference_value": "CU123",
    "active": true
  }
}

Response

Resource created successfully

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.