API Docs. Elcoin Ltd

Route. Fetch count payments POST

# ENDPOINT

/api/paymentRoute/getCountOfPaymentsForAuthorization/paymentsCountForAuthorizationRequest

# 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: paymentsCountForAuthorizationRequest

Type: object

Variable	Name	Type	Format	Usage	Description
actor_client_code	actor_client_code	string
subject_client_code	subject client code	string

# REQUEST BODY EXAMPLE

							{"subject_client_code":"EN00000CY","source_system":"IB"}

# POSITIVE RESPONSE

getCountOfPaymentsForAuthorization

Schema: CountOfPaymentsForAuthorization

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
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
form_title	form_title	string		Service field
id	id	integer	INT64	Record's sequence number generated in the system.
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
state	state	number	INT64	Record state for replication
uid	uid	string		Unique record identifier which is used to distinguish between existing records
version	version	number	INT64	Record version for replication

# RESPONSE POSITIVE EXAMPLE

							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": 1,
    "data": [
        {
            "actor_client_code": "EN0000FQS",
            "subject_client_code": "EN00000CY",
            "payment_count": 10
        }
    ]
}

# 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 data by Authorized Persons	/api/paymentRoute/getListOfPaymentAuthorizedPersons/documentReferenceRequest