API Docs. Elcoin Ltd

Hold Instruction. Fetch data by ID / UID GET

Fetch Hold Instruction data by ID or UID

# ENDPOINT

/model/holdInstruction/getDb/{id}

# REQUEST arguments

Variable	Value	Example	Usage	Description
X-App-Sig header 0			M	Dev Authentication
id path 0		247 - for ID e63486a3-654f-558a-6b14-380840ed8100 - for UID	M	Record ID or UID

# RESPONSE

# REQUEST arguments

Variable	Name	Type	Format	Usage	Description
X-App-Sig	X-App-Sig	header	string	M	Dev Authentication
id	id	path	integer	M	Record ID or UID
Example	247 - for ID e63486a3-654f-558a-6b14-380840ed8100 - for UID

# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: holdInstruction

Type: application/json

Variable	Name	Type	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	data of Response

attribute: data

Variable	Name	Type	Format	Description
account	account	string		account
account_scheme	account_scheme	string
action	Action	string
base_account	base_account	string		Base multicurrency account
client_code	Client code	string		Unique client identifier. Issued automatically by the System upon new Customer registration.
consolidated_amount_check	Consolidated amount check	boolean
create_date	Create Date	string	DATETIME	The date entry was created on
create_user	Create User	string		The username of ABS user who has created an entry
description	description	string		Description of a given record
document_reference	document_reference	string		The unique payment ID as assigned by the ABS system upon Payment registration in the ABS
error_description	Error Description	string		Description of error
form_title	form_title	string		Service field
hold_amount	hold_amount	number	decimal	Hold amount
hold_amount_agent	Hold amount agent	number
hold_amount_agent_num	Hold amount agent num	STRING
hold_amount_num	Hold amount num	double
hold_amount_tax	Hold amount tax	number
hold_amount_tax_num	Hold amount tax num	STRING
hold_balance	hold_balance	number	decimal	Hold balance
hold_balance_agent	Hold balance agent	number
hold_balance_agent_num	Hold balance agent num	STRING
hold_balance_num	Hold balance num	double
hold_balance_tax	Hold balance tax	number
hold_balance_tax_num	Hold balance tax num	STRING
hold_currency	hold_currency	string		Hold currency
hold_currency_exponenta	Hold currency exponenta	INTEGER
hold_payment_type	hold_payment_type	string		Type of hold payment
id	id	integer	INT64	Record's sequence number generated in the system.
instruction_type	instruction_type	string		Type hold instruction
insufficient_funds	insufficient_funds	boolean		Status of funds
modify_date	Modify Date	string	DATETIME	The date entry was last modified on
modify_user	Modify User	string		The username of ABS user who has made last changes to the entry
no_amount_check	No amount check	boolean
no_limits_check	No limits check	boolean
payment_type	payment_type	string		Payment type
processing_status	Processing Status	string		Status of remote client data processing received from the external system
processing_step	Processing step	string		Step of remote client data processing received from the external system
state	state	integer	INT64	Record state for replication
system	system	string
uid	uid	string		Unique record identifier which is used to distinguish between existing records
version	version	integer	INT64	Record version for replication

# RESPONSE POSITIVE EXAMPLE

							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "system.api.holdInstruction.holdInstructionModel",
    "total_records": 1,
    "data": {
        "system": "BANK",
        "hold_balance": 1.05,
        "hold_balance_tax": 0.0,
        "hold_balance_agent": 0.0,
        "payment_type": "",
        "description": "",
        "insufficient_funds": true,
        "processing_status": "",
        "processing_step": "NORMAL",
        "error_description": "",
        "document_reference": "PFEE200600GKRS9N",
        "client_code": "EN000C2A3",
        "base_account": "USDQ",
        "account": "USDEURJ",
        "account_scheme": "DEFAULT",
        "instruction_type": "HOLD",
        "hold_currency": "EUR",
        "hold_amount": 1.05,
        "hold_amount_tax": 0.0,
        "hold_amount_agent": 0.0,
        "hold_payment_type": "",
        "no_amount_check": false,
        "consolidated_amount_check": false,
        "uid": "e63486a3-654f-558a-6b14-380840ed8100",
        "id": 247,
        "version": 458070971,
        "state": 0,
        "create_user": "root",
        "create_date": "2020-06-10T13:49:36.399",
        "modify_user": "root",
        "modify_date": "2020-11-02T12:53:19.985"
    }
}

# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError

Type: application/json

Variable	Name	Type	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": "[RECORD-NOT-FOUND : Object holdInstructionModel cannot find record hold_instruction.id with value 111111111]",
    "error": {},
    "data_type": "system.api.holdInstruction.holdInstructionModel",
    "total_records": 1,
    "data": {}
}

# Other endpoints

Name	Endpoint
Hold Instruction. Fetch data by request	/api/holdInstruction/getData/holdInstructionSearchRequest
Hold Instruction. Validate data	/model/holdInstruction/validate
Hold Instruction. Prepare data	/model/holdInstruction/prepare
Hold Instruction. Create/update data	/model/holdInstruction/putDb
Hold Instruction. Delete item by ID	/api/holdInstruction/deleteItem/{id}
Hold Instruction. Check Available Funds	/api/holdInstruction/checkAvailableFunds/holdInstructionSetModel
Hold Instruction. Set HoldInstruction	/api/setHoldInstruction/holdInstructionSetModel