Webhooks

In response to some events, we generate and send out a webhook message to your defined URL.

All ClearBank webhooks consist of a DigitalSignature, Type,Version,Payload and Nonce. Payload parameters vary depending on the webhook. Webhook responses contain a 200 HTTP status code which includes a Nonce number in the body and your DigitalSignature.

Anatomy of a webhook

Element	Type	Description
`DigitalSignature`	string	ClearBank®'s Digital Signature
`Type`	string	The type of the event
`Version`	int	The webhook version
`Nonce`	int	Cryptographically secure number generated by ClearBank® for every single webhook. A nonce number is generated randomly and should not be used as a check for duplication
`Payload`	array[object]	Object which contains information related to the webhook

Response

Element	Type	Description
`DigitalSignature`	string	Signed hash of the body of the request. The hash signed by your private key
`Nonce`	int	The value that you receive in the webhook
`200`	int	HTTP response status code

The webhook sent by ClearBank® acts as a verification mechanism. You verify that it is ClearBank® that has sent you the webhook and subsequently, ClearBank® needs to verify that you have successfully received the webhook (based on your response acknowledging receipt). This verification occurs when you return a 200 HTTP response, which includes the Nonce number in the response body and your DigitalSignature. If your response is invalid, we will consider it as a failed webhook. ClearBank® will send the webhook every 15 minutes for 24 hours unless a successful response is returned by you.

To verify the integrity of the webhook received from ClearBank®:

Download a Public Key that is specific to your institution by clicking the Download Public Key button on the Webhook Management page of the Institution portal.
Hash the request body using SHA 256
Convert the DigitalSignature Request Header value from Base64 encoded string into the byte array
Verify the signature using the RSA algorithm

To create the webhook digital signature:

Take the Nonce number from the webhook and place it in the body of the response (e.g. {"nonce": <value>})
Hash the response body using SHA 256
Sign the hash with your Private Key and attach the signed hash as Base64 encoded in the DigitalSignature Response Header

Your Private Key needs to correspond to a Public Key which has been used to create a Certificate Signing Request (CSR). Please refer to creating your authentication profile for more information.

Example HTTP request:

POST http://yourdomain.com/sample/webhook HTTP/1.1
Content-Type: application/json
Content-Length: 72
Digitalsignature: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
X-Request-Id: f0309d95-4f68-4ecd-9c8d-b2d08d9fedd8
{"Type":"FITestEvent","Version":1,"Payload":"test me","Nonce":1448545215}

Example HTTP response:

HTTP/1.1 200 OK
Digitalsignature: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Content-Type: application/json
{
    "Nonce": 1448545215
}

You can create one webhook listener for all events or separate webhook listeners specific to an event. In this example, you will setup an FITestEvent webhook URL, which you can test against the TEST POST endpoint.

To manage your webhook definitions and set your webhook listener URLs for each event:

Log in to the Institution Portal. More information about accessing the portal can be found here.
From the menu, select Institution > Webhook Management.
Search for Test webhook and click the Edit button.
Enter the URL you want to define as your webhook listener for this webhook and set the webhook status to Enabled.
Click Save to successfully setup the webhook listern URL.
To test the webhook, click the Test button.
Enter a test message in the Test webhook window for example, ‘Hello World’ and click Send.

You should receive a FITestEvent webhook to your nominated URL and it should contain the test message in the body.

You must not include any sensitive information (such as API keys) in your webhook URLs.

The range of public IP addresses to support your interaction with ClearBank® webhooks are:

Simulation Public IP address range: 51.145.122.16/28
Production Public IP address range: 51.145.122.32/28

Associated Endpoint
- postCreate an account
Webhook
- Account Created Webhook

This webhook confirms the account has been created

Request body

{
    "Type":"AccountCreated",
    "Version":1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`AccountId`	Account identifier used to uniquely identify the account. Type: `string` Format: `GUID`
`AccountName`	Name of the account. Type: `string` Max. length: `128`
`AccountHolderLabel`	The account description. Type: `string` Max. length: `100`
`AccountIdentifiers`	Account identifier details. Type: `object` `IBAN`: International Bank Account Number associated with the account. Type: `string` Max. length: `34` `BBAN`: Basic Bank Account number associated with the account. Type: `string` Max. length: `30`
`TimestampCreated`	The date and time the account was created. Type: `string` Time Zone: `UTC` Format: `DateTime`
`AccountType`	Type of account. Type: `string` Examples: `CurrentAccount`, `DepositAccount`, `ControlAccount`, `SegregatedClientAccount`, `InstitutionAccount`
`Nonce`	Cryptographically secure number generated by ClearBank® for every single webhook. A nonce number is generated randomly and should not be used as a check for duplication.

Example account created webhook request body

{
    "Type":"AccountCreated",
    "Version":1,
    "Payload":{
        "AccountId":"56de3483-a569-42eb-90cc-acf59661356f",
        "AccountName":"John Doe",
        "AccountHolderLabel":"John Doe",
        "AccountIdentifiers":{
            "IBAN":"GB00CUBK11223312345678",
            "BBAN":"CUBK11223312345678"
        },
        "TimestampCreated":"2018-07-19T13:31:30.8789344Z",
        "AccountType":"CurrentAccount"
    },
    "Nonce":1082937278
}

Example webhook response

{
    "Nonce": 1082937278
}

Associated Endpoint
- postCreate virtual accounts
Webhook
- Virtual Account Created Webhook
- Virtual Account Creation Failed Webhook

This sends a webhook notification confirming the creation of a virtual account

Version 3 has introduced the following new optional field:

ExternalIdentifier

The ExternalIdentifier field in both webhooks will show the externalId that you have specified instead of an account identifier (IBAN, BBAN or sort code and account number) at the time of creating a virtual account.

Request body

The request body consists of a DigitalSignature, Type,Version,Payload and Nonce. Payload parameters vary depending on the webhook. Webhook responses a 200 HTTP status code which includes a Nonce number in the body and your DigitalSignature.

{
    "Type":"VirtualAccountCreated",
    "Version":3,
    "Payload": {...},
    "OwnerName": ,
    "TimestampCreated": ,
    "Nonce":
}

Payload

Element	Description
`AccountId`	Required Unique identifier for the real account associated with the virtual account. Type: `string` Format:`GUID` Min. length: `1`
`VirtualAccountId`	Required Account identifier used to uniquely identify the virtual account. Type: `string` Format: `GUID` Min. length: `1`
`AccountIdentifiers`	Required Virtual account identifier details. Type: `object` `IBAN`: International Bank Account Number associated with the virtual account. Type: `string` pattern: `^([A-Z]{2})([0-9]{2})([A-Za-z]{4})([0-9]{6})([0-9]{8})$` Min. length: `0` Max. length: `140` `BBAN`: Basic Bank Account number associated with the virtual account. Type: `string` Pattern: `^([A-Za-z]{4})([0-9]{6})([0-9]{8})$` Min. length: `0` Max. length: `140`
`ExternalIdentifier`	Optional Unique identifier specified at the time of creating a virtual account. Type: `string` Min. length: `0` Max. length: `50`
`OwnerName`	Optional Name for the owner of the virtual account. Type: `string` Min. length: `0` Max. length: `140`
`TimestampCreated`	Required The date and time the virtual account was created. Type: `string` Time Zone: `UTC` Format: `DateTime` Min. length: `1`
`Nonce`	Cryptographically secure number generated by ClearBank® for every single webhook. A nonce number is generated randomly and should not be used as a check for duplication.

Example virtual account created webhook request body

{
    "Type":"VirtualAccountCreated",
    "Version":3,
    "Payload":{
        "AccountId":"4fbe973b-2f30-45f0-b9e4-a488dd275861",
        "VirtualAccountId":"b3c93a68-5992-4f83-99d5-f13405fd2d90",
        "AccountIdentifier":{
            "Iban":"GB00CUBK22002243218765",
            "Bban":"CUBK22002243218765",
            "ExternalIdentifier":"98765432abcdefg"
        },
        "OwnerName":"Joe Brown",
        "TimestampCreated":"2018-07-19T13:44:56.7366698Z"
    },
    "Nonce":1623028327
}

Example webhook response

{
    "Nonce": 1623028327
}

This webhook confirms a virtual account creation failure

Version 3 has introduced the following new optional field:

ExternalIdentifier

Request body

The request body consists of a DigitalSignature, Type,Version,Payload and Nonce. Payload parameters vary depending on the webhook. Webhook responses a 200 HTTP status code which includes a Nonce number in the body and your DigitalSignature.

{
    "Type":"VirtualAccountCreationFailed",
    "Version":3,
    "Payload": {...},
    "Errors":{...},
    "OwnerName": ,
    "Nonce":
}

Payload

Element	Description
`AccountId`	Required Unique identifier for the real account associated with the virtual account. Type: `string` Format:`GUID` Min. length: `1`
`VirtualAccountId`	Required Account identifier used to uniquely identify the virtual account. Type: `string` Format: `GUID` Min. length: `1`
`AccountIdentifiers`	Required Virtual account identifier details. Type: `object` `IBAN`: International Bank Account Number associated with the virtual account. Type: `string` pattern: `^([A-Z]{2})([0-9]{2})([A-Za-z]{4})([0-9]{6})([0-9]{8})$` Min. length: `0` Max. length: `140` `BBAN`: Basic Bank Account number associated with the virtual account. Type: `string` Pattern: `^([A-Za-z]{4})([0-9]{6})([0-9]{8})$` Min. length: `0` Max. length: `140`
`ExternalIdentifier`	Optional Unique identifier specified at the time of creating a virtual account. Type: `string` Min. length: `0` Max. length: `50`
`Errors`	Required Error(s) which caused the virtual account creation to fail. Type: `Object` One or more errors that occurred during the processing of the request: Additional Properties Type: `string` An error code and error explanation will be provided as a Key value pair These are some examples of error codes: `AccountIban`, `AccountIbanSortCode`, `AccountIbanAccountNumber`, `AccountBban`, `AccountBbanSortCode`, `AccountBbanAccountNumber`, `AccountIdentifiers`, `AccountName`, `AccountHolderLabel`, `AccountIbanBankCode`, `AccountBbanBankCode`, `ClientMoneyAccountIdMissing`, `ExternalVirtualAccountIdNotUnique`, `ExternalVirtualAccountId`, `VirtualAccountIdMissing`, `AccountModulusFailed`, `SortCodeDoesNotBelongToInstitution`, `SortCodeTypeIsIncorrect`
`OwnerName`	Optional Name for the owner of the virtual account. Type: `string` Min. length: `0` Max. length: `140`
`Timestamp`	Required The date and time the virtual account was created. Type: `string` Time Zone: `UTC` Format: `DateTime` Min. length: `1`
`Nonce`	Cryptographically secure number generated by ClearBank® for every single webhook. A nonce number is generated randomly and should not be used as a check for duplication.

Example virtual account creation failed webhook request body

{
    "Type":"VirtualAccountCreationFailed",
    "Version":3,
    "Payload":{
        "AccountId":"e2fb8de0-675d-479a-8b0f-596bc6f52a61",
        "VirtualAccountId":"ba393cc1-8f58-4542-b72f-db62910dce0e",
        "AccountIdentifier":{
            "Iban":"GB00CUBK22002243218765",
            "Bban":"CUBK22002243218765",
            "ExternalIdentifier":"98765432abcdefg"
        },
        "Errors":{
            "AccountIbanSortCode":"Invalid Sort Code"
        },
        "OwnerName":"Joe Brown",
        "Timestamp":"2018-07-19T13:44:56.7406379Z"
    },
    "Nonce":482504208
}

Example webhook response

{
    "Nonce": 482504208
}

Associated Endpoint
- postCreate an account
Webhook
- Multicurrency Account Created Webhook

Associated Endpoint
- patchAmend the properties of an existing account
Webhook
- Multicurrency Account Updated Webhook

Associated Endpoint
- patchUpdate the status of an existing account
Webhook
- Multicurrency Account Updated Webhook

Associated Endpoint
- deleteClose an existing account
Webhook
- Multicurrency Account Updated Webhook

This webhook confirms that the multicurrency account has been created

Request body

{
    "Type":"Accounts.AccountCreated",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`AccountId`	Required Unique identifier for the account held with ClearBank. Type: `string` Format: `GUID`
`Name`	Required Name of the account. Type: `string` Min. Length: `1` Max. Length: `500`
`Label`	Required Friendly label for the account. Type: `string` Min. Length: `1` Max. Length: `100`
`Owner`	Required The name used to identify the legal owner of the account. Type: `string` Min. Length: `1` Max. Length: `140`
`Kind`	Required The type of funds the account will hold. Type: `string` Examples: `YourFunds`, `GeneralSegregated`, `DesignatedSegregated`, `GeneralClient`, `DesignatedClient`
`Currencies`	Required Currencies supported by the account. This is the three-letter ISO currency code. It is an array of strings. Type: `array` Min. Length: `3` Max. Length: `3` Pattern: `^[A-Z]{3}$`
`Status`	Required Current status of the account. Type: `string` Examples: `Active`, `Suspended`, `Closed`
`ProductId`	Optional The product identifier used to determine the behaviour of the account. Only applicable for FSCS accounts. Type: `string` Format: `GUID`
`CustomerId`	Optional Unique identifier for the customer that the account is associated with. Only applicable for FSCS accounts. Type: `string` Format: `GUID`
`Identifiers`	Required List of identifiers. It is an array of objects with an Identifier and Kind. Type: `array` `Identifier` Unique account identifier value that corresponds to the specified account identifier kind. Type: `string` Min. Length: `1` Max. Length: `50` `Kind` The kind of account identifier provided to uniquely identify the account. Type: `string` Min. Length: `1` Max. Length: `50`
`TimestampCreated`	Required Date and time the account was created. Time in UTC. Type: `string` Format: `date-time`
`Type`	Required The type of account. Valid options include: Customer, Operating, MinimumMandatedBalance, Treasury, HeldSuspense, RepairSuspense, Institution. Type: `string`

Example account created webhook request body

{
    "InstitutionId":"faeac33e-e6ea-4712-991d-8c85d0eefda0",
    "Type":"Accounts.AccountCreated",
    "Version":1,
    "Payload":{
        "AccountId":"d55149f7-f052-49cc-865b-7446b4fb05f5",
        "Name":"John Doe",
        "Label":"John Doe",
        "Owner":"Financial Services Limited",
        "Kind":"YourFunds",
        "Currencies":[
            "EUR",
            "GBP"
        ],
        "Status":"Active",
        "ProductId":"f65f7f4b-b724-4692-b375-5a48513d732c",
        "CustomerId":"9e9ac5af-53bc-4b77-a5ac-bd001c866ce3",
        "Identifiers":[
            {
                "Identifier":"GB88BARC20040425385198",
                "Kind":"IBAN"
            }
        ],
        "TimestampCreated":"2021-04-08T12:00:00.0000000",
        "Type":"Customer"
    },
    "Nonce":748392098
}

Example webhook response

{
    "Nonce": 748392098
}

This webhook confirms that the multicurrency account has been updated

Request body

{
    "Type":"Accounts.AccountUpdated",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`AccountId`	Required Unique identifier for the account held with ClearBank. Type: `string` Format: `GUID`
`Name`	Required Name of the account. Type: `string` Min. Length: `1` Max. Length: `500`
`Label`	Required Friendly label for the account. Type: `string` Min. Length: `1` Max. Length: `100`
`Owner`	Required The name used to identify the legal owner of the account. Type: `string` Min. Length: `1` Max. Length: `140`
`Kind`	Required The type of funds the account will hold. Type: `string` Examples: `YourFunds`, `GeneralSegregated`, `DesignatedSegregated`, `GeneralClient`, `DesignatedClient`
`Currencies`	Required Currencies supported by the account. It is an array of strings with each currency represented by a three-letter ISO currency code. Type: `array` Pattern: `^[A-Z]{3}$`
`Status`	Required Current status of the account. Type: `string` Examples: `Active`, `Suspended`, `Closed`
`ProductId`	Optional The product identifier used to determine the behaviour of the account. Only applicable for FSCS accounts. Type: `string` Format: `GUID`
`CustomerId`	Optional Unique identifier for the customer that the account is associated with. Only applicable for FSCS accounts. Type: `string` Format: `GUID`
`Identifiers`	Required List of identifiers. It is an array of objects with an Identifier and Kind. Type: `array` `Identifier` Unique account identifier value that corresponds to the specified account identifier kind. Type: `string` Min. Length: `1` Max. Length: `50` `Kind` The kind of account identifier provided to uniquely identify the account. Type: `string` Min. Length: `1` Max. Length: `50`
`TimestampCreated`	Required Date and time the account was created. Time in UTC. Type: `string` Format: `date-time`
`TimestampModified`	Required Date and time the account was last modified. Time in UTC. Type: `string` Format: `date-time`
`StatusReason`	Optional Reason for changing the current status of the account. Valid options include: AccountHolderBankrupt, DissatisfiedCustomer, FinancialCrime, FraudFirstParty, FraudThirdParty, AccountHolderDeceased, AccountSwitched, CompanyNoLongerTrading, DuplicateAccount, Other. Type: `string`
`StatusInformation`	Optional Additional information to support the specified status reason. Type: `string` Min. Length: `0` Max. Length: `100`
`Type`	Required The type of account. Valid options include: Customer, Operating, MinimumMandatedBalance, Treasury, HeldSuspense, RepairSuspense, Institution. Type: `string`

Example account updated webhook request body

{
    "InstitutionId":"18be20af-77a9-4b10-b34d-759854c4f5df",
    "Type":"Accounts.AccountUpdated",
    "Version":1,
    "Payload":{
        "AccountId":"1afe639b-60d0-4d88-8b81-046dcf0219f7",
        "Name":"Gen Seg Eco Bank",
        "Label":"Mid tier asset funds",
        "Owner":"Eco Bank",
        "Kind":"YourFunds",
        "Currencies":[
            "EUR"
        ],
        "Status":"Suspended",
        "ProductId":"8026e2f2-d127-422d-ae10-ef689282b11d",
        "CustomerId":"ba13205e-0ad3-406c-963b-14561d583bf3",
        "Identifiers":[
            {
                "Identifier":"GB29CLRB40391731926000",
                "Kind":"Iban"
            }
        ],
        "TimestampCreated":"2020-10-22T20:50:17.7107385",
        "TimestampModified":"2021-05-09T07:26:12.2224526",
        "StatusReason":"FraudThirdParty",
        "StatusInformation":"Customer spotted some unrecognised transactions on their account",
        "Type":"Customer"
    },
    "Nonce":732392098
}

Example webhook response

{
    "Nonce": 732392098
}

Associated Endpoint
- postCreate a new virtual account
Webhook
- Multicurrency Virtual Account Created Webhook

Associated Endpoint
- patchAmend the properties of an existing virtual account
Webhook
- Multicurrency Virtual Account Updated Webhook

Associated Endpoint
- patchUpdate the status of an existing virtual account
Webhook
- Multicurrency Virtual Account Updated Webhook

Associated Endpoint
- deleteClose an existing virtual account
Webhook
- Multicurrency Virtual Account Updated Webhook

This webhook confirms that the multicurrency virtual account has been created

Request body

{
    "Type":"Accounts.VirtualAccountCreated",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`VirtualAccountId`	Required Account identifier used to uniquely identify the virtual account. Type: `string` Min. Length: `1` Format: `GUID`
`AccountId`	Required Unique identifier for the real account associated with the virtual account. Type: `string` Min. Length: `1` Format: `GUID`
`BatchId`	Required Unique batch identifier specified while creating a batch of virtual accounts. Type: `string` Min. Length: `1` Format: `GUID`
`Owner`	Required The name used to identify the legal owner of the virtual account. Type: `string` Min. Length: `1` Max. Length: `140`
`Status`	Required The current status of the virtual account. Type: `string` Examples: `Active`, `Suspended`, `Closed`
`Identifiers`	Required List of identifiers. It is an array of objects with an Identifier and Kind. Type: `array` `Identifier` Unique virtual account identifier value that corresponds to the specified virtual account identifier kind. Type: `string` Min. Length: `1` Max. Length: `50` `Kind` The kind of virtual account identifier provided to uniquely identify the virtual account. Type: `string` Min. Length: `1` Max. Length: `50`
`TimestampCreated`	Required Date and time the virtual account was created. Time in UTC. Type: `string` Format: `date-time`

Example virtual account created webhook request body

{
    "Type":"Accounts.VirtualAccountCreated",
    "Version":1,
    "InstitutionId":"4befdd75-5297-44b3-b70f-234d8a525dd2",
    "Payload":{
        "VirtualAccountId":"b3c93a68-5992-4f83-99d5-f13405fd2d90",
        "AccountId":"d55149f7-f052-49cc-865b-7446b4fb05f5",
        "BatchId":"21d70e60-61f0-4bfb-bd22-a460216947b4",
        "Owner":"Joe Brown",
        "Status":"Active",
        "Identifiers":[
            {
                "Identifier":"GB88BARC20040425385198",
                "Kind":"IBAN"
            }
        ],
        "TimestampCreated":"2021-04-08T12:00:00.0000000"
    },
    "Nonce":748364091
}

Example webhook response

{
    "Nonce": 748364091
}

This webhook confirms that the multicurrency virtual account has been updated

Request body

{
    "Type":"Accounts.VirtualAccountUpdated",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`VirtualAccountId`	Required Account identifier used to uniquely identify the virtual account. Type: `string` Min. Length: `1` Format: `GUID`
`AccountId`	Required Unique identifier for the real account associated with the virtual account. Type: `string` Min. Length: `1` Format: `GUID`
`Owner`	Required The name used to identify the legal owner of the virtual account. Type: `string` Min. Length: `1` Max. Length: `140`
`Status`	Required The current status of the virtual account. Type: `string` Examples: `Active`, `Suspended`, `Closed`
`Identifiers`	Required List of identifiers. It is an array of objects with an Identifier and Kind. Type: `array` `Identifier` Unique virtual account identifier value that corresponds to the specified virtual account identifier kind. Type: `string` Min. Length: `1` Max. Length: `50` `Kind` The kind of virtual account identifier provided to uniquely identify the virtual account. Type: `string` Min. Length: `1` Max. Length: `50`
`TimestampCreated`	Required Date and time the virtual account was created. Time in UTC. Type: `string` Format: `date-time`
`TimestampModified`	Required Date and time the virtual account was last modified. Time in UTC. Type: `string` Format: `date-time`
`StatusReason`	Optional Reason for changing the current status of the virtual account. Valid options include: AccountHolderBankrupt, DissatisfiedCustomer, FinancialCrime, FraudFirstParty, FraudThirdParty, AccountHolderDeceased, AccountSwitched, CompanyNoLongerTrading, DuplicateAccount, Other. Type: `string`
`StatusInformation`	Optional Additional information to support the specified status reason. Type: `string` Min. Length: `0` Max. Length: `100`

Example virtual account updated webhook request body

{
    "Type":"Accounts.VirtualAccountUpdated",
    "Version":1,
    "Payload":{
        "VirtualAccountId":"2a77e175-9bf2-4e0b-a8ca-4cee0610cf26",
        "AccountId":"78b208f0-498e-4412-b462-68beadb6e555",
        "Owner":"E2E Financial Services Limited",
        "Status":"Suspended",
        "Identifiers":[
            {
                "Identifier":"GB43CLRB04040545703930",
                "Kind":"Iban"
            }
        ],
        "TimestampCreated":"2021-07-21T09:06:33.0628794Z",
        "TimestampModified":"2021-07-21T10:00:45.3113241Z",
        "StatusReason":null,
        "StatusInformation":null
    },
    "Nonce":177103143
}

Example webhook response

{
    "Nonce": 177103143
}

Associated Endpoint
- postRequest a statement for all accounts associated with your institution
Webhook
- Multicurrency Institution Statement Webhook

Associated Endpoint
- postRequest a statement for a specific account associated with your institution
Webhook
- Multicurrency Account Statement Webhook

This webhook allows you to download a statement for all accounts associated with your institution

Request body

{
    "Type":"MCCY.Statements.InstitutionStatement",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`Uri`	Required URI for downloading a statement for all accounts associated with your institution. Type: `string` Min. Length: `1` Format: `URI`
`ValidUntilDate`	Required Date and time the URI will remain valid until. Time in UTC. Type: `string` Min. Length: `1` Format: `date-time`
`Year`	Required Year for which the statement has been generated in the Four Digit Year format (e.g., 2021). Type: `integer` Format: `int32`
`Month`	Required Month for which the statement has been generated in the 1 - 12 format (e.g., 1 for January and 12 for December). Type: `integer` minimum: `1` maximum: `12` Format: `int32`
`Currency`	Required Three-letter ISO currency code for the currency of the accounts for which the statement has been generated. Type: `string` Min. Length: `3` Max. Length: `3`
`Format`	Required File format in which the statement has been generated. Type: `string` Min. Length: `3` Max. Length: `3`

Example institution statement webhook request body

{
    "Uri":"https://s9rzi0fsit.blob.core.windows.net/qhd30vev6g/Statement_EUR_2021_06_01aa9bf5-d56f-485f-bc37-c0c631977216.csv?skoid=9f02b375-e412-410d-bfdc-b7894320c935&sktid=0b131c91-9cfd-4603-a85a-920276f59a0f&skt=2021-07-09T08%3A11%3A33Z&ske=2021-07-10T08%3A11%3A33Z&sks=b&skv=2020-04-08&sv=2020-04-08&st=2021-07-09T07%3A11%3A33Z&se=2021-07-10T08%3A11%3A33Z&sr=b&sp=r&sig=spjcgi9e1o",
    "ValidUntilDate":"2021-07-10T00:00:00Z",
    "Year":2021,
    "Month":6,
    "Currency":"EUR",
    "Format":"csv"
},
    "Nonce":795391298
}

Example webhook response

{
    "Nonce": 795391298
}

This webhook allows you to download a statement for a specific account associated with your institution

Request body

{
    "Type":"MCCY.Statements.AccountStatement",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`Uri`	Required URI for downloading a statement for a specific account associated with your institution. Type: `string` Min. Length: `1` Format: `URI`
`ValidUntilDate`	Required Date and time the URI will remain valid until. Time in UTC. Type: `string` Min. Length: `1` Format: `date-time`
`Year`	Required Year for which the statement has been generated in the Four Digit Year format (e.g., 2021). Type: `integer` Format: `int32`
`Month`	Required Month for which the statement has been generated in the 1 - 12 format (e.g., 1 for January and 12 for December). Type: `integer` minimum: `1` maximum: `12` Format: `int32`
`Currency`	Required Three-letter ISO currency code for the currency of the account for which the statement has been generated. Type: `string` Min. Length: `3` Max. Length: `3`
`Format`	Required File format in which the statement has been generated. Type: `string` Min. Length: `3` Max. Length: `3`
`AccountIban`	Required International Bank Account Number for the account for which the statement has been generated. Type: `string` Min. Length: `1` Max. Length: `50`

Example account statement webhook request body

{
    "Uri":"https://s4u4h7sizl.blob.core.windows.net/dyx5atvaaz/Statement_EUR_2021_6_GB88BARC20035395232336_16a67e34-dc12-4fe4-a8e0-4c439a8cbd5e.csv?skoid=9330a684-1fc0-4b94-a2de-8c964bb798ef&sktid=f630ca29-77a1-43ec-9b3a-4e413c4fc4dfe&skt=2021-07-09T06%3A40%3A54Z&ske=2021-07-10T06%3A40%3A54Z&sks=b&skv=2020-04-08&sv=2020-04-08&st=2021-07-09T05%3A40%3A54Z&se=2021-07-10T06%3A40%3A53Z&sr=b&sp=r&sig=m0kdbayo1e",
    "ValidUntilDate":"2021-07-10T00:00:00Z",
    "Year":2021,
    "Month":6,
    "Currency":"EUR",
    "Format":"csv",
    "AccountIban":"GB88BARC20035395232336"
},
    "Nonce":748391298
}

Example webhook response

{
    "Nonce": 748391298
}

Associated Endpoint
- postInitiate a payment
Webhook

This sends a webhook notification confirming the transaction has settled

Request body

{
    "Type":"TransactionSettled",
    "Version":6,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`TransactionId`	Unique Identification of the Transaction. Type: `GUID` Max. Length: `36` Special Character: Hyphen `-` Example format of a typical TransactionId:`CE25B426-9430-4A82-8EB8-9311DA2D3E12`
`Status`	Transaction status. Type: `string` `Settled`
`Scheme`	Optional The Scheme type. `Transfer` `FasterPayments` `Bacs` `Chaps`
`EndToEndTransactionId`	Unique Identifier supplied by you in your API request. For inbound transactions, this identifier may not be unique. Type: `string` Max. length:`35`
`Amount`	Transaction amount. Type: `int`
`TimestampSettled`	Date and time the transaction settled. Time Zone: `UTC` Type: `DateTime`
`TimestampCreated`	Date and time the transaction was created. Time Zone: `UTC` Type: `DateTime`
`CurrencyCode`	Optional Code of transaction currency. `GBP`
`DebitCreditCode`	Movement of transaction. Type: `string` Options:`Credit`, `Debit`
`Reference`	(optional) Payment transaction reference. Max. length: `140`
`IsReturn`	Is the Transaction returned from Scheme? `True` `False`
`Account`	Account information object Type: `object` It contains the `IBAN`, `BBAN`, `OwnerName`, `TransactionOwner` and `InstitutionName`. `IBAN`: International Bank Account Number associated with the account. Type: `string` Max. length: `34` `BBAN`: Basic Bank Account number associated with the account. Type: `string` Max. length: `30` Depending on Scheme Type `OwnerName`: name of the beneficiary account holder registered with ClearBank®. Type: `string` Max. length: `128` - Faster Payments = Sender’s Account Name - Chaps = Ordering Customer’s Name `TransactionOwnerName` Type: `string` Max. length: `128` - Beneficiary Account Holder, as specified by the remitter in the payment message. - For outbound payments, as specified by ClearBank® as the remitter name in the payment message. `InstitutionName`: The institution name. Max. length: `128` - Chaps = Ordering Institution
`CounterpartAccount`	The account which is not held at ClearBank. It contains the `IBAN`, `BBAN`, `OwnerName`, `TransactionOwner` and `InstitutionName`. `IBAN`(Optional): International Bank Account Number associated with the account. Type: `string` Max. length: `34` `BBAN`(Optional): Basic Bank Account number associated with the account. Type: `string` Max. length: `30` Depending on Scheme Type `OwnerName`: name of the beneficiary account. Type: `string` Max. length: `128` - Populated with either the same name as `TransactionOwnerName`, or with `“Not Provided”` depending on what is provided in the payment message. - Faster Payments = Beneficiary's Account Name `TransactionOwnerName` Type: `string` Max. length: `128` Populated by Scheme with the name provided in the payment message. - For outbound payments, this is populated as the Beneficiary Name which is provided by you. `InstitutionName`: The institution name. Max. length: `128` - Chaps = Beneficiary Institution
`ActualEndToEndTransactionId`	Unique payment Identifier depending on Scheme Type. Maximum Field Length: `255` Faster Payments = `FPID` Chaps = `Field 20` FPID is the unique payment identifier generated by Faster Payments. Field 20 is the unique payment identifier generated by the remitting bank.
`DirectDebitMandateId`	(Optional) Unique Identification of a Direct Debit Instruction. Type: `GUID` Max. length: `36`
`TransactionCode`	(Optional) Direct Debit Transaction Code: `"01"` - First collection `"17"` - Regular collection `"18"` - Re-presented collection `"19"` - Final collection (Optional) Direct Credit Transaction Code: `"99"` - Standard Bank Giro Credit `"86"` - Bank to bank settlement `"Z4"` - Interest payment `"Z5"` - Dividend payment
`ServiceUserNumber`	(Optional) Service User's Unique Identifier registered with Bacs. Max. length: `6`
`BacsTransactionId`	(Optional) Type: `GUID` Max. length: `36`
`BacsTransactionDescription`	(Optional) `CreditTransactionSettled` `DebitContraTransactionSettled` `DebitTransactionSettled` `CreditContraTransactionSettled` `DirectDebitReceivedIndemnityClaimSettled`
`TransactionType`	(Optional) `DirectCredit` `DirectDebit` `DirectDebitIndemnityClaim`
`TransactionSource`	(Optional) /Origination of the Transaction : Max. length: `50` Example: `CardProcessor`
`SupplementaryData`	(Optional) Transaction supplementary data It is an array with the a `Name` and `Value`. `Name`: Field Number/Name for an inbound CHAPS or FPS message. Max. length: `33` `Name` options: `20`, `13C`, `23B`, `23E`, `26T`, `32A`, `33B`, `36`, `50a`, `51A`, `52a`, `53a`, `54a`, `55a`, `56a`, `57a`, `59a`, `70`, `71A`, `71F`, `71G`, `72`, `77B`, `SendingFpsInstitution`, `Currency`, `DateSent`, `PaymentType`, `TransactionReferenceNumber`, `Amount`, `OriginatingCreditInstitution`, `OriginatingCustomerAccountNumber`, `OriginatingCustomerAccountName`, `OriginatingCustomerAccountAddress`, `EndToEndReference`, `BeneficiaryCreditInstitution`, `BeneficiaryCustomerAccountNumber`, `BeneficiaryCustomerAccountName`, `BeneficiaryCustomerAccountAddress`, `ReturnedPaymentFpId`, `PaymentReturnCode`, `PaymentSubTypeCode`, `PurposeTransactionType`, `TypeOfAccountCode`, `NumericReference`, `ReferenceInformation`, `RemittanceInformation`, `RegulatoryReporting`, `OriginalCurrency`, `OriginalAmount`, `ExchangeRate`, `ChargingInformation`, `SubmittingMember`, `ReceivingMember`, `SettlementCycleId`, `FileId`, `ProcessedAsynchronously`, `AgencyAccountWithMember`, `AgencySortCodeWithMember` `Value` Max. length: `500` There could be more than one Name and Value pair.
`Nonce`	Cryptographically secure number generated by ClearBank® for every single webhook. A nonce number is generated randomly and should not be used as a check for duplication.

Example transaction settled webhook request body

{
    "Type":"TransactionSettled",
    "Version":6,
    "Payload":{
        "TransactionId":"d9162680-7d35-7994-4e38-fa80716899a2",
        "Status":"Settled",
        "Scheme":"Transfer",
        "EndToEndTransactionId":"05726acd06dc",
        "Amount":88.52,
        "TimestampSettled":"2019-01-01T10:02:00.964Z",
        "TimestampCreated":"2019-01-01T11:12:05.101Z",
        "CurrencyCode":"GBP",
        "DebitCreditCode":"Credit",
        "Reference":"51dcf7ba480e61c5a60bbb6c6b774d17",
        "IsReturn":false,
        "Account":{
            "IBAN":"GB00CUBK11223312345678",
            "BBAN":"CUBK11223312345678",
            "OwnerName":"John Doe",
            "TransactionOwnerName":"John Doe",
            "InstitutionName":"CustomerBank"
        },
        "CounterpartAccount":{
            "IBAN":"GB00CUBK44556687654321",
            "BBAN":"CUBK44556687654321",
            "OwnerName":"Jane Doe",
            "TransactionOwnerName":"Jane Doe",
            "InstitutionName":"CustomerBank"
        },
        "ActualEndToEndTransactionId":"e6e7ab2a97d1",
        "DirectDebitMandateId":"cbf17eb8-9e49-2043-2eca-0dae05e27fe5",
        "TransactionCode":"99",
        "ServiceUserNumber":"030201",
        "BacsTransactionId":"3ec6f5b0-0e6b-a30b-7dc4-cdcc0751d448",
        "BacsTransactionDescription":"CreditContraTransactionSettled",
        "TransactionType":"DirectCredit",
        "TransactionSource":"CardProcessor",
        "SupplementaryData":[
            {
                "Name":"20",
                "Value":"AJF9384DGSB48Sd"
            },
            {
                "Name":"23B",
                "Value":"CRED"
            }
        ]
    },
    "Nonce":949893874
}

Example webhook response

{
    "Nonce": 828803944
}

This webhook confirms the payment assessment has failed.

Scenarios which can trigger this event include (but not limited to); sending a payment which exceeds the scheme limit, sending the payment to a disabled account, sending the payment with a duplicate Payment Id, invalid BIC, CHAPS payment approved outside of the payment window and insufficient balance to cover multiple payments.

Request body

{
    "Type":"PaymentMessageAssessmentFailed",
    "Version":1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`MessageId`	Unique ID to identify the message. Type: `string` Format: `GUID` Max. length: `36`
`PaymentMethodType`	Optional The Scheme type. `Transfer` `FasterPayments` `Bacs`, `Chaps`
`AssessmentFailure`	The object describes the failure reason. Type: `object` It contains the `EndToEndId` and `Reasons` elements. `EndToEndId` : Unique Identifier supplied by you in your API request. Type: `string` Max. length: `35` `Reasons`: Reasons why ClearBank® will not accept the payment message. Type: `string` Max. length: `100` Example reasons include `Insufficient Funds` and `Account closed`
`AccountIdentification`	The object contains the account identification. Type: `object` It contains the `Debtor` and `Creditors` elements.
`Debtor`	Required Debtor information object. Type: `object` Contains `IBAN` and `BBAN` elements. `IBAN`: International Bank Account Number associated with the account. Type: `string` Max. length: `34` `BBAN`: Basic Bank Account number associated with the account. Type: `string` Max. length: `30`
`Creditors`	Creditors information object. Type: `object` Contains `Reference`, `Amount`, `CurrencyCode` (optional), `IBAN` and `BBAN` elements. `Reference` Type:`string` Max. length: `35` `Amount`: Transaction amount Type:`int` `CurrencyCode` (optional): Code of transaction currency, `GBP` Required `IBAN`: International Bank Account Number associated with the account. Type: `string` Max. length: `34` Required `BBAN`: Basic Bank Account number associated with the account. Type: `string` Max. length: `30`
`Nonce`	Cryptographically secure number generated by ClearBank® for every single webhook. A nonce number is generated randomly and should not be used as a check for duplication.

Example payment message assessment failed webhook request body

{
    "Type":"PaymentMessageAssessmentFailed",
    "Version":1,
    "Payload":{
        "MessageId":"624e0276-1b27-4a80-a06d-51759711bc0e",
        "PaymentMethodType":"Transfer",
        "AssesmentFailure":[
            {
                "EndToEndId":"51236da640c9",
                "Reasons":[
                    "Insufficient Funds"
                ]
            },
            {
                "EndToEndId":"fa2b005bf7a4",
                "Reasons":[
                    "Account closed"
                ]
            }
        ],
        "AccountIdentification":{
            "Debtor":{
                "IBAN":"GB00CUBK22002243218765",
                "BBAN":"CUBK22002243218765"
            },
            "Creditors":[
                {
                    "Reference":"b4e062e244c449f8afc7e2a941562768",
                    "Amount":17.95,
                    "CurrencyCode":"GBP",
                    "IBAN":"GB00CUBK44556687654321",
                    "BBAN":"CUBK44556687654321"
                },
                {
                    "Reference":"0bae808d96bb42a6a892bc9ade169993",
                    "Amount":17.95,
                    "CurrencyCode":"GBP",
                    "IBAN":"GB00CUBK11223312345678",
                    "BBAN":"CUBK11223312345678"
                }
            ]
        }
    },
    "Nonce":1082937278
}

Example webhook response

{
    "Nonce": 828803944
}

This webhook confirms the payment validation has failed.

Scenarios which can trigger this event include (but not limited to); sending a payment with an invalid character in the payment reference and sending a payment with an invalid character in the creditor information.

Request body

{
    "Type":"PaymentMessageValidationFailed",
    "Version":1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`MessageId`	Unique ID to identify the message. Type: `string` Format: `GUID` Max. length: `36`
`PaymentMethodType`	Required The Scheme type. `Transfer` `FasterPayments` `Bacs`, `Chaps`
`EndToEndId`	Unique Identifier supplied by you in your API request. Type: `string` Max. length:`35`
`Reasons`	Examples of possible reasons for failure: - Creditor name must only contain valid Faster Payments characters - Creditor name contains invalid characters - Creditor reference must only contain valid Faster Payments characters - Creditor reference contains invalid characters Type: `string` Max. length: `100`
`AccountIdentification`	Debtor information object Type: `object` It contains the `IBAN`, `BBAN`, `CUID` (optional), `UPIC` (optional), `AccountName` (optional), `AccountHolderLabel` (optional) and `InstitutionName` (optional). `IBAN`: International Bank Account Number associated with the account. Type: `string` Max. length: `34` `BBAN`: Basic Bank Account number associated with the account. Type: `string` Max. length: `30` `CUID` (optional): The CHIPS UID is assigned by the New York Clearing House `UPIC` (optional): Identifier used by the New York Clearing House `AccountName` (optional): Name of the account. Type: `string` Max. length: `128` `AccountHolderLabel` (optional):The account description. Type: `string` Max. length: `100` `InstitutionName` (optional): The institution name Type: `string` Max. length: `128`
`Creditors`	Creditor(s) information object Type: `object` It contains `Reference`,`Amount`,`CurrencyCode`,`IBAN`, `BBAN`,`CUID` (optional), `UPIC` (optional), `AccountName` (optional), `AccountHolderLabel` (optional) and `InstitutionName` (optional). `Reference`: Payment reference specified by the debtor. Type: `string` Max. length: `35` `Amount`: Transaction amount Type:`int` `CurrencyCode`: Code of transaction currency `IBAN`: International Bank Account Number associated with the account. Type: `string` Max. length: `34` `BBAN`: Basic Bank Account number associated with the account. Type: `string` Max. length: `30` `CUID` (optional): The CHIPS UID is assigned by the New York Clearing House `UPIC` (optional): Identifier used by the New York Clearing House `AccountName` (optional): Name of the account. Type: `string` Max. length: `128` `AccountHolderLabel` (optional):The account description. Type: `string` Max. length: `100` `InstitutionName` (optional): The institution name Type: `string` Max. length: `128`
`Nonce`	Cryptographically secure number generated by ClearBank® for every single webhook. A nonce number is generated randomly and should not be used as a check for duplication.

Example payment message validation failed webhook request body

{
    "Type":"PaymentMessageValidationFailed",
    "Version":1,
    "Payload":{
        "MessageId":"164ac6a0-8e15-4592-b99e-c0a7399f1295",
        "PaymentMethodType":"Transfer",
        "ValidationFailure":[
            {
                "EndToEndId":"72db39cd1693",
                "Reasons":[
                    "Creditor name contains invalid characters"
                ]
            }
        ],
        "AccountIdentification":{
            "Debtor":{
                "IBAN":"GB00CUBK22002243218765",
                "BBAN":"CUBK22002243218765",
                "CUID":null,
                "UPIC":null,
                "AccountName":"Jane Doe",
                "AccountHolderLabel":"Jane Doe",
                "InstitutionName":"CustomerBank"
            },
            "Creditors":[
                {
                    "Reference":"86671a4add96f7a9cc569a6a4a601b38",
                    "Amount":17.95,
                    "CurrencyCode":"GBP",
                    "IBAN":"GB00CUBK44556687654321",
                    "BBAN":"CUBK44556687654321",
                    "CUID":null,
                    "UPIC":null,
                    "AccountName":"Bob Robson",
                    "AccountHolderLabel":"Bob Robson",
                    "InstitutionName":"MyBank"
                }
            ]
        }
    },
    "Nonce":1634549462
}

Example webhook response

{
    "Nonce": 1634549462
}

This webhook confirms the payment has been rejected

Request body

{
    "Type":"TransactionRejected",
    "Version":2,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`TransactionId`	Unique Identification of the Transaction. Type: `GUID` Max. Length: `36` Special Character: Hyphen `-` Example format of a typical TransactionId:`073dca79-13b8-8bf2-b63b-148957caffe9`
`Status`	Transaction status. Type: `string` `Rejected`
`Scheme`	Optional The Scheme type. `Transfer` `FasterPayments` `Bacs`, `Chaps`
`EndToEndTransactionId`	Unique Identifier supplied by you in your API request. For inbound transactions, this identifier may not be unique. Type: `string` Max. length:`35`
`Amount`	Transaction amount. Type: `int`
`TimestampModified`	Date and Time the transaction was rejected. Time Zone: `UTC` Type: `DateTime`
`CurrencyCode`	(optional) Code of transaction currency. :`GBP`
`DebitCreditCode`	Movement of transaction. Type: `string` Options:`Credit`, `Debit`
`Reference`	Payment transaction reference Max. length: `35`
`IsReturn`	Is the transaction returned from scheme? `True` `False`
`CancellationReason`	(Optional) Textual representation of CancellationCode giving reason for rejection
`CancellationCode`	(Optional) Code of Cancellation – a combination of SWIFT and ClearBank® codes. `AC03`, `AC04`, `AC06`, `AC07`,`AC09`, `AC12`, `AG01`, `AG02`, `AG03`, `AM09`, `BE08` , `BE09`, `CB_AccountHoldersBankrupt`, `CB_AccountNameInvalid`, `CB_AccountSwitched`, `CB_AuthenticationFailure`,`CB_CancelledByBoEController`, `CB_CancelledByChapsMember`,`CB_CancelledCreditAccountDisabled`, `CB_CancelledDebitAccountDisabled`, `CB_CancelledQueuedCloseOfBusiness`, `CB_DupSttlmntOriginalIsQueued`, `CB_DupSttlmntOriginalWasRejected`, `CB_FailedModulusCheck`, `CB_InitiatingPartyActionRequired`, `CB_InitiatingPartyRequested`, `CB_InstructionCancelled`, `CB_InstructionCancelledByCustomer`, `CB_InstructionHasExpired`, `CB_InvalidProcessorState`, `CB_NewAccountUpdatedWithDDI`, `CB_SenderNotInTertiaryMode`, `COSE`, `CURR`, `CUTO`, `DDAT`, `DMON`, `DU05`, `ICAG`, `IVAG`, `MD01`, `MD07`, `OTHR`, `PY01`, `REFE`, `Other`, `Manual`, `BLBYTH`, `HOPRJ`, `MS03`, `MS02`, `AC05`, `MS01`, `CB_PaymentReferenceMissing`, `CB_PaymentReferenceIncorrect`, `CB_PaymentBeneficiaryNameMissing`, `CB_AccountNameAndNumberMismatch`
`Account`	Account information object Type: `object` It contains the `IBAN` and`BBAN`. `IBAN`: International Bank Account Number associated with the account. Type: `string` Max. length: `34` `BBAN`: Basic Bank Account number associated with the account. Type: `string` Max. length: `30`
`CounterpartAccount`	The account which is not held at ClearBank. Type: `object` It contains the `IBAN` and `BBAN`. `IBAN`: International Bank Account Number associated with the account. Type: `string` Max. length: `34` `BBAN`: Basic Bank Account number associated with the account. Type: `string` Max. length: `30`
`Nonce`	Cryptographically secure number generated by ClearBank® for every single webhook. A nonce number is generated randomly and should not be used as a check for duplication.

Example transaction rejected webhook request body

{
    "Type":"TransactionRejected",
    "Version":2,
    "Payload":{
        "TransactionId":"073dca79-13b8-8bf2-b63b-148957caffe9",
        "Status":"Rejected",
        "Scheme":"Transfer",
        "EndToEndTransactionId":"ccec481ee502",
        "Amount":97.45,
        "TimestampModified":"2018-08-01T23:01:04.635Z",
        "CurrencyCode":"GBP",
        "DebitCreditCode":"Credit",
        "Reference":"06a87c63c88c84b99294d910e283cae6",
        "IsReturn":false,
        "CancellationReason":"Beneficiary account name does not match beneficiary account number",
        "CancellationCode":"CB_AccountNameInvalid",
        "Account":{
            "IBAN":"GB00CUBK11223312345678",
            "BBAN":"CUBK11223312345678"
        },
        "CounterpartAccount":{
            "IBAN":"GB00CUBK44556687654321",
            "BBAN":"CUBK44556687654321"
        }
    },
    "Nonce":748392098
}

Example webhook response

{
    "Nonce": 748392098
}

You may occasionally receive multiple webhooks with the same EndtoEndTransactionId. In this instance, a duplicate check should take place using the TransactionId. If the same TransactionId is used for both payments, the webhook will be a duplicate. In case the TransactionId(s) are different, these will relate to separate transactions.

A full list of webhook documentation is available on ClearBank®'s Knowledge Centre and access can be granted as part of your onboarding journey. Please reach out to your main contact ClearBank® for more information.

Associated Endpoint
- postInitiate a payment
Webhook

This webhook confirms that a multicurrency transaction has been created

Request body

{
    "Type":"MccyPayloadTransactionCreated",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`TransactionId`	Required Unique internal identifier defined by ClearBank for each payment. Type: `string` Min. Length: `1` Format: `GUID`
`BatchId`	Required Unique identifier for the batch in which the payment was submitted. Type: `string` Min. Length: `1` Format: `GUID`
`EndToEndId`	Required Unique identifier provided to ClearBank for each payment. Type: `string` Min. Length: `1` Max. Length: `35`
`SchemeEndToEndId`	Optional Unique identifier created by ClearBank for each payment and passed through the scheme to the creditor. Type: `string` Min. Length: `0` Max. Length: `15`
`AccountId`	Required Unique identifier for the account held with ClearBank. Type: `string` Min. Length: `1` Format: `GUID`
`Reference`	Required Reference provided by the ultimate debtor for the payment. Type: `string` Min. Length: `1` Max. Length: `140`
`UltimateCreditorName`	Required Name of the ultimate creditor. Type: `string` Min. Length: `1` Max. Length: `140`
`UltimateCreditorAccountIdentifiers`	Required List of account identifiers used to uniquely identify the ultimate creditor. It is an array of objects with `Kind` and an `Identifier`. Type: `array` `Kind` The kind of account identifier which is provided. This can be either IBAN, BBAN, AccountId or Descriptor (another kind of identifier). Type: `string` Min. Length: `1` Max. Length: `10` `Identifier` Unique account identifier value that corresponds to the specified account identifier kind. Type: `string` Min. Length: `1` Max. Length: `36`
`UltimateDebtorName`	Required Name of the ultimate debtor. Type: `string` Min. Length: `1` Max. Length: `140`
`UltimateDebtorAccountIdentifiers`	Required List of account identifiers used to uniquely identify the ultimate debtor. It is an array of objects with `Kind` and an `Identifier`. Type: `array` `Kind` The kind of account identifier which is provided. This can be either IBAN, BBAN, AccountId or Descriptor (another kind of identifier). Type: `string` Min. Length: `1` Max. Length: `10` `Identifier` Unique account identifier value that corresponds to the specified account identifier kind. Type: `string` Min. Length: `1` Max. Length: `36`
`InstructedAmount`	Required Instructed payment amount. Type: `number` Format: `decimal`
`InstructedCurrency`	Required Currency of the instructed payment. This is the 3-letter ISO currency code. Type: `string` Min. Length: `3` Max. Length: `3` Pattern: `^[A-z]{3}$`
`SchemePaymentMethod`	Required Payment scheme used for submitting the transaction. Type: `string` Min. Length: `1` Max. Length: `50`
`TimestampCreated`	Required Date and time transaction was created. Time in UTC. Type: `string` Min. Length: `1` Format: `date-time`
`Identifiers`	Required List of identifiers. It is an array of objects with a `Scope`, `Name` and `Identifier`. Type: `array` `Scope` Type: `string` Min. Length: `1` Max. Lenght: `50` `Name` Type: `string` Min. Length: `1` Max. Lenght: `50` `Identifier` Type: `string` Min. Length: `1` Max. Lenght: `250`
`AdditionalProperties`	Required List of additional information. It is an array of objects with a `Key` and `Value`. Type: `array` `Key` Type: `string` Min. Length: `1` Max. Lenght: `50` `Value` Type: `string` Min. Length: `1` Max. Lenght: `250`

Example transaction created webhook request body

{
    "TransactionId":"fd7f3082-72d4-46b3-8e0e-1f66e4a91e13",
    "BatchId":"ab55f54a-26c3-4333-93cd-f917bb51ecad",
    "EndToEndId":"08c2c49c9e094df59f342a27cb64395c",
    "SchemeEndToEndId":"4026da87bb0f4a5",
    "AccountId":"50daac8a-72c3-4ae5-a6e3-e71b6187dbef",
    "Reference":"My payment reference 12345",
    "UltimateCreditorName":"John Baker",
    "UltimateCreditorAccountIdentifiers":[
        {
            "Kind":"AccountId",
            "Identifier":"fd75710b-4c0a-406d-a962-ef5c98836d3f"
        }
    ],
    "UltimateDebtorName":"Clark Kent",
    "UltimateDebtorAccountIdentifiers":[
        {
            "Kind":"IBAN",
            "Identifier":"GB33BUKB20201555555555"
        }
    ],
    "InstructedAmount":100.55,
    "InstructedCurrency":"EUR",
    "SchemePaymentMethod":"Partner 1",
    "TimestampCreated":"2021-05-22T00:00:00",
    "Identifiers":[
        {
            "Scope":"MCCYOutboundPayments",
            "Name":"SchemeEndToEndId",
            "Identifier":"4026da87bb0f4a5"
        }
    ],
    "AdditionalProperties":[
        {
            "Key":"DebtorName",
            "Value":"Acme Studios"
        },
        {
            "Key":"DebtorCountry",
            "Value":"GB"
        }
    ]
},
    "Nonce":748352091
}

Example webhook response

{
    "Nonce": 748352091
}

This webhook confirms that a multicurrency transaction has been settled

Request body

{
    "Type":"MccyPayloadTransactionSettled",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`TransactionId`	Required Unique internal identifier defined by ClearBank for each payment. Type: `string` Min. Length: `1` Format: `GUID`
`BatchId`	Required Unique identifier for the batch in which the payment was submitted. Type: `string` Min. Length: `1` Format: `GUID`
`EndToEndId`	Required Unique identifier provided to ClearBank for each payment. Type: `string` Min. Length: `1` Max. Length: `35`
`SchemeEndToEndId`	Optional Unique identifier created by ClearBank for each payment and passed through the scheme to the creditor. Type: `string` Min. Length: `0` Max. Length: `15`
`AccountId`	Required Unique identifier for the account held with ClearBank. Type: `string` Min. Length: `1` Format: `GUID`
`Reference`	Required Reference provided by the ultimate debtor for the payment. Type: `string` Min. Length: `1` Max. Length: `140`
`UltimateCreditorName`	Required Name of the ultimate creditor. Type: `string` Min. Length: `1` Max. Length: `140`
`UltimateCreditorAccountIdentifiers`	Required List of account identifiers used to uniquely identify the ultimate creditor. It is an array of objects with `Kind` and an `Identifier`. Type: `array` `Kind` The kind of account identifier which is provided. This can be either IBAN, BBAN, AccountId or Descriptor (another kind of identifier). Type: `string` Min. Length: `1` Max. Length: `10` `Identifier` Unique account identifier value that corresponds to the specified account identifier kind. Type: `string` Min. Length: `1` Max. Length: `36`
`UltimateDebtorName`	Required Name of the ultimate debtor. Type: `string` Min. Length: `1` Max. Length: `140`
`UltimateDebtorAccountIdentifiers`	Required List of account identifiers used to uniquely identify the ultimate debtor. It is an array of objects with `Kind` and an `Identifier`. Type: `array` `Kind` The kind of account identifier which is provided. This can be either IBAN, BBAN, AccountId or Descriptor (another kind of identifier). Type: `string` Min. Length: `1` Max. Length: `10` `Identifier` Unique account identifier value that corresponds to the specified account identifier kind. Type: `string` Min. Length: `1` Max. Length: `36`
`InstructedAmount`	Required Instructed payment amount. Type: `number` Format: `decimal`
`InstructedCurrency`	Required Currency of the instructed payment. This is the 3-letter ISO currency code. Type: `string` Min. Length: `3` Max. Length: `3` Pattern: `^[A-z]{3}$`
`SchemePaymentMethod`	Required Payment scheme used for submitting the transaction. Type: `string` Min. Length: `1` Max. Length: `50`
`TimestampCreated`	Required Date and time transaction was created. Time in UTC. Type: `string` Min. Length: `1` Format: `date-time`
`Identifiers`	Required List of identifiers. It is an array of objects with a `Scope`, `Name` and `Identifier`. Type: `array` `Scope` Type: `string` Min. Length: `1` Max. Lenght: `50` `Name` Type: `string` Min. Length: `1` Max. Lenght: `50` `Identifier` Type: `string` Min. Length: `1` Max. Lenght: `250`
`AdditionalProperties`	Required List of additional information. It is an array of objects with a `Key` and `Value`. Type: `array` `Key` Type: `string` Min. Length: `1` Max. Lenght: `50` `Value` Type: `string` Min. Length: `1` Max. Lenght: `250`
`TimestampSettled`	Required Date and time the transaction settled. Type: `string` Min. Length: `1` Format: `date-time`
`TimestampSubmitted`	Required Date and time transaction was submitted. This should be the same as the date and time of TimestampSettled but will reflect a different time if the transaction settlement is delayed. This time will represent the time the transaction should have settled had it not been delayed. Type: `string` Min. Length: `1` Format: `date-time`

Example transaction settled webhook request body

{
    "TransactionId": "fd7f3082-72d4-46b3-8e0e-1f66e4a91e13",
    "BatchId": "ab55f54a-26c3-4333-93cd-f917bb51ecad",
    "EndToEndId": "08c2c49c9e094df59f342a27cb64395c",
    "SchemeEndToEndId": "4026da87bb0f4a5",
    "AccountId": "50daac8a-72c3-4ae5-a6e3-e71b6187dbef",
    "Reference": "My payment reference 12345",
    "UltimateCreditorName": "John Baker",
    "UltimateCreditorAccountIdentifiers": [
        {
            "Kind": "AccountId",
            "Identifier": "fd75710b-4c0a-406d-a962-ef5c98836d3f"
        }
    ],
    "UltimateDebtorName": "Clark Kent",
    "UltimateDebtorAccountIdentifiers": [
        {
            "Kind": "IBAN",
            "Identifier": "GB33BUKB20201555555555"
        }
    ],
    "InstructedAmount": 100.55,
    "InstructedCurrency": "EUR",
    "SchemePaymentMethod": "Partner 1",
    "TimestampCreated": "2021-05-22T00:00:00",
    "Identifiers": [
        {
            "Scope": "MCCYOutboundPayments",
            "Name": "SchemeEndToEndId",
            "Identifier": "4026da87bb0f4a5"
        }
    ],
    "AdditionalProperties": [
        {
            "Key": "DebtorName",
            "Value": "Acme Studios"
        },
        {
            "Key": "DebtorCountry",
            "Value": "GB"
        }
    ],
    "TimestampSettled": "2020-09-13T012:22:17.4",
    "TimestampSubmitted": "2020-09-13T011:26:15.1"
},
    "Nonce":761164091
}

Example webhook response

{
    "Nonce": 761164091
}

This webhook confirms that a multicurrency transaction has been cancelled

Request body

{
    "Type":"MccyPayloadTransactionCancelled",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`TransactionId`	Required Unique internal identifier defined by ClearBank for each payment. Type: `string` Min. Length: `1` Format: `GUID`
`BatchId`	Required Unique identifier for the batch in which the payment was submitted. Type: `string` Min. Length: `1` Format: `GUID`
`EndToEndId`	Required Unique identifier provided to ClearBank for each payment. Type: `string` Min. Length: `1` Max. Length: `35`
`SchemeEndToEndId`	Optional Unique identifier created by ClearBank for each payment and passed through the scheme to the creditor. Type: `string` Min. Length: `0` Max. Length: `15`
`AccountId`	Required Unique identifier for the account held with ClearBank. Type: `string` Min. Length: `1` Format: `GUID`
`Reference`	Required Reference provided by the ultimate debtor for the payment. Type: `string` Min. Length: `1` Max. Length: `140`
`UltimateCreditorName`	Required Name of the ultimate creditor. Type: `string` Min. Length: `1` Max. Length: `140`
`UltimateCreditorAccountIdentifiers`	Required List of account identifiers used to uniquely identify the ultimate creditor. It is an array of objects with `Kind` and an `Identifier`. Type: `array` `Kind` The kind of account identifier which is provided. This can be either IBAN, BBAN, AccountId or Descriptor (another kind of identifier). Type: `string` Min. Length: `1` Max. Length: `10` `Identifier` Unique account identifier value that corresponds to the specified account identifier kind. Type: `string` Min. Length: `1` Max. Length: `36`
`UltimateDebtorName`	Required Name of the ultimate debtor. Type: `string` Min. Length: `1` Max. Length: `140`
`UltimateDebtorAccountIdentifiers`	Required List of account identifiers used to uniquely identify the ultimate debtor. It is an array of objects with `Kind` and an `Identifier`. Type: `array` `Kind` The kind of account identifier which is provided. This can be either IBAN, BBAN, AccountId or Descriptor (another kind of identifier). Type: `string` Min. Length: `1` Max. Length: `10` `Identifier` Unique account identifier value that corresponds to the specified account identifier kind. Type: `string` Min. Length: `1` Max. Length: `36`
`InstructedAmount`	Required Instructed payment amount. Type: `number` Format: `decimal`
`InstructedCurrency`	Required Currency of the instructed payment. This is the 3-letter ISO currency code. Type: `string` Min. Length: `3` Max. Length: `3` Pattern: `^[A-z]{3}$`
`SchemePaymentMethod`	Required Payment scheme used for submitting the transaction. Type: `string` Min. Length: `1` Max. Length: `50`
`TimestampCreated`	Required Date and time transaction was created. Time in UTC. Type: `string` Min. Length: `1` Format: `date-time`
`Identifiers`	Required List of identifiers. It is an array of objects with a `Scope`, `Name` and `Identifier`. Type: `array` `Scope` Type: `string` Min. Length: `1` Max. Lenght: `50` `Name` Type: `string` Min. Length: `1` Max. Lenght: `50` `Identifier` Type: `string` Min. Length: `1` Max. Lenght: `250`
`AdditionalProperties`	Required List of additional information. It is an array of objects with a `Key` and `Value`. Type: `array` `Key` Type: `string` Min. Length: `1` Max. Lenght: `50` `Value` Type: `string` Min. Length: `1` Max. Lenght: `250`
`TimestampCancelled`	Required Date and time transaction was cancelled. Time in UTC. Type: `string` Min. Length: `1` Format: `date-time`
`CancellationCode`	Required Cancellation code. Type: `string` Min. Length: `1`
`CancellationReason`	Required Reason transaction was cancelled. Type: `string` Min. Length: `1`

Example transaction cancelled webhook request body

{
    "TransactionId": "fd7f3082-72d4-46b3-8e0e-1f66e4a91e13",
    "BatchId": "ab55f54a-26c3-4333-93cd-f917bb51ecad",
    "EndToEndId": "08c2c49c9e094df59f342a27cb64395c",
    "SchemeEndToEndId": "4026da87bb0f4a5",
    "AccountId": "50daac8a-72c3-4ae5-a6e3-e71b6187dbef",
    "Reference": "My payment reference 12345",
    "UltimateCreditorName": "John Baker",
    "UltimateCreditorAccountIdentifiers": [
        {
            "Kind": "AccountId",
            "Identifier": "fd75710b-4c0a-406d-a962-ef5c98836d3f"
        }
    ],
    "UltimateDebtorName": "Clark Kent",
    "UltimateDebtorAccountIdentifiers": [
        {
            "Kind": "IBAN",
            "Identifier": "GB33BUKB20201555555555"
        }
    ],
    "InstructedAmount": 100.55,
    "InstructedCurrency": "EUR",
    "SchemePaymentMethod": "Partner 1",
    "TimestampCreated": "2021-05-22T00:00:00",
    "Identifiers": [
        {
            "Scope": "MCCYOutboundPayments",
            "Name": "SchemeEndToEndId",
            "Identifier": "4026da87bb0f4a5"
        }
    ],
    "AdditionalProperties": [
        {
            "Key": "DebtorName",
            "Value": "Acme Studios"
        },
        {
            "Key": "DebtorCountry",
            "Value": "GB"
        }
    ],
    "TimestampCancelled": "2020-09-13T09:26:15.1762781",
    "CancellationCode": "RejectedByScheme",
    "CancellationReason": "Contact ClearBank for more details"
},
    "Nonce":748364091
}

Example webhook response

{
    "Nonce": 748364091
}

This webhook confirms that a multicurrency payment has failed assessment

Currently, the only scenario which can trigger this event includes insufficient balance to cover payments.

Request body

{
    "Type":"MccyPayloadAssessmentFailed",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`Error`	Required Error which caused the payment assessment to fail. Type: `string` Min. Length: `1` Max. Length: `280`
`UltimateDebtorName`	Optional Name of the ultimate debtor making the payment. Type: `string` Min. Length: `0` Max. Length: `140`
`UltimateDebtorAccount`	Required Account details of the ultimate debtor making the payment. Type: `string` Min. Length: `5` Max. Length: `36`
`UltimateDebtorAccountIdentifier`	Required Account identifier used to uniquely identify the ultimate debtor. Valid values are IBAN or AccountId. Type: `string` Min. Length: `1`
`UltimateDebtorAddressLine1`	Required First line of the ultimate debtor's address. Type: `string` Min. Length: `1` Max. Length: `70`
`UltimateDebtorAddressLine2`	Optional Second line of the ultimate debtor's address. Type: `string` Min. Length: `0` Max. Length: `35`
`UltimateDebtorAddressLine3`	Optional Third line of the ultimate debtor's address. Type: `string` Min. Length: `0` Max. Length: `35`
`UltimateDebtorPostCode`	Required Postcode of the ultimate debtor. Type: `string` Min. Length: `1` Max. Length: `16`
`UltimateDebtorCountryCode`	Required Country code for the ultimate debtor's address. This is the 2-letter ISO country code. Type: `string` Min. Length: `2` Max. Length: `2` Pattern: `^[A-Z]{2}$`
`InstructedAmount`	Required Instructed payment amount. Type: `number` Format: `decimal`
`InstructedCurrency`	Required Currency of the instructed payment. This is the 3-digit ISO currency code. Type: `string` Min. Length: `3` Max. Length: `3` Pattern: `^[A-z]{3}$`
`Reference`	Required Reference provided by the ultimate debtor for the payment. Type: `string` Min. Length: `1` Max. Length: `140`
`BatchId`	Required Unique identifier for the batch in which the payment was submitted. Type: `string` Min. Length: `1` Format: `GUID`
`EndToEndId`	Required Unique identifier provided to ClearBank for each payment. Type: `string` Min. Length: `1` Max. Length: `35`
`SchemeEndToEndId`	Optional Unique identifier created by ClearBank for each payment and passed through the scheme to the creditor. Type: `string` Min. Length: `0` Max. Length: `15`
`UltimateCreditorIBAN`	Optional IBAN for the ultimate creditor. Mandatory only if Ultimate Creditor Account Number is not provided. Type: `string` Min. Length: `0` Max. Length: `34`
`UltimateCreditorAccountNumber`	Optional Account Number used to uniquely identify the ultimate creditor's account. Mandatory only if Ultimate Creditor IBAN is not provided. Type: `string` Min. Length: `0` Max. Length: `34`
`UltimateCreditorBic`	Optional BIC for the ultimate creditor. Type: `string` Min. Length: `8` Max. Length: `11` Pattern: `^[A-Z]{6}[A-Z2-9][A-NP-Z1-9]([A-Z0-9]{3})?$`
`UltimateCreditorName`	Required Name of the ultimate creditor. Type: `string` Min. Length: `1` Max. Length: `140`
`UltimateCreditorAddressLine1`	Required First line of the ultimate creditor's address. Type: `string` Min. Length: `1` Max. Length: `70`
`UltimateCreditorAddressLine2`	Optional Second line of the ultimate creditor's address. Type: `string` Min. Length: `0` Max. Length: `35`
`UltimateCreditorAddressLine3`	Optional Third line of the ultimate creditor's address. Type: `string` Min. Length: `0` Max. Length: `35`
`UltimateCreditorPostCode`	Required Postcode of the ultimate creditor. Type: `string` Min. Length: `1` Max. Length: `16`
`UltimateCreditorCountryCode`	Required Country code for the ultimate creditor's address. This is the 2-letter ISO country code. Type: `string` Min. Length: `2` Max. Length: `2` Pattern: `^[A-Z]{2}$`
`TransactionId`	Required Unique internal identifier defined by ClearBank for each payment. Type: `string` Min. Length: `1` Format: `GUID`

Example Payment Assessment Failed webhook request body

{
    "Error":"Insufficient funds or other failure",
    "UltimateDebtorName":"Richard Douglas",
    "UltimateDebtorAccount":"57d06e62-efca-49e7-a71f-8eb18d72c162",
    "UltimateDebtorAccountIdentifier":"AccountId",
    "UltimateDebtorAddressLine1":"4th Floor, Prologue Works",
    "UltimateDebtorAddressLine2":"25 Marsh St",
    "UltimateDebtorAddressLine3":"Bristol",
    "UltimateDebtorPostCode":"BS1 4AX",
    "UltimateDebtorCountryCode":"GB",
    "InstructedAmount":100.55,
    "InstructedCurrency":"EUR",
    "Reference":"My payment reference 12345",
    "BatchId":"ab55f54a-26c3-4333-93cd-f917bb51ecad",
    "EndToEndId":"08c2c49c9e094df59f342a27cb64395c",
    "SchemeEndToEndId":"4026da87bb0f4a5",
    "UltimateCreditorIBAN":"GB33BUKB20201555555555",
    "UltimateCreditorAccountNumber":null,
    "UltimateCreditorBic":"IIIGGB22",
    "UltimateCreditorName":"John Baker",
    "UltimateCreditorAddressLine1":"Martin Place",
    "UltimateCreditorAddressLine2":"London",
    "UltimateCreditorAddressLine3":null,
    "UltimateCreditorPostCode":"SW1A 1AA",
    "UltimateCreditorCountryCode":"GB",
    "TransactionId":"fd7f3082-72d4-46b3-8e0e-1f66e4a91e13"
},
    "Nonce":748224091
}

Example webhook response

{
    "Nonce": 748224091
}

This webhook confirms that a multicurrency payment has failed validation

Scenarios which can trigger this event include sending the payment from a debtor account that does not exist, has not yet been enabled to send payments or has not yet been enabled to send payments in the intended currency.

Request body

{
    "Type":"MccyPayloadValidationFailed",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`Errors`	Required Error(s) which caused the payment validation to fail. Type: `array` Min. Length: `1` Max. Length: `140`
`UltimateDebtorName`	Optional Name of the ultimate debtor making the payment. Type: `string` Min. Length: `0` Max. Length: `140`
`UltimateDebtorAccount`	Required Account details of the ultimate debtor making the payment. Type: `string` Min. Length: `5` Max. Length: `36`
`UltimateDebtorAccountIdentifier`	Required Account identifier used to uniquely identify the ultimate debtor. Valid values are IBAN or AccountId. Type: `string` Min. Length: `1`
`UltimateDebtorAddressLine1`	Required First line of the ultimate debtor's address. Type: `string` Min. Length: `1` Max. Length: `70`
`UltimateDebtorAddressLine2`	Optional Second line of the ultimate debtor's address. Type: `string` Min. Length: `0` Max. Length: `35`
`UltimateDebtorAddressLine3`	Optional Third line of the ultimate debtor's address. Type: `string` Min. Length: `0` Max. Length: `35`
`UltimateDebtorPostCode`	Required Postcode of the ultimate debtor. Type: `string` Min. Length: `1` Max. Length: `16`
`UltimateDebtorCountryCode`	Required Country code for the ultimate debtor's address. This is the 2-letter ISO country code. Type: `string` Min. Length: `2` Max. Length: `2` Pattern: `^[A-Z]{2}$`
`InstructedAmount`	Required Instructed payment amount. Type: `number` Format: `decimal`
`InstructedCurrency`	Required Currency of the instructed payment. This is the 3-digit ISO currency code. Type: `string` Min. Length: `3` Max. Length: `3` Pattern: `^[A-z]{3}$`
`Reference`	Required Reference provided by the ultimate debtor for the payment. Type: `string` Min. Length: `1` Max. Length: `140`
`BatchId`	Required Unique identifier for the batch in which the payment was submitted. Type: `string` Min. Length: `1` Format: `GUID`
`EndToEndId`	Required Unique identifier provided to ClearBank for each payment. Type: `string` Min. Length: `1` Max. Length: `35`
`SchemeEndToEndId`	Optional Unique identifier created by ClearBank for each payment and passed through the scheme to the creditor. Type: `string` Min. Length: `0` Max. Length: `15`
`UltimateCreditorIBAN`	Optional IBAN for the ultimate creditor. Mandatory only if Ultimate Creditor Account Number is not provided. Type: `string` Min. Length: `0` Max. Length: `34`
`UltimateCreditorAccountNumber`	Optional Account Number used to uniquely identify the ultimate creditor's account. Mandatory only if Ultimate Creditor IBAN is not provided. Type: `string` Min. Length: `0` Max. Length: `34`
`UltimateCreditorBic`	Optional BIC for the ultimate creditor. Type: `string` Min. Length: `8` Max. Length: `11` Pattern: `^[A-Z]{6}[A-Z2-9][A-NP-Z1-9]([A-Z0-9]{3})?$`
`UltimateCreditorName`	Required Name of the ultimate creditor. Type: `string` Min. Length: `1` Max. Length: `140`
`UltimateCreditorAddressLine1`	Required First line of the ultimate creditor's address. Type: `string` Min. Length: `1` Max. Length: `70`
`UltimateCreditorAddressLine2`	Optional Second line of the ultimate creditor's address. Type: `string` Min. Length: `0` Max. Length: `35`
`UltimateCreditorAddressLine3`	Optional Third line of the ultimate creditor's address. Type: `string` Min. Length: `0` Max. Length: `35`
`UltimateCreditorPostCode`	Required Postcode of the ultimate creditor. Type: `string` Min. Length: `1` Max. Length: `16`
`UltimateCreditorCountryCode`	Required Country code for the ultimate creditor's address. This is the 2-letter ISO country code. Type: `string` Min. Length: `2` Max. Length: `2` Pattern: `^[A-Z]{2}$`
`TransactionId`	Required Unique internal identifier defined by ClearBank for each payment. Type: `string` Min. Length: `1` Format: `GUID`

Example Payment Validation Failed webhook request body

{
    "Errors":[
        "Account is not enabled",
        "EndToEndId already exists.",
        "Account does not belong to this institution"
    ],
    "UltimateDebtorName":"Richard Douglas",
    "UltimateDebtorAccount":"57d06e62-efca-49e7-a71f-8eb18d72c162",
    "UltimateDebtorAccountIdentifier":"AccountId",
    "UltimateDebtorAddressLine1":"4th Floor, Prologue Works",
    "UltimateDebtorAddressLine2":"25 Marsh St",
    "UltimateDebtorAddressLine3":"Bristol",
    "UltimateDebtorPostCode":"BS1 4AX",
    "UltimateDebtorCountryCode":"GB",
    "InstructedAmount":100.55,
    "InstructedCurrency":"EUR",
    "Reference":"My payment reference 12345",
    "BatchId":"ab55f54a-26c3-4333-93cd-f917bb51ecad",
    "EndToEndId":"08c2c49c9e094df59f342a27cb64395c",
    "SchemeEndToEndId":"4026da87bb0f4a5",
    "UltimateCreditorIBAN":"GB33BUKB20201555555555",
    "UltimateCreditorAccountNumber":null,
    "UltimateCreditorBic":"IIIGGB22",
    "UltimateCreditorName":"John Baker",
    "UltimateCreditorAddressLine1":"Buckingham Palace",
    "UltimateCreditorAddressLine2":"London",
    "UltimateCreditorAddressLine3":null,
    "UltimateCreditorPostCode":"SW1A 1AA",
    "UltimateCreditorCountryCode":"GB",
    "TransactionId":"fd7f3082-72d4-46b3-8e0e-1f66e4a91e13"
},
    "Nonce":711364091
}

Example webhook response

{
    "Nonce": 711364091
}

Associated Endpoint
- postInitiate an internal transfer request.
Webhook
- Multicurrency Internal Transfers Settled Webhook
- Multicurrency Internal Transfers Cancelled Webhook

This webhook confirms that a multicurrency internal transfer request has been settled

Request body

{
    "Type":"Mccy.InternalTransfers.Settled",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`DebitAccountIban`	Optional International Bank Account Number for the debtor account. Type: `string`
`DebitAccountOther`	Optional The unique identifier for the specified account if an IBAN is not provided. It is an object with a Kind and an Identifier. Mandatory only if the IBAN is not provided. Type: `object` `Kind` The kind of account identifier provided. This can only be AccountId. Type: `string` Min. Length: `1` `Identifier` Unique account identifier value that corresponds to the specified account identifier kind. Type: `string` Min. Length: `1` Max. Length: `36`
`CreditAccountIban`	Optional International Bank Account Number for the creditor account. Type: `string`
`CreditAccountOther`	Optional The unique identifier for the specified account if an IBAN is not provided. It is an object with a Kind and an Identifier. Mandatory only if the IBAN is not provided. Type: `object` `Kind` The kind of account identifier provided. This can only be AccountId. Type: `string` Min. Length: `1` `Identifier` Unique account identifier value that corresponds to the specified account identifier kind. Type: `string` Min. Length: `1` Max. Length: `36`
`InstructedAmount`	Required Instructed internal transfer amount. Type: `number` Format: `decimal`
`InstructedCurrency`	Required Currency of the instructed internal transfer. This is the 3-letter ISO currency code. Type: `string` Min. Length: `3` Max. Length: `3` Pattern: `^[A-z]{3}$`
`EndToEndId`	Required Unique identifier provided to ClearBank for each payment. Type: `string` Min. Length: `1` Max. Length: `35`
`Reference`	Optional Reference provided by the debtor for the internal transfer. Type: `string` Min. Length: `0` Max. Length: `140`

Example internal transfer settled webhook request body

{
    "EndToEndId":"56de3483a56942eb90ccacf59661356f",
    "DebitAccountIban":"GB00CUBK11223312345678",
    "CreditAccountIban":"GB00CUBK88776687654321",
    "InstructedCurrency":"NOK",
    "InstructedAmount":13,
    "Reference":"f92af28f-0635-4d81-893f-6c32af1d2a17"
},
    "Nonce":748394375
}

Example webhook response

{
    "Nonce": 748394375
}

This webhook confirms that a multicurrency internal transfer request has been cancelled

Request body

{
    "Type":"Mccy.InternalTransfers.Cancelled",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`DebitAccountIban`	Optional International Bank Account Number for the debtor account. Type: `string`
`DebitAccountOther`	Optional The unique identifier for the specified account if an IBAN is not provided. It is an object with a Kind and an Identifier. Mandatory only if the IBAN is not provided. Type: `object` `Kind` The kind of account identifier provided. This can only be AccountId. Type: `string` Min. Length: `1` `Identifier` Unique account identifier value that corresponds to the specified account identifier kind. Type: `string` Min. Length: `1` Max. Length: `36`
`CreditAccountIban`	Optional International Bank Account Number for the creditor account. Type: `string`
`CreditAccountOther`	Optional The unique identifier for the specified account if an IBAN is not provided. It is an object with a Kind and an Identifier. Mandatory only if the IBAN is not provided. Type: `object` `Kind` The kind of account identifier provided. This can only be AccountId. Type: `string` Min. Length: `1` `Identifier` Unique account identifier value that corresponds to the specified account identifier kind. Type: `string` Min. Length: `1` Max. Length: `36`
`InstructedAmount`	Required Instructed internal transfer amount. Type: `number` Format: `decimal`
`InstructedCurrency`	Required Currency of the instructed internal transfer. This is the 3-letter ISO currency code. Type: `string` Min. Length: `3` Max. Length: `3` Pattern: `^[A-z]{3}$`
`EndToEndId`	Required Unique identifier provided to ClearBank for each payment. Type: `string` Min. Length: `1` Max. Length: `35`
`Reference`	Optional Reference provided by the debtor for the internal transfer. Type: `string` Min. Length: `0` Max. Length: `140`
`CancellationCode`	Required The cancellation code for the internal transfer. Valid options include: ValidationFailed, AssessmentFailed. Type: `string`
`FailureReasons`	Required Reasons the internal transfer was cancelled. Type: `array` Min. Items: `1`

Example internal transfer cancelled webhook request body

{
    "CancellationCode":"AssessmentFailed",
    "FailureReasons":[
        "Not enough funds"
    ],
    "EndToEndId":"9020d28f67f042aca26ae4f031765af5",
    "DebitAccountIban":"GB00CUBK11223312345678",
    "CreditAccountIban":"GB00CUBK88776687654321",
    "InstructedCurrency":"EUR",
    "InstructedAmount":53,
    "Reference":"226ef602-43e1-48a3-9fbd-f6a80849d74f"
},
    "Nonce":748394376
}

Example webhook response

{
    "Nonce": 748394376
}

Associated Endpoint
- postCreate a Foreign Exchange (FX) buy and sell order
Webhook

This webhook confirms that the FX trade has been executed

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 sellAccount. 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 buyAccount. Type: `string` Min. Length: `1` Max. Length: `35`
`Attestation`	Required Confirmation that the sellAccount and buyAccount 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 sellAccount. 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 buyAccount. Type: `string` Min. Length: `1` Max. Length: `35`
`Attestation`	Required Confirmation that the sellAccount and buyAccount 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 the FX trade has been cancelled

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 sellAccount. 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 buyAccount. Type: `string` Min. Length: `1` Max. Length: `35`
`Attestation`	Required Confirmation that the sellAccount and buyAccount 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
}

Webhooks

Overview

Anatomy of a webhook

Response

Responding to a webhook

Setting up and testing webhook listener URLs

Accounts

Associated Endpoint

Webhook

Virtual Accounts

Associated Endpoint

Webhook

Multicurrency Accounts

Associated Endpoint

Webhook

Associated Endpoint

Webhook

Associated Endpoint

Webhook

Associated Endpoint

Webhook

Multicurrency Virtual Accounts

Associated Endpoint

Webhook

Associated Endpoint

Webhook

Associated Endpoint

Webhook

Associated Endpoint

Webhook

Multicurrency Statements

Associated Endpoint

Webhook

Associated Endpoint

Webhook

Payments

Associated Endpoint

Webhook

High Value International Payments

Associated Endpoint

Webhook

Internal Transfers

Associated Endpoint

Webhook

FX Trade

Associated Endpoint

Webhook