Skip to main content

Activate Book Register

Overview​

The ActivateBookRegisterCommand activates an inactive book register, making it usable again.

API Endpoint​

POST /api/bpm/cmd

Headers​

Content-Type: application/json
Authorization: Bearer {access_token}
X-Tenant-ID: {tenant_id}

Request Structure​

{
  "cmd": "ActivateBookRegisterCommand",
  "data": {
    "id": 789,
    "remarks": "Reactivated per customer request"
  }
}

Request Fields​

FieldTypeRequiredDescription
idlongYesThe unique identifier of the book register to activate
remarksstringNoOptional notes explaining the activation

Sample Requests​

1. Activate Previously Deactivated Book​

{
  "cmd": "ActivateBookRegisterCommand",
  "data": {
    "id": 789,
    "remarks": "Customer found missing cheque book, reactivating"
  }
}

2. Activate After Temporary Hold​

{
  "cmd": "ActivateBookRegisterCommand",
  "data": {
    "id": 456,
    "remarks": "Investigation completed - no fraud detected"
  }
}

3. Simple Activation​

{
  "cmd": "ActivateBookRegisterCommand",
  "data": {
    "id": 321
  }
}

Response Structure​

Success Response​

{
  "isSuccessful": true,
  "message": "Book register activated successfully.",
  "statusCode": "00",
  "data": {
    "id": 789,
    "bookType": 1,
    "bookTypeDescription": "Cheque",
    "bookReference": "CHQ-2024-001",
    "depositAccountId": 12345,
    "accountNumber": "1234567890",
    "status": 1,
    "statusDescription": "ACTIVE",
    "isActive": true,
    "remarks": "Reactivated per customer request",
    "updatedAt": "2024-12-05T14:30:00Z",
    "updatedBy": "admin@bank.com"
  }
}

Error Responses​

Book Not Found​

{
  "isSuccessful": false,
  "message": "Book register not found.",
  "statusCode": "99",
  "data": null
}

Already Active​

{
  "isSuccessful": false,
  "message": "Book register is already active.",
  "statusCode": "99",
  "data": null
}

Cannot Activate Blocked Book​

{
  "isSuccessful": false,
  "message": "Cannot activate a blocked book register.",
  "statusCode": "99",
  "data": null
}

Status Transition Rules​

Valid Transitions:

  • INACTIVE (2) → ACTIVE (1) ✅ Allowed

Invalid Transitions:

  • ACTIVE (1) → ACTIVE (1) ❌ Already active
  • BLOCKED (3) → ACTIVE (1) ❌ Blocked books cannot be activated

Use Cases​

1. Customer Found Lost Book​

A customer reported a cheque book as lost, it was deactivated for security. Later, the customer found the book and requests reactivation.

{
  "cmd": "ActivateBookRegisterCommand",
  "data": {
    "id": 789,
    "remarks": "Customer located previously reported lost cheque book"
  }
}

2. Investigation Completed​

A book was deactivated pending fraud investigation. Investigation concluded with no issues found.

{
  "cmd": "ActivateBookRegisterCommand",
  "data": {
    "id": 456,
    "remarks": "Fraud investigation closed - no suspicious activity detected"
  }
}

3. Temporary Suspension Lifted​

A book was temporarily deactivated while updating account details. Account update is complete.

{
  "cmd": "ActivateBookRegisterCommand",
  "data": {
    "id": 321,
    "remarks": "Account details updated, resuming normal operations"
  }
}

Business Rules​

  1. Status Validation

    • Only INACTIVE books can be activated
    • BLOCKED books require special procedures (cannot be activated via API)
    • Already ACTIVE books return an error

  2. Account Status

    • The associated deposit account must be active
    • Inactive accounts prevent book activation

  3. Audit Trail

    • All activations are logged with timestamp and user
    • The remarks field is crucial for audit purposes

Best Practices​

  1. Document Reason

    • Always provide meaningful remarks explaining the activation
    • Reference investigation results or customer requests
    • Include ticket numbers or approval references

  2. Verification Before Activation

    • Verify the customer's identity
    • Confirm the physical book is in customer's possession
    • Check for any pending fraud alerts

  3. Communication

    • Notify the customer when book is reactivated
    • Update any monitoring systems
    • Document in customer interaction logs

  4. Security Considerations

    • Only authorized staff should activate books
    • Require approval for activations after security incidents
    • Monitor for patterns of repeated deactivation/activation

Notes​

  • Activation immediately makes the book usable for transactions
  • Blocked books require manual intervention and cannot be activated via this command
  • Cache is automatically invalidated after successful activation
  • The issuing branch and other details remain unchanged
  • Serial number range remains the same