right logo image
right logo image
Log on
⯆

API Explorer

Log off

v3.1 (83 APIs)

API Host: https://api.ttk.com.mk
Bank
Accounts
Views
Counterparties
Transactions

Create new Credit Application Form

Create new Credit Application Form.

Form will be used for applying for a loan trough OBP APIs

Property List:

  • name: Enter a name and surname of applicant
  • embg: Applicant social sec number
  • amount: Applicant desired loan amount. Can be expressed in MKD only
  • maturity: Applicant desired loan maturity. Can be expressed in months only
  • mobileNumber: Applicant mobile phone number
  • eMail: Applicant email address
  • acptTermsCond: Applicant has accepted terms and conditions of this product

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"creditApplicationForm"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "credit_application_form":{
    "creditApplicationFormId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"Marko Markosky",
    "embg":"1234567890123",
    "amount":30000,
    "maturity":3,
    "mobileNumber":"+38970123456",
    "eMail":"example@yahoo.com",
    "acptTermsCond":true
  }
}
Required Roles:
  • CanCreateDynamicEntity_SystemcreditApplicationForm - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_createcreditApplicationForm_, operation_id: OBPv4.0.0-dynamicEntity_createcreditApplicationForm_ Tags: _Credit Application Form, Dynamic-Entity, Dynamic,

Delete Credit Application Form by id

Delete Credit Application Form by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"creditApplicationForm"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "credit_application_form":{
    "creditApplicationFormId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"Marko Markosky",
    "embg":"1234567890123",
    "amount":30000,
    "maturity":3,
    "mobileNumber":"+38970123456",
    "eMail":"example@yahoo.com",
    "acptTermsCond":true
  }
}
Required Roles:
  • CanDeleteDynamicEntity_SystemcreditApplicationForm - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_deletecreditApplicationForm_, operation_id: OBPv4.0.0-dynamicEntity_deletecreditApplicationForm_ Tags: _Credit Application Form, Dynamic-Entity, Dynamic,

Get Credit Application Form List

Get Credit Application Form List.

Form will be used for applying for a loan trough OBP APIs

Property List:

  • name: Enter a name and surname of applicant
  • embg: Applicant social sec number
  • amount: Applicant desired loan amount. Can be expressed in MKD only
  • maturity: Applicant desired loan maturity. Can be expressed in months only
  • mobileNumber: Applicant mobile phone number
  • eMail: Applicant email address
  • acptTermsCond: Applicant has accepted terms and conditions of this product

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"creditApplicationForm"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /creditApplicationForm?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "credit_application_form_list":[{
    "credit_application_form":{
      "creditApplicationFormId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "name":"Marko Markosky",
      "embg":"1234567890123",
      "amount":30000,
      "maturity":3,
      "mobileNumber":"+38970123456",
      "eMail":"example@yahoo.com",
      "acptTermsCond":true
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_SystemcreditApplicationForm - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getcreditApplicationFormList_, operation_id: OBPv4.0.0-dynamicEntity_getcreditApplicationFormList_ Tags: _Credit Application Form, Dynamic-Entity, Dynamic,

Get Credit Application Form by id

Get Credit Application Form by id.

Form will be used for applying for a loan trough OBP APIs

Property List:

  • name: Enter a name and surname of applicant
  • embg: Applicant social sec number
  • amount: Applicant desired loan amount. Can be expressed in MKD only
  • maturity: Applicant desired loan maturity. Can be expressed in months only
  • mobileNumber: Applicant mobile phone number
  • eMail: Applicant email address
  • acptTermsCond: Applicant has accepted terms and conditions of this product

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"creditApplicationForm"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "credit_application_form":{
    "creditApplicationFormId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"Marko Markosky",
    "embg":"1234567890123",
    "amount":30000,
    "maturity":3,
    "mobileNumber":"+38970123456",
    "eMail":"example@yahoo.com",
    "acptTermsCond":true
  }
}
Required Roles:
  • CanGetDynamicEntity_SystemcreditApplicationForm - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getSinglecreditApplicationForm_, operation_id: OBPv4.0.0-dynamicEntity_getSinglecreditApplicationForm_ Tags: _Credit Application Form, Dynamic-Entity, Dynamic,

Update Credit Application Form

Update Credit Application Form.

Form will be used for applying for a loan trough OBP APIs

Property List:

  • name: Enter a name and surname of applicant
  • embg: Applicant social sec number
  • amount: Applicant desired loan amount. Can be expressed in MKD only
  • maturity: Applicant desired loan maturity. Can be expressed in months only
  • mobileNumber: Applicant mobile phone number
  • eMail: Applicant email address
  • acptTermsCond: Applicant has accepted terms and conditions of this product

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"creditApplicationForm"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "credit_application_form":{
    "creditApplicationFormId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "name":"Marko Markosky",
    "embg":"1234567890123",
    "amount":30000,
    "maturity":3,
    "mobileNumber":"+38970123456",
    "eMail":"example@yahoo.com",
    "acptTermsCond":true
  }
}
Required Roles:
  • CanUpdateDynamicEntity_SystemcreditApplicationForm - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_updatecreditApplicationForm_, operation_id: OBPv4.0.0-dynamicEntity_updatecreditApplicationForm_ Tags: _Credit Application Form, Dynamic-Entity, Dynamic,