-
Endpoint Mapping
-
Endpoint Mapping can be used to map each JSON field in a Dynamic Endpoint to different Dynamic EntiMore...
- Create Bank Level Endpoint Mapping
- Create Endpoint Mapping
- Delete Bank Level Endpoint Mapping
- Delete Endpoint Mapping
- Get Bank Level Endpoint Mapping
- Get Endpoint Mapping by Id
- Get all Bank Level Endpoint Mappings
- Get all Endpoint Mappings
- Update Bank Level Endpoint Mapping
- Update Endpoint Mapping
-
-
Endpoint Mapping
- Create Bank Level Endpoint Mapping
- Create Endpoint Mapping
- Delete Bank Level Endpoint Mapping
- Delete Endpoint Mapping
- Get Bank Level Endpoint Mapping
- Get Endpoint Mapping by Id
- Get all Bank Level Endpoint Mappings
- Get all Endpoint Mappings
- Update Bank Level Endpoint Mapping
- Update Endpoint Mapping
v5.1.0 filtered by tag: Endpoint-Mapping (10 APIs)
Create Bank Level Endpoint Mapping
{
"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account",
"request_mapping":{
},
"response_mapping":{
"name":{
"entity":"FooBar",
"field":"name",
"query":"number"
},
"balance":{
"entity":"FashionBrand",
"field":"number",
"query":"number"
}
},
"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}
-
CanCreateBankLevelEndpointMapping
- Please login to request this Role
-
CanCreateEndpointMapping
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- 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.
Create Endpoint Mapping
{
"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account",
"request_mapping":{
},
"response_mapping":{
"name":{
"entity":"FooBar",
"field":"name",
"query":"number"
},
"balance":{
"entity":"FashionBrand",
"field":"number",
"query":"number"
}
},
"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}
-
CanCreateEndpointMapping
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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.
Delete Bank Level Endpoint Mapping
Delete a Bank Level Endpoint Mapping.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
ENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
JSON response body fields:
true
-
CanDeleteBankLevelEndpointMapping
- Please login to request this Role
-
CanDeleteEndpointMapping
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- 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.
Delete Endpoint Mapping
Delete a Endpoint Mapping.
Authentication is Mandatory
URL Parameters:
ENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
JSON response body fields:
true
-
CanDeleteEndpointMapping
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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.
Get Bank Level Endpoint Mapping
Get an Bank Level Endpoint Mapping by ENDPOINT_MAPPING_ID.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
ENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
JSON response body fields:
name: ACCOUNT_MANAGEMENT_FEE
{
"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account",
"request_mapping":{
},
"response_mapping":{
"name":{
"entity":"FooBar",
"field":"name",
"query":"number"
},
"balance":{
"entity":"FashionBrand",
"field":"number",
"query":"number"
}
},
"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}
-
CanGetBankLevelEndpointMapping
- Please login to request this Role
-
CanGetEndpointMapping
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Endpoint Mapping by Id
Get an Endpoint Mapping by ENDPOINT_MAPPING_ID.
Authentication is Mandatory
URL Parameters:
ENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
JSON response body fields:
name: ACCOUNT_MANAGEMENT_FEE
{
"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account",
"request_mapping":{
},
"response_mapping":{
"name":{
"entity":"FooBar",
"field":"name",
"query":"number"
},
"balance":{
"entity":"FashionBrand",
"field":"number",
"query":"number"
}
},
"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}
-
CanGetEndpointMapping
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get all Bank Level Endpoint Mappings
{
"endpoint-mappings":[{
"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account",
"request_mapping":{
},
"response_mapping":{
"name":{
"entity":"FooBar",
"field":"name",
"query":"number"
},
"balance":{
"entity":"FashionBrand",
"field":"number",
"query":"number"
}
},
"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}]
}
-
CanGetAllBankLevelEndpointMappings
- Please login to request this Role
-
CanGetAllEndpointMappings
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get all Endpoint Mappings
Get all Endpoint Mappings.
Authentication is Mandatory
JSON response body fields:
name: ACCOUNT_MANAGEMENT_FEE
{
"endpoint-mappings":[{
"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account",
"request_mapping":{
},
"response_mapping":{
"name":{
"entity":"FooBar",
"field":"name",
"query":"number"
},
"balance":{
"entity":"FashionBrand",
"field":"number",
"query":"number"
}
},
"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}]
}
-
CanGetAllEndpointMappings
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Update Bank Level Endpoint Mapping
Update an Bank Level Endpoint Mapping.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
ENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
JSON response body fields:
name: ACCOUNT_MANAGEMENT_FEE
{
"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account",
"request_mapping":{
},
"response_mapping":{
"name":{
"entity":"FooBar",
"field":"name",
"query":"number"
},
"balance":{
"entity":"FashionBrand",
"field":"number",
"query":"number"
}
},
"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}
-
CanUpdateBankLevelEndpointMapping
- Please login to request this Role
-
CanUpdateEndpointMapping
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- 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.
Update Endpoint Mapping
Update an Endpoint Mapping.
Authentication is Mandatory
URL Parameters:
ENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
JSON response body fields:
name: ACCOUNT_MANAGEMENT_FEE
{
"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account",
"request_mapping":{
},
"response_mapping":{
"name":{
"entity":"FooBar",
"field":"name",
"query":"number"
},
"balance":{
"entity":"FashionBrand",
"field":"number",
"query":"number"
}
},
"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}
-
CanUpdateEndpointMapping
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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.