right logo image
right logo image
Ingresar

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

Anfitrión de la API: https://obp-apisandbox.joinfincubator.com
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://https://obp-apisandbox.joinfincubator.com/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 test 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://https://obp-apisandbox.joinfincubator.com/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 test Title, Dynamic-Endpoint, Dynamic,

Get User

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://https://obp-apisandbox.joinfincubator.com/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_User187 - 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 test 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://https://obp-apisandbox.joinfincubator.com/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 test 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://https://obp-apisandbox.joinfincubator.com/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 test Title, Dynamic-Endpoint, Dynamic,

Get Atms

Get list of atms

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://obp-apisandbox.joinfincubator.com/obp/v5.1.0/banks/obp1/atms"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
[{
  "atmId":"1",
  "atmType":"Enum",
  "atmInfo":{
    "name":{
      "arName":"asd",
      "enName":"ASD"
    },
    "address":{
      "addressLines":{
        "line1":"1",
        "line2":"2",
        "line3":"3"
      },
      "city":"Amman",
      "state":"Amman",
      "postCode":"xxx000",
      "countryInfo":{
        "countryCode":"JO",
        "countryName":"Jordan"
      },
      "location":{
        "latitude":0,
        "longitude":0
      },
      "moreInfo":"short walk to the lake from here"
    },
    "institutionBasicInfo":{
      "institutionType":"BANK",
      "institutionIdentification":{
        "schema":"BIC",
        "code":"BIC"
      },
      "name":{
        "enName":"BIC_CODE",
        "arName":"XXXXJOAX",
        "enTradeName":"",
        "arTradeName":""
      },
      "institutionPhoneNumber":"+381631954907"
    },
    "branchBasicInfo":{
      "branchIdentification":{
        "schema":"BIC",
        "code":"BIC"
      },
      "name":{
        "enName":"string",
        "arName":"testtest"
      },
      "branchPhoneNumber":"+381631954907"
    }
  },
  "access24HoursIndicator":true,
  "workingHours":{
    "sunday":{
      "isWorkingDay":true,
      "openingTime":"10:00",
      "closingTime":"18:00",
      "secondOpeningTime":"19:00",
      "secondClosingTime":"23:00"
    },
    "monday":{
      "isWorkingDay":true,
      "openingTime":"10:00",
      "closingTime":"23:00"
    },
    "tuesday":{
      "isWorkingDay":true,
      "openingTime":"10:00",
      "closingTime":"18:00",
      "secondOpeningTime":"19:00",
      "secondClosingTime":"23:00"
    },
    "wednesday":{
      "isWorkingDay":true,
      "openingTime":"10:00",
      "closingTime":"18:00",
      "secondOpeningTime":"19:00",
      "secondClosingTime":"23:00"
    },
    "thursday":{
      
    },
    "friday":{
      
    },
    "saturday":{
      
    }
  },
  "isAvailable":true,
  "hasAccessiblityFeatures":true,
  "accessibilityFeatures":["wheelchairSupported"],
  "hasDepositCapability":true,
  "languages":[{
    "languageCode":"CCC",
    "languageDesc":"asd"
  }],
  "services":["cashOut"],
  "currencies":["JOD"],
  "notes":["test"],
  "minwithdrawal":{
    "currency":"JOD",
    "amount":5
  },
  "maxwithdrawal":{
    "currency":"JOD",
    "amount":5000
  },
  "defaultFeeSurcharges":{
    "defaultCashWithdrawalNationalFee":{
      "currency":"JOD",
      "amount":1
    },
    "defaultCashWithdrawalInternationalFee":{
      "currency":"JOD",
      "amount":1
    },
    "defaultBalanceInquiryFee":{
      "currency":"JOD",
      "amount":"0.2"
    }
  },
  "routings":[{
    "scheme":"CLIQ",
    "address":"RAFBJOAXAXXX"
  }],
  "_links":{
    "self":{
      "href":"institution/{institutionType}/{code}/ATM/{atmId}"
    },
    "institution":{
      "href":"institution/{institutionType}/{code}"
    }
  }
}]
Roles Requeridos:
  • CanGetDynamicEndpoint_Atms464 - 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_atms, operation_id: OBPv4.0.0-dynamicEndpoint_GET_atms Tags: JOPACC ATM TEST service, Dynamic-Endpoint, Dynamic,

Create Atm

Create an atm

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://obp-apisandbox.joinfincubator.com/obp/v5.1.0/banks/obp1/atms2"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "atmId":"1",
  "atmType":"Enum"
}
Roles Requeridos:
  • CanCreateDynamicEndpoint_Atm143 - 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_atms2, operation_id: OBPv4.0.0-dynamicEndpoint_POST_atms2 Tags: JOPACC TEST ATM 2 service, Dynamic-Endpoint, Dynamic,

Get Atms

Get list of atms

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://obp-apisandbox.joinfincubator.com/obp/v5.1.0/banks/obp1/atms2"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
[{
  "atmId":"1",
  "atmType":"Enum"
}]
Roles Requeridos:
  • CanGetDynamicEndpoint_Atms143 - 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_atms2, operation_id: OBPv4.0.0-dynamicEndpoint_GET_atms2 Tags: JOPACC TEST ATM 2 service, Dynamic-Endpoint, Dynamic,

Add A New Pet To The Store

Add a new pet to the store

MethodRouting settings example:

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

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
"Successful operation"
Roles Requeridos:
  • CanCreateDynamicEndpoint_Pet151 - 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_pet, operation_id: OBPv4.0.0-dynamicEndpoint_POST_pet Tags: Swagger Petstore - OpenAPI 3.1, Dynamic-Endpoint, Dynamic,

Deletes A Pet

Delete a pet

MethodRouting settings example:

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

Authentication is Mandatory

Respuesta Exitosa Típica:
Roles Requeridos:
  • CanDeleteDynamicEndpoint_Pet160 - 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_pet_PET_ID, operation_id: OBPv4.0.0-dynamicEndpoint_DELETE_pet_PET_ID Tags: Swagger Petstore - OpenAPI 3.1, Dynamic-Endpoint, Dynamic,

Find Pet By Id

Returns a single pet

MethodRouting settings example:

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

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
"successful operation"
Roles Requeridos:
  • CanGetDynamicEndpoint_PetById160 - 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_pet_PET_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_pet_PET_ID Tags: Swagger Petstore - OpenAPI 3.1, Dynamic-Endpoint, Dynamic,

Update An Existing Pet

Update an existing pet by 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":"//pet"
    },
    {
        "key":"http_method",
        "value":"PUT"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
"Successful operation"
Roles Requeridos:
  • CanUpdateDynamicEndpoint_Pet151 - 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_pet, operation_id: OBPv4.0.0-dynamicEndpoint_PUT_pet Tags: Swagger Petstore - OpenAPI 3.1, Dynamic-Endpoint, Dynamic,

Get Bank Account By Id

Get Bank Account

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://obp_mock//accounts/{account_id}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "name":"family account",
  "balance":1
}
Roles Requeridos:
  • CanGetDynamicEndpoint__account202 - 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_accounts_ACCOUNT_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_accounts_ACCOUNT_ID Tags: test-dynamic, Dynamic-Endpoint, Dynamic,

Get Bank Account By Id

Get Bank Account

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://obp_mock//banks/joinfincubator.01.jo.joinfincubator/accounts/{account_id}"
    },
    {
        "key":"http_method",
        "value":"GET"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "name":"family account",
  "balance":1
}
Roles Requeridos:
  • CanGetDynamicEndpoint__account898 - 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_joinfincubator_01_jo_joinfincubator_accounts_ACCOUNT_ID, operation_id: OBPv4.0.0-dynamicEndpoint_GET_banks_joinfincubator_01_jo_joinfincubator_accounts_ACCOUNT_ID Tags: test-dynamic, Dynamic-Endpoint, Dynamic,

Post Accounts

POST Accounts

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://obp_mock//accounts"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "name":"family account",
  "balance":1
}
Roles Requeridos:
  • CanCreateDynamicEndpoint_POST_account118 - 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_accounts, operation_id: OBPv4.0.0-dynamicEndpoint_POST_accounts Tags: test-dynamic, Dynamic-Endpoint, Dynamic,

Post Accounts

POST Accounts

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://obp_mock//banks/joinfincubator.01.jo.joinfincubator/accounts"
    },
    {
        "key":"http_method",
        "value":"POST"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Respuesta Exitosa Típica: 

								
									
{
  "name":"family account",
  "balance":1
}
Roles Requeridos:
  • CanCreateDynamicEndpoint_POST_account627 - 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_banks_joinfincubator_01_jo_joinfincubator_accounts, operation_id: OBPv4.0.0-dynamicEndpoint_POST_banks_joinfincubator_01_jo_joinfincubator_accounts Tags: test-dynamic, Dynamic-Endpoint, Dynamic,