8.2 Execute API

The Execute (POST) API triggers the FTP Engine to process the submitted account data and generate transfer pricing rates.

  • Method – POST
  • URL - /ftpwebservices/v1/execute

Request Headers Details

The following lists the Request Headers:

  • ofs_workspace_id - Workspace ID of the Application. The default value is WS001 and same should be passed each time.
  • ofs_tenant_id - Tenant ID of the Application.
  • ofs_service_id - Service ID of the Application.
  • ofs_remote_user - User ID of the user.
  • Locale - Local language in the language code format. For example, en-US.
  • Authorization: Bearer <token> - Access token required to authenticate the API. If this token is not provided, a 401 Unauthorized error is generated. For more information about the Bearer token, refer to Generate the Access Token.

Attributes

  • PROCESS_ID - Unique identifier for the process request
  • AS_OF_DATE - The as-of-date for which rates are computed
  • ACCOUNT_DATA - Array of account objects, each containing:

    ACCOUNT_OFFICER_CD, CUSTOMER_CD, DEAL_ID, PRODUCT_ID, ISO_CURRENCY_CD, AMRT_TYPE_CD, ADJUSTABLE_TYPE_CD, ORIGINATION_DATE, ORG_TERM, ORG_TERM_MULT, AMRT_TERM, AMRT_TERM_MULT, MATURITY_DATE

Request Body

{
    "PROCESS_ID": "1730979970394",
    "AS_OF_DATE": "2015-03-31",
    "ACCOUNT_DATA": [
        {
            "ACCOUNT_OFFICER_CD": "1234",
            "CUSTOMER_CD": "C1",
            "DEAL_ID": "D1",
            "PRODUCT_ID": "10011",
            "ISO_CURRENCY_CD": "USD",
            "AMRT_TYPE_CD": "400",
            "ADJUSTABLE_TYPE_CD": "0",
            "ORIGINATION_DATE": "2024-11-12",
            "ORG_TERM": 43,
            "ORG_TERM_MULT": "D",
            "AMRT_TERM": 5,
            "AMRT_TERM_MULT": "M",
            "MATURITY_DATE": "2024-11-28"
        }
    ]
}

Sample Response Body

The following Response body is a sample for Success. For more information about status codes in the response body, refer to Rest API Status Codes.

{
    "severity": "info",
    "summary": "FTP Engine triggered successfully with Request Id: 87",
    "requestId": "87",
    "details": "FTP Engine triggered successfully",
    "status": "Success",
    "statusCode": "0"
}

The following Response body is a sample for a Failed request.

{
    "severity": "error",
    "summary": "Validation failed",
    "requestId": "",
    "details": [
        "ACCOUNT_OFFICER_CD Should Match NUMBER(5,0)",
        "AMRT_TERM_MULT Should Only Allow D(Days)/ M(Months) / Y(Years)"
    ],
    "status": "Invalid arguments passed in request/not enough params in Request body",
    "statusCode": "-4"
}