Skip to main content
Custom fields allow you to associate additional data with your claims using key-value pairs. This feature provides flexibility to include additional information that isn’t covered by Decisionly’s standard fields.

​
Custom Field Requirements

Custom fields must adhere to the following requirements:
  • Field limit: Maximum of 25 key-value pairs per claim
  • Key constraints: Each key must be 50 characters or fewer
  • Value types: Values must be strings only
  • String values: Maximum length of 250 characters

​
Using Custom Fields

When creating or updating a claim, you can include custom fields in your request body. These fields can be used to:
  • Store internal reference IDs
  • Include category or classification data
  • Trigger workflow rules for automated case handling
  • Store any other relevant claim metadata

​
Managing Custom Fields

You can create, update, and remove custom fields as needed:
  • Create/Update: Set a value for the field in your request
  • Remove: Set the field value to null to completely remove the key-value pair from the claim

​
Example

// POST /v2/issuer/claims
{
  "cardholder": {
    "name": "Jane Smith",
    "email": "jane@example.com",
    "type": "individual"
  },
  "card": {
    "network": "visa",
    "type": "credit",
    "last4": "4242",
    "expiry_month": 12,
    "expiry_year": 2028
  },
  "dispute": {
    "reason": "fraud",
    "raised_by": "cardholder",
    "date": "2025-02-01T00:00:00.000Z"
  },
  "custom_fields": {
    "internal_reference_id": "REF-12345",
    "wallet_type": "mobile",
    "customer_category": "platinum",
    "card_program": "CardHub"
  }
}

​
Custom Fields with Workflow Rules

Custom fields can power Decisionly’s workflow rules, enabling automated actions based on field values. When using custom fields for workflow automation:
  • Maintain consistency: Use identical string values across cases (e.g., always use “high_priority” instead of mixing with “High Priority”)
  • Document conventions: Maintain internal documentation of your custom field naming and value conventions