right logo image
right logo image
Ingresar
⯆

API Explorer

Log off

v5.1.0 (549 APIs)

Anfitrión de la API: https://obp-api-sandbox.intercam.com.mx/
Banco
Cuentas
Vistas
Contrapartes
Transacciones

Create Bank Level Endpoint Mapping

Create an Bank Level Endpoint Mapping.

Note: at moment only support the dynamic endpoints

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Parámetros de URL:

BANK_ID: gh.29.uk

Campos del cuerpo de la solicitud JSON:

name: ACCOUNT_MANAGEMENT_FEE

Campos del cuerpo de la respuesta JSON:

name: ACCOUNT_MANAGEMENT_FEE

Respuesta Exitosa Típica: 

								
									
{
  "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"
}
Roles Requeridos:
  • CanCreateBankLevelEndpointMapping - Please login to request this Role
  • CanCreateEndpointMapping - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by createBankLevelEndpointMapping, operation_id: OBPv4.0.0-createBankLevelEndpointMapping Tags: Endpoint-Mapping,

Create Endpoint Mapping

Create an Endpoint Mapping.

Note: at moment only support the dynamic endpoints

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Campos del cuerpo de la solicitud JSON:

name: ACCOUNT_MANAGEMENT_FEE

Campos del cuerpo de la respuesta JSON:

name: ACCOUNT_MANAGEMENT_FEE

Respuesta Exitosa Típica: 

								
									
{
  "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"
}
Roles Requeridos:
  • CanCreateEndpointMapping - 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 createEndpointMapping, operation_id: OBPv4.0.0-createEndpointMapping Tags: Endpoint-Mapping,

Delete Bank Level Endpoint Mapping

Delete a Bank Level Endpoint Mapping.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Parámetros de URL:

BANK_ID: gh.29.uk

ENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID

Campos del cuerpo de la respuesta JSON:

Respuesta Exitosa Típica: 

								
									
true
Roles Requeridos:
  • CanDeleteBankLevelEndpointMapping - Please login to request this Role
  • CanDeleteEndpointMapping - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by deleteBankLevelEndpointMapping, operation_id: OBPv4.0.0-deleteBankLevelEndpointMapping Tags: Endpoint-Mapping,

Delete Endpoint Mapping

Delete a Endpoint Mapping.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Parámetros de URL:

ENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID

Campos del cuerpo de la respuesta JSON:

Respuesta Exitosa Típica: 

								
									
true
Roles Requeridos:
  • CanDeleteEndpointMapping - 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 deleteEndpointMapping, operation_id: OBPv4.0.0-deleteEndpointMapping Tags: Endpoint-Mapping,

Get Bank Level Endpoint Mapping

Get an Bank Level Endpoint Mapping by ENDPOINT_MAPPING_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Parámetros de URL:

BANK_ID: gh.29.uk

ENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID

Campos del cuerpo de la respuesta JSON:

name: ACCOUNT_MANAGEMENT_FEE

Respuesta Exitosa Típica: 

								
									
{
  "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"
}
Roles Requeridos:
  • CanGetBankLevelEndpointMapping - Please login to request this Role
  • CanGetEndpointMapping - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getBankLevelEndpointMapping, operation_id: OBPv4.0.0-getBankLevelEndpointMapping Tags: Endpoint-Mapping,

Get Endpoint Mapping by Id

Get an Endpoint Mapping by ENDPOINT_MAPPING_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Parámetros de URL:

ENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID

Campos del cuerpo de la respuesta JSON:

name: ACCOUNT_MANAGEMENT_FEE

Respuesta Exitosa Típica: 

								
									
{
  "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"
}
Roles Requeridos:
  • CanGetEndpointMapping - 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 getEndpointMapping, operation_id: OBPv4.0.0-getEndpointMapping Tags: Endpoint-Mapping,

Get all Bank Level Endpoint Mappings

Get all Bank Level Endpoint Mappings.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Parámetros de URL:

BANK_ID: gh.29.uk

Campos del cuerpo de la respuesta JSON:

name: ACCOUNT_MANAGEMENT_FEE

Respuesta Exitosa Típica: 

								
									
{
  "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"
  }]
}
Roles Requeridos:
  • CanGetAllBankLevelEndpointMappings - Please login to request this Role
  • CanGetAllEndpointMappings - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getAllBankLevelEndpointMappings, operation_id: OBPv4.0.0-getAllBankLevelEndpointMappings Tags: Endpoint-Mapping,

Get all Endpoint Mappings

Get all Endpoint Mappings.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Campos del cuerpo de la respuesta JSON:

name: ACCOUNT_MANAGEMENT_FEE

Respuesta Exitosa Típica: 

								
									
{
  "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"
  }]
}
Roles Requeridos:
  • CanGetAllEndpointMappings - 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 getAllEndpointMappings, operation_id: OBPv4.0.0-getAllEndpointMappings Tags: Endpoint-Mapping,

Update Bank Level Endpoint Mapping

Update an Bank Level Endpoint Mapping.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Parámetros de URL:

BANK_ID: gh.29.uk

ENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID

Campos del cuerpo de la respuesta JSON:

name: ACCOUNT_MANAGEMENT_FEE

Respuesta Exitosa Típica: 

								
									
{
  "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"
}
Roles Requeridos:
  • CanUpdateBankLevelEndpointMapping - Please login to request this Role
  • CanUpdateEndpointMapping - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • 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.
Métodos de conector::
Version: OBPv4.0.0, function_name: by updateBankLevelEndpointMapping, operation_id: OBPv4.0.0-updateBankLevelEndpointMapping Tags: Endpoint-Mapping,

Update Endpoint Mapping

Update an Endpoint Mapping.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Parámetros de URL:

ENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID

Campos del cuerpo de la respuesta JSON:

name: ACCOUNT_MANAGEMENT_FEE

Respuesta Exitosa Típica: 

								
									
{
  "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"
}
Roles Requeridos:
  • CanUpdateEndpointMapping - 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 updateEndpointMapping, operation_id: OBPv4.0.0-updateEndpointMapping Tags: Endpoint-Mapping,