transaction-rejected-v2.mdx

title	version	webhook
Transaction Rejected webhook	2	true

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: number Format: decimal
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: 140
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 andBBAN. 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
}