Schemas Postman

Fee. Prepare data POST

prepare data model

# ENDPOINT
/model/fee/prepare
# REQUEST BODY
# RESPONSE
# REQUEST BODY
Schema: fee
Type: object
Variable Name Type Format Usage Description
account account string M account
account_product_settings_id Account settings Id integer
account_scheme account_scheme string
account_settings_description Account settings string
action Action string
activation_date Activation Date string DATE M Activation date in the system
agent_account agent_account string M Agent Account
agent_base_account Agent Base account STRING M
agent_gl agent_gl integer INT64 Agent Gl
agent_percentage agent_percentage number DECIMAL Agent Percentage
algorithm algorithm string Algorithm
base_account base_account string M Base multicurrency account
client_code Client code string M Unique client identifier. Issued automatically by the System upon new Customer registration.
client_group client_group string M Client group
List of allowed values in field (value=>name):
  • 0
    AGENT
  • 1
    APPLICANT
  • 2
    BENEFICIARY
  • 3
    BRANCH
  • 4
    CHALLENGER
  • 5
    CLIENT
  • 6
    CLIENT
  • 7
    COMPANY
  • 8
    CONTACT
  • 9
    COUNTERPARTY
  • 10
    EMPLOYEE
  • 11
    PROVIDER
  • 12
    PSP
  • 13
    RECIPIENT
  • 14
    REGULATOR
  • 15
    RELATED_PERSON
  • 16
    SUPPLIER
  • 17
    USER
client_statuses client_statuses string M Client statuses
country_group country_group string M Country group
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
cycle_code cycle_code string M
List of allowed values in field (value=>name):
  • 0
    DAY
  • 1
    MONTH
  • 2
    OPERATION
  • 3
    YEAR
event_code event_code string M Event code
List of allowed values in field (value=>name):
  • 0
    ACCOUNT_ACTIVE
  • 1
    ACCOUNT_CLOSE
  • 2
    ACCOUNT_OPEN_NEW
  • 3
    CLIENT_BECOME
  • 4
    CONVERTATION
  • 5
    FEE_MANUAL
  • 6
    FEE_PERIODIC
  • 7
    FEE_PERIODIC_ACTIVE_CARD
  • 8
    FEE_WITHOUT_TARIFF
  • 9
    INACTIVE_ACCOUNTS
  • 10
    INACTIVE_BASE_ACCOUNT
  • 11
    INTERNAL
  • 12
    INTERNAL_CLIENT
  • 13
    INWARD
  • 14
    INWARD_CLIENT
  • 15
    OUTWARD
  • 16
    OUTWARD_FX
  • 17
    OUTWARD_FX_CLIENT
expiration_date Expiration Date string DATE M Expiration date in the system
fee_code fee_code string M Fee code
fee_code_description Description string
fee_currency fee_currency string M Fee currency
fee_dates_status fee_dates_status string Fee status
List of allowed values in field (value=>name):
  • 0
    ACTIVE
  • 1
    DISABLED
  • 2
    EXPIRED
  • 3
    PENDING
fee_status fee_status string Fee status
List of allowed values in field (value=>name):
  • 0
    ACTIVE
  • 1
    DISABLED
  • 2
    EXPIRED
  • 3
    PENDING
fixed_amount fixed_amount number DECIMAL Fixed amount
form_title form_title string Service field
gl Gl integer
id id integer INT64 Record's sequence number generated in the system.
link_type link_type string M Link type
maximum_amount maximum_amount number DECIMAL M Maximum amount
minimum_amount minimum_amount number DECIMAL M Minimum amount
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
operation_amount_from operation_amount_from number DECIMAL M Operation amount from
outgoing_chanel Outgoing chanel string
List of allowed values in field (value=>name):
  • 0
    DIGITAL_ADDRESS
  • 1
    EU_SEPA_INSTANT
  • 2
    EU_SEPA_STEP2
  • 3
    EU_SEPA_TARGET2
  • 4
    EU_VIRTUAL
  • 5
    FX-NETWORK
  • 6
    GB_BACS
  • 7
    GB_BACS_DIRECT_DEBIT
  • 8
    GB_CHAPS
  • 9
    GB_FASTER_PAYMENTS
  • 10
    GB_VIRTUAL
  • 11
    INTERNAL-NETWORK
  • 12
    POS_TERMINAL
  • 13
    REMOTE-BOOKKEEPING
  • 14
    SG_FAST
  • 15
    SG_VIRTUAL
  • 16
    SWIFT
  • 17
    SWIFT_VIRTUAL
  • 18
    US_ACH
  • 19
    US_VIRTUAL
  • 20
    US_WIRES
payment_currency payment_currency string M Payment currency
percentage percentage number DECIMAL Percentage"
state state integer INT64 Record state for replication
subscription_code Subscription Code string M Subscription code
tax_account tax_account string M TAX Account
tax_base_account Tax Base account STRING M
tax_gl tax_gl integer INT64 TAX Gl
tax_percentage tax_percentage number DECIMAL TAX Percentage
uid uid string Unique record identifier which is used to distinguish between existing records
urgency urgency string M Payment’s urgency type as specified by the system or customer
List of allowed values in field (value=>name):
  • 0
    INSTANT
  • 1
    STANDART
  • 2
    URGENT
version version integer INT64 Record version for replication
# REQUEST BODY EXAMPLE
# POSITIVE RESPONSE

200 - Response successfully when status is OK

200 - Response successfully when status is OK

Schema: fee
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 data of Response
attribute: data
Variable Name Type Format Description
account account string account
account_product_settings_id Account settings Id integer
account_scheme account_scheme string
account_settings_description Account settings string
action Action string
activation_date Activation Date string DATE Activation date in the system
agent_account agent_account string Agent Account
agent_base_account Agent Base account STRING
agent_gl agent_gl integer INT64 Agent Gl
agent_percentage agent_percentage number DECIMAL Agent Percentage
algorithm algorithm string Algorithm
base_account base_account string Base multicurrency account
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
client_group client_group string Client group
client_statuses client_statuses string Client statuses
country_group country_group string Country group
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
cycle_code cycle_code string
event_code event_code string Event code
expiration_date Expiration Date string DATE Expiration date in the system
fee_code fee_code string Fee code
fee_code_description Description string
fee_currency fee_currency string Fee currency
fee_dates_status fee_dates_status string Fee status
fee_status fee_status string Fee status
fixed_amount fixed_amount number DECIMAL Fixed amount
form_title form_title string Service field
gl Gl integer
id id integer INT64 Record's sequence number generated in the system.
link_type link_type string Link type
maximum_amount maximum_amount number DECIMAL Maximum amount
minimum_amount minimum_amount number DECIMAL Minimum amount
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
operation_amount_from operation_amount_from number DECIMAL Operation amount from
outgoing_chanel Outgoing chanel string
payment_currency payment_currency string Payment currency
percentage percentage number DECIMAL Percentage"
state state integer INT64 Record state for replication
subscription_code Subscription Code string Subscription code
tax_account tax_account string TAX Account
tax_base_account Tax Base account STRING
tax_gl tax_gl integer INT64 TAX Gl
tax_percentage tax_percentage number DECIMAL TAX Percentage
uid uid string Unique record identifier which is used to distinguish between existing records
urgency urgency string Payment’s urgency type as specified by the system or customer
version version integer INT64 Record version for replication
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

200 - Response with error when status is ERROR

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
Fee. Fetch data by request /api/fee/getData/clientFeeRequest
Fee. Fetch data by ID /model/fee/getDb/{id}
Fee. Validate data /model/fee/validate
Fee. Create/update data /model/fee/putDb
Fee. Delete item by ID /api/fee/deleteItem/{id}