FTOS_CB_ApproveContractTopUp

Changes the business status of a record from the FTOS_CB_ContractEvent entity representing a contract top up event to Approved.

Syntax

The FTOS_CB_ApproveContractTopUp custom endpoint is called from within the callAction endpoint. Visit the callAction page for more details.

Copy 
POST <host_address>/api/openApi/CallAction
Content-Type: application/json
            
{
    "Request":{
        "ActionName":"FTOS_CB_ApproveContractTopUp",
        "Data": "{ "ContractTopUp": { "contractNo":"<contract_number>","contractID":null,"eventNo":"<event_number>"} }"
    },
    "ApiInfo":{
        "UserName":"<user_name>",
        "Token":"<access_token>"
    }
}

Here's a list of the available parameters:

Parameter Description
host_address URL of the High Productivity Fintech Infrastructure server.
access_token Access token used to connect to the API endpoint. For details, see GetToken.
user_name The username of an existing user account on the High Productivity Fintech Infrastructure, previously used to get the access token.
Data Key-value pairs of any input parameters to be passed to the internal endpoint in JSON format. Double quotes that enclose string parameter values must be escaped with backslash characters, eg.: \"string value\".
contractNo Mandatory if contractId is not filled. The number of the contract.
contractId Mandatory if contractNo is not filled. The identifier of the contract.
eventNo Mandatory. The number of the top up event.

Response

The response indicates the result of the code execution, specifically the result of approving a contract top up event. If the record is updated successfully, its ContractTopUpIdentifier is returned.

Example

To approve a top up, send the following request, changing the parameter values with your desired values.

Request

Copy 
POST https://FintechOSStudio/api/openApi/CallAction
Content-Type: application/json
            
{
    "Request":{
        "ActionName":"FTOS_CB_ApproveContractTopUp",
        "Data": "{ "ContractTopUp": { "contractNo":"2252 TL_EUR","contractID":null,"eventNo":"ECB 2233"} }"
    },
    "ApiInfo":{
        "UserName":"host",
        "Token":"5b445502-f776-4e11-8b9b-8562b23b01aa"
    }
}

Response

Copy 
{
    "UIResult": {
        "NavigateToEntityPage": false,
        "NavigateToEntityPageOnEdit": false,
        "NavigateToEntityFormName": null,
        "NavigateToEntityName": null,
        "NavigateToEntityId": null,
        "NavigateToEntityInsertDefaults": null,
        "NavigateToUrl": null,
        "DownloadFile": null,
        "ReloadPage": false,
        "Message": null,
        "IsSuccess": false,
        "Data": "{"ContractTopUpIdentifier":"ECB 2233"}",
        "NavigateToPageNo": null
    },
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0
}