v5.1.0 filtered by tag: Dynamic (16 APIs)

Anfitrión de la API: https://api.ttk.com.mk
Banco
Cuentas
Vistas
Contrapartes
Transacciones

Create User

Create User

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"http://localhost:8080/user/save"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
{ "id":1, "first_name":"string", "last_name":"string", "age":1, "career":"string" }
Roles Requeridos:
  • CanCreateDynamicEndpoint_User469 - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEndpoint_POST_save, operation_id: OBPv4.0.0-dynamicEndpoint_POST_save Tags: Example Title, Dynamic-Endpoint, Dynamic,

Delete User

Delete user by user ID

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"http://localhost:8080/user/delete/{userId}"
    },
    {
        "key":"http_method",
        "value":"DELETE"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
"the successful delete user by user ID"
Roles Requeridos:
  • CanDeleteDynamicEndpoint_User972 - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEndpoint_DELETE_delete_USER_ID, operation_id: OBPv4.0.0-dynamicEndpoint_DELETE_delete_USER_ID Tags: Example Title, Dynamic-Endpoint, Dynamic,

Get User

Get reuested user by user ID

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"http://localhost:8080/user/getById/{userId}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
{ "id":1, "first_name":"string", "last_name":"string", "age":1, "career":"string" }
Roles Requeridos:
  • CanGetDynamicEndpoint_User202 - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_getById_USER_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_getById_USER_ID Tags: Example Title, Dynamic-Endpoint, Dynamic,

Get Users

Get list of users

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"http://localhost:8080/user/listUsers"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
[{ "id":1, "first_name":"string", "last_name":"string", "age":1, "career":"string" }]
Roles Requeridos:
  • CanGetDynamicEndpoint_Users187 - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_listUsers, operation_id: OBPv4.0.0-dynamicEndpoint_GET_listUsers Tags: Example Title, Dynamic-Endpoint, Dynamic,

Update User

Update User

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"http://localhost:8080/user/updateUser"
    },
    {
        "key":"http_method",
        "value":"PUT"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
{ "id":1, "first_name":"string", "last_name":"string", "age":1, "career":"string" }
Roles Requeridos:
  • CanUpdateDynamicEndpoint_User114 - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEndpoint_PUT_updateUser, operation_id: OBPv4.0.0-dynamicEndpoint_PUT_updateUser Tags: Example Title, Dynamic-Endpoint, Dynamic,

Call Obp_Api Get Banks

Call get banks

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEndpointProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"url_pattern",
        "value":"https://api.ttk.com.mk/obp/v4.0.0/banks"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
[{ "id":"gh.29.uk", "short_name":"short name value", "full_name":"full name value", "logo":"http://xxx/yyy.png", "website":"www.openbankproject.com", "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" } }]
Roles Requeridos:
  • CanGetDynamicEndpoint_Bank143 - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEndpoint_GET_banks, operation_id: OBPv4.0.0-dynamicEndpoint_GET_banks Tags: Swagger Call getBanks, Dynamic-Endpoint, Dynamic,

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

Respuesta Exitosa Típica:

								
									
{ "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 } }
Roles Requeridos:
  • CanCreateDynamicEntity_SystemcreditApplicationForm - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
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

Respuesta Exitosa Típica:

								
									
{ "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 } }
Roles Requeridos:
  • CanDeleteDynamicEntity_SystemcreditApplicationForm - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
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)

Respuesta Exitosa Típica:

								
									
{ "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 } }] }
Roles Requeridos:
  • CanGetDynamicEntity_SystemcreditApplicationForm - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
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

Respuesta Exitosa Típica:

								
									
{ "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 } }
Roles Requeridos:
  • CanGetDynamicEntity_SystemcreditApplicationForm - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
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

Respuesta Exitosa Típica:

								
									
{ "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 } }
Roles Requeridos:
  • CanUpdateDynamicEntity_SystemcreditApplicationForm - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_updatecreditApplicationForm_, operation_id: OBPv4.0.0-dynamicEntity_updatecreditApplicationForm_ Tags: _Credit Application Form, Dynamic-Entity, Dynamic,

Create new TESTING

Create new TESTING.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

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

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
{ "testing":{ "tESTINGId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "name":"James Brown", "number":698761728 } }
Roles Requeridos:
  • CanCreateDynamicEntity_SystemTESTING - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_createTESTING_, operation_id: OBPv4.0.0-dynamicEntity_createTESTING_ Tags: _TESTING, Dynamic-Entity, Dynamic,

Delete TESTING by id

Delete TESTING 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":"TESTING"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
{ "testing":{ "tESTINGId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "name":"James Brown", "number":698761728 } }
Roles Requeridos:
  • CanDeleteDynamicEntity_SystemTESTING - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteTESTING_, operation_id: OBPv4.0.0-dynamicEntity_deleteTESTING_ Tags: _TESTING, Dynamic-Entity, Dynamic,

Get TESTING List

Get TESTING List.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

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

Authentication is Mandatory

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

Respuesta Exitosa Típica:

								
									
{ "testing_list":[{ "testing":{ "tESTINGId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "name":"James Brown", "number":698761728 } }] }
Roles Requeridos:
  • CanGetDynamicEntity_SystemTESTING - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_getTESTINGList_, operation_id: OBPv4.0.0-dynamicEntity_getTESTINGList_ Tags: _TESTING, Dynamic-Entity, Dynamic,

Get TESTING by id

Get TESTING by id.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

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

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
{ "testing":{ "tESTINGId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "name":"James Brown", "number":698761728 } }
Roles Requeridos:
  • CanGetDynamicEntity_SystemTESTING - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleTESTING_, operation_id: OBPv4.0.0-dynamicEntity_getSingleTESTING_ Tags: _TESTING, Dynamic-Entity, Dynamic,

Update TESTING

Update TESTING.

Description of this entity, can be markdown text.

Property List:

  • name: description of name field, can be markdown text.
  • number: description of number field, can be markdown text.

MethodRouting settings example:

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

Authentication is Mandatory

Respuesta Exitosa Típica:

								
									
{ "testing":{ "tESTINGId":"d8839721-ad8f-45dd-9f78-2080414b93f9", "name":"James Brown", "number":698761728 } }
Roles Requeridos:
  • CanUpdateDynamicEntity_SystemTESTING - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by dynamicEntity_updateTESTING_, operation_id: OBPv4.0.0-dynamicEntity_updateTESTING_ Tags: _TESTING, Dynamic-Entity, Dynamic,