Convertation. Fetch data by monitoring request POST

Get Payment Convertation data by request

# ENDPOINT
/api/paymentConvertation/getData/paymentConvertationMonitoringRequest
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0
DEV-SKIP DEV-SKIP 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
Example DEV-SKIP
# REQUEST BODY
Schema: paymentConvertationMonitoringRequest
Type: object
Variable Name Type Format Usage Description
account_debtor_or_creditor Account debtor or creditor STRING
amount_from amount_from number decimal Amount operation From
amount_to amount_to number decimal Amount operation To
base_account_debtor_or_creditor Base account debtor or creditor STRING
client_code client_code string Unique customer ID in external system
creditor_account creditor_account string Creditor’s account number
creditor_base_account Creditor E-wallet STRING
creditor_currency Creditor currency string
creditor_gl Creditor gl integer
creditor_master_account Creditor master account STRING
creditor_master_gl Creditor master gl INTEGER
date_from date_from string DATE The period of dates for which you need to receive an extract - date From
date_to date_to string DATE The period of dates for which you need to receive an extract - date To
debtor_account debtor_account string Debtor’s account number
debtor_base_account Debtor E-wallet STRING
debtor_currency Debtor currency string
debtor_gl Debtor gl integer
debtor_master_account Debtor master account STRING
debtor_master_gl Debtor master gl INTEGER
division_client_code Division client code string
document_reference document_reference string
master_account_debtor_or_creditor Master account debtor or creditor STRING
processing_status Processing Status string Processing operation status
List of allowed values in field (value=>name):
  • 0
    CANCELLED
  • 1
    COMPLETED
  • 2
    INVALID
  • 3
    NEW
processing_step Processing step string
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
							{
    "date_from":"2021/01/01"
   
}						
# POSITIVE RESPONSE

200 - Response successfully when status is OK

200 - Response successfully when status is OK

Schema: paymentConvertation
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_signature amount_signature string Signature operation for amount
application_id Application id integer
assumed_rate Assumed rate number
assumed_rate_exponenta Assumed rate exponenta integer
assumed_rate_num Assumed rate num double
attachments attachments string Attachments
calculation_type Calculation type STRING
client_authorization_type Client authorization type 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
creditor_account creditor_account string Creditor’s account number
creditor_account_iban creditor_account_iban string The IBAN of the creditor
creditor_account_number Creditor account number string
creditor_account_reference_id Creditor account reference id integer
creditor_amount Creditor amount number
creditor_amount_num Creditor amount num double
creditor_base_account Creditor E-wallet STRING
creditor_base_nostro Creditor base nostro STRING
creditor_client_code creditor_client_code string Unique customer ID in external system
creditor_counterparty_id Creditor counterparty id integer
creditor_currency Creditor currency string
creditor_currency_exponenta Creditor currency exponenta integer
creditor_gl Creditor gl integer
creditor_liquidity_base_nostro Creditor liquidity base nostro STRING
creditor_master_account Creditor master account STRING
creditor_master_base_account Creditor master base account STRING
creditor_master_gl Creditor master gl INTEGER
currency_rate_id Currency rate id integer
debtor_account debtor_account string Debtor’s account number
debtor_account_iban debtor_account_iban string The IBAN of the debtor
debtor_account_number Debtor account number string
debtor_account_reference_id Debtor account reference id integer
debtor_amount Debtor amount number
debtor_amount_num Debtor amount num double
debtor_base_account Debtor E-wallet STRING
debtor_base_nostro Debtor base nostro STRING
debtor_client_code debtor_client_code string Unique customer ID in external system
debtor_counterparty_id Debtor counterparty id integer
debtor_currency Debtor currency string
debtor_currency_exponenta Debtor currency exponenta integer
debtor_gl Debtor gl integer
debtor_liquidity_base_nostro Debtor liquidity base nostro STRING
debtor_master_account Debtor master account STRING
debtor_master_base_account Debtor master base account STRING
debtor_master_gl Debtor master gl INTEGER
debtor_name debtor_name string Debtor Name and Surname for Individual and Company Name for Business customer types respectively
details details string Details of payment
disable_check_zero_amounts Disable check zero amounts boolean
document_id document_id integer int64 Document ID
document_reference document_reference string
document_type document_type string Document type
error_description Error Description string Description of error
fee_account fee_account string Fee account
fee_amount fee_amount number decimal Amount of fee
fee_amount_num Fee amount num double
fee_currency fee_currency string Fee currency
fee_currency_exponenta Fee currency exponenta integer
fee_details fee_details string Fee details
fee_id fee_id integer int64 Fee ID
fee_revenue_account Fee revenue account string
fee_revenue_gl Fee revenue gl integer
financial_institution financial_institution string
fixed_side Fixed side string
form_title form_title string Service field
id id integer INT64 Record's sequence number generated in the system.
instruction_codes Instruction codes string
internal_market_rate Internal market rate number
internal_timestamp Internal deal rate time datetime-tz
market_rate Market rate number
market_rate_exponenta Market rate exponenta integer
market_rate_num Market rate num double
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
oauth_access_token Oauth access token string
old_client_authorization_type Old client authorization type string
old_processing_status Old processing status string
old_processing_step Old processing step string
order_type Order type string
original_reference Original reference string
payment_date Payment Date string DATE Payment creation date and time
payment_fee_id Payment fee id integer
payment_reference payment_reference string The unique payment ID as assigned by the ABS system upon Payment registration in the ABS
payment_template_id Payment template id integer
payment_template_initialized Payment template initialized boolean
payment_type payment_type string Payment type
processing_status Processing Status string Processing operation status
processing_step Processing step string
rate rate number decimal Rate of operation

rate_expiration_timestamp Rate expiration timestamp datetime-tz
rate_exponenta Rate exponenta integer
rate_num Rate num double
rate_signature rate_signature string Signature operation for rate
rate_timestamp rate_timestamp string DATETIME Operation Date/time
receiver_account_destination_tag Receiver account destination tag STRING
receiver_account_digital_address Receiver account digital address STRING
receiver_agent_code Receiver agent code STRING
receiver_details Receiver details STRING
receiver_name Receiver name STRING
revenue Revenue number
source_system Source system string Source system. For Internetbank please setup "IB"
state state integer INT64 Record state for replication
system system string
transaction_header Transaction integer
transaction_time Transaction time 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
# RESPONSE POSITIVE EXAMPLE
							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": 3,
    "data": [
        {
            "id": 6829786,
            "uid": "e0f98c53-704f-67aa-7914-8587b842b678",
            "version": 672793552,
            "state": 0,
            "modify_date": "2021-02-01T16:21:20.228",
            "modify_user": "root",
            "create_date": "2021-02-01T16:21:18.425",
            "create_user": "root",
            "document_id": 28968099,
            "payment_date": "2021-02-01",
            "details": "Currency exchange 22 EUR to 18.52 GBP rate .84184808 EUR/GBP",
            "buy_amount": 22.00,
            "buy_currency": "EUR",
            "sell_amount": 18.52,
            "sell_currency": "GBP",
            "base_currency": "",
            "debtor_name": "Silver Pink",
            "rate": 0.84184808,
            "revenue": 1.05,
            "debtor_gl": 0,
            "debtor_account": "6002978000000858",
            "debtor_ewallet": "222210000055",
            "creditor_gl": 0,
            "creditor_account": "22221000005GBP1",
            "creditor_ewallet": "222210000055",
            "payment_reference": "P000156",
            "processing_status": "COMPLETED",
            "document_reference": "FXCM210200MLC131",
            "debtor_client_code": "EN000C26L",
            "creditor_client_code": "EN000C26L",
            "rate_timestamp": "2021-02-01T16:21:16.121",
            "market_rate": 0.00000000,
            "fee_amount": 8.08,
            "fee_currency": "EUR",
            "fee_account": "6002978000000858",
            "error_description": "",
            "internal_timestamp": "2021-02-01T16:19:08.692+02:00",
            "internal_market_rate": 0.88367900,
            "fee_id": 14,
            "payment_type": "CONVERTATION",
            "fee_details": "Conversion fee for FXCM210200MLC131, EUR 8.08, rate EUR/EUR=1",
            "fee_revenue_gl": 60245000,
            "debtor_counterparty_id": 2351219,
            "creditor_counterparty_id": 2351219,
            "creditor_account_reference_id": 0,
            "debtor_account_reference_id": 0,
            "fee_revenue_account": "",
            "payment_fee_id": 6829787,
            "transaction_header": 11236899,
            "transaction_time": "2021-02-01T16:21:19.915"
        },
        {
            "id": 6829679,
            "uid": "817379f6-2f73-f9b0-7914-8183e06a2f8f",
            "version": 671708281,
            "state": 0,
            "modify_date": "2021-02-01T10:13:24.897",
            "modify_user": "root",
            "create_date": "2021-02-01T10:13:24.064",
            "create_user": "root",
            "document_id": 28962231,
            "payment_date": "2021-02-01",
            "details": "Currency exchange 22 GBP to 26.13 EUR rate .84184808 GBP/EUR",
            "buy_amount": 22.00,
            "buy_currency": "GBP",
            "sell_amount": 26.13,
            "sell_currency": "EUR",
            "base_currency": "",
            "debtor_name": "Silver Pink",
            "rate": 0.84184808,
            "revenue": -1.24,
            "debtor_gl": 0,
            "debtor_account": "22221000005GBP1",
            "debtor_ewallet": "222210000055",
            "creditor_gl": 0,
            "creditor_account": "60000C26550EURF",
            "creditor_ewallet": "60000C26550V",
            "payment_reference": "P000634",
            "processing_status": "COMPLETED",
            "document_reference": "FXCM210200ML6YN9",
            "debtor_client_code": "EN000C26L",
            "creditor_client_code": "EN000C26L",
            "rate_timestamp": "2021-02-01T10:13:22.975",
            "market_rate": 0.00000000,
            "fee_amount": 7.14,
            "fee_currency": "GBP",
            "fee_account": "22221000005GBP1",
            "error_description": "",
            "internal_timestamp": "2021-02-01T10:11:13.553+02:00",
            "internal_market_rate": 1.13389000,
            "fee_id": 14,
            "payment_type": "CONVERTATION",
            "fee_details": "Conversion fee for FXCM210200ML6YN9, EUR 8.08, rate EUR/GBP=1.1314393039",
            "fee_revenue_gl": 60245000,
            "debtor_counterparty_id": 0,
            "creditor_counterparty_id": 0,
            "creditor_account_reference_id": 0,
            "debtor_account_reference_id": 0,
            "fee_revenue_account": "",
            "payment_fee_id": 6829680,
            "transaction_header": 11233790,
            "transaction_time": "2021-02-01T10:13:24.639"
        },
        {
            "id": 6829677,
            "uid": "817379f6-2f73-f9b0-7914-7883c85d9007",
            "version": 671698706,
            "state": 0,
            "modify_date": "2021-02-01T10:10:04.227",
            "modify_user": "root",
            "create_date": "2021-02-01T10:09:59.552",
            "create_user": "root",
            "document_id": 28962045,
            "payment_date": "2021-02-01",
            "details": "Currency exchange 22 GBP to 26.13 EUR rate .84184808 GBP/EUR",
            "buy_amount": 22.00,
            "buy_currency": "GBP",
            "sell_amount": 26.13,
            "sell_currency": "EUR",
            "base_currency": "",
            "debtor_name": "Silver Pink",
            "rate": 0.84184808,
            "revenue": -1.24,
            "debtor_gl": 0,
            "debtor_account": "22221000005GBP1",
            "debtor_ewallet": "222210000055",
            "creditor_gl": 0,
            "creditor_account": "60000C26550EURF",
            "creditor_ewallet": "60000C26550V",
            "payment_reference": "P000633",
            "processing_status": "COMPLETED",
            "document_reference": "FXCM210200ML6T7K",
            "debtor_client_code": "EN000C26L",
            "creditor_client_code": "EN000C26L",
            "rate_timestamp": "2021-02-01T10:09:58.258",
            "market_rate": 0.00000000,
            "fee_amount": 7.14,
            "fee_currency": "GBP",
            "fee_account": "22221000005GBP1",
            "error_description": "",
            "internal_timestamp": "2021-02-01T10:07:52.521+02:00",
            "internal_market_rate": 1.13345000,
            "fee_id": 14,
            "payment_type": "CONVERTATION",
            "fee_details": "Conversion fee for FXCM210200ML6T7K, EUR 8.08, rate EUR/GBP=1.1314393039",
            "fee_revenue_gl": 60245000,
            "debtor_counterparty_id": 2360921,
            "creditor_counterparty_id": 2360921,
            "creditor_account_reference_id": 0,
            "debtor_account_reference_id": 0,
            "fee_revenue_account": "",
            "payment_fee_id": 6829678,
            "transaction_header": 11233781,
            "transaction_time": "2021-02-01T10:10:03.367"
        }
    ]
}						
# 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