Enrollment Services

Enrollment services provides to manage available registries on service provider. You can view and make an update according to any specific decision on available enrollments.

Note: For now, verification is only available enrollment type which means registry for confirmation of payee (pay.uk) directory on clearbank. This means, if status set as active, related bank account is registered on pay.uk directory.

Update

PATCH /bank-account-enrollments/{bankAccountEnrollmentId}

Field	Description
workflow.code	client.verification.direct and organization.verification.direct available values
data.bankAccountEnrollment.status	active and inactive available values.
data.bankAccountEnrollment.reason	If status field set as inactive, this field will be meaningful, otherwise it will be ignored.

{
  "workflow": {
    "code": "client.verification.direct"
  },
  "data": {
    "bankAccountEnrollment": {
      "status": "inactive",
      "reason": "inactive test"
    }
  },
  "connect": {},
  "metadata": {}
}

{
  "workflow": {
    "code": "client.verification.direct"
  },
  "data": {
    "bankAccountEnrollment": {
      "id": "00000000-0000-0000-0000-000000000000",
      "bankAccountId": "00000000-0000-0000-0000-000000000000",
      "owner": "client",
      "type": "verification",
      "status": "inactive",
      "reason": "inactive test",
      "connection": {
        "id": "00000000-0000-0000-0000-000000000000",
        "serviceProvider": "clearbank",
        "status": "inactive",
        "state": "update-in-progress",
        "method": "built-in"
      },
      "serviceProvider": "clearbank"
    }
  },
  "connect": {},
  "metadata": {}
}

List Bank Account Enrollments

GET /bank-account-enrollments

Supported query parameters:

Parameter	Description
metadata.page.number	0-indexed, default=0
metadata.page.size	default=20; max=100
data.bankAccountEnrollment.bankAccountId	UUID of bank account which enrollment belongs to
data.bankAccountEnrollment.owner	organization or client
data.bankAccountEnrollment.type	verification only available type
data.bankAccountEnrollment.status	active or inactive
data.bankAccountEnrollment.serviceProvider

{
  "workflow": {},
  "data": {
    "bankAccountEnrollments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "bankAccountId": "00000000-0000-0000-0000-000000000000",
        "owner": "organization",
        "type": "verification",
        "status": "active",
        "reason": null,
        "connection": {
          "id": "00000000-0000-0000-0000-000000000000",
          "serviceProvider": "clearbank",
          "status": "active",
          "state": "completed-up-to-date",
          "method": "built-in"
        },
        "serviceProvider": "clearbank"
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "bankAccountId": "00000000-0000-0000-0000-000000000000",
        "owner": "client",
        "type": "verification",
        "status": "inactive",
        "reason": "any reason",
        "connection": {
          "id": "00000000-0000-0000-0000-000000000000",
          "serviceProvider": "clearbank",
          "status": "inactive",
          "state": "completed-up-to-date",
          "method": "built-in"
        },
        "serviceProvider": "clearbank"
      }
    ]
  },
  "connect": {},
  "metadata": {
    "page": {
      "size": 20,
      "number": 0,
      "totalElements": 2,
      "totalPages": 1
    }
  }
}

Get Bank Account Enrollment

GET /bank-account-enrollments/{id}

{
  "workflow": {},
  "data": {
    "bankAccountEnrollment": {
      "id": "00000000-0000-0000-0000-000000000000",
      "bankAccountId": "00000000-0000-0000-0000-000000000000",
      "owner": "organization",
      "type": "verification",
      "status": "active",
      "reason": null,
      "connection": {
        "id": "00000000-0000-0000-0000-000000000000",
        "serviceProvider": "clearbank",
        "status": "active",
        "state": "completed-up-to-date",
        "method": "built-in"
      },
      "serviceProvider": "clearbank"
    }
  },
  "connect": {
    "connection": {
      "id": "00000000-0000-0000-0000-000000000000",
      "serviceProvider": "clearbank",
      "status": "active",
      "state": "completed-up-to-date",
      "method": "built-in"
    }
  },
  "metadata": {}
}