WorldLink FX Booking

POST

///v3/fx/bookfx

POST

/v3/fx/bookfx

curl -X POST /v3/fx/bookfx \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "SignonRq": {
    "ClientDt": "2025-12-17T05:21:02",
    "CustLangPref": "ENGLISH",
    "ClientApp": {
      "Name": "ABCDBANK",
      "Org": "CTSI INTERFACE",
      "Version": "1.0"
    }
  },
  "BankSvcRq": [
    {
      "RqUID": "99dc17a3-6bbf-4310-973a-a369e5",
      "ForExRateDealAddRq": [
        {
          "RqUID": "99dc17a3-6bbf-4310-973a-a369e50",
          "CustId": {
            "SPName": "CTSI",
            "CustPermId": "85370001"
          },
          "ForExDealInfo": {
            "CurConvertRule": "DIRECT",
            "IssueCurCode": "INR",
            "RemitCurCode": "USD",
            "SPRefId": "XML56EQB",
            "ForExRateDealType": "SELL",
            "RemitAmt": "3"
          }
        }
      ],
      "PrefPrice": "N",
      "WLFlag": "W",
      "DealType": "O"
    }
  ]
}'

{
  "IFX": {
    "BankSvcRs": {
      "DealType": "O",
      "ForExRateDealAddRs": {
        "ForExDealInfo": {
          "CurConvertRule": "Direct",
          "ForExRateDealType": "SELL",
          "IssueCurCode": "INR",
          "RemitAmt": "3",
          "RemitCurCode": "USD",
          "SPRefId": "XML56HEG"
        },
        "ForExDealRec": {
          "ForExDealId": "AA6594101242034",
          "ForExDealInfo": {
            "CurConvertRule": "Direct",
            "CurRate": 89.83,
            "ForExUnw": "2026-01-15-05.00.00",
            "IssueAmt": 269.49,
            "IssueCurCode": "INR",
            "RemitAmt": 3,
            "RemitCurCode": "USD",
            "SPRefId": "XML56HEG"
          }
        },
        "RqUID": "99dc17a3-6bbf-4310-973a-a369e50",
        "Status": {
          "Severity": "NONE",
          "StatusCode": "PROCESSED",
          "StatusDesc": "000 : Rate returned"
        }
      },
      "PrefPrice": "N",
      "RqUID": "99dc17a3-6bbf-4310-973a-a369e5",
      "Status": {
        "Severity": "NONE",
        "StatusCode": "PROCESSED",
        "StatusDesc": "000 : Rate returned"
      },
      "WLFlag": "W"
    }
  }
}

The CitiConnect WorldLink FX Booking endpoint allows you to book FX deals according to rate quotes received through CitiConnect FX Rate Inquiry for available currency combinations.

Content Type: Supports application/xml or application/json.

Authorization: The OAuth Token prefixed with Bearer and space in between.

Request: For more information on specific field mappings, please refer to Customized IFX XML standards.

Authentication

AuthorizationBearer

All CitiConnect APIs use the oAuth2 authentication scheme, which requires a bearer token to authenticate your API call. The Token URL includes the version of authentication used by this API. See the Citi Authentication API reference for information on requesting a token.

Query parameters

client_idstringRequired

Unique identifier created during the onboarding process.

Request

This endpoint expects an object.

SignonRqobjectRequired

BankSvcRqlist of objectsRequired

Bank Service Request for Book FX

Response

BankSvcRsobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Headers

Query parameters

Request

Response

Errors