Skip to main content

Basetemplateconfiguration

Represents a base template

type stringrequired

Represents a base template

Possible values: [WEB_HOOK]

authorizationstring

Model representation of the authorization type.

Possible values: [NO_AUTHORIZATION, BASIC_AUTHORIZATION]

contentTypestringrequired

Model representation of the content type.

Possible values: [PLAIN_TEXT, APPLICATION_JSON, APPLICATION_XML]

headers object[]

The template's message headers.

  • Array [
  • headerKeystringrequired

    The template request header key, which must be unique.

    headerValuestringrequired

    The template request header value, which must be unique.

    idstring

    The template request header ID, which must be unique.

  • ]
  • passwordstring

    If authorization is not default, the password used to authenticate.

    requestTypestringrequired

    Model representation of the HTTP method contained by the requestType field of the template.

    Possible values: [POST, PUT, PATCH]

    urlstringrequired

    The template url, which must be not null.

    usernamestring

    If authorization is not default, the username used to authenticate.

    activatedboolean

    The template activation state. If empty, default is true.

    bodystringrequired

    The template body

    eventstringrequired

    Represents an event of a base template configuration.

    Possible values: [DO_NOTHING, MANUAL, CLIENT_CREATED, CLIENT_APPROVED, GROUP_ACTIVITY, GROUP_CREATED, LOAN_CREATED, INTEREST_RATE_CHANGED, CLIENT_REJECTED, CLIENT_ACTIVITY, LOAN_REPAYMENT, LOAN_REPAYMENT_REVERSAL, FEE_APPLIED, FEE_ADJUSTED, FEE_CHARGED, FEES_DUE_REDUCED, FEE_REDUCTION_ADJUSTMENT, PENALTY_APPLIED, PENALTY_ADJUSTMENT, LOAN_APPROVAL, LOAN_ACCOUNT_CLOSURE, LOAN_ACCOUNT_WRITE_OFF, LOAN_ACCOUNT_REJECTION, LOAN_ACCOUNT_RESCHEDULED, LOAN_ACCOUNT_REFINANCED, REPAYMENT_REMINDER, ACCOUNT_IN_ARREARS, LOAN_DISBURSEMENT, LOAN_DISBURSEMENT_REVERSAL, LOAN_ACCOUNT_ACTIVITY, LOAN_ANTICIPATED_DISBURSEMENT, SAVINGS_CREATED, SAVINGS_DEPOSIT, REAPPLIED_SAVINGS_DEPOSIT, SAVINGS_DEPOSIT_REVERSAL, SAVINGS_APPROVAL, SAVINGS_ACCOUNT_ACTIVATED, SAVINGS_ACCOUNT_CLOSURE, SAVINGS_ACCOUNT_REJECTION, SAVINGS_WITHDRAWAL, REAPPLIED_SAVINGS_WITHDRAWAL, SAVINGS_WITHDRAWAL_REVERSAL, SAVINGS_ACCOUNT_ACTIVITY, DEPOSIT_INTEREST_APPLIED, DEPOSIT_INTEREST_APPLIED_ADJUSTMENT, ACCOUNT_AUTHORISATION_HOLD_CREATED, ACCOUNT_AUTHORISATION_HOLD_SETTLED, CARDS_AUTHORISATION_HOLD_CREATED, CARDS_AUTHORISATION_HOLD_IN_BULK_CREATED, CARDS_AUTHORISATION_HOLD_SETTLED, CARDS_AUTHORISATION_HOLD_AMOUNT_DECREASED, CARDS_AUTHORISATION_HOLD_AMOUNT_INCREASED, CARDS_AUTHORISATION_HOLD_EXPIRED, CARDS_AUTHORISATION_HOLD_REVERSED, CARD_WITHDRAWAL_REVERSAL, CARD_DEPOSIT_REVERSAL, ACCOUNT_AUTHORISATION_HOLD_REVERSED, PORTAL_ACTIVATED, PORTAL_PASSWORD_RESET, END_OF_DAY_PROCESSING_COMPLETED, DATA_ACCESS_STATE_CHANGED, PAYMENT_ORDER_ACTIVITY, COLLECTION_ORDER_ACTIVITY, CREDIT_ARRANGEMENT_CREATED, CREDIT_ARRANGEMENT_CLOSED, CREDIT_ARRANGEMENT_APPROVED, CREDIT_ARRANGEMENT_REJECTED, CREDIT_ARRANGEMENT_WITHDRAWN, CREDIT_ARRANGEMENT_DELETED, CREDIT_ARRANGEMENT_ACCOUNT_ADDED, CREDIT_ARRANGEMENT_ACCOUNT_REMOVED, CREDIT_ARRANGEMENT_EDITED, JOURNAL_ENTRY_ADDED, JOURNAL_ENTRY_ADJUSTED, SAVINGS_TRANSACTION_EDITED]

    filterConstraints object[]

    The template filter constraints.

  • Array [
  • customFieldIdstring

    The custom field id, which is needed to correlate the CUSTOM filter constraint to a custom field.

    dataFieldEntityTypestringrequired

    The custom filter constraint data field entity type.

    dataFieldTypestringrequired

    Represents a data field type of a custom filter constraint.

    Possible values: [NATIVE, CUSTOM]

    dataFieldValuestring

    The custom filter constraint data field value.

    dataTypestringrequired

    Represents a data type of a custom filter constraint.

    Possible values: [BIG_DECIMAL, DATE, DATE_UTC, DATE_TIME, ENUM, KEY, LONG, MONEY, PERCENT, NUMBER, OBJECT, STRING, BOOLEAN, JAVA_BLOB]

    filterElementstringrequired

    Represents a filter element of a custom filter constraint.

    Possible values: [EQUALS, EQUALS_CASE_SENSITIVE, DIFFERENT_THAN, MORE_THAN, MORE_THAN_OR_EQUALS, LESS_THAN, LESS_THAN_OR_EQUALS, BETWEEN, IN, ON, AFTER, AFTER_INCLUSIVE, BEFORE, BEFORE_INCLUSIVE, STARTS_WITH, STARTS_WITH_CASE_SENSITIVE, TODAY, THIS_WEEK, THIS_MONTH, THIS_YEAR, LAST_DAYS, EMPTY, NOT_EMPTY]

    groupNumberinteger<int32>

    The custom filter constraint group number.

    idstring

    The custom filter constraint ID, which must be unique.

    indexinteger<int32>

    The custom filter constraint index.

    secondValuestring

    The custom filter constraint second value.

    valuestringrequired

    The custom filter constraint value, which must be not null.

  • ]
  • filtersLinkingOperatorstring

    Represents an expression operator of a base template configuration.

    Possible values: [MATCH_ALL, MATCH_ANY]

    idstring

    The template ID, which must be unique.

    namestringrequired

    The template name, which must be unique

    subscriptionOptionstring

    Represents a subscription option.

    Possible values: [OPT_IN, OPT_OUT]

    targetstringrequired

    Represents a target type of a base template configuration.

    Possible values: [CLIENT, GROUP, LOANS, SAVINGS, BACKGROUND_PROCESS, DATA_ACCESS, PAYMENT_ORDER, ACCOUNTING]

    triggerstring

    Represents a template trigger type of a base template configuration.

    Possible values: [AUTOMATIC, MANUAL]

    triggerDaysinteger<int32>

    The template trigger days period. If empty, default is 0

    Basetemplateconfiguration
    {
    "activated": true,
    "body": "string",
    "event": "DO_NOTHING",
    "filterConstraints": [
    {
    "customFieldId": "string",
    "dataFieldEntityType": "string",
    "dataFieldType": "NATIVE",
    "dataFieldValue": "string",
    "dataType": "BIG_DECIMAL",
    "filterElement": "EQUALS",
    "groupNumber": 0,
    "id": "string",
    "index": 0,
    "secondValue": "string",
    "value": "string"
    }
    ],
    "filtersLinkingOperator": "MATCH_ALL",
    "id": "string",
    "name": "string",
    "subscriptionOption": "OPT_IN",
    "target": "CLIENT",
    "trigger": "AUTOMATIC",
    "triggerDays": 0,
    "type": "WEB_HOOK"
    }