API Docs. Elcoin Ltd

Initiation Import. Prepare data POST

prepare data model

# ENDPOINT

/model/paymentInitiationImport/prepare

# RESPONSE

# REQUEST BODY

Schema: paymentInitiationImport

Type: object

Variable	Name	Type	Format	Description
action	Action	string
checksum	checksum	string		Checksum
client_code	Client code	string		Unique client identifier. Issued automatically by the System upon new Customer registration.
content	content	string
content_type	content_type	string		Content type
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
debtor_account	debtor_account	string		Debtorâ€™s account number
error_description	Error Description	string		Description of error
file_name	file_name	string		File name
form_title	form_title	string		Service field
id	id	integer	INT64	Record's sequence number generated in the system.
message_id	message_id	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
number_of_transactions	number_of_transactions	integer	INT64	Number of transactions
package_id	Package id	integer
payment_information_id	payment_information_id	string		Payment information id
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
requested_execution_date	requested_execution_date	string	DATE	Requested execution date
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

# REQUEST BODY EXAMPLE

# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: paymentInitiationImport

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
action	Action	string
checksum	checksum	string		Checksum
client_code	Client code	string		Unique client identifier. Issued automatically by the System upon new Customer registration.
content	content	string
content_type	content_type	string		Content type
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
debtor_account	debtor_account	string		Debtorâ€™s account number
error_description	Error Description	string		Description of error
file_name	file_name	string		File name
form_title	form_title	string		Service field
id	id	integer	INT64	Record's sequence number generated in the system.
message_id	message_id	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
number_of_transactions	number_of_transactions	integer	INT64	Number of transactions
package_id	Package id	integer
payment_information_id	payment_information_id	string		Payment information id
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
requested_execution_date	requested_execution_date	string	DATE	Requested execution date
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

# 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

# Other endpoints

Name	Endpoint
Initiation Import. Fetch data by ID	/model/paymentInitiationImport/getDb/{id}
Initiation Import. Validate data	/model/paymentInitiationImport/validate
Initiation Import. Create/update record	/model/paymentInitiationImport/putDb
Initiation Import. Delete item by ID	/api/paymentInitiationImport/deleteItem/{id}
Initiation Import. Fetch data by request	/api/paymentInitiationImport/getData/paymentInitiationImportRequest