8.3 Fetch Rates API

Use the Fetch Rates API to retrieve the computed transfer pricing rates for a previously submitted request.

• Method – GET
• URL - /ftpwebservices/v1/fetch-rates/{requestId}

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.
• Authorization: Bearer <token> - Access token required to authenticate the API. For more information about the Bearer token, refer to Ways to Generate Access Token

Attributes

• requestId - Path parameter identifying the request whose rates are to be fetched (obtained from the Execute API response)

Sample Response Body

Success (rates available):

{
    "severity": "info",
    "summary": "FTP Engine executed successfully with Request Id: 87",
    "result": [
        {
            "ACCOUNT_NUMBER": "RTTP_87_1",
            "AS_OF_DATE": "2015-03-31",
            "REQUEST_ID": 87,
            "TRANSFER_RATE": "8.668865",
            "LIQUIDITY_PREMIUM_RATE": "10.56",
            "PRICING_INCENTIVE_RATE": "15.779165189",
            "OTHER_ADD_ON_RATE": "8.668865",
            "ALL_IN_TP_RATE": "43.676895189"
        }
    ],
    "details": "FTP Engine executed successfully",
    "status": "Success",
    "statusCode": "0"
}

Ongoing:

{
    "severity": "info",
    "summary": "FTP Engine Execution is Ongoing with Request Id: 94",
    "requestId": "94",
    "details": "FTP Engine Execution Ongoing",
    "status": "Ongoing",
    "statusCode": "2"
}

Failure:

{
    "severity": "info",
    "summary": "FTP Engine Execution Is Failed with Request Id: 94",
    "requestId": "94",
    "details": "FTP Engine Execution Failed",
    "status": "Failure",
    "statusCode": "-1"
}