Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FPS abusive message filter enhancement, transaction rejected webhook type updated #115

Merged
merged 1 commit into from Jan 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions content-new/docs/api/getting-started.mdx
Expand Up @@ -13,8 +13,8 @@ This authentication profile includes your Digital Certificate and secure API tok

| Environment | ClearBank Portal URL |What you need for access|
|-------------------------|-----|---|
| Simulation | https://institution-sim.clearbank.co.uk/ | - Login credentials for the Institution Portal (these are provided to you during the onboarding process) <br/> - Your authentication profile|
| Production | https://institution.clearbank.co.uk/ | - Login credentials for the Institution Portal (these are provided to you during the onboarding process) <br/> - A generic authenticator app such as Microsoft Authenticator (or for pre-migration users, the ClearBank Authenticator app) registered with your Android, iOS or Windows device <br/> - Your authentication profile |
| Simulation | https://institution-sim.clearbank.co.uk/ | - Sign in credentials for the ClearBank Portal (these are provided to you during the onboarding process) <br/> - Your authentication profile|
| Production | https://institution.clearbank.co.uk/ | - Sign in credentials for the ClearBank Portal (these are provided to you during the onboarding process) <br/> - A generic authenticator app such as Microsoft Authenticator (or for pre-migration users, the ClearBank Authenticator app) registered with your Android, iOS or Windows device <br/> - Your authentication profile |

### Create your authentication profile

Expand Down
2 changes: 1 addition & 1 deletion content-new/docs/lookup/webhook-lookup-table.mdx
Expand Up @@ -50,7 +50,7 @@ The rows are ordered alphabetically based on the webhook type.
| [Payments.Mccy.PaymentValidationFailed](../multi-currency/multi-currency-payments#multi-currency-payment-validation-failed-webhook) | 1 | Notification that a multi-currency payment has failed validation |
| [PaymentMessageAssesmentFailed](../uk-payments/faster-payments#payment-message-assessment-failed-webhook) | 1 | Notification that a payment assessment has failed |
| [PaymentMessageValidationFailed](../uk-payments/faster-payments#payment-message-validation-failed-webhook) | 1 | Notification that a payment validation has failed |
| [TransactionRejectedV2](../uk-payments/faster-payments#transaction-rejected-webhook) | 2 | Notification that a payment validation has failed |
| [TransactionRejected](../uk-payments/faster-payments#transaction-rejected-webhook) | 2 | Notification that a payment validation has failed |
| [TransactionSettled](../uk-payments/faster-payments#transaction-settled-webhook) | 6 | Notification that a transaction has settled |
| [VirtualAccountCreated](../gbp-accounts/manage-accounts#virtual-account-created-webhook) | 3 | Notification that a virtual account has been created |
| [VirtualAccountCreationFailed](../gbp-accounts/manage-accounts#virtual-account-creation-failed-webhook) | 3 | Notification that a virtual account creation has failed |
12 changes: 10 additions & 2 deletions content-new/docs/uk-payments/faster-payments.mdx
Expand Up @@ -41,9 +41,17 @@ This endpoint uses the endToEndIdentification field as a duplicate check to ensu

To protect payment recipients from harm and abuse, outbound payments are subject to screening to check for profanities.

The screening checks the `Reference` string of the `RemittanceInformation` object. If any part of this string matches a term on the profanity list, it will be removed and the field will be blank when the payment reaches the beneficiary.
The screening checks the `Reference` string of the `RemittanceInformation` object. If any term in this string matches a term on the profanity list, it will be removed and the field will be blank when the payment reaches the beneficiary.

References will be removed if they match terms found in (but not limited to) the Pay.UK profanities list that can be found on the Reference Documents page of the Knowledge Centre. This can be accessed by signing in to the [ClearBank Portal](https://clearbank.github.io/docs/api/getting-started).

The result of the screening can be found in the `SupplementaryData` object of the Transaction Settled webhook as follows:

| Abusive message screening result | Supplementary Data value |
|--------------------------------------|-------------------------------|
| Pass (no match) | `AbusiveMessageScreeningResult:Pass` |
| Fail (match) | `AbusiveMessageScreeningResult:Fail`<br /> `AbusiveMessageScreeningIdentifiers:paymentInstruction.creditTransfer.remittanceInformation.structured.creditorReferenceInformation.reference` |

References will be removed if they contain profanity as per (but not limited to) the Pay.UK list of profanities that can be found on the Reference Documents page of the Knowledge Centre. This can be accessed by signing in to the ClearBank Portal.

<EndpointBlock
type="post"
Expand Down
4 changes: 2 additions & 2 deletions webhooks/transaction-rejected-v2.mdx
Expand Up @@ -10,7 +10,7 @@ This webhook confirms the payment has been rejected.

```json
{
"Type":"TransactionRejectedV2",
"Type":"TransactionRejected",
"Version":2,
"Payload": {...},
"Nonce":
Expand Down Expand Up @@ -40,7 +40,7 @@ This webhook confirms the payment has been rejected.

```json
{
"Type":"TransactionRejectedV2",
"Type":"TransactionRejected",
"Version":2,
"Payload":{
"TransactionId":"073dca79-13b8-8bf2-b63b-148957caffe9",
Expand Down
2 changes: 1 addition & 1 deletion webhooks/transaction-settled-webhook-v6.mdx
Expand Up @@ -41,7 +41,7 @@ This webhook confirms the transaction has settled. For Bacs payments, this is se
| `BacsTransactionDescription` | *(Optional)*<br /> `CreditTransactionSettled`<br /> `DebitContraTransactionSettled`<br /> `DebitTransactionSettled`<br /> `CreditContraTransactionSettled`<br /> `DirectDebitReceivedIndemnityClaimSettled`|
| `TransactionType` | *(Optional)* <br /> `DirectCredit`<br /> `DirectDebit`<br /> `DirectDebitIndemnityClaim`|
| `TransactionSource` | *(Optional)*<br />Origination of the Transaction :<br /> Max. length: `50` <br /> Example: `CardProcessor`|
| `SupplementaryData` | *(Optional)*<br />Transaction supplementary data<br /> It is an array with the a `Name` and `Value`. <br /><br /> `Name`: Field Number/Name for an inbound CHAPS or FPS message. <br />Max. length: `33` <br /> `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` <br /><br /> `Value`<br /> Max. length: `500` <br /><br /> **There could be more than one Name and Value pair.**|
| `SupplementaryData` | *(Optional)*<br />Transaction supplementary data<br /> It is an array with the a `Name` and `Value`. <br /><br /> `Name`: Field Number/Name for an inbound CHAPS or FPS message. <br />Max. length: `33` <br /> `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` <br /><br /> `Value`<br /> Max. length: `500` <br /><br /> **There could be more than one Name and Value pair.**|
| `Iso20022XmlDocument` | *(Optional)*<br />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. <br />Type: `string`<br /> Min. Length: `0`<br /> Max. Length: `80000` <br />|
| `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.|

Expand Down