Fx-Deal-Inquiry-API-Response

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-fx-get-deal-operation-response-schema.json",
  "title": "Fx-Deal-Inquiry-API-Response",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-contract-status-inquiry-api-openapi.yml#/components/schemas/FxGetDealOperationResponse",
  "properties": {
    "FXP588INOperationResponse": {
      "$ref": "#/$defs/FXP588INOperationResponse"
    }
  },
  "$defs": {
    "FXP588INOperationResponse": {
      "type": "object",
      "title": "Fx-Get-Deal-Operation-Response",
      "required": [
        "FxDealInquiryRsp"
      ],
      "properties": {
        "FXP588IN-Operation-Response": {
          "$ref": "#/$defs/FxDealInquiryRsp"
        }
      }
    },
    "FxDealInquiryRsp": {
      "type": "object",
      "title": "FXP588IN-Operation-Response",
      "properties": {
        "WLClntId": {
          "type": "string",
          "description": "WorldLink Client ID. WorldLink Client Number and Branch Number. Provide Branch number if the Branch Number was part of FX request",
          "maxLength": 9,
          "title": "WLClntId"
        },
        "ContractRef": {
          "type": "string",
          "description": "WorldLink Contract Reference number. WorldLink Contract Number and WorldLink Sequence Number - this is the true unique identifier.  External interfaces use contract number concatenated to sequence number to designate unique deals. Please use this if available.",
          "maxLength": 15,
          "title": "ContractRef"
        },
        "UserId": {
          "type": "string",
          "description": "Unique UserId created by WorldLink. It will be used as a key to reference the requests and accepts.  For successful deal lookup responses, UserId will be mandatorily populated by WorldLink.  In case the lookup fails or the Deal is not found in WorldLink, then UserId will not be populated in the response.",
          "maxLength": 8,
          "title": "UserId"
        },
        "ResTime": {
          "type": "string",
          "description": "Date and Time when the response is generated by WorldLink.  Format: \"YYYY-MM-DD-HH:MM:SS\"",
          "maxLength": 19,
          "title": "ResTime"
        },
        "PymtCcy": {
          "type": "string",
          "description": "WorldLink Payment Currency SWIFT code.",
          "maxLength": 3,
          "title": "PymtCcy"
        },
        "PymtCcyAmt": {
          "type": "string",
          "description": "WorldLink Payment Currency amount.",
          "maxLength": 16,
          "title": "PymtCcyAmt"
        },
        "FundCcy": {
          "type": "string",
          "description": "WorldLink Funding Currency SWIFT code.",
          "maxLength": 3,
          "title": "FundCcy"
        },
        "FundCcyAmt": {
          "type": "string",
          "description": "WorldLink Funding Currency amount.",
          "maxLength": 16,
          "title": "FundCcyAmt"
        },
        "Rate": {
          "type": "number",
          "description": "FX Rate for Prebook.",
          "maximum": 99999999.99999999,
          "title": "Rate"
        },
        "BookDate": {
          "type": "string",
          "description": "FX Booking date in WorldLink. If the deal is found the actual booking date is shared  Format: YYYYMMDD.",
          "maxLength": 8,
          "title": "BookDate"
        },
        "ValueDate": {
          "type": "string",
          "description": "FX Contract Value Date Format: YYYYMMDD.",
          "maxLength": 8,
          "title": "ValueDate"
        },
        "DealTs": {
          "type": "string",
          "description": "Date and Time when the prebook deal was booked in OLR. Format: \"YYYY-MM-DD-HH.MM.SS.nnnnnn\"",
          "maxLength": 26,
          "title": "DealTs"
        },
        "FundActTotalLmt": {
          "type": "string",
          "description": "Total FX limit set-up by OLR - Funding account. This will only be populated if LinkToPymt is \"N\"",
          "maxLength": 16,
          "title": "FundActTotalLmt"
        },
        "FundActAvlLmt": {
          "type": "string",
          "description": "Total available limit - Funding account (Total limit - Limit earmarked). This will only be populated if LinkToPymt is \"N\"",
          "maxLength": 16,
          "title": "FundActAvlLmt"
        },
        "FundActEarMrkLmt": {
          "type": "string",
          "description": "Current limit earmarked - Funding account (Current earmarked limit + current drawdown amt). This will only be populated if LinkToPymt is \"N\"",
          "maxLength": 16,
          "title": "FundActEarMrkLmt"
        },
        "FundActUtilLmt": {
          "type": "string",
          "description": "Funding account - Current FX limit utilized post payment release (current utilized limit + receipt of infotelex). This will only be populated if LinkToPymt is \"N\"",
          "maxLength": 16,
          "title": "FundActUtilLmt"
        },
        "PymtActTotalLmt": {
          "type": "string",
          "description": "Total FX limit set-up by OLR - Payment account. This will only be populated if LinkToPymt is \"N\"",
          "maxLength": 16,
          "title": "PymtActTotalLmt"
        },
        "PymtActAvlLmt": {
          "type": "string",
          "description": "Total available limit - Payment account. Total limit - Limit earmarked . This will only be populated if LinkToPymt is \"N\"",
          "maxLength": 16,
          "title": "PymtActAvlLmt"
        },
        "PymtActEarMrkLmt": {
          "type": "string",
          "description": "Current limit earmarked - Payment account (Current earmarked limit + current drawdown amt). This will only be populated if LinkToPymt is \"N\"",
          "maxLength": 16,
          "title": "PymtActEarMrkLmt"
        },
        "PymtActUtilLmt": {
          "type": "string",
          "description": "Payment account - Current FX limit utilized post payment release (current utilized limit + receipt of infotelex). This will only be populated if LinkToPymt is \"N\"",
          "maxLength": 16,
          "title": "PymtActUtilLmt"
        },
        "StatusCode": {
          "type": "string",
          "description": "This parameter will be mandatorily sent in WorldLink response as per the following scenarios -  1. For successful execution WorldLink will return \"000\" 2. For any detail level error, a non-zero value is shown",
          "maxLength": 3,
          "title": "StatusCode"
        },
        "StatusMsg": {
          "type": "string",
          "description": "This parameter will be mandatorily sent in WorldLink response along with StatusCode. Message describing the error code/reason.",
          "maxLength": 255,
          "title": "StatusMsg"
        }
      }
    }
  }
}