Schemas Postman

Queue. Fetch data by request POST

Get Queue Payment data by request

# ENDPOINT
/api/queuePayment/getData/queueRequest
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0 		M Dev Authentication
# REQUEST BODY
# RESPONSE
# REQUEST arguments
Variable Name Type Format Usage Description
X-App-Sig X-App-Sig header string M Dev Authentication
# REQUEST BODY
Schema: queueRequest
Type: object
Variable Name Type Format Usage Description
api_call api_call string
created_from created_from string
created_to created_to string
error_description Error Description string Description of error
financial_institution financial_institution string
in_out in_out string
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
payload payload string
processing_status Processing Status string Status of remote client data processing received from the external system
queue_name queue_name string
reference reference string reference
skip_total_records Skip total records boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
# REQUEST BODY EXAMPLE
# POSITIVE RESPONSE

200 - Response successfully when status is OK

<p style="color:green;font-size:16px;">200 - Response successfully when status is OK</p>

Schema: queuePayment
Type: application/json
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
api_call api_call 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
error_description Error Description string Description of error
financial_institution financial_institution string
form_title form_title string Service field
id id integer INT64 Record's sequence number generated in the system.
in_out in_out string
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
payload payload string
payload_char Payload char string
processing_status Processing Status string Status of remote client data processing received from the external system
queue_name queue_name string
reference reference string reference
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

<p style="color:red;font-size:16px;">200 - Response with error when status is ERROR</p>

Schema: HeaderResponseStatusError
Type: application/json
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
# Other endpoints
Name Endpoint
Queue. Fetch data by ID /model/queuePayment/getDb/{id}
Queue. Validate data /model/queuePayment/validate
Queue. Prepare data /model/queuePayment/prepare
Queue. Create/update data /model/queuePayment/putDb
Queue. Delete item by ID /api/queuePayment/deleteItem/{id}