right logo image
right logo image
Ingresar
⯆

API Explorer

Log off

v2.1.0 (211 APIs)

Anfitrión de la API: https://apisandbox.openbankproject.com
Banco
Cuentas
Vistas
Contrapartes
Transacciones

Enable or Disable Consumers

Enable/Disable a Consumer specified by CONSUMER_ID.

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

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

enabled: false

Respuesta Exitosa Típica: 

								
									
{
  "enabled":false
}
Roles Requeridos:
  • CanEnableConsumers - Please login to request this Role
  • CanDisableConsumers - 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: OBPv2.1.0, function_name: by enableDisableConsumers, operation_id: OBPv2.1.0-enableDisableConsumers Tags: Consumer, Old-Style,

Get Consumer

Get the Consumer specified by CONSUMER_ID.

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

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

app_name: appNameBank

app_type: Web

consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

created:

created_by_user:

created_by_user_id:

description: Description of the object. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: false

provider: ETHEREUM

provider_id:

redirect_url: https://apisandbox.openbankproject.com

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

Respuesta Exitosa Típica: 

								
									
{
  "consumer_id":1213,
  "app_name":"SOFI",
  "app_type":"Web",
  "description":"Account Management",
  "developer_email":"felixsmith@example.com",
  "redirect_url":"www.openbankproject.com",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "created_by_user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "enabled":true,
  "created":"1100-01-01T00:00:00Z"
}
Roles Requeridos:
  • CanGetConsumers - 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-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv2.1.0, function_name: by getConsumer, operation_id: OBPv2.1.0-getConsumer Tags: Consumer, Old-Style,

Get Consumers

Get the all Consumers.

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

JSON response body fields:

app_name: appNameBank

app_type: Web

consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

created:

created_by_user:

created_by_user_id:

description: Description of the object. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: false

list:

provider: ETHEREUM

provider_id:

redirect_url: https://apisandbox.openbankproject.com

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

Respuesta Exitosa Típica: 

								
									
{
  "list":[{
    "consumer_id":1213,
    "app_name":"SOFI",
    "app_type":"Web",
    "description":"Account Management",
    "developer_email":"felixsmith@example.com",
    "redirect_url":"www.openbankproject.com",
    "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "created_by_user":{
      "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "email":"felixsmith@example.com",
      "provider_id":"Chris",
      "provider":"http://127.0.0.1:8080",
      "username":"felixsmith"
    },
    "enabled":true,
    "created":"1100-01-01T00:00:00Z"
  }]
}
Roles Requeridos:
  • CanGetConsumers - 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: OBPv2.1.0, function_name: by getConsumers, operation_id: OBPv2.1.0-getConsumers Tags: Consumer, Old-Style,

Update Consumer RedirectUrl

Update an existing redirectUrl for a Consumer specified by CONSUMER_ID.

CONSUMER_ID can be obtained after you register the application.

Or use the endpoint 'Get Consumers' to get it

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

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

app_name: appNameBank

app_type: Web

consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

created:

created_by_user:

created_by_user_id:

description: Description of the object. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: false

provider: ETHEREUM

provider_id:

redirect_url: https://apisandbox.openbankproject.com

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

Respuesta Exitosa Típica: 

								
									
{
  "consumer_id":1213,
  "app_name":"SOFI",
  "app_type":"Web",
  "description":"Account Management",
  "developer_email":"felixsmith@example.com",
  "redirect_url":"www.openbankproject.com",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "created_by_user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "enabled":true,
  "created":"1100-01-01T00:00:00Z"
}
Roles Requeridos:
  • CanUpdateConsumerRedirectUrl - 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: OBPv2.1.0, function_name: by updateConsumerRedirectUrl, operation_id: OBPv2.1.0-updateConsumerRedirectUrl Tags: Consumer,