API Docs. Elcoin Ltd

Route. Fetch data by Authorized Persons POST

# ENDPOINT

/api/paymentRoute/getListOfPaymentAuthorizedPersons/documentReferenceRequest

# REQUEST arguments

Variable	Value	Example	Usage	Description
X-App-Sig header 0			M

# REQUEST BODY

# RESPONSE

# REQUEST arguments

Variable	Name	Type	Format	Usage	Description
X-App-Sig	X-App-Sig	header	string	M

# REQUEST BODY

Schema: documentReferenceRequest

Type: object

Variable	Name	Type	Usage	Description
division_client_code	Division client code	string
document_reference	document_reference	string	M	The unique payment ID as assigned by the ABS system upon Payment registration in the ABS
payment_id	Payment id	integer

# REQUEST BODY EXAMPLE

							{
    "payment_id":2570,
    "source_system":"IB",
    "client_code":"EN00000CY"
}

# POSITIVE RESPONSE

getListOfPaymentAuthorizedPersons

Schema: paymentRoute

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	array	data of Response

attribute: data

Variable	Name	Type	Format	Description
action	Action	string
authorized_client_code	authorized_client_code	string
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
document_reference	document_reference	string		The unique payment ID as assigned by the ABS system upon Payment registration in the ABS
form_title	form_title	string		Service field
id	id	integer	INT64	Record's sequence number generated in the system.
info	Action	string
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
notifications_status	notifications_status	string
oauth_access_token	Oauth access token	string
payment_id	Payment id	integer
procedure	Procedure	string	X(40)
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
source_table	Source table	string
state	state	integer	INT64	Record state for replication
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": "",
    "total_records": 1,
    "data": [
        {
            "id": 22932,
            "uid": "bb03734e-4ac4-ffa0-8114-f4ae60b2fd9d",
            "version": 851982346,
            "state": 0,
            "modify_date": "2021-06-14T13:04:31.084",
            "modify_user": "root",
            "create_date": "2021-06-14T13:04:28.967",
            "create_user": "EN00000CY",
            "source_table": "payment_outward",
            "payment_id": 2570,
            "document_reference": "RMOU210600005PJF",
            "procedure": "paymentOutwardModel:doAfterPutDb",
            "info": "Status: NEW, Step: NORMAL",
            "oauth_access_token": "990149ff-82cb-0494-8114-f4ae587add8a",
            "authorized_client_code": "EN00000CY",
            "processing_status": "NEW",
            "processing_step": "NORMAL",
            "notifications_status": "PROCESSED"
        }
    ]
}

# NEGATIVE RESPONSE

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

# Other endpoints

Name	Endpoint
Route. Fetch data by document reference request	/api/paymentRoute/getData/documentReferenceRequest
Route. Fetch count payments	/api/paymentRoute/getCountOfPaymentsForAuthorization/paymentsCountForAuthorizationRequest