Initiation Import. Fetch data by request POST

# ENDPOINT
/api/paymentInitiationImport/getData/paymentInitiationImportRequest
# REQUEST BODY
# RESPONSE
        						
# REQUEST BODY
Schema: paymentInitiationImportRequest
Type: object
Variable Name Type Format Usage Description
client_code client_code string Unique customer ID in external system
incompleted_only Incompleted only boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
limit limit integer int64 Count records for part data to get
offset_version Offset version INTEGER
offsetid Offsetid integer
page page integer int64 Part data with number of page
page_changes_version_offset Page changes version offset INTEGER
skip_total_records Skip total records boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
# REQUEST BODY EXAMPLE
							{
"client_code": "EN00000CY",
"id_list": "[22,23,24]",
"incompleted_only": "no"
}						
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR



Schema: HeaderResponseStatusError
Type: object
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
# POSITIVE RESPONSE

200 - Response successfully when status is OK

 

Schema: paymentInitiationImport
Type: object
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
action Action string
checksum checksum string Checksum
client_code client_code string Unique customer ID in external system
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 Processing operation status
processing_step Processing step string
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
# RESPONSE POSITIVE EXAMPLE
							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": 3,
    "data": [
        {
            "id": 22,
            "uid": "9aab5835-a5c2-7b9f-8814-3d239427a8a9",
            "version": 998110291,
            "state": 0,
            "modify_date": "2021-09-30T17:44:52.263",
            "modify_user": "ishafranek",
            "create_date": "2021-09-30T16:16:43.658",
            "create_user": "ishafranek",
            "content_type": "",
            "content": null,
            "message_id": "",
            "payment_information_id": "",
            "transaction_sum": 0.00,
            "number_of_transactions": 0,
            "requested_execution_date": null,
            "debtor_account": "",
            "processing_status": "COMPLETED",
            "error_description": "",
            "client_code": "EN00000CY",
            "file_name": "",
            "checksum": "",
            "processing_step": "NORMAL",
            "package_id": 0
        },
        {
            "id": 23,
            "uid": "9aab5835-a5c2-7b9f-8814-5a2314a06455",
            "version": 998110292,
            "state": 0,
            "modify_date": "2021-09-30T17:44:52.278",
            "modify_user": "ishafranek",
            "create_date": "2021-09-30T16:26:59.364",
            "create_user": "ishafranek",
            "content_type": "",
            "content": null,
            "message_id": "",
            "payment_information_id": "",
            "transaction_sum": 0.00,
            "number_of_transactions": 0,
            "requested_execution_date": null,
            "debtor_account": "",
            "processing_status": "COMPLETED",
            "error_description": "",
            "client_code": "EN00000CY",
            "file_name": "",
            "checksum": "",
            "processing_step": "NORMAL",
            "package_id": 0
        },
        {
            "id": 24,
            "uid": "9aab5835-a5c2-7b9f-8814-8e23ec1cf5d6",
            "version": 998110293,
            "state": 0,
            "modify_date": "2021-09-30T17:44:52.295",
            "modify_user": "ishafranek",
            "create_date": "2021-09-30T16:45:46.922",
            "create_user": "ishafranek",
            "content_type": "",
            "content": null,
            "message_id": "",
            "payment_information_id": "",
            "transaction_sum": 0.00,
            "number_of_transactions": 0,
            "requested_execution_date": null,
            "debtor_account": "",
            "processing_status": "COMPLETED",
            "error_description": "",
            "client_code": "EN00000CY",
            "file_name": "",
            "checksum": "",
            "processing_step": "NORMAL",
            "package_id": 0
        }
    ]
}