right logo image
right logo image
Ingresar

v5.1.0 filtered by tag: Counterparty-Limits (5 APIs)

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

Create Counterparty Limit

Create limits (for single or recurring payments) for a counterparty specified by the COUNTERPARTY_ID.

Using this endpoint, we can attach a limit record to a Counterparty referenced by its counterparty_id (a UUID).

For more information on Counterparty Limits, see here

For an introduction to Counterparties in OBP, see here

You can automate the process of creating counterparty limits and consents for VRP with this endpoint.

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

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

COUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

VIEW_ID: owner

JSON request body fields:

currency: EUR

max_monthly_amount: 10000.11

max_number_of_monthly_transactions: 10

max_number_of_transactions: 100

max_number_of_yearly_transactions: 100

max_single_amount: 1000.11

max_total_amount: 10000.12

max_yearly_amount: 12000.11

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

counterparty_limit_id: abc9a7e4-6d02-40e3-a129-0b2bf89de9b1

currency: EUR

max_monthly_amount: 10000.11

max_number_of_monthly_transactions: 10

max_number_of_transactions: 100

max_number_of_yearly_transactions: 100

max_single_amount: 1000.11

max_total_amount: 10000.12

max_yearly_amount: 12000.11

view_id: owner

Respuesta Exitosa Típica: 

								
									
{
  "counterparty_limit_id":"abc9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "view_id":"owner",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "currency":"EUR",
  "max_single_amount":"1000.11",
  "max_monthly_amount":"10000.11",
  "max_number_of_monthly_transactions":10,
  "max_yearly_amount":"12000.11",
  "max_number_of_yearly_transactions":100,
  "max_total_amount":"10000.12",
  "max_number_of_transactions":100
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv5.1.0, function_name: by createCounterpartyLimit, operation_id: OBPv5.1.0-createCounterpartyLimit Tags: Counterparty-Limits,

Delete Counterparty Limit

Delete Counterparty Limit.

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

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

COUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

VIEW_ID: owner

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-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv5.1.0, function_name: by deleteCounterpartyLimit, operation_id: OBPv5.1.0-deleteCounterpartyLimit Tags: Counterparty-Limits,

Get Counterparty Limit

Get Counterparty Limit.

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

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

COUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

VIEW_ID: owner

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

counterparty_limit_id: abc9a7e4-6d02-40e3-a129-0b2bf89de9b1

currency: EUR

max_monthly_amount: 10000.11

max_number_of_monthly_transactions: 10

max_number_of_transactions: 100

max_number_of_yearly_transactions: 100

max_single_amount: 1000.11

max_total_amount: 10000.12

max_yearly_amount: 12000.11

view_id: owner

Respuesta Exitosa Típica: 

								
									
{
  "counterparty_limit_id":"abc9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "view_id":"owner",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "currency":"EUR",
  "max_single_amount":"1000.11",
  "max_monthly_amount":"10000.11",
  "max_number_of_monthly_transactions":10,
  "max_yearly_amount":"12000.11",
  "max_number_of_yearly_transactions":100,
  "max_total_amount":"10000.12",
  "max_number_of_transactions":100
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv5.1.0, function_name: by getCounterpartyLimit, operation_id: OBPv5.1.0-getCounterpartyLimit Tags: Counterparty-Limits,

Get Counterparty Limit Status

Get Counterparty Limit Status.

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

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

COUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

VIEW_ID: owner

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

counterparty_limit_id: abc9a7e4-6d02-40e3-a129-0b2bf89de9b1

currency: EUR

currency_status: currency_status

max_monthly_amount: 10000.11

max_monthly_amount_status: max_monthly_amount_status

max_number_of_monthly_transactions: 10

max_number_of_monthly_transactions_status: max_number_of_monthly_transactions_status

max_number_of_transactions: 100

max_number_of_transactions_status: max_number_of_transactions_status

max_number_of_yearly_transactions: 100

max_number_of_yearly_transactions_status: max_number_of_yearly_transactions_status

max_single_amount: 1000.11

max_total_amount: 10000.12

max_total_amount_status: max_total_amount_status

max_yearly_amount: 12000.11

max_yearly_amount_status: max_yearly_amount_status

status:

view_id: owner

Respuesta Exitosa Típica: 

								
									
{
  "counterparty_limit_id":"abc9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "view_id":"owner",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "currency":"EUR",
  "max_single_amount":"1000.11",
  "max_monthly_amount":"10000.11",
  "max_number_of_monthly_transactions":10,
  "max_yearly_amount":"12000.11",
  "max_number_of_yearly_transactions":100,
  "max_total_amount":"10000.12",
  "max_number_of_transactions":100,
  "status":{
    "currency_status":"EUR",
    "max_monthly_amount_status":"1000.11",
    "max_number_of_monthly_transactions_status":10,
    "max_yearly_amount_status":"12000.11",
    "max_number_of_yearly_transactions_status":100,
    "max_total_amount_status":"10000.12",
    "max_number_of_transactions_status":100
  }
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv5.1.0, function_name: by getCounterpartyLimitStatus, operation_id: OBPv5.1.0-getCounterpartyLimitStatus Tags: Counterparty-Limits,

Update Counterparty Limit

Update Counterparty Limit.

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

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

COUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

VIEW_ID: owner

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

counterparty_limit_id: abc9a7e4-6d02-40e3-a129-0b2bf89de9b1

currency: EUR

max_monthly_amount: 10000.11

max_number_of_monthly_transactions: 10

max_number_of_transactions: 100

max_number_of_yearly_transactions: 100

max_single_amount: 1000.11

max_total_amount: 10000.12

max_yearly_amount: 12000.11

view_id: owner

Respuesta Exitosa Típica: 

								
									
{
  "counterparty_limit_id":"abc9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "view_id":"owner",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "currency":"EUR",
  "max_single_amount":"1000.11",
  "max_monthly_amount":"10000.11",
  "max_number_of_monthly_transactions":10,
  "max_yearly_amount":"12000.11",
  "max_number_of_yearly_transactions":100,
  "max_total_amount":"10000.12",
  "max_number_of_transactions":100
}
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv5.1.0, function_name: by updateCounterpartyLimit, operation_id: OBPv5.1.0-updateCounterpartyLimit Tags: Counterparty-Limits,