Schemas Postman

Hold Instruction. Prepare data POST

Prepare Hold Instruction data

# ENDPOINT
/model/holdInstruction/prepare
# 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: holdInstruction
Type: object
Variable Name Type Format Usage Description
account account string M account
account_scheme account_scheme string
action Action string
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.
consolidated_amount_check Consolidated amount check boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
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
description description string Description of a given record
document_reference document_reference string The unique payment ID as assigned by the ABS system upon Payment registration in the ABS
error_description Error Description string Description of error
form_title form_title string Service field
hold_amount hold_amount number decimal M Hold amount
hold_amount_agent Hold amount agent number
hold_amount_agent_num Hold amount agent num STRING
hold_amount_num Hold amount num double
hold_amount_tax Hold amount tax number
hold_amount_tax_num Hold amount tax num STRING
hold_balance hold_balance number decimal M Hold balance
hold_balance_agent Hold balance agent number
hold_balance_agent_num Hold balance agent num STRING
hold_balance_num Hold balance num double
hold_balance_tax Hold balance tax number
hold_balance_tax_num Hold balance tax num STRING
hold_currency hold_currency string M Hold currency
hold_currency_exponenta Hold currency exponenta INTEGER
hold_payment_type hold_payment_type string Type of hold payment
id id integer INT64 Record's sequence number generated in the system.
instruction_type instruction_type string M Type hold instruction
List of allowed values in field (value=>name):
  • 0
    CARD_RESERVATION
  • 1
    HOLD
  • 2
    NOSTRO_OMA_PAYMENT_RESERVATION
  • 3
    PAYMENT_CREDITOR_NOSTRO_RESERVATION
  • 4
    PAYMENT_CREDITOR_RESERVATION
  • 5
    PAYMENT_FEE
  • 6
    PAYMENT_FEE_RESERVATION
  • 7
    PAYMENT_FEE_RESERVATION_WITHOUT_CHECK
  • 8
    PAYMENT_RESERVATION
  • 9
    PAYMENT_RESERVATION_WITHOUT_CHECK
  • 10
    RESERVATION
  • 11
    STOP_CREDIT
  • 12
    STOP_DEBET
insufficient_funds insufficient_funds boolean Status of funds
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
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
no_amount_check No amount check boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
no_limits_check No limits check boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
payment_type payment_type string Payment type
List of allowed values in field (value=>name):
  • 0
    Nothing
  • 1
    CONVERTATION
  • 2
    INTERCOMPANY
  • 3
    INTERNAL
  • 4
    INWARD
  • 5
    OFF-BALANCE
  • 6
    OUTWARD
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
    COMPLETED
  • 1
    PREPARE
  • 2
    PROCESSING
  • 3
    PROCESSING ERROR
  • 4
    READY
  • 5
    SENT
  • 6
    TRANSACTION
processing_step Processing step string Step of remote client data processing received from the external system
List of allowed values in field (value=>name):
  • 0
    ERROR
  • 1
    NORMAL
state state integer INT64 Record state for replication
system system string
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
# 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: holdInstruction
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_scheme account_scheme string
action Action string
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.
consolidated_amount_check Consolidated amount check boolean
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
description description string Description of a given record
document_reference document_reference string The unique payment ID as assigned by the ABS system upon Payment registration in the ABS
error_description Error Description string Description of error
form_title form_title string Service field
hold_amount hold_amount number decimal Hold amount
hold_amount_agent Hold amount agent number
hold_amount_agent_num Hold amount agent num STRING
hold_amount_num Hold amount num double
hold_amount_tax Hold amount tax number
hold_amount_tax_num Hold amount tax num STRING
hold_balance hold_balance number decimal Hold balance
hold_balance_agent Hold balance agent number
hold_balance_agent_num Hold balance agent num STRING
hold_balance_num Hold balance num double
hold_balance_tax Hold balance tax number
hold_balance_tax_num Hold balance tax num STRING
hold_currency hold_currency string Hold currency
hold_currency_exponenta Hold currency exponenta INTEGER
hold_payment_type hold_payment_type string Type of hold payment
id id integer INT64 Record's sequence number generated in the system.
instruction_type instruction_type string Type hold instruction
insufficient_funds insufficient_funds boolean Status of funds
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
no_amount_check No amount check boolean
no_limits_check No limits check 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
state state integer INT64 Record state for replication
system system string
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
Hold Instruction. Fetch data by request /api/holdInstruction/getData/holdInstructionSearchRequest
Hold Instruction. Fetch data by ID / UID /model/holdInstruction/getDb/{id}
Hold Instruction. Validate data /model/holdInstruction/validate
Hold Instruction. Create/update data /model/holdInstruction/putDb
Hold Instruction. Delete item by ID /api/holdInstruction/deleteItem/{id}
Hold Instruction. Check Available Funds /api/holdInstruction/checkAvailableFunds/holdInstructionSetModel
Hold Instruction. Set HoldInstruction /api/setHoldInstruction/holdInstructionSetModel