Get Payment Inward data by request
| Variable | Name | Type | Format | Usage | Description |
|---|---|---|---|---|---|
| X-App-Sig | X-App-Sig | header | string | M | Dev Authentication |
| Example | DEV-SKIP | ||||
| 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 |
| creditor_account | creditor_account | string | Creditor’s account number | ||
| creditor_account_iban | creditor_account_iban | string | The IBAN of the creditor | ||
| creditor_client_code | creditor_client_code | string | Unique customer ID in external system | ||
| creditor_name | creditor_name | string | Creditor full name [Name] and [Surname] and [Company Name] only for Business customer types respectively | ||
| currency | currency | string | Currency of the account | ||
| debtor_account | debtor_account | string | Debtor’s account number | ||
| debtor_account_iban | debtor_account_iban | string | The IBAN of the debtor | ||
| debtor_name | debtor_name | string | Debtor Name and Surname for Individual and Company Name for Business customer types respectively | ||
| division_client_code | Division client code | string | |||
| document_reference | document_reference | string | The unique payment ID as assigned by the ABS system upon Payment registration in the ABS | ||
| 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 | |||
| payment_date_from | payment_date_from | string | DATE | M | Date operation From |
| payment_date_to | payment_date_to | string | DATE | M | Date operation To |
| payment_reference | payment_reference | string | external system issued payment ID | ||
| processing_status | Processing Status | string | Status of remote client data processing received from the external system | ||
| search | Search | string | |||
| skip_total_records | Skip total records | boolean | List of allowed values in field (value=>name):
|
||
| system | system | string | List of allowed values in field (value=>name):
|
{
"amount_to": "10"
}
200 - Response successfully when status is OK
200 - Response successfully when status is OK
| 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 |
| Variable | Name | Type | Format | Description |
|---|---|---|---|---|
| action | Action | string | ||
| amount | amount | number | decimal | Operation amount |
| amount_num | Amount num | double | ||
| amount_signature | amount_signature | string | Signature operation for amount | |
| application_id | Application id | integer | ||
| attachments | attachments | string | Attachments | |
| authorise_date | Authorise date | string | ||
| authorise_status | Authorise status | string | ||
| authorise_user | Authorise user | string | ||
| charges_type | charges_type | string | Charge type is optionally filled | |
| 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 | |
| credit_gl | Credit gl | integer | ||
| credit_pending_gl | Credit pending gl | INTEGER | ||
| creditor_account | creditor_account | string | Creditor’s account number | |
| creditor_account_destination_tag | Creditor account destination tag | string | ||
| creditor_account_digital_address | Creditor account digital address | string | ||
| creditor_account_domestic | Creditor account domestic | string | ||
| 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_address | creditor_address | string | Customer full address | |
| creditor_address_region | Creditor address region | string | ||
| creditor_address_street | Creditor address street | string | ||
| creditor_agent_address | creditor_agent_address | string | Creditor’s agent full address | |
| creditor_agent_bic_swift | creditor_agent_bic_swift | string | Creditor’s agent Bank Identification Code / Swift Code as for the International payment standard. | |
| creditor_agent_code | creditor_agent_code | string | Creditor’s agent Code | |
| creditor_agent_code_type | creditor_agent_code_type | string | Creditor’s agent Code Type | |
| creditor_agent_country | creditor_agent_country | string | The agent is country of a payment creditor | |
| creditor_agent_name | creditor_agent_name | string | The agent name of a payment creditor | |
| creditor_base_account | Creditor E-wallet | STRING | ||
| creditor_city | Creditor city | string | ||
| creditor_client_code | creditor_client_code | string | Unique customer ID in external system | |
| creditor_counterparty_id | Creditor counterparty id | integer | ||
| creditor_country | creditor_country | string | Country wherein a creditor is living or incorporated | |
| creditor_date_of_birth | Creditor date of birth | string | ||
| creditor_entity_type | creditor_entity_type | string | Creditor entity type | |
| creditor_first_name | Creditor first name | string | ||
| creditor_last_name | Creditor last name | string | ||
| creditor_master_account | Creditor master account | STRING | ||
| creditor_master_base_account | Creditor master base account | STRING | ||
| creditor_master_gl | Creditor master gl | INTEGER | ||
| creditor_name | creditor_name | string | Creditor full name [Name] and [Surname] and [Company Name] only for Business customer types respectively | |
| creditor_national_id | creditor_national_id | string | Creditor national ID | |
| creditor_post_code | Creditor post code | string | ||
| currency | currency | string | Currency of the account | |
| currency_exponenta | Currency exponenta | integer | ||
| debet_gl | Debit gl | integer | ||
| debtor_account | debtor_account | string | Debtor’s account number | |
| debtor_account_destination_tag | Debtor account destination tag | string | ||
| debtor_account_digital_address | Debtor account digital address | string | ||
| debtor_account_domestic | Debtor account domestic | string | ||
| 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_address | Debtor address | string | ||
| debtor_agent_address | Debtor agent address | string | ||
| debtor_agent_bic_swift | Debtor agent bic | string | ||
| debtor_agent_code | Debtor agent sort code | string | ||
| debtor_agent_code_type | Debtor agent code type | string | ||
| debtor_agent_country | Debtor agent country | string | ||
| debtor_agent_name | Debtor agent name | string | ||
| debtor_base_account | Debtor E-wallet | STRING | ||
| debtor_client_code | debtor_client_code | string | Unique customer ID in external system | |
| debtor_counterparty_id | Debtor counterparty id | integer | ||
| debtor_country | Sender\'s country | 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 | |
| debtor_national_id | Debtor national id | string | ||
| details | details | string | Details of payment | |
| document_id | document_id | integer | int64 | Document ID |
| document_reference | document_reference | string | The unique payment ID as assigned by the ABS system upon Payment registration in the ABS | |
| document_type | document_type | string | Document type | |
| enrollement_method | Enrollement method | string | ||
| error_description | Error Description | string | Description of error | |
| external_fee_amount | External fee amount | NUMBER | ||
| external_fee_amount_num | External fee amount num | double | ||
| external_fee_currency | External fee currency | STRING | ||
| external_fee_currency_exponenta | External fee currency exponenta | INTEGER | ||
| fee_account | fee_account | string | Fee account | |
| fee_account_iban | fee_account_iban | string | Fee account IBAN number as for the EU standard | |
| 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 | ||
| intermediary_account_number | Intermediary account number | STRING | ||
| intermediary_address | Intermediary address | STRING | ||
| intermediary_bic_swift | Intermediary bic swift | STRING | ||
| intermediary_country | Intermediary country | STRING | ||
| intermediary_name | Intermediary name | STRING | ||
| message_type | message_type | 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 | |
| nonident_account | Nonident account | string | ||
| nostro_account | nostro_account | string | Nostro account | |
| nostro_name | Nostro name | string | ||
| oauth_access_token | Oauth access token | string | ||
| old_client_authorization_type | Old client authorization type | string | ||
| old_processing_status | Old processing status | string | Previous status of remote client data processing received from the external system | |
| old_processing_step | Old processing step | string | Previous step of remote client data processing received from the external system | |
| original_reference | Original reference | string | ||
| outgoing_chanel | Outgoing chanel | string | ||
| payment_date | Payment Date | string | DATE | Payment creation date and time |
| payment_fee_id | Payment fee id | integer | ||
| payment_reference | payment_reference | string | external system issued payment ID | |
| 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 | 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 | |
| rate | rate | number | decimal | Rate of operation |
| rate_timestamp | rate_timestamp | string | DATETIME | Operation Date/time |
| return_agent_code | Return agent code | STRING | ||
| return_destination_tag | Return destination tag | STRING | ||
| return_digital_address | Return digital address | STRING | ||
| send_amount | Send amount | number | ||
| send_currency | Send currency | string | ||
| source_system | Source system | string | Source system. For Internetbank please setup "IB" | |
| 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 | |
| ultimate_creditor_name | Ultimate creditor name | string | ||
| ultimate_debtor_name | Ultimate debtor name | string | ||
| unallocated_account | Unallocated account | string | ||
| urgency | urgency | string | Payment’s urgency type as specified by the system or customer | |
| value_date | Value Date | string | DATE | |
| version | version | integer | INT64 | Record version for replication |
{
"status": "ok",
"error_description": "",
"error": {},
"data_type": "",
"total_records": 4,
"data": [
{
"id": 6829216,
"uid": "ada4409e-9a88-f4bb-7914-2f5360840ae8",
"version": 658040926,
"state": 0,
"modify_date": "2021-01-29T08:26:13.700",
"modify_user": "root",
"create_date": "2021-01-29T08:26:07.843",
"create_user": "root",
"document_id": 28720801,
"payment_subtype": "0",
"payment_date": "2021-01-29",
"amount": 3.48,
"currency": "EUR",
"details": "",
"urgency": "STANDART",
"charges_type": "SHA",
"value_date": "2021-01-29",
"debtor_name": "Tonya Tarasova",
"debtor_address": "",
"debtor_country": "",
"debtor_account": "",
"debtor_account_iban": "LV21HABA0001408032543",
"debtor_agent_name": "Example Bank",
"debtor_agent_address": "",
"debtor_agent_country": "GB",
"debtor_agent_bic_swift": "HABALV22XXX",
"creditor_name": "KOSTIK KRIVOJ",
"creditor_address": "",
"creditor_country": "LT",
"creditor_account": "600023M8AU1EUR5",
"creditor_account_iban": "GB93TEST33159980834214",
"creditor_ewallet": "600023M8AU1K",
"creditor_agent_name": "Example Bank",
"creditor_agent_address": "",
"creditor_agent_country": "GB",
"creditor_agent_bic_swift": "TESTGB21",
"nostro_account": "60003GKTVEZEUR8",
"unallocated_account": "",
"fee_amount": 0.00,
"fee_currency": "",
"fee_account": "",
"debet_gl": 0,
"credit_gl": 30360000,
"fee_gl": 0,
"document_reference": "RMIN210100ME260E",
"nonident_account": "",
"processing_status": "AML",
"payment_reference": "RMIN210100ME260E",
"enrollement_method": "NONIDENT",
"nostro_name": "",
"debtor_client_code": "",
"creditor_client_code": "EN0023M85",
"system": "RAILSBANK",
"return_code": "",
"return_code_desc": "",
"error_description": "[ERROR-NOT-WHITELISTED-PERSON : Person not found in whitelist: counterparty_name=Tonya Tarasova]",
"ultimate_debtor_name": "",
"original_reference": "6013aa75-0f75-4316-90f0-f2d9da7fa4dc",
"ultimate_creditor_name": "",
"creditor_agent_code": "",
"debtor_agent_code": "",
"fee_id": 0,
"payment_type": "INWARD",
"message_type": "",
"fee_details": "",
"fee_revenue_gl": 0,
"debtor_counterparty_id": 2353288,
"creditor_counterparty_id": 2351276,
"document_type": "INTERNATIONAL",
"creditor_national_id": "",
"debtor_national_id": "",
"creditor_account_reference_id": 782743,
"debtor_account_reference_id": 778721,
"fee_revenue_account": "",
"processing_step": "NORMAL",
"payment_fee_id": 0,
"keep_fee_on_cancel": false
},
{
"id": 6829144,
"uid": "959307e2-27e0-46b2-7914-2e52a84ba3b5",
"version": 657770515,
"state": 0,
"modify_date": "2021-01-29T06:54:08.641",
"modify_user": "root",
"create_date": "2021-01-29T06:54:04.523",
"create_user": "root",
"document_id": 28720058,
"payment_subtype": "0",
"payment_date": "2021-01-29",
"amount": 1.03,
"currency": "EUR",
"details": "",
"urgency": "STANDART",
"charges_type": "SHA",
"value_date": "2021-01-29",
"debtor_name": "Sergio Perrera",
"debtor_address": "",
"debtor_country": "",
"debtor_account": "",
"debtor_account_iban": "LV47PARX0000115401017",
"debtor_agent_name": "Example Bank",
"debtor_agent_address": "",
"debtor_agent_country": "GB",
"debtor_agent_bic_swift": "PARXLV22XXX",
"creditor_name": "KOSTIK KRIVOJ",
"creditor_address": "",
"creditor_country": "LT",
"creditor_account": "600023M8AU1EUR5",
"creditor_account_iban": "GB93TEST33159980834214",
"creditor_ewallet": "600023M8AU1K",
"creditor_agent_name": "Example Bank",
"creditor_agent_address": "",
"creditor_agent_country": "GB",
"creditor_agent_bic_swift": "TESTGB21",
"nostro_account": "60003GKTVEZEUR8",
"unallocated_account": "",
"fee_amount": 0.00,
"fee_currency": "",
"fee_account": "",
"debet_gl": 0,
"credit_gl": 30360000,
"fee_gl": 0,
"document_reference": "RMIN210100ME1J7C",
"nonident_account": "",
"processing_status": "AML",
"payment_reference": "RMIN210100ME1J7C",
"enrollement_method": "NONIDENT",
"nostro_name": "",
"debtor_client_code": "",
"creditor_client_code": "EN0023M85",
"system": "RAILSBANK",
"return_code": "",
"return_code_desc": "",
"error_description": "[ERROR-NOT-WHITELISTED-PERSON : Person not found in whitelist: counterparty_name=Sergio Perrera]",
"ultimate_debtor_name": "",
"original_reference": "601394e3-a54f-4396-b8b7-55c57b67894c",
"ultimate_creditor_name": "",
"creditor_agent_code": "",
"debtor_agent_code": "",
"fee_id": 0,
"payment_type": "INWARD",
"message_type": "",
"fee_details": "",
"fee_revenue_gl": 0,
"debtor_counterparty_id": 2353289,
"creditor_counterparty_id": 2351276,
"document_type": "INTERNATIONAL",
"creditor_national_id": "",
"debtor_national_id": "",
"creditor_account_reference_id": 782743,
"debtor_account_reference_id": 779397,
"fee_revenue_account": "",
"processing_step": "NORMAL",
"payment_fee_id": 0,
"keep_fee_on_cancel": false
},
{
"id": 6829139,
"uid": "ba1c08e7-0116-cfbb-7914-2851e8e9cf61",
"version": 658624061,
"state": 0,
"modify_date": "2021-01-29T11:51:36.810",
"modify_user": "root",
"create_date": "2021-01-29T05:20:11.102",
"create_user": "root",
"document_id": 28720051,
"payment_subtype": "0",
"payment_date": "2021-01-29",
"amount": 0.02,
"currency": "EUR",
"details": "New Dummy Invoice 29/01/2021 05:20:07.864+02:00",
"urgency": "STANDART",
"charges_type": "SHA",
"value_date": "2021-01-29",
"debtor_name": "DRAGI JOVANOVICH",
"debtor_address": "V Kudir 28",
"debtor_country": "NL",
"debtor_account": "",
"debtor_account_iban": "NL19RABO2718081430",
"debtor_agent_name": "",
"debtor_agent_address": "",
"debtor_agent_country": "NL",
"debtor_agent_bic_swift": "RABONL2XXXX",
"creditor_name": "ANNA ANNOVA",
"creditor_address": "Brivibas iela 17",
"creditor_country": "LT",
"creditor_account": "60003GL7000EUR1",
"creditor_account_iban": "LT873420060003GL7000",
"creditor_ewallet": "60003GL7000F",
"creditor_agent_name": "ELCOIN LTD",
"creditor_agent_address": "",
"creditor_agent_country": "GB",
"creditor_agent_bic_swift": "BAXXLT22XXX",
"nostro_account": "CBLT.EUR",
"unallocated_account": "",
"fee_amount": 0.00,
"fee_currency": "",
"fee_account": "",
"debet_gl": 0,
"credit_gl": 30360000,
"fee_gl": 0,
"document_reference": "RMIN210100ME1J1Y",
"nonident_account": "",
"processing_status": "AML",
"payment_reference": "RMIN210100ME1J1Y",
"enrollement_method": "NONIDENT",
"nostro_name": "",
"debtor_client_code": "",
"creditor_client_code": "EN003GL7A",
"system": "SEPA",
"return_code": "",
"return_code_desc": "",
"error_description": "[ERROR-NOT-WHITELISTED-PERSON : Person not found in whitelist: counterparty_name=DRAGI JOVANOVICH]",
"ultimate_debtor_name": "",
"original_reference": "REF6215-1928",
"ultimate_creditor_name": "",
"creditor_agent_code": "",
"debtor_agent_code": "",
"fee_id": 0,
"payment_type": "INWARD",
"message_type": "",
"fee_details": "",
"fee_revenue_gl": 0,
"debtor_counterparty_id": 2354131,
"creditor_counterparty_id": 2352249,
"document_type": "SEPA",
"creditor_national_id": "",
"debtor_national_id": "",
"creditor_account_reference_id": 782752,
"debtor_account_reference_id": 782764,
"fee_revenue_account": "",
"processing_step": "NORMAL",
"payment_fee_id": 0,
"keep_fee_on_cancel": false
},
{
"id": 6829133,
"uid": "8ef42634-81fe-8787-7914-a74f70e26802",
"version": 657120725,
"state": 0,
"modify_date": "2021-01-29T03:02:20.530",
"modify_user": "root",
"create_date": "2021-01-29T03:02:15.277",
"create_user": "root",
"document_id": 28720041,
"payment_subtype": "0",
"payment_date": "2021-01-29",
"amount": 0.74,
"currency": "EUR",
"details": "New Dummy Invoice 29/01/2021 03:02:13.552+02:00",
"urgency": "STANDART",
"charges_type": "SHA",
"value_date": "2021-01-29",
"debtor_name": "John Walker",
"debtor_address": "11 London street",
"debtor_country": "GB",
"debtor_account": "",
"debtor_account_iban": "GB93HBUK40031171774158",
"debtor_agent_name": "",
"debtor_agent_address": "",
"debtor_agent_country": "GB",
"debtor_agent_bic_swift": "LOYDGB20",
"creditor_name": "KRUZA SIA",
"creditor_address": "Brivibas iela 17",
"creditor_country": "LT",
"creditor_account": "60003GLR000EUR2",
"creditor_account_iban": "LT543420060003GLR000",
"creditor_ewallet": "60003GLR000G",
"creditor_agent_name": "ELCOIN LTD",
"creditor_agent_address": "",
"creditor_agent_country": "GB",
"creditor_agent_bic_swift": "BAXXLT22XXX",
"nostro_account": "CBLT.EUR",
"unallocated_account": "",
"fee_amount": 0.00,
"fee_currency": "",
"fee_account": "",
"debet_gl": 0,
"credit_gl": 30360000,
"fee_gl": 0,
"document_reference": "RMIN210100ME1HTK",
"nonident_account": "",
"processing_status": "AML",
"payment_reference": "RMIN210100ME1HTK",
"enrollement_method": "NONIDENT",
"nostro_name": "",
"debtor_client_code": "",
"creditor_client_code": "EN003GLRB",
"system": "SEPA",
"return_code": "",
"return_code_desc": "",
"error_description": "[ERROR-NOT-WHITELISTED-PERSON : Person not found in whitelist: counterparty_name=John Walker]",
"ultimate_debtor_name": "",
"original_reference": "REF3509-8360",
"ultimate_creditor_name": "",
"creditor_agent_code": "",
"debtor_agent_code": "",
"fee_id": 0,
"payment_type": "INWARD",
"message_type": "",
"fee_details": "",
"fee_revenue_gl": 0,
"debtor_counterparty_id": 2357272,
"creditor_counterparty_id": 2351984,
"document_type": "SEPA",
"creditor_national_id": "",
"debtor_national_id": "",
"creditor_account_reference_id": 782736,
"debtor_account_reference_id": 782965,
"fee_revenue_account": "",
"processing_step": "NORMAL",
"payment_fee_id": 0,
"keep_fee_on_cancel": false
}
]
}
200 - Response with error when status is ERROR
200 - Response with error when status is ERROR
| 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 |
{
"status": "error",
"error_description": "ERROR-DESERIALIZE: ** Decimal number is too large. (536)",
"error": {},
"data_type": "",
"total_records": -2,
"data": {}
}