right logo image
right logo image
Ingresar
⯆

API Explorer

v5.1.0 filtered by tag: Balance (5 APIs)

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

Create Bank Account Balance

Create a new Balance for a Bank Account.

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

JSON request body fields:

balance_amount: 50.89

balance_type: openingBooked

JSON response body fields:

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

balance_amount: 50.89

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

balance_type: openingBooked

bank_id: gh.29.uk

Respuesta Exitosa Típica: 

								
									
{
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "balance_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "balance_type":"openingBooked",
  "balance_amount":"50.89"
}
Roles Requeridos:
  • CanCreateBankAccountBalance - 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: OBPv5.1.0, function_name: by createBankAccountBalance, operation_id: OBPv5.1.0-createBankAccountBalance Tags: Account, Balance,

Delete Bank Account Balance

Delete a Bank Account Balance specified by BALANCE_ID.

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

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

BANK_ID: gh.29.uk

JSON response body fields:

Respuesta Exitosa Típica:
Roles Requeridos:
  • CanDeleteBankAccountBalance - 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: OBPv5.1.0, function_name: by deleteBankAccountBalance, operation_id: OBPv5.1.0-deleteBankAccountBalance Tags: Account, Balance,

Get All Bank Account Balances

Get all Balances for a Bank Account.

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

JSON response body fields:

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

balance_amount: 50.89

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

balance_type: openingBooked

balances: balances

bank_id: gh.29.uk

Respuesta Exitosa Típica: 

								
									
{
  "balances":[{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "balance_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "balance_type":"openingBooked",
    "balance_amount":"50.89"
  }]
}
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: OBPv5.1.0, function_name: by getAllBankAccountBalances, operation_id: OBPv5.1.0-getAllBankAccountBalances Tags: Account, Balance,

Get Bank Account Balance By ID

Get a specific Bank Account Balance by its BALANCE_ID.

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

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

BANK_ID: gh.29.uk

JSON response body fields:

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

balance_amount: 50.89

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

balance_type: openingBooked

bank_id: gh.29.uk

Respuesta Exitosa Típica: 

								
									
{
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "balance_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "balance_type":"openingBooked",
  "balance_amount":"50.89"
}
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: OBPv5.1.0, function_name: by getBankAccountBalanceById, operation_id: OBPv5.1.0-getBankAccountBalanceById Tags: Account, Balance,

Update Bank Account Balance

Update an existing Bank Account Balance specified by BALANCE_ID.

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

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

BANK_ID: gh.29.uk

JSON response body fields:

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

balance_amount: 50.89

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

balance_type: openingBooked

bank_id: gh.29.uk

Respuesta Exitosa Típica: 

								
									
{
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "balance_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "balance_type":"openingBooked",
  "balance_amount":"50.89"
}
Roles Requeridos:
  • CanUpdateBankAccountBalance - 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: OBPv5.1.0, function_name: by updateBankAccountBalance, operation_id: OBPv5.1.0-updateBankAccountBalance Tags: Account, Balance,