Prepare Payment Outward data
Variable | Name | Type | Format | Usage | Description |
---|---|---|---|---|---|
X-App-Sig | X-App-Sig | header | string | M | Dev Authentication |
Variable | Name | Type | Format | Usage | Description |
---|---|---|---|---|---|
action | Action | string | |||
additional_data | Additional data | string | data that is necessary for payment execution in defined countries (as purposeCode, charity number, ect.). Data filled in json format. Example: { 'beneficiaryBankCorrespondentAccount': 'data of beneficiaryBankCorrespondentAccount', 'beneficiaryInn': 'data of beneficiaryInn', 'beneficiaryKpp': 'data of beneficiaryKpp', ... } | ||
amount | amount | number | decimal | Operation amount | |
amount_num | Amount num | double | |||
amount_requested | Amount requested | number | |||
amount_requested_num | Amount requested 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 | |||
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 | M | Creditor’s agent Code | |
creditor_agent_code_type | creditor_agent_code_type | string | M | Creditor’s agent Code Type List of allowed values in field (value=>name):
|
|
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 List of allowed values in field (value=>name):
|
||
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 | M | 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 | M | The unique payment ID as assigned by the ABS system upon Payment registration in the ABS | |
document_type | document_type | string | Document type | ||
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 | List of allowed values in field (value=>name):
|
||
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 | ||
nostro_account | nostro_account | string | M | 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 | List of allowed values in field (value=>name):
|
||
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 | List of allowed values in field (value=>name):
|
||
payment_type | payment_type | string | Payment type | ||
processing_status | Processing Status | string | M | 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 | M | ||
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 | |||
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 |
200 - Response successfully when status is OK
<p style="color:green;font-size:16px;">200 - Response successfully when status is OK</p>
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 | data of Response |
Variable | Name | Type | Format | Description |
---|---|---|---|---|
action | Action | string | ||
additional_data | Additional data | string | data that is necessary for payment execution in defined countries (as purposeCode, charity number, ect.). Data filled in json format. Example: { 'beneficiaryBankCorrespondentAccount': 'data of beneficiaryBankCorrespondentAccount', 'beneficiaryInn': 'data of beneficiaryInn', 'beneficiaryKpp': 'data of beneficiaryKpp', ... } | |
amount | amount | number | decimal | Operation amount |
amount_num | Amount num | double | ||
amount_requested | Amount requested | number | ||
amount_requested_num | Amount requested 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 | ||
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 | |
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 | |
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 | ||
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 |
200 - Response with error when status is ERROR
<p style="color:red;font-size:16px;">200 - Response with error when status is ERROR</p>
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 |