Schemas Postman

Remittance. Fetch data by request POST

Get Remittance data by request

# ENDPOINT
/api/remittance/getData/remittanceRequest
# 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: remittanceRequest
Type: object
Variable Name Type Format Usage Description
amount_from amount_from number decimal M Amount operation From
amount_to amount_to number decimal M Amount operation To
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
currency currency string M Currency of the account
inout_type inout_type string
List of allowed values in field (value=>name):
  • 0
    CNV
  • 1
    FL
  • 2
    IN
  • 3
    INT
  • 4
    OUT
  • 5
    TR
limit limit integer int64 Count records for part data to get
message_type message_type string
message_type_004 pacs.004 boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
message_type_008 pacs.008 boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
message_type_027 camt.027 boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
message_type_028 pacs.028 boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
message_type_029_3 camt.029.03 boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
message_type_029_8 camt.029.08 boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
message_type_054 camt.054 boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
message_type_056 camt.056 boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
message_type_087 camt.087 boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
message_type_other Other boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
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
processing_status Processing Status string Status of remote client data processing received from the external system
List of allowed values in field (value=>name):
  • 0
    Nothing
  • 1
    NEW
  • 2
    PROCESSED
  • 3
    REGISTERED
  • 4
    SENT
processing_step Processing step string Step of remote client data processing received from the external system
receiver_bic receiver_bic string
reference reference string reference
remittance_date_from remittance_date_from string
remittance_date_to remittance_date_to string
remittance_reference Remittance reference string
remittance_status remittance_status string
List of allowed values in field (value=>name):
  • 0
    Nothing
  • 1
    ACCP
  • 2
    ACCP/B
  • 3
    N/A
  • 4
    RJCT
sender_bic sender_bic string
skip_total_records Skip total records boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
system system string
List of allowed values in field (value=>name):
  • 0
    BANK
  • 1
    BINANCE
  • 2
    CONNPAY
  • 3
    MODULR
  • 4
    PAYSTREE
  • 5
    RAILSBANK
  • 6
    SUMSUB
  • 7
    ZEROHASH
# 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: remittance
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
amount amount number decimal Operation amount
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
content content string
content_footer content_footer string
content_header content_header 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
currency currency string Currency of the account
document_id document_id integer int64 Document ID
error_description Error Description string Description of error
form_title form_title string Service field
id id integer INT64 Record's sequence number generated in the system.
inout_type inout_type string
message_type message_type string
message_type_full Message type full 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
payment_id Payment id integer
payment_type payment_type string Payment type
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
queue_state queue_state string
receiver_bic receiver_bic string
reference reference string reference
related_sepa_file_id Related sepa file id integer
remittance_date remittance_date string
remittance_payment_type Remittance payment type string
remittance_reference Remittance reference string
remittance_status remittance_status string
remittance_transaction_reference Remittance transaction reference string
remittance_transaction_type Remittance transaction type string
send_order Send order integer
sender_bic sender_bic string
sender_identifier Sender identifier STRING
sepa_file_id Sepa file id integer
state state integer INT64 Record state for replication
system system string
transaction_type transaction_type string Type of transaction
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
Remittance. Fetch data by ID /model/remittance/getDb/{id}
Remittance. Validate data /model/remittance/validate
Remittance. Prepare data /model/remittance/prepare
Remittance. Create/update data /model/remittance/putDb
Remittance. Delete item by ID /api/remittance/deleteItem/{id}