Cheques

ClearBank accounts can support cheque deposits. If you'd like access to this product, please speak to your relationship manager.

You can submit cheques as image files using the POST /v1/submitDeposit endpoint.

The message flow for cheques submitted via the endpoint is shown here.

alt text

You can submit a cheque image in either TIFF or JPEG file format.

Cheques can be submitted any time and may take up to three working days to process. If the cheque passes processing, is submitted to the ICS scheme, and approved for payment, you will receive the Cheque Paid and Transaction Settled webhooks. If the cheque cannot be processed automatically, you will receive the Cheque Reconciled and Transaction Settled webhooks.

Scenarios where the cheque wouldn't process successfully include:

If the cheque is over the limits you defined during onboarding, you will receive a 400 response when you submit the cheque.
If a cheque cannot be submitted to the ICS scheme, for example, due to low image quality, you will receive a 400 response when you submit the cheque.
If the cheque is successfully submitted, but there is missing information, you will receive the transaction rejected report from ClearBank on Freshdesk.
If a decision is made by the issuing bank through ICS to not pay the cheque, you will receive the Cheque Not Paid webhook.

For cheque images to successfully validate, they must satisfy the following requirements:

File type	Encoding	Resolution	Image size in Base64 length	Image size in bytes
Bitonal JPEG	Base64 encoded string	200 DPI	800,000 characters	600,000 bytes
Bitonal TIFF	Base64 encoded string	200 DPI	90,000 characters	67,500 bytes

Cheque images must be:

Clear
Uncrumpled
Without folded corners and have visible edges
Free from shadows

Submit a cheque

post/payments/cheques/v1/submit-deposit

Submit deposit.

Parameters

Authorization string, header, Required
Your API token, retrieved from the web portal.
DigitalSignature string, header, Required
Signed hash of the body of the request. The hash is signed by your private key.
X-Request-Id string, header, Required
A unique identifier for the request.

Request Payload (application/json)

deposit object, Required
Deposit details.
messageId string, Required
The unique identifier for the message.
Minimum length
1
Maximum length
35
Pattern
^\S{1,35}$

request

{
  "deposit": {
    "beneficiary": {
      "accountNumber": "string",
      "sortCode": "string",
      "names": [
        "string"
      ]
    },
    "chequeAmount": 0,
    "currency": "str",
    "chequeImages": {
      "frontImage": "string",
      "backImage": "string",
      "imageType": "tiff"
    }
  },
  "messageId": "string"
}

Code copied

Response (application/json)

200 OK
400 Bad request
403 Forbidden

OK

{
  "messageId": "string",
  "status": "accepted"
}

Code copied

Bad request

{
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "messageId": "string",
  "errorCode": "string"
}

Code copied

Forbidden

{
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "messageId": "string",
  "errorCode": "string"
}

Code copied

This webhook confirms a cheque has been received and will be paid. You will receive the Transaction Settled webhook at the same time.

Request body

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

Payload

Element	Description
`TransactionSetId`	Required Unique Transaction Set ID used for Image Clearing System (ICS) processing. Type: `string` Max. Length: `22` Min. Length: `1` Pattern: `^[0-9]*$`
`CreditItemId`	Required Unique Credit Item ID used for Image Clearing System (ICS) processing. Type: `string` Max. Length: `25` Min. Length: `1`
`Account`	Required Account details of the creditor party associated with the cheque. `SortCode` Type: `string` Max. Length: `6` Min. Length: `6` Pattern: `^[0-9]$` `AccountNumber` Type: `string` Max. Length: `8` Min. Length: `8` Pattern: `^[0-9]$`
`DebitItemId`	Required Unique Debit Item ID used for Image Clearing System (ICS) processing. Type: `string` Max. Length: `25` Min. Length: `1`
`ChequeAmount`	Required Amount for the cheque debit item in the transaction, in sterling. Type: `number` Format: `decimal`
`CounterpartAccount`	Required Account details of the debtor party associated with the cheque. `SortCode` Type: `string` Max. Length: `6` Min. Length: `6` Pattern: `^[0-9]$` `AccountNumber` Type: `string` Max. Length: `8` Min. Length: `8` Pattern: `^[0-9]$`
`ChequeSerialNumber`	Required Cheque Serial Number for the cheque debit item in the transaction. Max. Length: `6` Min. Length: `1` Pattern: `^[0-9]*$`
`SwitchedSortCode`	New sort code used when the current account switching service has provided switched account details. Type: `string` or `null` Max. Length: `6` Min. Length: `6` Pattern: `^[0-9]*$`
`SwitchedAccountNumber`	New account number used when the current account switching service has provided switched account details. Type: `string` or `null` Max. Length: `8` Min. Length: `8` Pattern: `^[0-9]*$`
`MessageId`	Required Unique identifier provided to ClearBank for each payment. Type: `string` Max. Length: `36` Min. Length: `1`
`MessageSourceId`	ClearBank client identifier. Type: `string` or `null` Max. Length: `36` Min. Length: `0`
`TimestampCreated`	Required The date and time (in UTC) when the cheque was processed as paid within our system. Type: `string` Format: `date-time`

This webhook is used to confirm a cheque has failed scrutiny and provide a reason for that failure using a four character reason code as the ScrutinyFailureReasonCode.

The table below covers common scenarios that can trigger this event. We cannot provide a complete list as these may change. The scenarios provided are designed to be human-readable, and you should be prepared to accept other values in these fields.

Reason code	Summary name	Description	Retryable?	Corrective action to take
ALNI	ALterations Not Initialled	Any alterations or amendments made to the cheque have not been initialled.	No	You will not be able to resubmit the cheque via ClearBank's service, but may be successful via another channel.
AMMM	AMount MisMatch	The amount advised for the deposit is not the same as the value advised on the cheque itself.	Yes	Ensure the value of the cheque matches the value entered in the app.
CRRC	CRedit Read as Cheque	A credit slip has been incorrectly captured as a cheque in the deposit stage.	No	You will be made aware that the credit was not a valid cheque. No further action can be taken.
DUPL	DUPLicate	The deposit was initially accepted but at scrutiny, has been identified as a duplicate.	No	Check your records to identify the cheque previously deposited.
IMQY	IMage QualitY	The image of the cheque taken for the deposit is not at an acceptable standard to send to scheme.	Yes	Re-attempt the cheque deposit but ensure the image captured is of a better quality.
NDTE	No DaTE	No date has been advised on the cheque.	Yes	Ask whoever wrote the cheque to add a date to it, and then re-attempt the deposit. Note: if the ink or handwriting don't match, the cheque might be rejected as fraudulent.
NSGR	No SiGnatuRe	A signature has failed to be advised on the cheque.	Yes	Request the payer of the cheque provides their signature on the cheque and re-attempt the deposit. In the unique case of a NS&I cheque, the payee (creditor) needs to sign the cheque and should advise this on the cheque.
OTHR	OTHeR	The cheque failed scrutiny however it is not for any of the specified reasons given above.	No	You will not be able to resubmit the cheque via ClearBank's service, but may be successful via another channel.
PNCH	Payee Name CHanged	Payee name has been changed in the case where the cheque specifies for the advised payee only.	No	You will not be able to resubmit the cheque via ClearBank's service, but may be successful via another channel.
PNMM	Payee Name MisMatch	The name of the payee on the cheque does not match the payee name associated with the creditor account.	Yes	Review the name on the cheque and the name of the account being deposited into to ensure they match. If they don't, the cheque deposit can be attempted again, but will need to be to a different account.
SCVA	SCheme VAlidation	The cheque passed scrutiny and sent to scheme, however, scheme have rejected it due to an issue.	No	Contact ClearBank to investigate the matter further. This may be due to a sortcode mis-scan.
WAFG	Words And FiGures	The value advised in the wording of the amount is not the same as the figure amount advised.	No	You will not be able to resubmit the cheque via ClearBank's service, but may be successful via another channel.

Request body

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

Payload

Element	Description
`ScrutinyFailureReasonCode`	Required Reason code indicating why the cheque failed scrutiny. Possible values: ALNI (alterations not initialled), AMMM (amount mismatch), CRRC (credit read as cheque), DUPL (duplicate), IMQY (image quality), NDTE (No date), NSGR (no signature), OTHR (other), PNCH (payee name changed), PNMM (payee name mismatch), SCVA (scheme validation), WAFG (words and figures do not match). Type: `string` Max. Length: `4` Min. Length: `4`
`MessageId`	Required Unique identifier provided to ClearBank for each payment. Type: `string` Max. Length: `36` Min. Length: `1`
`TransSetId`	Required Unique Transaction Set ID used for Cheque processing. Due to the cheque having failed scrutiny, this ID is not provided by the industry scheme and has a different format to the TransactionSetId provided in other cheque-related webhooks. Type: `string` Max. Length: `14` Min. Length: `14`
`Account`	Required Account details of the creditor party associated with the cheque. `SortCode` Type: `string` Max. Length: `6` Min. Length: `6` Pattern: `^[0-9]$` `AccountNumber` Type: `string` Max. Length: `8` Min. Length: `8` Pattern: `^[0-9]$`
`CounterpartAccount`	Required Account details of the debtor party associated with the cheque. `SortCode` Type: `string` Max. Length: `6` Min. Length: `6` Pattern: `^[0-9]$` `AccountNumber` Type: `string` Max. Length: `8` Min. Length: `8` Pattern: `^[0-9]$`
`ChequeAmount`	Required Amount for the cheque debit item in the transaction, in sterling. Type: `number` Format: `decimal`
`ChequeSerialNumber`	Required Cheque Serial Number for the cheque debit item in the transaction. Max. Length: `6` Min. Length: `1` Pattern: `^[0-9]*$`
`ProcessingDate`	Required Advises the date which the deposit was worked within (YYYY-MM-DD). Format: `date`
`CollectionChannel`	Required Advises the Collection Channel of the original deposit made. Possible values: M (Mobile channel - ClearBank's service) or P (Postal channel). Type: `string` Max. Length: `1` Min. Length: `1`
`TimestampCreated`	Required The date and time (in UTC) when the cheque failed the scrutiny process within our system. Type: `string` Format: `date-time`

Example Cheque Failed Scrutiny webhook request body

{
    "Type": "ChequeFailedScrutiny",
    "Version": 1,
    "Payload": {
        "ScrutinyFailureReasonCode": "IMQY",
        "MessageId": "cbcheque_0000AjUiQUs4qDanyrt4u9",
        "TransactionSetId": "M0000012650501",
        "Account": {
            "SortCode": "040404",
            "AccountNumber": "01234567"
        },
        "CounterpartAccount": {
            "SortCode": "040404",
            "AccountNumber": "12345678"
        },
        "ChequeAmount": 1.1,
        "ChequeSerialNumber": "123456",
        "ProcessingDate": "2024-07-17",
        "CollectionChannel": "M",
        "TimestampCreated": "2024-04-23T18:25:43.511Z"
    },
    "Nonce": 1224437580
}

Example webhook response

{
    "Nonce": 1224437580
}

This webhook confirms a cheque has been received and will not be paid.

Request body

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

Payload

Element	Description
`NoPayReasonCode`	Required Reason code to specify why the cheque has not been paid by the paying bank. Type: `string` Max. Length: `4` Min. Length: `1` Pattern: `^[0-9]*$`
`TransactionSetId`	Required Unique Transaction Set ID used for Image Clearing System (ICS) processing. Type: `string` Max. Length: `22` Min. Length: `1` Pattern: `^[0-9]*$`
`CreditItemId`	Required Unique Credit Item ID used for Image Clearing System (ICS) processing. Type: `string` Max. Length: `25` Min. Length: `1`
`Account`	Required Account details of the creditor party associated with the cheque. `SortCode` Type: `string` Max. Length: `6` Min. Length: `6` Pattern: `^[0-9]$` `AccountNumber` Type: `string` Max. Length: `8` Min. Length: `8` Pattern: `^[0-9]$`
`DebitItemId`	Required Unique Debit Item ID used for Image Clearing System (ICS) processing. Type: `string` Max. Length: `25` Min. Length: `1`
`ChequeAmount`	Required Amount for the cheque debit item in the transaction, in sterling. Type: `number` Format: `decimal`
`CounterpartAccount`	Required Account details of the debtor party associated with the cheque. `SortCode` Type: `string` Max. Length: `6` Min. Length: `6` Pattern: `^[0-9]$` `AccountNumber` Type: `string` Max. Length: `8` Min. Length: `8` Pattern: `^[0-9]$`
`ChequeSerialNumber`	Required Cheque Serial Number for the cheque debit item in the transaction. Max. Length: `6` Min. Length: `1` Pattern: `^[0-9]*$`
`SwitchedSortCode`	Account switching scenario - switched sort code of the cheque. Type: `string` or `null` Max. Length: `6` Min. Length: `6` Pattern: `^[0-9]*$`
`SwitchedAccountNumber`	Account switching scenario - switched account number of the cheque. Type: `string` or `null` Max. Length: `8` Min. Length: `8` Pattern: `^[0-9]*$`
`MessageId`	Required Unique identifier provided to ClearBank for each payment. Type: `string` Max. Length: `36` Min. Length: `1`
`MessageSourceId`	ClearBank client identifier. Type: `string` or `null` Max. Length: `36` Min. Length: `0`
`TimestampCreated`	Required The date and time (in UTC) when the cheque was processed as not paid within our system. Type: `string` Format: `date-time`

This webhook confirms a cheque has been received, manually processed, and will be paid. You will receive the Transaction Settled webhook at the same time.

Request body

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

Payload

Element	Description
`TransactionSetId`	Required Unique Transaction Set ID used for Image Clearing System (ICS) processing. Type: `string` Max. Length: `22` Min. Length: `1` Pattern: `^[0-9]*$`
`CreditItemId`	Required Unique Credit Item ID used for Image Clearing System (ICS) processing. Type: `string` Max. Length: `25` Min. Length: `1`
`Account`	Required Account details of the creditor party associated with the cheque. `SortCode` Type: `string` Max. Length: `6` Min. Length: `6` Pattern: `^[0-9]$` `AccountNumber` Type: `string` Max. Length: `8` Min. Length: `8` Pattern: `^[0-9]$`
`DebitItemId`	Required Unique Debit Item ID used for Image Clearing System (ICS) processing. Type: `string` Max. Length: `25` Min. Length: `1`
`ChequeAmount`	Required Amount for the cheque debit item in the transaction, in pounds sterling. Type: `number` Format: `decimal`
`CounterpartAccount`	Required Account details of the debtor party associated with the cheque. `SortCode` Type: `string` Max. Length: `6` Min. Length: `6` Pattern: `^[0-9]$` `AccountNumber` Type: `string` Max. Length: `8` Min. Length: `8` Pattern: `^[0-9]$`
`ChequeSerialNumber`	Required Cheque Serial Number for the cheque debit item in the transaction. Max. Length: `6` Min. Length: `1` Pattern: `^[0-9]*$`
`SwitchedSortCode`	New sort code used when the current account switching service has provided switched account details. Type: `string` or `null` Max. Length: `6` Min. Length: `6` Pattern: `^[0-9]*$`
`SwitchedAccountNumber`	New account number used when the current account switching service has provided switched account details. Type: `string` or `null` Max. Length: `8` Min. Length: `8` Pattern: `^[0-9]*$`
`MessageId`	Required Unique identifier provided to ClearBank for each payment. Type: `string` Max. Length: `36` Min. Length: `1`
`MessageSourceId`	ClearBank client identifier. Type: `string` or `null` Max. Length: `36` Min. Length: `0`
`TimestampCreated`	Required Date and time when the cheque was reconciled within ClearBank. Time in UTC. Type: `string` Format: `date-time`

This webhook confirms the transaction has settled. For Bacs payments, this is sent on Day 3 of Bacs processing cycle.

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`	For outbound Faster Payments and CHAPS transactions, this is the unique identifier you supplied in the endToEndIdentification field in your API request. For inbound CHAPS payments, this is the prefix "II-" followed by the Instruction Identification, which is unique. For outbound cheque transactions, this is the unique identifier you supplied in the MessageId value in your submit a cheque API request. For internal transfers, this will not be unique, as the value specified in the two webhooks describing the transactions applied to the debtor and creditor accounts will match. Type: `string` Max. length:`35`
`Amount`	Transaction amount. Type: `decimal`
`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 = `Instruction Identification` Cheques = `CreditItemId` FPID is the unique payment identifier generated by Faster Payments. Instruction Identification is the unique payment identifier generated by the remitting bank. ICS Credit Item Identification is the unique payment identifier generated by the cheque scheme.
`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`, `Cheques`
`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`, `RedirectedBeneficiaryCreditInstitution`, `RedirectedBeneficiaryCustomerAccountNumber`, `AbusiveMessageScreeningResult`, `AbusiveMessageScreeningIdentifiers` `Value` Max. length: `500` There could be more than one Name and Value pair.
`Iso20022XmlDocument`	(Optional) Only appears if `Scheme` is Chaps and the message type received is in ISO 20022 (MX) format. Content of the Document node (payload) of the received payment message, to enable processing of ISO 20022 messages for CHAPS. This value can be very long, so we recommend checking your firewall settings to ensure they will not prevent you from receiving the webhook. See below for examples. Type: `string` Min. Length: `0` Max. Length: `80000`
`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 for Transfer scheme type

{
    "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": 949893874
}

Example transaction settled webhook request body for CHAPS scheme type, Iso20022XmlDocument field present - populated for an inbound credit CHAPS payment of pacs.008 type

{
    "Type": "TransactionSettled",
    "Version": 6,
    "Payload": {
        "TransactionId": "fbb84b68-fb67-4532-bfd6-2b540e341a21",
        "Status": "Settled",
        "Scheme": "Chaps",
        "EndToEndTransactionId": "EndToEndId8",
        "Amount": 9.09,
        "TimestampSettled": "2023-02-15T15:32:52.773Z",
        "TimestampCreated": "2023-02-15T15:32:52.437Z",
        "CurrencyCode": "GBP",
        "DebitCreditCode": "Credit",
        "Reference": "Reference17",
        "IsReturn": false,
        "Account": {
            "IBAN": "GB57CLRB04040100057354",
            "BBAN": "CLRB04040100057354",
            "OwnerName": "Fictional - Name",
            "TransactionOwnerName": "Some Other Name",
            "InstitutionName": "ClearBank"
        },
        "CounterpartAccount": {
            "IBAN": "GB58CLRB04040009547509",
            "OwnerName": "GB58CLRB04040009547509",
            "TransactionOwnerName": "GB58CLRB04040009547509",
            "InstitutionName": "LOYDGB22XXX"
        },
        "ActualEndToEndTransactionId": "EndToEndId8",
        "SupplementaryData": [
            {
                "Name": "20",
                "Value": "InstrId7"
            },
            {
                "Name": "32A",
                "Value": "1909-11-1\r\n9.09"
            },
            {
                "Name": "33B",
                "Value": ""
            },
            {
                "Name": "50K",
                "Value": "DebtorName16\r\nGB58CLRB04040009547509"
            },
            {
                "Name": "52A",
                "Value": "LOYDGB22XXX"
            },
            {
                "Name": "57A",
                "Value": "CLRBGB20XXX"
            },
            {
                "Name": "59",
                "Value": "GB57CLRB04040100057354"
            },
            {
                "Name": "70",
                "Value": "EndToEndId8\r\nReference17"
            },
            {
                "Name": "71A",
                "Value": "DEBT"
            }
        ],
        "Iso20022XmlDocument": "<Document xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns=\"urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08\"><FIToFICstmrCdtTrf><GrpHdr><CreDtTm>1900-02-03T04:00:30+00:00</CreDtTm><NbOfTxs>1</NbOfTxs></GrpHdr><CdtTrfTxInf><PmtId><InstrId>InstrId7</InstrId><EndToEndId>EndToEndId8</EndToEndId><UETR>c2f6a588-8d1a-44cb-af87-4741bf2812a3</UETR></PmtId><IntrBkSttlmAmt Ccy=\"GBP\">9.09</IntrBkSttlmAmt><IntrBkSttlmDt>1909-11-12</IntrBkSttlmDt><ChrgBr>DEBT</ChrgBr><Dbtr><Nm>DebtorName16</Nm></Dbtr><DbtrAcct><Id><IBAN>GB58CLRB04040009547509</IBAN></Id></DbtrAcct><DbtrAgt><FinInstnId><BICFI>LOYDGB22XXX</BICFI></FinInstnId></DbtrAgt><CdtrAgt><FinInstnId><BICFI>CLRBGB20XXX</BICFI></FinInstnId></CdtrAgt><CdtrAcct><Id><IBAN>GB57CLRB04040100057354</IBAN></Id></CdtrAcct><RmtInf><Ustrd>Reference17</Ustrd></RmtInf></CdtTrfTxInf></FIToFICstmrCdtTrf></Document>"
    },
    "Nonce": 1772448763
}

API

GBP Accounts

GBP Payments

Multi-currency/FX

Embedded Banking

Cheques

Cheques

Image requirements

Submit a cheque

Parameters

Request Payload (application/json)

request

Response (application/json)

OK

Bad request

Forbidden

Associated Webhooks