API Explorer

v4.0.0 (353 APIs)

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":"e19555f0-2add-48fe-83b3-c7e5aca7bac3", "name":"Marko Markosky", "embg":"1234567890123", "amount":30000, "maturity":3, "mobileNumber":"+38970123456", "eMail":"example@yahoo.com", "acptTermsCond":true } }
Required Roles:
  • CanCreateDynamicEntity_creditApplicationForm - Please login to request this Role
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:
Implemented in OBPv4.0.0 by dynamicEntity_createcreditApplicationForm, operation_id: OBPv4.0.0-dynamicEntity_createcreditApplicationForm

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":"9c54e035-ebfa-47c9-9415-bddafec6158f", "name":"Marko Markosky", "embg":"1234567890123", "amount":30000, "maturity":3, "mobileNumber":"+38970123456", "eMail":"example@yahoo.com", "acptTermsCond":true } }
Required Roles:
  • CanDeleteDynamicEntity_creditApplicationForm - Please login to request this Role
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:
Implemented in OBPv4.0.0 by dynamicEntity_deletecreditApplicationForm, operation_id: OBPv4.0.0-dynamicEntity_deletecreditApplicationForm

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":"1a9c3e27-9e2e-489d-9df4-f6e7fb095e12", "name":"Marko Markosky", "embg":"1234567890123", "amount":30000, "maturity":3, "mobileNumber":"+38970123456", "eMail":"example@yahoo.com", "acptTermsCond":true } }] }
Required Roles:
  • CanGetDynamicEntity_creditApplicationForm - Please login to request this Role
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:
Implemented in OBPv4.0.0 by dynamicEntity_getcreditApplicationFormList, operation_id: OBPv4.0.0-dynamicEntity_getcreditApplicationFormList

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":"ca7032d4-44ac-449c-ac59-0f83d5ffff39", "name":"Marko Markosky", "embg":"1234567890123", "amount":30000, "maturity":3, "mobileNumber":"+38970123456", "eMail":"example@yahoo.com", "acptTermsCond":true } }
Required Roles:
  • CanGetDynamicEntity_creditApplicationForm - Please login to request this Role
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:
Implemented in OBPv4.0.0 by dynamicEntity_getSinglecreditApplicationForm, operation_id: OBPv4.0.0-dynamicEntity_getSinglecreditApplicationForm

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":"c0cc5a9b-d80f-4483-afbb-44df988a7521", "name":"Marko Markosky", "embg":"1234567890123", "amount":30000, "maturity":3, "mobileNumber":"+38970123456", "eMail":"example@yahoo.com", "acptTermsCond":true } }
Required Roles:
  • CanUpdateDynamicEntity_creditApplicationForm - Please login to request this Role
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:
Implemented in OBPv4.0.0 by dynamicEntity_updatecreditApplicationForm, operation_id: OBPv4.0.0-dynamicEntity_updatecreditApplicationForm