FX trade (RFQ)

A Request for Quote (RFQ) in the context of foreign exchange (FX) will allow you to request a price up-front for any of our currently supported currency pairs and hold that rate for a set period.

Once you receive the response with the quote, the rate is held for 45 seconds. If you decide that you want to initiate the trade, a separate trade request must be submitted within the held rate period. This functionality enhances your trading capabilities by providing a transparent and efficient way to secure the held rates via ClearBank.

This message flow diagram shows the flow of requesting a rate quote, successfully executing the trade within the held rate period, and the associated trade settled webhook.

This message flow diagram shows the flow of requesting a rate quote, an attempt to execute the trade outside the held rate period, and the associated 400 error.

You can use our FX trade functionality to perform FX trades between accounts which belong to the same owner. For example, let’s assume that you want to sell GBP from Account A to purchase EUR for Account B – in doing so, you will need to ensure that the owner of both accounts is the same. This applies to two accounts that belong to you, that is, the financial institution or your customers.

Trade Request:

InstructedAmount: 1000
FixedSide: Sell
BuyCurrency: USD
SellCurrency: GBP (This means the fixed side of the trade is GBP and the floating side is USD. Therefore, the margin will be in USD).
Margin: 0.01 (Where 0.01 represents a 1% margin)
Assume the ClearBank rate is: 1.40 for GBP/USD
Margin amount: 1.4 x 0.01 x GBP 1000 = USD 14

Resulting transactions in respective accounts:

Debit to the sellAccount: GBP 1000.00
Credit to the buyAccount: USD 1386 [USD 1.4 x (1-0.01) x 1000]
Credit to the specified margin account: USD 14

Trade Request:

InstructedAmount: 1400
FixedSide: Buy
BuyCurrency: USD
SellCurrency: GBP
This means the fixed side of the trade is USD and the floating side is GBP, therefore the margin will be in GBP
Margin: 0.01 (Where 0.01 represents a 1% margin)
Assume the ClearBank rate is: 1.40 for GBP/USD
Margin amount: 1400 / 1.4 x 0.01 = GBP 10

Resulting transactions in respective accounts:

Debit to the sellAccount: GBP [1110 (1400 / 1.4 x (1 + 0.01)]
Credit to the buyAccount: USD 1400
Credit to the specified margin account: GBP 10

If a trade is booked in time for same-day settlement, you will receive a webhook notification of the settlement. If it fails to settle (in practice, because there are insufficient funds in the account), you will learn of the failure immediately. ClearBank will then send a fx-trade-cancelled-v1 webhook.
If a trade is booked, but cannot be settled until a later day, and the settlement fails, the fx-trade-settlement-failed-v1 webhook notifies you of the failure. Make sure you subscribe to this webhook if you are making FX trades with a value (settlement) date later than the day of booking.

Refer to the below table detailing the cut-off times for all currently supported currencies. Note that all times are in UK time.

Currency	Currency code	Start time	FX cut-off time (same day)	FX cut-off time (next day/2 days' time)
Canadian Dollar	CAD	07:00	13:00	23:30
Swiss Franc	CHF	07:00	09:30	23:30
Czech Koruna	CZK	07:00	TBC	23:30 (not yet enabled)
Danish Krone	DKK	07:00	09:30	23:30
Euro	EUR	07:00	13:00	23:30
British Pounds	GBP	07:00	13:00	23:30
Hungarian Forint	HUF	07:00	TBC	23:30 (not yet enabled)
Norwegian Krone	NOK	07:00	09:30	23:30
Polish Zloty	PLN	07:00	TBC	23:30 (not yet enabled)
Romanian Leu	RON	07:00	TBC	23:30 (not yet enabled)
Swedish Krona	SEK	07:00	09:30	23:30
United States Dollar	USD	07:00	13:00	23:30

FX trades have minimum trading values defined for each currency. If you try to request a trade below these values, you will receive a 400 error response. For the full list of minimum trade values per currency, see Foreign exchange trade.

Request a quote

post/fx/v1/quote

Requests a quote for a specified FX trade.

Parameters

Authorization string, header, Required
Your API token, obtained from the ClearBank Portal.
DigitalSignature string, header, Required
Signed hash of the body of the request. The hash is signed by your private key.
X-Request-Id string, header, Required
A unique identifer for the request; valid for 24 hours, max length 83.

Request Payload (application/json)

valueDate string, Required
Settlement date for the proposed FX trade in the format yyyy-MM-ddTHH:mm:ssZ.
instructedAmount number, Required
Amount instructed to buy or sell.
fixedSide string, Required
The side of the trade to be fixed.
Enum array
buy, sell
sellCurrency string, Required
Three-letter ISO 4217 currency code for the currency to sell.
Minimum length
3
Maximum length
3
buyCurrency string, Required
Three-letter ISO 4217 currency code for the currency to buy.
Minimum length
3
Maximum length
3
margin number
The optional margin (as a percentage) from the trade to be credited to a margin account. Must be below 0.05 (for example, 0.002 = 0.2% margin).
Minimum
0
Maximum
0.0499

request

{
  "valueDate": "2024-08-24T14:15:22Z",
  "instructedAmount": "1000.00",
  "fixedSide": "buy",
  "sellCurrency": "EUR",
  "buyCurrency": "USD",
  "margin": "0.01"
}

Code copied

Response (application/json)

200 OK
400 Bad Request

OK

{
  "quoteRequest": {
    "valueDate": "2024-08-24T14:15:22Z",
    "instructedAmount": "1000.00",
    "fixedSide": "buy",
    "sellCurrency": "EUR",
    "buyCurrency": "USD",
    "margin": "0.01"
  },
  "quoteId": "d4f23e64-276c-48b1-9b8c-5c4e1c395a82",
  "valueDate": "2024-08-24T14:15:22Z",
  "currencyPair": "EUR/USD",
  "exchangeRate": "1.214021494",
  "sellCurrency": "EUR",
  "sellAmount": "1000.00",
  "buyCurrency": "USD",
  "buyAmount": "1214.02",
  "createdAt": "2024-08-24T14:15:23Z",
  "expiresAt": "2024-08-24T14:16:08Z",
  "marginAmount": "12.29",
  "marginCurrency": "USD"
}

Code copied

Bad Request

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Code copied

Execute a quote

post/fx/v1/ExecuteQuote

Execute a trade using the quoted rate.

Parameters

Authorization string, header, Required
Your API token, obtained from the ClearBank Portal.
DigitalSignature string, header, Required
Signed hash of the body of the request. The hash is signed by your private key.
X-Request-Id string, header, Required
A unique identifer for the request; valid for 24 hours, max length 83.

Request Payload (application/json)

quoteId string, Required
ID of the quoted rate to be executed in the trade
customerInformation object, Required
marginAccount object

request

{
  "quoteId": "d4f23e64-276c-48b1-9b8c-5c4e1c395a82",
  "customerInformation": {
    "sellAccount": {
      "owner": "FX Service Ltd",
      "iban": "GB57CLRB04040100057354"
    },
    "buyAccount": {
      "owner": "FX Service Ltd",
      "iban": "GB57CLRB04040100057354"
    },
    "attestation": "Y"
  },
  "marginAccount": {
    "owner": "FX Service Ltd",
    "iban": "GB57CLRB04040100057354"
  }
}

Code copied

Response (application/json)

202 Accepted
400 Bad Request
409 Conflict
423 Locked
503 Service Unavailable

This webhook confirms that the FX trade has been booked.

Request body

{
    "Type":"Fx.Trade.Executed",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`SellAccountOwner`	Required The name used to identify the legal owner of the account from which to debit funds. Type: `string` Min. Length: `1` Max. Length: `140`
`SellAccountIban`	Required International Bank Account Number associated with the Sell Account. Type: `string` Min. Length: `1` Max. Length: `35`
`BuyAccountOwner`	Required The name used to identify the legal owner of the account in which to credit funds. Type: `string` Min. Length: `1` Max. Length: `140`
`BuyAccountIban`	Required International Bank Account Number associated with the Buy Account. Type: `string` Min. Length: `1` Max. Length: `35`
`Attestation`	Required Confirmation that the Sell Account and Buy Account are owned by the same legal owner. Options that can be specified are Y and N. Must be Y for the FX trade to be created successfully. Type: `string` Min. Length: `1` Max. Length: `1`
`ValueDate`	Required Settlement date for the FX trade. Type: `string` Format: `date-time` Min. Length: `1`
`InstructedAmount`	Required Amount instructed to buy or sell. Type: `number` Format: `decimal`
`FixedSide`	Required The side of the trade to be fixed. This can either be buy or sell. Type: `string` Min. Length: `3` Max. Length: `4`
`BuyCurrency`	Required Three-letter ISO currency code for the currency to buy. Type: `string` Min. Length: `3` Max. Length: `3`
`SellCurrency`	Required Three-letter ISO currency code for the currency to sell. Type: `string` Min. Length: `3` Max. Length: `3`
`Margin`	Optional The optional margin (as a percentage) from the trade to be credited to a margin account. Type: `number` Format: `decimal`
`MarginAccountIban`	Optional International Bank Account Number associated with the account in which the margin amount is to be deposited. Type: `string` Min. Length: `1` Max. Length: `35`
`EndToEndId`	Required Unique identifier provided to ClearBank for the FX trade. Type: `string` Min. Length: `1` Max. Length: `35`
`UnstructuredInformation`	Optional Additional, optional information about the FX trade. Type: `string` Max. Length: `140`
`Symbol`	Required Currency pair for the FX trade. Type: `string` Min. Length: `1`
`FIReceivedMarginAmount`	Optional Margin amount received by the financial institution if an optional margin has been applied to the FX trade. Type: `number` Format: `decimal`
`BuyAmount`	Required The amount of currency purchased. Type: `number` Format: `decimal`
`SellAmount`	Required The amount of currency sold. Type: `number` Format: `decimal`
`ClearBankRate`	Required Exchange rate given to the financial institution by ClearBank. Type: `number` Format: `decimal`
`FIRate`	Required Exchange rate applied after the financial institution margin (if any) has been deducted. Type: `number` Format: `decimal`
`RequestedTime`	Required Date and time for when the FX trade was received. Type: `string` Format: `date-time` Min. Length: `1`
`ExecutedTime`	Required Date and time for when the FX trade was executed. Type: `string` Format: `date-time` Min. Length: `1`

Example FX Trade Executed webhook request body

{
    "Type":"Fx.Trade.Executed",
    "Version":1,
    "Payload":{
        "SellAccountOwner":"Selling Bank",
        "SellAccountIban":"GB00CUBK22002243218765",
        "BuyAccountOwner":"Buying Bank",
        "BuyAccountIban":"GB00CUBK44556687654321",
        "Attestation":"Y",
        "ValueDate":"2021-04-29T11:36:51.4635892Z",
        "InstructedAmount":1000,
        "FixedSide":"Sell",
        "BuyCurrency":"EUR",
        "SellCurrency":"GBP",
        "Margin":0.001,
        "MarginAccountIban":"GB00CUBK11223312345678",
        "EndToEndId":"bd382f05e8fa4056b25e",
        "UnstructuredInformation":"Client order ID: HGN76934",
        "Symbol":"EUR/GBP",
        "FIReceivedMarginAmount":1.16,
        "BuyAmount":1163.74684512785,
        "SellAmount":1000,
        "ClearBankRate":0.858434121,
        "FIRate":0.859293414,
        "RequestedTime":"2021-04-29T11:36:52.7262458Z",
        "ExecutedTime":"2021-04-29T11:36:52.7262514Z"
    },
    "Nonce":1449825370
}

Example webhook response

{
    "Nonce": 1449825370
}

This webhook confirms that the FX trade has been settled.

Request body

{
    "Type":"Fx.Trade.Settled",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`SellAccountOwner`	Required The name used to identify the legal owner of the account from which to debit funds. Type: `string` Min. Length: `1` Max. Length: `140`
`SellAccountIban`	Required International Bank Account Number associated with the Sell Account. Type: `string` Min. Length: `1` Max. Length: `35`
`BuyAccountOwner`	Required The name used to identify the legal owner of the account in which to credit funds. Type: `string` Min. Length: `1` Max. Length: `140`
`BuyAccountIban`	Required International Bank Account Number associated with the Buy Account. Type: `string` Min. Length: `1` Max. Length: `35`
`Attestation`	Required Confirmation that the Sell Account and Buy Account are owned by the same legal owner. Options that can be specified are Y and N. Must be Y for the FX trade to be created successfully. Type: `string` Min. Length: `1` Max. Length: `1`
`ValueDate`	Required Settlement date for the FX trade. Type: `string` Format: `date-time` Min. Length: `1`
`InstructedAmount`	Required Amount instructed to buy or sell. Type: `number` Format: `decimal`
`FixedSide`	Required The side of the trade to be fixed. This can either be buy or sell. Type: `string` Min. Length: `3` Max. Length: `4`
`BuyCurrency`	Required Three-letter ISO currency code for the currency to buy. Type: `string` Min. Length: `3` Max. Length: `3`
`SellCurrency`	Required Three-letter ISO currency code for the currency to sell. Type: `string` Min. Length: `3` Max. Length: `3`
`Margin`	Optional The optional margin (as a percentage) from the trade to be credited to a margin account. Type: `number` Format: `decimal`
`MarginAccountIban`	Optional International Bank Account Number associated with the account in which the margin amount is to be deposited. Type: `string` Min. Length: `1` Max. Length: `35`
`EndToEndId`	Required Unique identifier provided to ClearBank for the FX trade. Type: `string` Min. Length: `1` Max. Length: `35`
`UnstructuredInformation`	Optional Additional, optional information about the FX trade. Type: `string` Max. Length: `140`
`DebitTransactionId`	Required Unique identifier defined by ClearBank for each debit transaction. Type: `string` Format: `GUID` Min. Length: `1`
`DebitAmount`	Required Amount that has been debited from the sell account. Type: `number` Format: `decimal`
`DebitCurrency`	Required Three-letter ISO currency code for the debit transaction. Type: `string` Min. Length: `3` Max. Length: `3`
`DebitTransactionIdentifiers`	Optional Additional identifiers assigned to the debit transaction. It is an array of objects with a `Scope`, `Name` and `Identifier`. Type: `array` `Scope` Type: `string` `Name` Type: `string` `Identifier` Type: `string`
`DebitAdditionalProperties`	Optional Additional properties assigned to the debit transaction which relate to the FX Trade. It is an array of objects with a `Key` and `Value`. Type: `array` `Key` Type: `string` `Value` Type: `string`
`DebitCreatedAt`	Required Date and time for when the debit transaction was created. Type: `string` Format: `date-time` Min. Length: `1`
`DebitSettledAt`	Required Date and time for when the debit transaction was settled. Type: `string` Format: `date-time` Min. Length: `1`
`CreditTransactionId`	Required Unique identifier defined by ClearBank for each credit transaction. Type: `string` Format: `GUID` Min. Length: `1`
`CreditAmount`	Required Amount that has been credited to the buy account. Type: `number` Format: `decimal`
`CreditCurrency`	Required Three-letter ISO currency code for the credit transaction. Type: `string` Min. Length: `3` Max. Length: `3`
`CreditTransactionIdentifiers`	Optional Additional identifiers assigned to the credit transaction. It is an array of objects with a `Scope`, `Name` and `Identifier`. Type: `array` `Scope` Type: `string` `Name` Type: `string` `Identifier` Type: `string`
`CreditAdditionalProperties`	Optional Additional properties assigned to the credit transaction which relate to the FX Trade. It is an array of objects with a `Key` and `Value`. Type: `array` `Key` Type: `string` `Value` Type: `string`
`CreditCreatedAt`	Required Date and time for when the credit transaction was created. Type: `string` Format: `date-time` Min. Length: `1`
`CreditSettledAt`	Required Date and time for when the credit transaction was settled. Type: `string` Format: `date-time` Min. Length: `1`
`MarginTransactionId`	Optional Unique identifier defined by ClearBank for each margin transaction. Type: `string` Format: `GUID`
`MarginAmount`	Optional The margin amount credited to the margin account. Type: `number` Format: `decimal`
`MarginCurrency`	Optional Three-letter ISO currency code for the margin transaction. Type: `string` Min. Length: `3` Max. Length: `3`
`MarginTransactionIdentifiers`	Optional Additional identifiers assigned to the margin transaction. It is an array of objects with a `Scope`, `Name` and `Identifier`. Type: `array` `Scope` Type: `string` `Name` Type: `string` `Identifier` Type: `string`
`MarginAdditionalProperties`	Optional Additional properties assigned to the margin transaction which relate to the FX Trade. It is an array of objects with a `Key` and `Value`. Type: `array` `Key` Type: `string` `Value` Type: `string`
`MarginCreatedAt`	Optional Date and time for when the margin transaction was created. Type: `string` Format: `date-time`
`MarginSettledAt`	Optional Date and time for when the margin transaction was settled. Type: `string` Format: `date-time`

Example FX Trade Settled webhook request body

{
    "Type":"Fx.Trade.Settled",
    "Version":1,
    "Payload":{
        "SellAccountOwner":"Smith",
        "SellAccountIban":"GB38CLRB04040100003764",
        "BuyAccountOwner":"Smith",
        "BuyAccountIban":"GB14CLRB04040541930570",
        "Attestation":"Y",
        "ValueDate":"2021-06-04T12:24:59.969Z",
        "InstructedAmount":1000,
        "FixedSide":"Sell",
        "BuyCurrency":"EUR",
        "SellCurrency":"GBP",
        "Margin":0.001,
        "MarginAccountIban":"GB38CLRB04040100003764",
        "EndToEndId":"8gIlFlqLBX01TmCO7138DbcEmNWJk0OXjC0",
        "UnstructuredInformation":"Unstructured Information",
        "DebitTransactionId":"28bfd9f5-d4a3-4466-8fa8-600a630a466d",
        "DebitAmount":1000,
        "DebitCurrency":"GBP",
        "DebitTransactionIdentifiers":[
            
        ],
        "DebitAdditionalProperties":[
            
        ],
        "DebitCreatedAt":"2021-06-04T12:25:11.6041133Z",
        "DebitSettledAt":"2021-06-04T12:25:12.8510952Z",
        "CreditTransactionId":"e444fa2e-891a-42b8-82df-815007b2c90e",
        "CreditAmount":1163.74684512785,
        "CreditCurrency":"EUR",
        "CreditTransactionIdentifiers":[
            {
                "Scope":"AutoFXTradeOrders",
                "Name":"TradeRequestID",
                "Identifier":"bafa1d1f-461d-4cee-a092-afc3658b4776"
            },
            {
                "Scope":"JPMExecutionReports",
                "Name":"ExecutionID",
                "Identifier":"bafa1d1f-461d-4cee-a092-afc3658b4776"
            }
        ],
        "CreditAdditionalProperties":[
            {
                "Key":"FixedSide",
                "Value":"Sell"
            }
        ],
        "CreditCreatedAt":"2021-06-04T12:25:15.1297014Z",
        "CreditSettledAt":"2021-06-04T12:25:15.2053396Z",
        "MarginTransactionId":"8fdb8482-894c-4d4a-bd12-a0fe76505c6e",
        "MarginAmount":1.16,
        "MarginCurrency":"EUR",
        "MarginTransactionIdentifiers":[
            
        ],
        "MarginAdditionalProperties":[
            
        ],
        "MarginCreatedAt":"2021-06-04T12:25:16.1273482Z",
        "MarginSettledAt":"2021-06-04T12:25:16.6258492Z"
    },
    "Nonce":369049401
}

Example webhook response

{
    "Nonce": 369049401
}

This webhook confirms that an FX trade has been cancelled. If a same-day trade fails (for example, due to insufficient funds), you are immediately notified of the failure, after which you receive this webhook informing you that ClearBank has cancelled the trade.

Request body

{
    "Type":"Fx.Trade.Cancelled",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`SellAccountOwner`	Required The name used to identify the legal owner of the account from which to debit funds. Type: `string` Min. Length: `1` Max. Length: `140`
`SellAccountIban`	Required International Bank Account Number associated with the Sell Account. Type: `string` Min. Length: `1` Max. Length: `35`
`BuyAccountOwner`	Required The name used to identify the legal owner of the account in which to credit funds. Type: `string` Min. Length: `1` Max. Length: `140`
`BuyAccountIban`	Required International Bank Account Number associated with the Buy Account. Type: `string` Min. Length: `1` Max. Length: `35`
`Attestation`	Required Confirmation that the Sell Account and Buy Account are owned by the same legal owner. Options that can be specified are Y and N. Must be Y for the FX trade to be created successfully. Type: `string` Min. Length: `1` Max. Length: `1`
`ValueDate`	Required Settlement date for the FX trade. Type: `string` Format: `date-time` Min. Length: `1`
`InstructedAmount`	Required Amount instructed to buy or sell. Type: `number` Format: `decimal`
`FixedSide`	Required The side of the trade to be fixed. This can either be buy or sell. Type: `string` Min. Length: `3` Max. Length: `4`
`BuyCurrency`	Required Three-letter ISO currency code for the currency to buy. Type: `string` Min. Length: `3` Max. Length: `3`
`SellCurrency`	Required Three-letter ISO currency code for the currency to sell. Type: `string` Min. Length: `3` Max. Length: `3`
`Margin`	Optional The optional margin (as a percentage) from the trade to be credited to a margin account. Type: `number` Format: `decimal`
`MarginAccountIban`	Optional International Bank Account Number associated with the account in which the margin amount is to be deposited. Type: `string` Min. Length: `1` Max. Length: `35`
`EndToEndId`	Required Unique identifier provided to ClearBank for the FX trade. Type: `string` Min. Length: `1` Max. Length: `35`
`UnstructuredInformation`	Optional Additional, optional information about the FX trade. Type: `string` Max. Length: `140`
`CancellationCode`	Required Cancellation code. Type: `string` Min. Length: `1`
`CancellationReason`	Required Reason FX trade was cancelled. Type: `string` Min. Length: `1`

Example FX Trade Cancelled webhook request body

{
    "Type":"Fx.Trade.Cancelled",
    "Version":1,
    "Payload":{
        "SellAccountOwner":"Selling Bank",
        "SellAccountIban":"GB00CUBK22002243218765",
        "BuyAccountOwner":"Buying Bank",
        "BuyAccountIban":"GB00CUBK44556687654321",
        "Attestation":"Y",
        "ValueDate":"2021-04-29T11:36:51.4635892Z",
        "InstructedAmount":1000.0,
        "FixedSide":"BUY",
        "BuyCurrency":"EUR",
        "SellCurrency":"GBP",
        "Margin":0.5,
        "MarginAccountIban":"GB00CUBK11223312345678",
        "EndToEndId":"bd382f05e8fa4056b25e",
        "UnstructuredInformation":"Client order ID: HGN76934",
        "CancellationCode":"1",
        "CancellationReason":"Account validation failed"
    },
    "Nonce":2051888317
}

Example webhook response

{
    "Nonce": 2051888317
}

This webhook notifies that the settlement of an FX trade has failed. In contrast to the FX Trade Cancelled webhook, this applies to transactions that are not settled on the same day as booked. In practice, the settlement only fails if the payer account is insufficiently provisioned at the moment of settlement.

Request body

{
    "Type":"Fx.Trade.Settlement.Failed",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`SellAccountOwner`	Required The name used to identify the legal owner of the account from which to debit funds. Type: `string` Min. Length: `1` Max. Length: `140`
`SellAccountIban`	Required International Bank Account Number associated with the Sell Account. Type: `string` Min. Length: `1` Max. Length: `35`
`BuyAccountOwner`	Required The name used to identify the legal owner of the account in which to credit funds. Type: `string` Min. Length: `1` Max. Length: `140`
`BuyAccountIban`	Required International Bank Account Number associated with the Buy Account. Type: `string` Min. Length: `1` Max. Length: `35`
`Attestation`	Required Confirmation that the Sell Account and Buy Account are owned by the same legal owner. Options that can be specified are Y and N. Must be Y for the FX trade to be created successfully. Type: `string` Min. Length: `1` Max. Length: `1`
`ValueDate`	Required Settlement date for the FX trade. Type: `string` Format: `date-time` Min. Length: `1`
`InstructedAmount`	Required Amount instructed to buy or sell. Type: `number` Format: `decimal`
`FixedSide`	Required The side of the trade to be fixed. This can either be buy or sell. Type: `string` Min. Length: `3` Max. Length: `4`
`BuyCurrency`	Required Three-letter ISO currency code for the currency to buy. Type: `string` Min. Length: `3` Max. Length: `3`
`SellCurrency`	Required Three-letter ISO currency code for the currency to sell. Type: `string` Min. Length: `3` Max. Length: `3`
`Margin`	Optional The optional margin (as a percentage) from the trade to be credited to a margin account. Type: `number` Format: `decimal`
`MarginAccountIban`	Optional International Bank Account Number associated with the account in which the margin amount is to be deposited. Type: `string` or `null` Min. Length: `1` Max. Length: `35`
`EndToEndId`	Required Unique identifier provided to ClearBank for the FX trade. Type: `string` Min. Length: `1` Max. Length: `35`
`UnstructuredInformation`	Optional Additional, optional information about the FX trade. Type: `string` or `null` Max. Length: `140`
`CancellationCode`	Required Cancellation code. Type: `string` Min. Length: `1`
`CancellationReason`	Required Reason FX order was cancelled. Type: `string` Min. Length: `1`
`WillBeRetried`	Required Whether the settlement will be retried; defaults to `false`. Type: `boolean`
`ReversalFee`	Required Fee incurred due to reversal of executed trade. Type: `number` Format: `decimal`
`ReversalFeeCurrency`	Required Three-letter ISO currency code for the currency of the reversal fee. Type: `string` Min. Length: `3` Max. Length: `3`

Example FX Trade Settlement Failed webhook request body

{
    "Type":"Fx.Trade.Settlement.Failed",
    "Version":1,
    "Payload":{
        "SellAccountOwner":"Selling Bank",
        "SellAccountIban":"GB00CUBK22002243218765",
        "BuyAccountOwner":"Buying Bank",
        "BuyAccountIban":"GB00CUBK44556687654321",
        "Attestation":"Y",
        "ValueDate":"2021-04-29T11:36:51.4635892Z",
        "InstructedAmount":1000.0,
        "FixedSide":"BUY",
        "BuyCurrency":"EUR",
        "SellCurrency":"GBP",
        "Margin":0.5,
        "MarginAccountIban":"GB00CUBK11223312345678",
        "EndToEndId":"bd382f05e8fa4056b25e",
        "UnstructuredInformation":"Client order ID: HGN76934",
        "CancellationCode":"1",
        "CancellationReason":"Insufficient funds",
        "WillBeRetried":"false",
        "ReversalFee":2.50,
        "ReversalFeeCurrency":"GBP"
    },
    "Nonce":2051888318
}

Example webhook response

{
    "Nonce": 2051888318
}

API

GBP Accounts

GBP Payments

Multi-currency/FX

Embedded Banking

FX trade (RFQ)

FX trade (RFQ)

Trade examples

Example: Specifying the sell amount with margin

Example: Specifying the buy amount with margin

FX trade cut-off times

FX trades minimum values

Request a quote

Parameters

Request Payload (application/json)

request

Response (application/json)

OK

Bad Request

Execute a quote

Parameters

Request Payload (application/json)

request

Response (application/json)

Associated Webhooks