SEPA Credit Transfer

SEPA Credit Transfer (SCT) is a payment scheme that enables you to move euros between scheme participants. Transactions are capped at €999,999,999.99 per payment.

You can:

Send an SCT payment
Recall an SCT payment
Return an SCT payment (Integrating with recall and return is required.)
Receive and respond to an SCT recall request
Receive an SCT payment
Receive a returned SCT payment
Simulate SCT payment scenarios
You will be notified of incoming SCT payments via the SEPA CT Inbound Payment Completed webhook.

Inbound SCT payments can be received on Netherlands business days between 02:30 and 16:30 CET.

Outbound SCT payments can be sent on Netherlands business days between 07:00 and 16:00 CET. Transactions submitted after 16:00 or on bank holidays or weekends will be rejected. If a payment is submitted before the cut-off point but cannot be submitted to scheme, it will be placed in a queue until outbound payments reopen.

To send a payment, use the POST /payments/sepa-ct/v1/customer-payments endpoint. You will receive the SEPA CT Outbound Payment Completed webhook and the Customer Accounts Transaction Completed webhook.

A message flow diagram explaining how to send an SCT payment

Send an SCT outbound payment

post/payments/sepa-ct/v1/customer-payments

This endpoint is used to create an outbound SCT payment.

Parameters

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

Request Payload (application/json)

endToEndId string, Required
Unique identification, as assigned by the originating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Minimum length
1
Maximum length
35
Pattern
([0-9a-zA-Z\-\?:\.,'\+](/?([0-9a-zA-Z\-\?:\.,'\+ ]/?)*[0-9a-zA-Z\-\?:\.,'\+]+)?)
amount number, Required
Amount of money to be moved between the debtor and creditor, before deduction of charges.
Minimum
0.01
Maximum
999,999,999.99
currency string, Required
An active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
Minimum length
1
Pattern
^[A-Z]{3}$
debtor object, Required
creditor object, Required
creditorAgent object
remittanceInformationUnstructured string, Required
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts receivable system, in an unstructured form. Test the return of an SCT payment in the simulation environment by populating with '--SCTRETURN--'
Minimum length
1
Maximum length
140
Pattern
^[0-9a-zA-Z\-\?:\.,'\+]((?!//)([0-9a-zA-Z\-\?:\.,'\+/ ]))+[0-9a-zA-Z\-\?:\.,'\+]$

request

{
  "endToEndId": "End2EndId",
  "amount": "2.99",
  "currency": "EUR",
  "debtor": {
    "name": "John Doe",
    "accountIban": "NL73ABNA0529451824",
    "postalAddress": {
      "streetName": "My Street",
      "buildingNumber": "1",
      "townName": "London",
      "postCode": "XX99 9XX",
      "countrySubdivision": "London",
      "country": "GB"
    },
    "identification": {
      "organisationIdentification": {
        "bic": "BUKBNL20",
        "lei": "724500EAW1MTCM9M1X68",
        "other": {
          "identificationNumber": "123456789",
          "schemeNameCode": "BANK",
          "schemeNameProprietary": "SchemeName",
          "issuer": "IssuerName"
        }
      },
      "privateIdentification": {
        "dateAndPlaceOfBirth": {
          "dateOfBirth": "2004-05-15",
          "placeOfBirth": "Birth Town"
        },
        "other": "Other identification."
      }
    }
  },
  "creditor": {
    "name": "John Doe",
    "accountIban": "DE75512108001245126199",
    "postalAddress": {
      "streetName": "My Street",
      "buildingNumber": "1",
      "townName": "London",
      "postCode": "XX99 9XX",
      "countrySubdivision": "London",
      "country": "GB"
    },
    "identification": {
      "organisationIdentification": {
        "bic": "BUKBNL20"
      },
      "privateIdentification": {
        "dateAndPlaceOfBirth": {
          "dateOfBirth": "2004-05-15",
          "placeOfBirth": "Birth Town"
        },
        "other": "Other identification."
      }
    }
  },
  "creditorAgent": {
    "bic": "BUKBNL20"
  },
  "remittanceInformationUnstructured": "My remittance information."
}

Code copied

Response (application/json)

202 Accepted
400 Bad Request
409 Conflict

Accepted

{
  "paymentId": "1bfb7a86-7d9b-45ff-9d5c-34048efc4c8a"
}

Code copied

Bad Request

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

Code copied

Conflict

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

Code copied

Associated Webhooks

SEPA CT Outbound Payment Completed webhook
SEPA CT Outbound Payment Failed webhook
Customer Accounts Transaction Completed webhook

This webhook confirms an outgoing SCT payment has completed.

Request body

{
    "Type": "Sepa.Ct.OutboundPayment.Completed",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`PaymentId`	Required ClearBank identifier that uniquely identifies the payment instruction. Type: `string` Format: `guid` Max. Length: `36` Min. Length: `36` Pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
`TransactionId`	Required The ID of the debit transaction associated with this outbound payment. Type: `string` Format: `guid` Max. Length: `36` Min. Length: `36` Pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
`EndToEndIdentification`	Required Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Type: `string` Max. Length: `35` Min. Length: `1` Pattern: `^[^\n]{1,35}$`

Example SEPA CT Outbound Payment Completed webhook request body

{
    "Type": "Sepa.Ct.OutboundPayment.Completed",
    "Version": 1,
    "Payload": {
        "PaymentId": "061b687d-ef1e-4979-a086-669905545247",
        "TransactionId": "44abdea4-92f9-472a-975d-f5c901cc090e",
        "EndToEndIdentification": "f70w45r3cxbg15"
    },
    "Nonce": 163290462
}

Example webhook response

{
    "Nonce": 163290462
}

This webhook confirms a transaction has completed.

Request body

{
    "Type": "CustomerAccounts.TransactionCompleted",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Customer Accounts Transaction Completed webhook payload

Element	Description
`TransactionId`	Required Unique identification, assigned by ClearBank, to unambiguously identify the transaction. Type: `string`
`EndToEndIdentification`	Required The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. Type: `string`
`CreatedDateTime`	Required The date time in which the transaction was created in ClearBank's system. Type: `string`
`CompletedDateTime`	Required The date time on which the amount of money ceases to be available or becomes available to the account in ClearBank's system. Type: `string`
`ClearingChannel`	Required The clearing channel to be used to process the transaction. Type: `string`
`DebitCreditCode`	Required Movement of transaction. Type: `string`
`Amount`	Required Amount of money to be moved between the debtor and creditor. Type: `decimal`
`Currency`	Required Unit of currency is explicit and compliant with ISO 4217. Type: `string`
`RemittanceInformation`	Required Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. Unstructured data or flattened version of the structured data. Type: `string`
`CreditorAccount`	Required Unambiguous identification of the account of the debtor to which a debit entry is posted. Type: `object` `AccountId` Represents the account ID used within ClearBank's systems. Type: `string` `IBAN` The IBAN for the account. Type: `string` Max. Length: `34` `BBAN` The BBAN for the account. Type: `string` Max. Length: `30` `Descriptor` Represents an arbitrary account descriptor. Type: `string`
`DebtorAccount`	Required Unambiguous identification of the account of the creditor to which a credit entry is posted. Type: `object` `AccountId` Represents the account ID used within ClearBank's systems. Type: `string` `IBAN` The IBAN for the account. Type: `string` Max. Length: `34` `BBAN` The BBAN for the account. Type: `string` Max. Length: `30` `Descriptor` Represents an arbitrary account descriptor. Type: `string`

This webhook confirms an outgoing SCT payment request has failed.

Request body

{
    "Type": "Sepa.Ct.OutboundPayment.Failed",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`PaymentId`	Required ClearBank identifier that uniquely identifies the payment instruction. Type: `string` Format: `guid` Max. Length: `36` Min. Length: `36` Pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
`Reason`	Required Specifies the reason for the failure. Type: `string` Max. Length: `4` Min. Length: `1` Pattern: `^[^\n]{1,4}$`
`AdditionalInformation`	Required Further details on the reason. Type: `string` Max. Length: `105` Min. Length: `1`
`EndToEndIdentification`	Required Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Type: `string` Max. Length: `35` Min. Length: `1` Pattern: `^[^\n]{1,35}$`

Example SEPA CT Outbound Payment Failed webhook request body

{
    "Type": "Sepa.Ct.OutboundPayment.Failed",
    "Version": 1,
    "Payload": {
        "PaymentId": "f9902c78-f25d-4fb7-b29f-68cb3c0caf01",
        "Reason": "CODE",
        "AdditionalInformation": "AdditionalInformation",
        "EndToEndIdentification": "f70w45r3cxbg15"
    },
    "Nonce": 185037285
}

Example webhook response

{
    "Nonce": 185037285
}

Outbound payments may fail due to internal validation failure (the payment did not pass our internal validation rules) or external validation failure (the payment did not pass SEPA scheme or beneficiary bank validation rules).

When a payment fails, you'll receive an Outbound Payment Failed webhook, which includes a reason code specifying the reason for failure. The failure codes include, but are not limited to:

Reason code	Description	Internal validation failure	External validation failure
AB15	Account is held suspense account / account is repair suspense account	X
AC01	Account identifier invalid or incorrect	X	X
AC04	Account not active / closed	X	X
AC06	Blocked account	X	X
AM03	EUR currency not enabled	X
AM04	Insufficient funds	X	X
BE01	Account does not belong to institution	X
CB01	Unknown error	X	X
CB02	A valid creditor agent BIC cannot be derived from the supplied IBAN	X
CNOR	Creditor bank is not registered	X	X
CUST	Requested by customer		X
RR04	Regulatory reason		X

When you call our endpoints in simulation, any IBANs you provide are validated. To support your testing, refer to the below tables of valid and invalid IBANs:

Valid IBAN	Country
NL73ABNA0529451824	Netherlands
FR7630006000011234567890189	France
GB33BUKB20201555555555	UK
DE75512108001245126199	Germany
DK9520000123456789	Denmark
IE07BOFI900017556967	Ireland
PT88003506514393326125714	Portugal
ES7921000813610123456789	Spain
AT483200000012345864	Austria

Invalid IBAN	Country
GB20FMFX42731695687653	UK
NL51IKXV1050288017	Netherlands
BE66173933352443	Belgium
LT089128849492191749	Lithuania

Example Customer Accounts Transaction Completed webhook request body for inbound SCT payment

{
   "Type":"CustomerAccounts.TransactionCompleted",
   "Version":1,
   "Payload":{
      "TransactionId":"ce57422c-1276-4820-b97b-e7108f9c59cd",
      "EndToEndIdentification":"Inbound12345677",
      "CreatedDateTime":"2025-02-10T12:54:58.0766667Z",
      "CompletedDateTime":"2025-02-10T12:54:58.0966667Z",
      "ClearingChannel":"SEPA",
      "DebitCreditCode":"Credit",
      "Amount":1000.0,
      "Currency":"EUR",
      "RemittanceInformation":"Funding",
      "DebtorAccount":{
         "AccountId":null,
         "Iban":"NL51XBLT6087402426",
         "Bban":null,
         "Descriptor":null
      },
      "CreditorAccount":{
         "AccountId":"5602a737-675f-4c85-bbc1-d5d4b4478e64",
         "Iban":"NL25CLRB0066110527",
         "Bban":null,
         "Descriptor":null
      }
   },
   "Nonce":740685879
}

Example webhook response

{
    "Nonce": 740685879
}

Example Customer Accounts Transaction Completed webhook request body for outbound SCT payment

{
   "Type":"CustomerAccounts.TransactionCompleted",
   "Version":1,
   "Payload":{
      "TransactionId":"2a259909-e2b5-4bb5-ba91-5e40070ce901",
      "EndToEndIdentification":"4751967232218871296240",
      "CreatedDateTime":"2024-07-29T09:56:59.58Z",
      "CompletedDateTime":"2024-07-29T10:00:23.82Z",
      "ClearingChannel":"SEPA",
      "DebitCreditCode":"Debit",
      "Amount":224.0,
      "Currency":"EUR",
      "RemittanceInformation":"deposit",
      "DebtorAccount":{
         "AccountId":"c182ac1e-3f15-4b58-b9c3-22719a6b6461",
         "Iban":"NL74CLRB0113702695",
         "Bban":null,
         "Descriptor":null
      },
      "CreditorAccount":{
         "AccountId":null,
         "Iban":"NL32INGB0000092273",
         "Bban":null,
         "Descriptor":null
      }
   },
   "Nonce":437327901
}

Example webhook response

{
    "Nonce": 437327901
}

This webhook confirms an inbound SCT payment request has completed.

Request body

{
    "Type": "Sepa.Ct.InboundPayment.Completed",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`PaymentId`	Required ClearBank identifier that uniquely identifies the payment instruction. Type: `guid` Max. Length: `36` Min. Length: `36` Pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
`EndToEndIdentification`	Required Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Type: `string` Max. Length: `35` Min. Length: `1` Pattern: `^[^\n]{1,35}$`
`InstructedAmount`	Required A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217. `Amount` Type: `number` Format: `decimal` `Currency` Type: `string` Min. Length: `1` Pattern: `^[A-Z]{3}$`
`Debtor`	Required Party that owes an amount of money to the (ultimate) creditor. Required `Name` The name used to identify the legal owner of the account from which to debit funds. Type: `string` Min. Length: `1` Max Length: `140` Required `PostalAddress` Debtor address that locates and identifies a specific address, as defined by postal services. Type: `object` `BuildingNumber` Number that identifies the position of a building on a street. Type: `string` or `null` Max Length: `16` Min. Length: `1` `BuildingName` Name of the building or house. Type: `string` or `null` Max Length: `35` Min. Length: `1` `StreetName` Name of a street or thoroughfare. Type: `string` or `null` Max Length: `70` Min. Length: `1` `TownName` Name of a built-up area, with defined boundaries, and a local government. Type: `string` or `null` Max Length: `35` Min. Length: `1` `Country` Nation with its own government. Type: `string` or `null` Pattern: `[A-Z]{2,2}` `PostCode` Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. Type: `string` or `null` Max Length: `16` Min. Length: `1`
`Creditor`	Required Party that is owed an amount of money. Required `Name` The name used to identify the legal owner of the account to which to credit funds. Type: `string` Min. Length: `1` Max Length: `140` Required `PostalAddress` Debtor address that locates and identifies a specific address, as defined by postal services. Type: `object` `BuildingNumber` Number that identifies the position of a building on a street. Type: `string` or `null` Max Length: `16` Min. Length: `1` `BuildingName` Name of the building or house. Type: `string` or `null` Max Length: `35` Min. Length: `1` `StreetName` Name of a street or thoroughfare. Type: `string` or `null` Max Length: `70` Min. Length: `1` `TownName` Name of a built-up area, with defined boundaries, and a local government. Type: `string` or `null` Max Length: `35` Min. Length: `1` `Country` Nation with its own government. Type: `string` or `null` Pattern: `[A-Z]{2,2}` `PostCode` Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. Type: `string` or `null` Max Length: `16` Min. Length: `1`
`DebtorAccount`	Required Type: `object` `Iban` International Bank Account Number associated with the debtor account to which a debit entry will be made as a result of the transaction. Min. Length: `1` Pattern: `[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}`
`CreditorAccount`	Required Type: `object` `Iban` International Bank Account Number associated with the creditor account to which a credit entry will be made as a result of the transaction. Min. Length: `1` Pattern: `[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}`
`TransactionId`	Required The ID of the debit transaction associated with this outbound payment. Type: `string` Format: `guid` Max. Length: `36` Min. Length: `36` Pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
`TransactionReference`	Optional Provides contextual information about the payment. For outbound SCT transactions, this will match the information supplied in the RemittanceInformationUnstructured field. For inbound SCT transactions, this provides unstructured remittance information; structured information if unstructured is not provided; otherwise NOTPROVIDED. Type: `string` Max. Length: `143` Min. Length: `1`

Example SEPA CT Inbound Payment Completed webhook request body

{
    "Type": "Sepa.Ct.InboundPayment.Completed",
    "Version": 1,
    "Payload": {
        "PaymentId": "ad8021b5-0cd1-45bc-91e8-e47bea662f69",
        "EndToEndIdentification": "o3oytft7uo48uiy",
        "InstructedAmount": {
            "Amount": 100,
            "Currency": "EUR"
        },
        "Debtor": {
            "Name": "John Smith",
            "PostalAddress": {
                "BuildingNumber": "1",
                "BuildingName": "Building Name",
                "StreetName": "Street Name",
                "TownName": "Amsterdam",
                "Country": "NL",
                "PostCode": "1234AB"
            }
        },
        "Creditor": {
            "Name": "John Smith",
            "PostalAddress": {
                "BuildingNumber": "1",
                "BuildingName": "Building Name",
                "StreetName": "Street Name",
                "TownName": "Amsterdam",
                "Country": "NL",
                "PostCode": "1234AB"
            }
        },
        "DebtorAccount": {
            "Iban": "GB24BKEN10000031510604"
        },
        "CreditorAccount": {
            "Iban": "GB24BKEN10000031510604"
        },
        "TransactionId": "a4a5fc68-2109-4931-adbc-a7af92a4d203",
        "TransactionReference": "InvoiceID746881496675415799854"
        },
    "Nonce": 758387779
}

Example webhook response

{
    "Nonce": 758387779
}

You can send an SCT recall requests using the POST /payments/sepa-ct/v1/recall endpoint. Recalls can take up to 15 business days.

If your recall request has been accepted, you will be notified via the SEPA CT Outbound Payment Return Completed and Customer Accounts Transaction Completed webhooks.
If your recall request has been rejected, you will be notified via the SEPA CT Outbound Payment Recall Rejected webhook.

A message flow diagram explaining how to an SCT recall request is sent, then accepted or rejected by the original creditor

Recalls can be requested using the following reason codes:

Reason	Description	Time limit to send recall request
DUPL	Duplicate sending	10 business days
TECH	Technical problems resulting in an erroneous SCT Transaction	10 business days
FRAD	Fraudulent originated SCT Instruction	13 months
AC03	Wrong account number in original transfer	13 months
AM09	Wrong amount in original transfer	13 months
CUST	Requested by customer	13 months

Request an SCT payment recall

post/payments/sepa-ct/v1/recall

This endpoint is used to request a recall for an outbound SCT payment.

Parameters

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

Request Payload (application/json)

paymentId string, Required
Unique identifier of the Outbound SCT payment to be recalled.
Maximum length
36
Pattern
[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}
recallCode string, Required
Reason code to recall an Outbound SCT Payment
Minimum length
4
Maximum length
4
Pattern
^[A-Z0-9]{1,4}$
additionalInfo string
Additional Information
Minimum length
1
Maximum length
105
Pattern
^[0-9a-zA-Z\-\?:\.,'\+]((?!//)([0-9a-zA-Z\-\?:\.,'\+/ ]))+[0-9a-zA-Z\-\?:\.,'\+]$

request

{
  "paymentId": "1bfb7a86-7d9b-45ff-9d5c-34048efc4c8a",
  "recallCode": "CUST",
  "additionalInfo": "Some additional information."
}

Code copied

Response (application/json)

202 Accepted
400 Bad Request
409 Conflict

Bad Request

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

Code copied

Conflict

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

Code copied

Associated Webhooks

SEPA CT Outbound Payment Return Completed webhook
Customer Accounts Transaction Completed webhook
SEPA CT Outbound Payment Recall Rejected webhook

This webhook confirms an outgoing SCT payment return has completed.

Request body

{
    "Type": "Sepa.Ct.OutboundPayment.ReturnCompleted",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`PaymentId`	Required ClearBank identifier that uniquely identifies the payment instruction. Type: `string` Format: `guid` Max. Length: `36` Min. Length: `36` Pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
`TransactionId`	Required The ID of the credit transaction associated with this returned outbound payment. Type: `string` Format: `guid` Max. Length: `36` Min. Length: `36` Pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
`Reason`	Required Specifies the reason for the return. Type: `string` Max. Length: `4` Min. Length: `1` Pattern: `^[^\n]{1,4}$`
`EndToEndIdentification`	Required Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Type: `string` Max. Length: `35` Min. Length: `1` Pattern: `^[^\n]{1,35}$`

Example SEPA CT Outbound Payment Return Completed webhook request body

{
    "Type": "Sepa.Ct.OutboundPayment.ReturnCompleted",
    "Version": 1,
    "Payload": {
        "PaymentId": "061b687d-ef1e-4979-a086-669905545247",
        "TransactionId": "44abdea4-92f9-472a-975d-f5c901cc090e",
        "Reason": "AC06",
        "EndToEndIdentification": "tg8lHRTzQUX7HXKqCoGoJa5pwZOSKSnlgNE"
    },
    "Nonce": 593865028
}

Example webhook response

{
    "Nonce": 593865028
}

This webhook confirms when your outbound SCT payment recall request is rejected.

Request body

{
    "Type": "Sepa.Ct.OutboundPayment.RecallRejected",
    "Version": 1,
    "Payload": {...},
    "Nonce": 
}

Payload

Element	Description
`PaymentId`	Required ClearBank identifier that uniquely identifies the payment instruction. Type: `string` Format: `guid` Max. Length: `36` Min. Length: `36` Pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
`Reason`	Required Specifies the reason code for the recall rejection. Type: `string` Max. Length: `4` Min. Length: `1` Pattern: `^[^\n]{1,4}$`
`EndToEndIdentification`	Required Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Type: `string` Max. Length: `35` Min. Length: `1`

Example SEPA CT Outbound Payment Recall Rejected webhook request body

{
    "Type": "Sepa.Ct.OutboundPayment.RecallRejected",
    "Payload": {
        "PaymentId": "f9902c78-f25d-4fb7-b29f-68cb3c0caf01",
        "Reason": "CUST",
        "EndToEndIdentification": "e20w26d5cxbg15"
    },
    "Nonce": 185447285
}

Example webhook response

{
    "Nonce": 185447285
}

You may receive a recall request via the SEPA CT Inbound Payment Recalled webhook. You can review the details of the request by referring to the 'PaymentId' for details of the original payment received and 'CancellationReasonInformation' for the reason the sending party is requesting the recall (see recall request reason codes).

To respond to the recall request, use the /v1/payments/sepa/{paymentId}/recall-response endpoint. Recall requests should be responded to within 15 business days. If after 15 business days you do not accept or reject the recall, ClearBank will automatically reject the request.

You can accept the recall request by setting the RecallResponseAccepted boolean to true.

A message flow diagram showing how to accept an inbound SCT recall request

If you do not agree with the reason for the recall cited by the requesting party in the CancellationReasonInformation field, you can reject the recall request by setting the RecallResponseAccepted boolean to false. When rejecting a recall request, the 'RejectCode' field must be populated (see recall response reason codes).

A message flow diagram showing how to reject an inbound SCT recall request

Recalls can be accepted with the following reason code:

Reason	Description
FOCR	Following cancellation request

Recalls can be rejected for the following reason codes:

Reason	Description
AC04	Closed account number
NOOR	No original transaction received
AM04	Insufficient funds
ARDT	Already returned transaction
NOAS	No answer from customer
LEGL	Legal decision
CUST	Customer decision

Recall requests should be responded to within 15 business days.

This webhook confirms an inbound SCT payment has had a recall request.

Request body

{
    "Type": "Sepa.Ct.InboundPayment.Recalled",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`PaymentId`	Required ClearBank identifier that uniquely identifies the payment instruction. Type: `string` Format: `guid` Max. Length: `36` Min. Length: `36` Pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
`CancellationReasonInformation`	Required Information describing the reason for the cancellation request. Type: `object` Required `Reason` Type: `string` Max. Length: `4` Min. Length: `1` Optional `AdditionalInformation` Type: `string` or `null` Max. Length: `105` Min. Length: `0`
`EndToEndIdentification`	Required Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Type: `string` Max. Length: `35` Min. Length: `1` Pattern: `^[^\n]{1,35}$`

Example SEPA CT Inbound Payment Recalled Request webhook request body

{
    "Type":"Sepa.Ct.InboundPayment.Recalled",
    "Version": 1,
    "Payload": {
        "PaymentId": "31d42c5d-fa7f-4385-86e3-1ee9e2d60142",
        "CancellationReasonInformation": {
            "Reason": "CODE",
            "AdditionalInformation": "AdditionalInformation"
        },
        "EndToEndIdentification": "5v8flwwosny59jsdg9t"
    },
    "Nonce": 185769097
}

Example webhook response

{
    "Nonce": 185769097
}

Respond to an SCT recall request

post/payments/sepa-ct/v1/recall-response

This endpoint is used to approve or reject a recall request of an inbound SCT payment.

Parameters

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

Request Payload (application/json)

paymentId string, Required
Unique identifier of the Inbound SCT payment to be recalled.
Maximum length
36
Pattern
[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}
recallResponseAccepted boolean, Required
Accept or reject a request for recall of an SCT inbound payment
rejectCode string
Reason code required if recall request is rejected
Minimum length
4
Maximum length
4
Pattern
^[A-Z0-9]{1,4}$
additionalInfo string
Additional information
Minimum length
1
Maximum length
105
Pattern
^[0-9a-zA-Z\-\?:\.,'\+]((?!//)([0-9a-zA-Z\-\?:\.,'\+/ ]))+[0-9a-zA-Z\-\?:\.,'\+]$

request

{
  "paymentId": "1bfb7a86-7d9b-45ff-9d5c-34048efc4c8a",
  "recallResponseAccepted": "True",
  "rejectCode": "CUST",
  "additionalInfo": "Additional details."
}

Code copied

Response (application/json)

202 Accepted
400 Bad Request

Bad Request

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

Code copied

Associated Webhooks

SEPA CT Inbound Payment Recalled webhook

SCT payments can also be returned to the payment originator.

You can return a payment using the POST /payments/sepa-ct/v1/payment-returns endpoint. You can only return a payment after receiving the SEPA CT Inbound Payment Completed webhook. Returns must be sent within three business days of the original payment's settlement date.

A message flow diagram explaining how to send an SCT return

Once the return has been processed, you will either receive the SEPA CT Inbound Payment Return Completed and Customer Accounts Transaction Completed webhooks or the SEPA CT Inbound Payment Return Failed webhook.

Return an SCT payment

post/payments/sepa-ct/v1/payment-returns

This endpoint is used to return an inbound SCT payment.

Parameters

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

Request Payload (application/json)

paymentId string, Required
Unique identifier of the payment to be returned.
Maximum length
36
Pattern
[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}

request

{
  "paymentId": "b907589a-f3c5-4328-84c5-c83df6f66d07"
}

Code copied

Response (application/json)

202 Accepted
400 Bad Request
409 Conflict

Bad Request

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

Code copied

Conflict

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

Code copied

Associated Webhooks

SEPA CT Inbound Payment Return Completed webhook
SEPA CT Inbound Payment Return Failed webhook
Customer Accounts Transaction Completed webhook

This webhook confirms an inbound SCT payment return has completed.

Request body

{
    "Type": "Sepa.Ct.InboundPayment.ReturnCompleted",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`PaymentId`	Required ClearBank identifier that uniquely identifies the payment instruction. Type: `string` Format: `guid` Max. Length: `36` Min. Length: `36` Pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
`TransactionId`	Required The ID of the debit transaction associated with this outbound payment. Type: `string` Format: `guid` Max. Length: `36` Min. Length: `36` Pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
`EndToEndIdentification`	Required Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Type: `string` Max. Length: `35` Min. Length: `1` Pattern: `^[^\n]{1,35}$`

Example SEPA CT Inbound Payment Return Completed webhook request body

{
    "Type":"Sepa.Ct.InboundPayment.ReturnCompleted",
    "Version": 1,
    "Payload": {
        "PaymentId": "cc8cf403-a31e-47bd-aafb-4584b7a24921",
        "TransactionId": "b2c95a9f-f132-4916-9e93-74eb2a32b6fd",
        "EndToEndIdentification": "0l99ff01jw6qq1p2j76wwe"
    },
    "Nonce": 294701747
}

Example webhook response

{
    "Nonce": 294701747
}

This webhook confirms an inbound SCT payment return has failed.

Request body

{
    "Type": "Sepa.Ct.InboundPayment.ReturnFailed",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`PaymentId`	Required ClearBank identifier that uniquely identifies the payment instruction. Type: `string` Format: `guid` Max. Length: `36` Min. Length: `36` Pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
`Reason`	Required Specifies the reason for the failure. Type: `string` Max. Length: `4` Min. Length: `1` Pattern: `^[^\n]{1,4}$`
`AdditionalInformation`	Required Further details on the reason. Type: `string` Max. Length: `105` Min. Length: `1`
`EndToEndIdentification`	Required Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Type: `string` Max. Length: `35` Min. Length: `1` Pattern: `^[^\n]{1,35}$`

Example SEPA CT Inbound Payment Return Failed webhook request body

{
    "Type":"Sepa.Ct.InboundPayment.ReturnFailed",
    "Version": 1,
    "Payload": {
        "PaymentId": "cf983933-4d16-4a5c-9b30-e4af270c694b",
        "Reason": "CODE",
        "AdditionalInformation": "AdditionalInformation",
        "EndToEndIdentification": "akt6m60quuv9"
    },
    "Nonce": 121582053
}

Example webhook response

{
    "Nonce": 121582053
}

You will be notified of a successful SCT return payment via the SEPA CT Outbound Payment Return Completed webhook.

This webhook confirms an outgoing SCT payment return has completed.

Request body

{
    "Type": "Sepa.Ct.OutboundPayment.ReturnCompleted",
    "Version": 1,
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`PaymentId`	Required ClearBank identifier that uniquely identifies the payment instruction. Type: `string` Format: `guid` Max. Length: `36` Min. Length: `36` Pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
`TransactionId`	Required The ID of the credit transaction associated with this returned outbound payment. Type: `string` Format: `guid` Max. Length: `36` Min. Length: `36` Pattern: `^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$`
`Reason`	Required Specifies the reason for the return. Type: `string` Max. Length: `4` Min. Length: `1` Pattern: `^[^\n]{1,4}$`
`EndToEndIdentification`	Required Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Type: `string` Max. Length: `35` Min. Length: `1` Pattern: `^[^\n]{1,35}$`

Example SEPA CT Outbound Payment Return Completed webhook request body

{
    "Type": "Sepa.Ct.OutboundPayment.ReturnCompleted",
    "Version": 1,
    "Payload": {
        "PaymentId": "061b687d-ef1e-4979-a086-669905545247",
        "TransactionId": "44abdea4-92f9-472a-975d-f5c901cc090e",
        "Reason": "AC06",
        "EndToEndIdentification": "tg8lHRTzQUX7HXKqCoGoJa5pwZOSKSnlgNE"
    },
    "Nonce": 593865028
}

Example webhook response

{
    "Nonce": 593865028
}

The following will allow you to test SCT payment scenarios in the ClearBank simulation environment.

Simulate an inbound SCT payment

post/v1/payments/sepa-ct/emulator/inbound/payment

Simulates an inbound SCT payment for testing purposes in the ClearBank simulation environment.

Parameters

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

Request Payload (application/json)

amount number, Required
Amount of money to be moved between the debtor and creditor, before deduction of charges.
Pattern
[0-9]{0,15}([\.]([0-9]{0,2})){0,1}
creditorAccount string, Required
International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer.
Minimum length
1
Pattern
[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
endToEndId string, Required
Unique identification, as assigned by the originating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
Minimum length
1
Pattern
([0-9a-zA-Z\-\?:\.,'\+](/?([0-9a-zA-Z\-\?:\.,'\+ ]/?)*[0-9a-zA-Z\-\?:\.,'\+]+)?)
reference string, Required
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts receivable system, in an unstructured form
Minimum length
1
Maximum length
140
Pattern
^[0-9a-zA-Z\-\?:\.,'\+]((?!//)([0-9a-zA-Z\-\?:\.,'\+/ ]))+[0-9a-zA-Z\-\?:\.,'\+]$
debtorAgentBic string, Required
Business identifier code (BIC) - Code allocated to a financial institution by the ISO 9362 Registration Authority
Minimum length
1
Pattern
[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}

request

{
  "amount": "2.99",
  "creditorAccount": "GB33BUKB20201555555555",
  "endToEndId": "End2EndId",
  "reference": "TestReference",
  "debtorAgentBic": "BUKBGB20"
}

Code copied

Response (application/json)

202 Accepted
400 Bad Request

Bad Request

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

Code copied

Associated Webhooks

SEPA CT Outbound Payment Completed webhook
Customer Accounts Transaction Completed webhook

To simulate the return of an SCT payment in the simulation environment, use the Send an SCT payment endpoint with the remittanceInformationUnstructured field populated with --SCTRETURN--. This will simulate an outbound SCT payment settling and then being returned by the creditor.

Receipt of the SEPA CT Outbound Payment Return Completed webhook confirms the return payment.

"remittanceInformationUnstructured": "--SCTRETURN--"

SEPA Credit Transfer