Account. Fetch data by request POST

Get Account data by request

# ENDPOINT
/api/account/getData/accountSearchRequest
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0
DEV-SKIP DEV-SKIP M Dev Authentication
# REQUEST BODY
# RESPONSE
        						
# REQUEST arguments
Variable Name Type Format Usage Description
X-App-Sig X-App-Sig header string M Dev Authentication
Example DEV-SKIP
# REQUEST BODY
Schema: accountSearchRequest
Type: object
Variable Name Type Format Usage Description
account account string account
account_group account_group string Group of account
account_scheme account_scheme string
List of allowed values in field (value=>name):
  • 0
    BINANCE
  • 1
    CONNPAY
  • 2
    DEFAULT
  • 3
    MODULR
  • 4
    PAYSTREE
  • 5
    RAILSBANK
  • 6
    ZEROHASH
account_status Account Status string Status which is given to the account
List of allowed values in field (value=>name):
  • 0
    ACTIVATING
  • 1
    ACTIVE
  • 2
    BLOCKED
  • 3
    CLOSED
  • 4
    CLOSING
account_subtype account_subtype string Account subtype
List of allowed values in field (value=>name):
  • 0
    Nothing
  • 1
    OMA
  • 2
    SCA
base_account base_account string Base multicurrency account
branch branch string
client_code client_code string M Unique customer ID in external system
close_date_from Close date from string
close_date_to Close date to string
currency currency string M Currency of counterparty account
description description string Description of a given record
division_client_code Division client code string
external_number external_number string External client number for client
full_name full_name string Customer full name [first_name] and [last_name] for PERSON and [first_name] only for BUSINESS customer types respectively
gl Gl integer M
iban iban string A unique account IBAN generated by the System according to IBAN generation rules
joint_account joint_account string Joint account for current account
limit limit integer int64 Count records for part data to get
nostro_account nostro_account string Nostro account
nostro_owner_code nostro_owner_code string Counterparty code
offset_version Offset version INTEGER
offsetid Offsetid integer
open_date_from Open date from string
open_date_to Open date to string
page page integer int64 Part data with number of page
page_changes_version_offset Page changes version offset INTEGER
product_code Product Code string Code of a given product
search Search string
search_division_childs Search division childs boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
skip_closed skip_closed boolean Skip closed
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
skip_total_records Skip total records boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
subledger_type subledger_type string M Subledger type
List of allowed values in field (value=>name):
  • 0
    ARP
  • 1
    CIF
  • 2
    CIF
  • 3
    DFB
  • 4
    DFB
  • 5
    EPS
with_balances with_balances boolean With balances
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
with_ewallets With ewallets boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
# REQUEST BODY EXAMPLE
							{
  "account": "60003J7K000EURD",
  "currency": "EUR",
  "with_balances": true
}						
# POSITIVE RESPONSE

200 - Response successfully when status is OK

200 - Response successfully when status is OK

Schema: account
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data array data of Response
attribute: data
Variable Name Type Format Description
base_account base_account string Base multicurrency account
account account string account
account_number account_number string Account_number
iban iban string A unique account IBAN generated by the System according to IBAN generation rules
client_code client_code string Unique customer ID in external system
full_name full_name string Customer full name [first_name] and [last_name] for PERSON and [first_name] only for BUSINESS customer types respectively
account_group account_group string Group of account
service_provider_settings_id Service provider settings id INTEGER
currency currency string Currency of counterparty account
gl Gl integer
description description string Description of a given record
open_date Open Date string DATE A date when account was set to Active
account_scheme account_scheme string
account_product_settings_id Account settings Id integer
account_settings_description Account settings string
account_subtype account_subtype string Account subtype
joint_account joint_account string Joint account for current account
master_gl Master gl INTEGER
master_base_account Master base account STRING
master_account Master account STRING
account_status Account Status string Status which is given to the account
nostro_account nostro_account string Nostro account
close_date Close Date string DATE Client close date in the system
nostro_owner_code nostro_owner_code string Counterparty code
counterparty_name counterparty_name string
overdraft_account overdraft_account string Overdraft account for current account
external_number external_number string External client number for client
subledger_type subledger_type string Subledger type
product_code Product Code string Code of a given product
branch branch string
client_id Client ID integer
open_amount open_amount number Account open amount (for overdraft/deposit) move to data
last_operation_date last_operation_date STRING
last_debet_date last_debet_date STRING
last_debet_amount last_debet_amount NUMBER
last_credit_date last_credit_date STRING
last_credit_amount last_credit_amount NUMBER
action Action string
currency_exponenta Currency exponenta integer
balance_num Balance double
balance balance number decimal Current account balance at the moment
external_balance_num External balance double
external_balance External balance exponented NUMBER
uid uid string Unique record identifier which is used to distinguish between existing records
hold_balance hold_balance number decimal Hold balance
hold_balance_num Hold balance num double
id id integer INT64 Record's sequence number generated in the system.
stop_debit SD STRING
version version integer INT64 Record version for replication
state state integer INT64 Record state for replication
stop_credit SC STRING
division_client_code Division client code string
form_title form_title string Service field
reservations Reserved NUMBER
create_user Create User string The username of ABS user who has created an entry
holds holds number decimal Holds
client_type Client type STRING
old_account_status Old account status STRING
error_description Error Description string Description of error
create_date Create Date string DATETIME The date entry was created on
modify_user Modify User string The username of ABS user who has made last changes to the entry
view_ewallet view_ewallet string
modify_date Modify Date string DATETIME The date entry was last modified on
# RESPONSE POSITIVE EXAMPLE
							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": 1,
    "data": [
        {
            "id": 372305,
            "uid": "d5a3bd78-f545-4ca8-7814-f94b18505184",
            "version": 581858134,
            "state": 0,
            "modify_date": "2021-01-12T14:29:11.743",
            "modify_user": "root",
            "create_date": "2021-01-12T14:29:01.994",
            "create_user": "root",
            "gl": 30311000,
            "iban": "GB47TEST85516104545487",
            "account": "60003J7K000EURD",
            "base_account": "60003J7K000T",
            "overdraft_account": "",
            "currency": "EUR",
            "account_group": "",
            "subledger_type": "CIF",
            "account_subtype": "",
            "product_code": "",
            "branch": "",
            "client_code": "EN003J7KN",
            "client_id": 2360518,
            "account_status": "ACTIVE",
            "description": "Fred Graham",
            "open_date": "2021-01-12",
            "close_date": null,
            "open_amount": 0.00,
            "last_operation_date": null,
            "last_debet_date": null,
            "last_debet_amount": 0.00,
            "last_credit_date": null,
            "last_credit_amount": 0.00,
            "joint_account": "",
            "external_number": "",
            "account_scheme": "RAILSBANK",
            "error_description": "",
            "nostro_account": "60003J7K0T0EURK",
            "nostro_owner_code": "",
            "full_name": "Fred Graham",
            "balance": 2165.56,
            "hold_balance": 228.35,
            "stop_debit": "",
            "stop_credit": "",
            "reservations": 0.0,
            "holds": 228.35,
            "client_type": "PERSON",
            "view_ewallet": "60003J7K000T",
            "type_order": 2,
            "currency_order": 1,
            "status_order": 1,
            "base_account_status_order": 0,
            "base_account_open_date": null
        }
    ]
}						
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object Empty object
# RESPONSE NEGATIVE EXAMPLE
							{
    "status": "error",
    "error_description": "[ERROR-VALIDATE-REQUEST] [EMPTY-FILTER-PARAMETERS]",
    "error": {},
    "data_type": "",
    "total_records": -2,
    "data": {}
}