right logo image
right logo image
Ingresar

v5.1.0 filtered by tag: Consumer (11 APIs)

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

Enable or Disable Consumers

Enable/Disable a Consumer specified by CONSUMER_ID.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

enabled: true

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: OBPv3.1.0, function_name: by enableDisableConsumers, operation_id: OBPv3.1.0-enableDisableConsumers Tags: Consumer,

Get Call Limits for a Consumer

Get Calls limits per Consumer.
Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

per_day_call_limit:

per_hour_call_limit:

per_minute_call_limit:

per_month_call_limit:

per_second_call_limit: 10

per_week_call_limit:

calls_made: 50

current_state:

per_day: 4000

per_hour:

per_minute:

per_month: 500

per_second: 1000

per_week: 50000

reset_in_seconds:

Respuesta Exitosa Típica: 

								
									
{
  "per_second_call_limit":"-1",
  "per_minute_call_limit":"-1",
  "per_hour_call_limit":"-1",
  "per_day_call_limit":"-1",
  "per_week_call_limit":"-1",
  "per_month_call_limit":"-1",
  "current_state":{
    "per_second":{
      "calls_made":-1,
      "reset_in_seconds":-1
    },
    "per_minute":{
      "calls_made":-1,
      "reset_in_seconds":-1
    },
    "per_hour":{
      "calls_made":-1,
      "reset_in_seconds":-1
    },
    "per_day":{
      "calls_made":-1,
      "reset_in_seconds":-1
    },
    "per_week":{
      "calls_made":-1,
      "reset_in_seconds":-1
    },
    "per_month":{
      "calls_made":-1,
      "reset_in_seconds":-1
    }
  }
}
Roles Requeridos:
  • CanSetCallLimits - 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-10001: Incorrect json format.
  • OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30023: Cannot update Consumer
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.1.0, function_name: by getCallsLimit, operation_id: OBPv3.1.0-getCallsLimit Tags: Consumer,

Get Consumer

Get the Consumer specified by CONSUMER_ID.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

app_name:

app_type:

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

created:

created_by_user:

created_by_user_id:

description: This an optional field. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: true

provider: ETHEREUM

provider_id:

redirect_url:

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-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.1.0, function_name: by getConsumer, operation_id: OBPv3.1.0-getConsumer Tags: Consumer,

Get Consumers

Get the all Consumers.

Authentication is Mandatory

JSON response body fields:

app_name:

app_type:

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

consumers:

created:

created_by_user:

description: This an optional field. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: true

provider: ETHEREUM

provider_id:

redirect_url:

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

username: felixsmith

Respuesta Exitosa Típica: 

								
									
{
  "consumers":[{
    "consumer_id":"8e716299-4668-4efd-976a-67f57a9984ec",
    "app_name":"SOFI",
    "app_type":"Web",
    "description":"Account Management",
    "developer_email":"felixsmith@example.com",
    "redirect_url":"www.openbankproject.com",
    "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: OBPv3.1.0, function_name: by getConsumers, operation_id: OBPv3.1.0-getConsumers Tags: Consumer,

Get Consumers (logged in User)

Get the Consumers for logged in User.

Authentication is Mandatory

JSON response body fields:

app_name:

app_type:

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

consumers:

created:

created_by_user:

description: This an optional field. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: true

provider: ETHEREUM

provider_id:

redirect_url:

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

username: felixsmith

Respuesta Exitosa Típica: 

								
									
{
  "consumers":[{
    "consumer_id":"8e716299-4668-4efd-976a-67f57a9984ec",
    "app_name":"SOFI",
    "app_type":"Web",
    "description":"Account Management",
    "developer_email":"felixsmith@example.com",
    "redirect_url":"www.openbankproject.com",
    "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"
  }]
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.1.0, function_name: by getConsumersForCurrentUser, operation_id: OBPv3.1.0-getConsumersForCurrentUser Tags: Consumer,

Post a Consumer

Create a Consumer (Authenticated access).

Authentication is Mandatory

JSON request body fields:

app_name:

app_type:

clientCertificate: clientCertificate

created:

created_by_user_id:

description: This an optional field. Maximum length is 2000. It can be any characters here.

developer_email:

enabled: true

redirect_url:

JSON response body fields:

app_name:

app_type:

client_certificate: client_certificate

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

created:

created_by_user:

created_by_user_id:

description: This an optional field. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: true

key: CustomerNumber

provider: ETHEREUM

provider_id:

redirect_url:

secret: secret

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

username: felixsmith

Respuesta Exitosa Típica: 

								
									
{
  "consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "key":"xwdgylv3vau0n2gkxu1aize4glapftfldp5y1bic",
  "secret":"bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq",
  "app_name":"SOFI",
  "app_type":"Web",
  "description":"Account Management",
  "client_certificate":"-----BEGIN CERTIFICATE-----\nclient_certificate_content\n-----END CERTIFICATE-----",
  "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:
  • CanCreateConsumer - 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 createConsumer, operation_id: OBPv4.0.0-createConsumer Tags: Consumer,

Set Calls Limit for a Consumer

Set the API call limits for a Consumer:

Per Second
Per Minute
Per Hour
Per Week
Per Month

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

from_date:

per_day_call_limit:

per_hour_call_limit:

per_minute_call_limit:

per_month_call_limit:

per_second_call_limit: 10

per_week_call_limit:

to_date:

api_name: api_name

api_version:

bank_id: gh.29.uk

Respuesta Exitosa Típica: 

								
									
{
  "from_date":"1100-01-01T00:00:00Z",
  "to_date":"1100-01-01T00:00:00Z",
  "per_second_call_limit":"-1",
  "per_minute_call_limit":"-1",
  "per_hour_call_limit":"-1",
  "per_day_call_limit":"-1",
  "per_week_call_limit":"-1",
  "per_month_call_limit":"-1"
}
Roles Requeridos:
  • CanSetCallLimits - 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-10001: Incorrect json format.
  • OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30023: Cannot update Consumer
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by callsLimit, operation_id: OBPv4.0.0-callsLimit Tags: Consumer,

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

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

app_name:

app_type:

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

created:

created_by_user:

created_by_user_id:

description: This an optional field. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: true

provider: ETHEREUM

provider_id:

redirect_url:

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,

Create Scope for a Consumer

Create Scope. Grant Role to Consumer.

Scopes are used to grant System or Bank level roles to the Consumer (App). (For Account level privileges, see Views)

For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""

For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"

Authentication is Mandatory

URL Parameters:

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

JSON request body fields:

bank_id: gh.29.uk

role_name:

JSON response body fields:

bank_id: gh.29.uk

role_name:

scope_id:

Respuesta Exitosa Típica: 

								
									
{
  "scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f",
  "role_name":"CanGetEntitlementsForAnyUserAtOneBank",
  "bank_id":"gh.29.uk"
}
Roles Requeridos:
  • CanCreateScopeAtAnyBank - Please login to request this Role
  • CanCreateScopeAtOneBank - 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-20024: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-10001: Incorrect json format.
  • OBP-10007: Incorrect Role name:
  • OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
  • OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
  • OBP-30216: Entitlement already exists for the user.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv4.0.0, function_name: by addScope, operation_id: OBPv4.0.0-addScope Tags: Scope, Consumer,

Delete Consumer Scope

Delete Consumer Scope specified by SCOPE_ID for an consumer specified by CONSUMER_ID

Authentication is required and the user needs to be a Super Admin.
Super Admins are listed in the Props file.

Authentication is Mandatory

URL Parameters:

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

SCOPE_ID:

JSON response body fields:

Respuesta Exitosa Típica:
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30212: EntitlementId not found
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv3.0.0, function_name: by deleteScope, operation_id: OBPv3.0.0-deleteScope Tags: Scope, Consumer,

Get Scopes for Consumer

Get all the scopes for an consumer specified by CONSUMER_ID

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

bank_id: gh.29.uk

list:

role_name:

scope_id:

Respuesta Exitosa Típica: 

								
									
{
  "list":[{
    "scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f",
    "role_name":"CanGetEntitlementsForAnyUserAtOneBank",
    "bank_id":"gh.29.uk"
  }]
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30212: EntitlementId not found
  • OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv4.0.0, function_name: by getScopes, operation_id: OBPv4.0.0-getScopes Tags: Scope, Consumer,