T2 | ClearBank Developer Portal

T2, formerly known as TARGET2, is the Real Time Gross Settlement payment scheme for euro payments. It uses ISO 20022 message formats.

T2 has no transaction limit, making it suitable for high-value payments. Transactions are processed in euros using central bank money. When you submit a payment, we send a settlement request to the RTGS system. This processes the request and, upon approval, debits ClearBank and credits the recipient bank. It also sends a settlement confirmation.

T2 message flow diagram

Customer payments (pacs.008) are payments that have either your or another financial institution's (FI) customer as the ultimate debtor or creditor.

Institution payments (pacs.009) are exclusively for FI to FI payments. If you attempt to send an institution payment to an end-user account, the payment will be returned. However, you'll still be charged a processing fee for the payment.

Return payments (pacs.004) are payments returned to either your customer or a financial institution.

There are three endpoints you can use to submit or return T2 payments:

Endpoint	Purpose	Completed webhook	Failed webhook
/payments/t2-rtgs/v1/customer-payments	Send a T2 payment (pacs.008)	T2 Customer Credit Transfer Outbound Completed webhook	T2 Customer Credit Transfer Outbound Failed webhook
/payments/t2-rtgs/v1/payment-returns	Return a T2 payment (pacs.004)	T2 Payment Return Outbound Completed webhook	T2 Payment Return Outbound Failed webhook
/payments/t2-rtgs/v1/institution-payments	Send a T2 payment to an institution (pacs.009)	T2 Financial Institution Outbound Credit Transfer Completed webhook	T2 Financial Institution Outbound Credit Transfer Failed webhook

There are also webhooks for incoming payments:

The T2 Customer Credit Transfer Inbound Completed webhook is for incoming customer payments
The T2 Payment Return Inbound Completed webhook is for incoming returns
The T2 Financial Institution Inbound Transfer Completed webhook is for incoming payments from financial institutions

You can receive T2 payments Monday - Friday, 02:30 - 18:00 CET.

You can send pacs.008 and pacs.004 payments Monday - Friday, 07:00 - 17:00 CET, with pacs.009 extended until 18:00 CET. Outside of these operating hours, outgoing payments will be rejected.

T2 does not operate on the following days:

New Year's Day (1 January)
Good Friday
Easter Monday
Labour Day (1 May)
Christmas Day (25 December)
Boxing Day (26 December)

To send a T2 payment, use the /payments/t2-rtgs/v1/customer-payments endpoint. You will receive the T2 Customer Credit Transfer Outbound Completed webhook when the payment successfully goes through.

T2 send a payment message flow diagram

If the payment fails, you will receive the T2 Customer Credit Transfer Outbound Failed webhook.

Send a T2 payment

post/payments/t2-rtgs/v1/customer-payments

This endpoint will send a T2 customer payment (pacs.008).

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; valid for 24 hours, max length 83.

Request Payload (application/json)

sourceAccount object, Required
The ClearBank account that will be debited based on the successful completion of the payment instruction.
creditor object, Required
The name and, optionally, the legal entity identifier of the account.
creditorAccount object, Required
The creditor's bank account number. You must provide a value for the Iban OR the nonIban field.
creditorAgent object, Required
Information that identifies the creditor agent as a financial institution.
debtor object, Required
Details about the account holder.
debtorAccount object, Required
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
endToEndIdentification string, 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.
Minimum length
1
Maximum length
35
Pattern
[0-9a-zA-Z/\-\?:\.,'\+](|[0-9a-zA-Z/\-\?:\.,'\+]|[0-9a-zA-Z/\-\?:\.,'\+ ]{1,33}[0-9a-zA-Z/\-\?:\.,'\+])
instructionIdentification string, Required
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction.
Minimum length
1
Maximum length
35
Pattern
[0-9a-zA-Z/\-\?:\.,'\+](|[0-9a-zA-Z/\-\?:\.,'\+]|[0-9a-zA-Z/\-\?:\.,'\+ ]{1,33}[0-9a-zA-Z/\-\?:\.,'\+])
uetr string, Required
Universally unique identifier to provide an end-to-end reference of a payment transaction.
Pattern
[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}
interbankSettlementAmount object, 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.
exchangeRate number
Exchange rate applied to convert the currency of the source amount or OriginalCurrency (prior to deduction of charges) to EUR. Note: If the original payment is in euro, this field should be populated with `1`, or not be used.
instructedAmount object
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the original currency as ordered by the initiating party.
previousInstructingAgents array
Agents who were previously involved with the payment.
initiatingParty object
Information about the party that holds the initiating payment account.
ultimateCreditor object
Information about the ultimate creditor of the transaction.
ultimateDebtor object
Information about the ultimate debtor of the transaction (the party holding the ultimate debtor account).
purpose string
Underlying reason for the payment transaction, as published in an external purpose code list.
remittanceInformationUnstructured string
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, in an unstructured form.
Minimum length
1
Maximum length
140
Pattern
[0-9a-zA-Z/\-\?:\.,'\+!#$%&\*=^_`\{\|\}~";<>@\[\\\]](|[0-9a-zA-Z/\-\?:\.,'\+!#$%&\*=^_`\{\|\}~";<>@\[\\\]]|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\*=^_`\{\|\}~";<>@\[\\\]]{1,138}[0-9a-zA-Z/\-\?:\.,'\+!#$%&\*=^_`\{\|\}~";<>@\[\\\]])

request

{
  "sourceAccount": {
    "bicfi": "BKMGNL2A200",
    "iban": "NL02ABNA0123456789"
  },
  "creditor": {
    "name": "example party name",
    "postalAddress": {
      "streetName": "Lange Straat",
      "postCode": "5342 RX",
      "townName": "Eindhoven",
      "country": "NL"
    },
    "countryOfResidence": "NL",
    "organisationIdentification": {
      "anyBic": "BKMGNL2A200",
      "lei": "VQGYRMYR7KCX3QYROF33",
      "other": [
        {
          "identification": "ow6UuzfTxIEChCVivtN4q0wkychyjYS0VWH",
          "schemeName": "TXID",
          "issuer": "Example issuer identifier"
        }
      ]
    },
    "privateIdentification": {
      "dateAndPlaceOfBirth": {
        "birthDate": "1996-11-05",
        "cityOfBirth": "Amsterdam",
        "countryOfBirth": "NL",
        "provinceOfBirth": "Drenthe"
      },
      "other": [
        {
          "identification": "ow6UuzfTxIEChCVivtN4q0wkychyjYS0VWH",
          "schemeName": "TXID",
          "issuer": "Example issuer identifier"
        }
      ]
    }
  },
  "creditorAccount": {
    "iban": "NL02ABNA0123456789",
    "nonIban": "P1tVsMEG-dkL9uFgw:cmHBlMu-l5kLYwbW"
  },
  "creditorAgent": {
    "bicfi": "BKMGNL2A200"
  },
  "debtor": {
    "name": "example party name",
    "postalAddress": {
      "streetName": "Lange Straat",
      "postCode": "5342 RX",
      "townName": "Eindhoven",
      "country": "NL"
    },
    "countryOfResidence": "NL",
    "organisationIdentification": {
      "anyBic": "BKMGNL2A200",
      "lei": "VQGYRMYR7KCX3QYROF33",
      "other": [
        {
          "identification": "ow6UuzfTxIEChCVivtN4q0wkychyjYS0VWH",
          "schemeName": "TXID",
          "issuer": "Example issuer identifier"
        }
      ]
    },
    "privateIdentification": {
      "dateAndPlaceOfBirth": {
        "birthDate": "1996-11-05",
        "cityOfBirth": "Amsterdam",
        "countryOfBirth": "NL",
        "provinceOfBirth": "Drenthe"
      },
      "other": [
        {
          "identification": "ow6UuzfTxIEChCVivtN4q0wkychyjYS0VWH",
          "schemeName": "TXID",
          "issuer": "Example issuer identifier"
        }
      ]
    }
  },
  "debtorAccount": {
    "iban": "NL02ABNA0123456789"
  },
  "endToEndIdentification": "z6sU7U9b5RmFCX7dzTfZsEm4KGzJlLIl88F",
  "instructionIdentification": "Qa4UwIV2FIumfJUbqx6u1WsUOzHpu1rEVYz",
  "uetr": "7e238933-7787-4f67-9d92-fe6f474c60d7",
  "interbankSettlementAmount": {
    "amount": "5211.48",
    "currency": "EUR"
  },
  "exchangeRate": 1,
  "instructedAmount": {
    "amount": "5211.48",
    "currency": "EUR"
  },
  "previousInstructingAgents": [
    {
      "order": 0,
      "agent": {
        "name": "Example Party Name",
        "postalAddress": {
          "streetName": "Lange Straat",
          "townName": "Eindhoven",
          "country": "NL"
        },
        "bicfi": "BKMGNL2A200",
        "lei": "E3OVRVFF5D9U6VV7SX12"
      },
      "agentAccount": {
        "iban": "NL02ABNA0123456789"
      }
    }
  ],
  "initiatingParty": {
    "name": "example party name",
    "postalAddress": {
      "streetName": "Lange Straat",
      "postCode": "5342 RX",
      "townName": "Eindhoven",
      "country": "NL"
    },
    "countryOfResidence": "NL",
    "organisationIdentification": {
      "anyBic": "BKMGNL2A200",
      "lei": "VQGYRMYR7KCX3QYROF33",
      "other": [
        {
          "identification": "ow6UuzfTxIEChCVivtN4q0wkychyjYS0VWH",
          "schemeName": "TXID",
          "issuer": "Example issuer identifier"
        }
      ]
    },
    "privateIdentification": {
      "dateAndPlaceOfBirth": {
        "birthDate": "1996-11-05",
        "cityOfBirth": "Amsterdam",
        "countryOfBirth": "NL",
        "provinceOfBirth": "Drenthe"
      },
      "other": [
        {
          "identification": "ow6UuzfTxIEChCVivtN4q0wkychyjYS0VWH",
          "schemeName": "TXID",
          "issuer": "Example issuer identifier"
        }
      ]
    }
  },
  "ultimateCreditor": {
    "name": "example party name",
    "postalAddress": {
      "streetName": "Lange Straat",
      "postCode": "5342 RX",
      "townName": "Eindhoven",
      "country": "NL"
    },
    "countryOfResidence": "NL",
    "organisationIdentification": {
      "anyBic": "BKMGNL2A200",
      "lei": "VQGYRMYR7KCX3QYROF33",
      "other": [
        {
          "identification": "ow6UuzfTxIEChCVivtN4q0wkychyjYS0VWH",
          "schemeName": "TXID",
          "issuer": "Example issuer identifier"
        }
      ]
    },
    "privateIdentification": {
      "dateAndPlaceOfBirth": {
        "birthDate": "1996-11-05",
        "cityOfBirth": "Amsterdam",
        "countryOfBirth": "NL",
        "provinceOfBirth": "Drenthe"
      },
      "other": [
        {
          "identification": "ow6UuzfTxIEChCVivtN4q0wkychyjYS0VWH",
          "schemeName": "TXID",
          "issuer": "Example issuer identifier"
        }
      ]
    }
  },
  "ultimateDebtor": {
    "name": "example party name",
    "postalAddress": {
      "streetName": "Lange Straat",
      "postCode": "5342 RX",
      "townName": "Eindhoven",
      "country": "NL"
    },
    "countryOfResidence": "NL",
    "organisationIdentification": {
      "anyBic": "BKMGNL2A200",
      "lei": "VQGYRMYR7KCX3QYROF33",
      "other": [
        {
          "identification": "ow6UuzfTxIEChCVivtN4q0wkychyjYS0VWH",
          "schemeName": "TXID",
          "issuer": "Example issuer identifier"
        }
      ]
    },
    "privateIdentification": {
      "dateAndPlaceOfBirth": {
        "birthDate": "1996-11-05",
        "cityOfBirth": "Amsterdam",
        "countryOfBirth": "NL",
        "provinceOfBirth": "Drenthe"
      },
      "other": [
        {
          "identification": "ow6UuzfTxIEChCVivtN4q0wkychyjYS0VWH",
          "schemeName": "TXID",
          "issuer": "Example issuer identifier"
        }
      ]
    }
  },
  "purpose": "string",
  "remittanceInformationUnstructured": "example unstructured text"
}

Code copied

Response (application/json)

202 Accepted
400 Bad Request

Accepted

{
  "paymentId": "string"
}

Code copied

Bad Request

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

Code copied

Associated Webhooks

T2 Customer Credit Transfer Outbound Completed webhook
T2 Customer Credit Transfer Outbound Failed webhook
Customer Accounts Transaction Completed webhook

This webhook confirms a T2 customer credit transfer outbound payment has completed.

Request body

{
    "Type": "Target2.CustomerCreditTransfer.Outbound.Completed",
    "Version": 1,                                                         
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`InstructionId`	Required Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. Type: `string` Pattern: `[0-9a-zA-Z/\-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+]{1,33}[0-9a-zA-Z\/-?:().,''+])`
`Uetr`	Required Randomly generated UUID to provide an end-to-end reference of a payment transaction. Format: `guid` Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`
`TransactionId`	Required ID of the transaction used to move funds for this payment. Type: `guid` Format: `string` Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`
`PaymentId`	Required ClearBank internal identifier for this payment. Format: `string` Pattern: `[a-zA-Z0-9_-]{0,50}`
`EndToEndId`	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. Format: `string` Pattern: `[0-9a-zA-Z/\-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+]{1,33}[0-9a-zA-Z\/-?:().,''+])`

Example T2 Customer Credit Transfer Outbound Completed webhook request body

{
  "Type": "Target2.CustomerCreditTransfer.Outbound.Completed",
  "Version": 1,
  "Payload": {
    "EndToEndId": "eb713ec63e714eebaba05c67429224c5",
    "InstructionId": "494582c62a6747538a776067c4201ea9",
    "Uetr": "48ab1a10-36c2-46d9-800f-41b2ce684e0f",
    "TransactionId": "021b8daf-8554-4bef-bec5-ad7745022fba",
    "PaymentId": "Outbound_48ab1a1036c246d9800f41b2ce684e0f"
  },
  "Nonce": 1203694242
}

Example webhook response

{
    "Nonce": 1203694242
}

This webhook confirms a T2 customer credit transfer outbound payment has failed.

Request body

{
    "Type": "Target2.CustomerCreditTransfer.Outbound.Failed",
    "Version": 1,                                                         
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`InstructionId`	Required Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. Type: `string` Pattern: `[0-9a-zA-Z/\-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+]{1,33}[0-9a-zA-Z\/-?:().,''+])`
`Uetr`	Required Randomly generated UUID to provide an end-to-end reference of a payment transaction. Format: `guid` Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`
`PaymentId`	Required ClearBank internal identifier for this payment. Format: `string` Pattern: `[a-zA-Z0-9_-]{0,50}`
`EndToEndId`	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. Format: `string` Pattern: `[0-9a-zA-Z/\-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+]{1,33}[0-9a-zA-Z\/-?:().,''+])`
`Errors`	Required A list of reasons why the payment failed. Type: `array` Required `ErrorCode` ISO 20022/ClearBank code for why the payment failed. Type: `string` Max. Length: `4` Min. Length: `1` Required `AdditionalInformation` Text description of why the payment failed. Type: `string`

Example T2 Customer Credit Transfer Outbound Failed webhook request body

{
  "Type": "Target2.CustomerCreditTransfer.Outbound.Failed",
  "Version": 1,
  "Payload": {
    "EndToEndId": "eb713ec63e714eebaba05c67429224c5",
    "InstructionId": "e69df0ff97a7442591ee0570f8e71c52",
    "Uetr": "583fedc5-85f3-4a6f-adb5-5d115901a9a6",
    "PaymentId": "Outbound_583fedc585f34a6fadb55d115901a9a6",
    "Errors": [
      {
        "Reason": "AM03",
        "AdditionalInformation": "Account doesn't support EUR"
      }
    ]
  },
  "Nonce": 365827338
}

Example webhook response

{
    "Nonce": 365827338
}

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`
`InstitutionId`	Required Unique identification, assigned by ClearBank, to unambiguously identify the institution the transaction belongs to. 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: `string`
`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`

T2 webhook examples

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

{
   "Type":"CustomerAccounts.TransactionCompleted",
   "Version":1,
   "Payload":{
      "TransactionId":"70e7d2ff-bbb2-4f1f-90f0-f2221029447a",
      "EndToEndIdentification":"Inbound Payment",
      "CreatedDateTime":"2025-02-10T12:49:55.5733333Z",
      "CompletedDateTime":"2025-02-10T12:49:55.6Z",
      "ClearingChannel":"Target2",
      "DebitCreditCode":"Credit",
      "Amount":1000.0,
      "Currency":"EUR",
      "RemittanceInformation":"75030e66dc7844ed9e4a1266c9e8410f",
      "DebtorAccount":{
         "AccountId":null,
         "Iban":"NL17CLRB0126793871",
         "Bban":null,
         "Descriptor":null
      },
      "CreditorAccount":{
         "AccountId":"5602a737-675f-4c85-bbc1-d5d4b4478e64",
         "Iban":"NL25CLRB0066110527",
         "Bban":null,
         "Descriptor":null
      }
   },
   "Nonce":944609635
}

Example webhook response

{
    "Nonce": 944609635
}

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

{
   "Type":"CustomerAccounts.TransactionCompleted",
   "Version":1,
   "Payload":{
      "TransactionId":"a94a49f7-9007-419a-8722-bc45b0ddc7ec",
      "EndToEndIdentification":"46189668732340195406845",
      "CreatedDateTime":"2025-02-20T10:44:06.7833333Z",
      "CompletedDateTime":"2025-02-20T10:44:09.7633333Z",
      "ClearingChannel":"Target2",
      "DebitCreditCode":"Debit",
      "Amount":424.0,
      "Currency":"EUR",
      "RemittanceInformation":"Example Remittance",
      "DebtorAccount":{
         "AccountId":"c182ac1e-3f15-4b58-b9c3-22719a6b6461",
         "Iban":"NL74CLRB0113702695",
         "Bban":null,
         "Descriptor":null
      },
      "CreditorAccount":{
         "AccountId":null,
         "Iban":"NL91ABNA0417164300",
         "Bban":null,
         "Descriptor":null
      }
   },
   "Nonce":1269251375
}

Example webhook response

{
    "Nonce": 1269251375
}

SCT webhook examples

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
}

SCT Inst webhook examples

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

{
   "Type":"CustomerAccounts.TransactionCompleted",
   "Version":1,
   "Payload":{
      "TransactionId":"e05bfe3b-3187-28b1-340d-57d57a8739fa",
      "EndToEndIdentification":"12345678",
      "CreatedDateTime":"2025-02-10T12:52:43.7433333Z",
      "CompletedDateTime":"2025-02-10T12:52:43.7666667Z",
      "ClearingChannel":"SEPA-Instant",
      "DebitCreditCode":"Credit",
      "Amount":1000.0,
      "Currency":"EUR",
      "RemittanceInformation":"e05bfe3b-3187-28b1-340d-57d57a8739fa",
      "DebtorAccount":{
         "AccountId":null,
         "Iban":"GB68INST20182441739477",
         "Bban":null,
         "Descriptor":null
      },
      "CreditorAccount":{
         "AccountId":"5602a737-675f-4c85-bbc1-d5d4b4478e64",
         "Iban":"NL25CLRB0066110527",
         "Bban":null,
         "Descriptor":null
      }
   },
   "Nonce":263934935
}

Example webhook response

{
    "Nonce": 263934935
}

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

{
   "Type":"CustomerAccounts.TransactionCompleted",
   "Version":1,
   "Payload":{
      "TransactionId":"8fa1ceea-e592-480c-26fa-1fd040c89df1",
      "EndToEndIdentification":"0947eaf6-2b51-496b-afba-969a0a72f38",
      "CreatedDateTime":"2025-02-10T15:54:09.97Z",
      "CompletedDateTime":"2025-02-10T15:54:14.29Z",
      "ClearingChannel":"SEPA-Instant",
      "DebitCreditCode":"Debit",
      "Amount":100.0,
      "Currency":"EUR",
      "RemittanceInformation":"testing instant",
      "DebtorAccount":{
         "AccountId":"5602a737-675f-4c85-bbc1-d5d4b4478e64",
         "Iban":"NL25CLRB0066110527",
         "Bban":null,
         "Descriptor":null
      },
      "CreditorAccount":{
         "AccountId":null,
         "Iban":"DE25370502991000122343",
         "Bban":null,
         "Descriptor":null
      }
   },
   "Nonce":1778087803
}

Example webhook response

{
    "Nonce": 1778087803
}

To return a T2 payment, use the /payments/t2-rtgs/v1/payment-returns endpoint. You will receive the T2 Payment Return Outbound Completed webhook when the return successfully goes through.

T2 return a payment message flow diagram

If the return fails, you will receive the T2 Payment Return Outbound Failed webhook.

Return a T2 payment

post/payments/t2-rtgs/v1/payment-returns

This endpoint will send a payment return request (pacs.004).

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; valid for 24 hours, max length 83.

Request Payload (application/json)

originalUetr string, Required
Pattern
[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}
requestingParty string, Required
Enum array
Creditor, CreditorAgent, IntermediaryAgent3, IntermediaryAgent2, IntermediaryAgent1
reason string, Required
Payment reason codes, compliant with ISO 20022.
Minimum length
1
Maximum length
4
Enum array
AC01, AC03, AC04, AC06, AC13, AC14, AC15, AC16, AC17, AG01, AG02, AM01, AM02, AM03, AM04, AM05, AM06, AM07, AM09, AM10, ARDT, BE01, BE04, BE05, BE06, BE07, BE08, CN01, CNOR, CNPC, CURR, CUST, DNOR, DS28, DT01, DT02, ED01, ED03, ED05, EMVL, ERIN, FF05, FOCR, FR01, FRTR, MD01, MD02, MD06, MD07, MS02, MS03, NARR, NOAS, NOCM, NOOR, PINL, RC01, RC07, RF01, RR01, RR02, RR03, RR04, RUTA, SL01, SL02, SL11, SL12, SL13, SL14, SP01, SP02, SVNR, TM01, TRAC, UPAY, AGNT, FF06, RC08, BE11, BE17, AC02, RR11, BE10, BE16, RC11, RR12, FF03, FF07, FF04, RR09, RR05, RR07, RR08, RR06, AG07, G004, MD05, AC07, DC04
instructionIdentification string, Required
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction.
Minimum length
1
Maximum length
35
Pattern
[0-9a-zA-Z/\-\?:\.,'\+](|[0-9a-zA-Z/\-\?:\.,'\+]|[0-9a-zA-Z/\-\?:\.,'\+ ]{1,33}[0-9a-zA-Z/\-\?:\.,'\+])
SettlementAmount object
chargesInformation array
initiatingParty object
Information about the party that holds the initiating payment account.

request

{
  "originalUetr": "a9753bd1-1124-4898-b9ee-11ac88876ec0",
  "requestingParty": "Creditor",
  "reason": "AC01",
  "instructionIdentification": "LZWeaNrMpJzpENjQZy5sEfao96QAIoeDwRY",
  "SettlementAmount": {
    "amount": "1211.98",
    "currency": "EUR"
  },
  "chargesInformation": [
    {
      "bicfi": "BKMGNL2A200",
      "chargeAmount": {
        "amount": "1211.98",
        "currency": "EUR"
      }
    }
  ],
  "initiatingParty": {
    "name": "Example party name",
    "postalAddress": {
      "streetName": "Lange Straat",
      "postCode": "5644 RX",
      "townName": "Eindhoven",
      "country": "NL"
    },
    "countryOfResidence": "NL",
    "organisationIdentification": {
      "anyBic": "BKMGNL2A200",
      "lei": "5BCE02QVRU2NWB71G212",
      "other": [
        {
          "identification": "7YpaJHC4WHJcV1fufUNCHQEYpRvvO3OW0TJ",
          "schemeName": "TXID",
          "issuer": "Example issuer identifier"
        }
      ]
    },
    "privateIdentification": {
      "dateAndPlaceOfBirth": {
        "birthDate": "1984-11-24",
        "provinceOfBirth": "Utrecht",
        "cityOfBirth": "Zeist",
        "countryOfBirth": "NL"
      },
      "other": [
        {
          "identification": "7YpaJHC4WHJcV1fufUNCHQEYpRvvO3OW0TJ",
          "schemeName": "TXID",
          "issuer": "Example issuer identifier"
        }
      ]
    }
  }
}

Code copied

Response (application/json)

202 Accepted
400 Bad Request
404 Not Found

Accepted

{
  "paymentReturnId": "string"
}

Code copied

Bad Request

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

Code copied

Not Found

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

Code copied

Associated Webhooks

T2 Payment Return Outbound Completed webhook
T2 Payment Return Outbound Failed webhook
Customer Accounts Transaction Completed webhook

This webhook confirms a T2 return outbound payment has completed.

Request body

{
    "Type": "Target2.PaymentReturn.Outbound.Completed",
    "Version": 1,                                                         
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`ReturnInstructionId`	Required Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. Type: `string` Pattern: `[0-9a-zA-Z/\-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+]{1,33}[0-9a-zA-Z\/-?:().,''+])`
`Uetr`	Required Randomly generated UUID to provide an end-to-end reference of a payment transaction. Format: `guid` Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`
`TransactionId`	Required ID of the transaction used to move funds for this payment. Type: `guid` Format: `string` Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`
`PaymentReturnId`	Required ClearBank internal identifier for this payment. Format: `string` Pattern: `[a-zA-Z0-9_-]{0,50}`
`EndToEndId`	Required Unique identification, as assigned by the original initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Format: `string` Pattern: `[0-9a-zA-Z/\-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+]{1,33}[0-9a-zA-Z\/-?:().,''+])`

Example T2 Payment Return Outbound Completed webhook request body

  {
  "Type": "Target2.PaymentReturn.Outbound.Completed",
  "Version": 1,
  "Payload": {
    "EndToEndId": "eb713ec63e714eebaba05c67429224c5",
    "ReturnInstructionId": "b6a914c923bf4bbf9bed006e2ffd469b",
    "Uetr": "46e0bf29-38aa-4e16-9c2c-8497dacd5f58",
    "TransactionId": "7287d349-f36d-455e-896f-4b82a2c51096",
    "PaymentReturnId": "return_46e0bf2938aa4e169c2c8497dacd5f58"
  },
  "Nonce": 1540026201
}

Example webhook response

{
    "Nonce": 1540026201
}

This webhook confirms a T2 return outbound payment has failed.

Request body

{
    "Type": "Target2.PaymentReturn.Outbound.Failed",
    "Version": 1,                                                         
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`ReturnInstructionId`	Required Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. Type: `string` Pattern: `[0-9a-zA-Z/\-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+]{1,33}[0-9a-zA-Z\/-?:().,''+])`
`Uetr`	Required Randomly generated UUID to provide an end-to-end reference of a payment transaction. Format: `guid` Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`
`PaymentReturnId`	Required ClearBank internal identifier for this payment. Format: `string` Pattern: `[a-zA-Z0-9_-]{0,50}`
`EndToEndId`	Required Unique identification, as assigned by the original initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Format: `string` Pattern: `[0-9a-zA-Z/\-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+]{1,33}[0-9a-zA-Z\/-?:().,''+])`
`Errors`	Required A list of reasons why the payment failed. Type: `array` Required `ErrorCode` ISO 20022/ClearBank code for why the payment failed. Type: `string` Max. Length: `4` Min. Length: `1` Required `AdditionalInformation` Text description of why the payment failed. Type: `string`

Example T2 Payment Return Outbound Failed webhook request body

  {
  "Type": "Target2.PaymentReturn.Outbound.Failed",
  "Version": 1,
  "Payload": {
    "EndToEndId": "eb713ec63e714eebaba05c67429224c5",
    "ReturnInstructionId": "9fa7b5ddb64b4a789a431aa387f4cf49",
    "Uetr": "ffc74b99-49d6-40f9-b798-a02ce02c2c0e",
    "PaymentReturnId": "return_ffc74b9949d640f9b798a02ce02c2c0e",
    "Errors": [
      {
        "Reason": "AC06",
        "AdditionalInformation": "Account not active"
      }
    ]
  },
  "Nonce": 456773897
}

Example webhook response

{
    "Nonce": 456773897
}

To send a T2 payment to an institution, use the /payments/t2-rtgs/v1/institution-payments endpoint. You will receive the T2 Payment Return Outbound Completed webhook when the payment successfully goes through.

T2 send an FI payment message flow diagram

If the payment fails, you will receive the T2 Payment Return Outbound Completed webhook.

Send a T2 payment to an institution

post/payments/t2-rtgs/v1/institution-payments

This endpoint will send a T2 institution payment (pacs.009).

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; valid for 24 hours, max length 83.

Request Payload (application/json)

creditor object, Required
The name and, optionally, the legal entity identifier of the account.
creditorAccount object, Required
Information about the creditor account in a given transaction.
creditorAgent object, Required
Information that identifies the creditor agent as a financial institution.
debtor object, Required
Details about the account holder.
debtorAccount object, Required
Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.
endToEndIdentification string, 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.
Minimum length
1
Maximum length
35
Pattern
[0-9a-zA-Z/\-\?:\.,'\+](|[0-9a-zA-Z/\-\?:\.,'\+]|[0-9a-zA-Z/\-\?:\.,'\+ ]{1,33}[0-9a-zA-Z/\-\?:\.,'\+])
instructionIdentification string, Required
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction.
Minimum length
1
Maximum length
35
Pattern
[0-9a-zA-Z/\-\?:\.,'\+](|[0-9a-zA-Z/\-\?:\.,'\+]|[0-9a-zA-Z/\-\?:\.,'\+ ]{1,33}[0-9a-zA-Z/\-\?:\.,'\+])
interbankSettlementAmount object, Required
The payment that has been instructed to be made in euros.
sourceAccount object, Required
The ClearBank account that will be credited or debited based on the successful completion of the payment instruction.
uetr string, Required
Universally unique identifier to provide an end-to-end reference of a payment transaction.
Pattern
[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}
previousInstructingAgents array
Agents who were previously involved with the payment.
purpose string
Underlying reason for the payment transaction, as published in an external purpose code list.
remittanceInformationUnstructured string
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, in an unstructured form.
Minimum length
1
Maximum length
140
Pattern
[0-9a-zA-Z/\-\?:\.,'\+!#$%&\*=^_`\{\|\}~";<>@\[\\\]](|[0-9a-zA-Z/\-\?:\.,'\+!#$%&\*=^_`\{\|\}~";<>@\[\\\]]|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\*=^_`\{\|\}~";<>@\[\\\]]{1,138}[0-9a-zA-Z/\-\?:\.,'\+!#$%&\*=^_`\{\|\}~";<>@\[\\\]])

request

{
  "creditor": {
    "lei": "FMJF2V44DW0NW9IL4C12",
    "name": "Example name",
    "postalAddress": {
      "streetName": "Lange Straat",
      "postCode": "5644 RX",
      "townName": "Eindhoven",
      "country": "NL"
    },
    "bicfi": "BKMGNL2A200"
  },
  "creditorAccount": {
    "iban": "NL02ABNA0123456789"
  },
  "creditorAgent": {
    "bicfi": "BKMGNL2A200"
  },
  "debtor": {
    "lei": "FMJF2V44DW0NW9IL4C12",
    "name": "Example name",
    "postalAddress": {
      "streetName": "Lange Straat",
      "postCode": "5644 RX",
      "townName": "Eindhoven",
      "country": "NL"
    },
    "bicfi": "BKMGNL2A200"
  },
  "debtorAccount": {
    "iban": "NL02ABNA0123456789"
  },
  "endToEndIdentification": "VFgvXgkhD?si+vu-r844SKwwzoUF:8rKgkj",
  "instructionIdentification": "M6S3kFZxh,5Off.MbuRHupu1gjTwOa9Mc5E",
  "interbankSettlementAmount": {
    "amount": "1201.98",
    "currency": "EUR"
  },
  "sourceAccount": {
    "bicfi": "BKMGNL2A200",
    "iban": "NL02ABNA0123456789"
  },
  "uetr": "aa9931fe-be6c-4100-9650-d3b62d243547",
  "previousInstructingAgents": [
    {
      "order": 0,
      "agent": {
        "lei": "O7W7966QWQVT9CFZ9U67",
        "name": "Party name",
        "postalAddress": {
          "streetName": "Lange Straat",
          "postCode": "5644 RX",
          "townName": "Eindhoven",
          "country": "NL"
        },
        "bicfi": "BKMGNL2A200"
      },
      "agentAccount": {
        "iban": "NL02ABNA0123456789"
      }
    }
  ],
  "purpose": "string",
  "remittanceInformationUnstructured": "string"
}

Code copied

Response (application/json)

202 Accepted
400 Bad Request

Accepted

{
  "paymentId": "string"
}

Code copied

Bad Request

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

Code copied

Associated Webhooks

T2 Financial Institution Credit Transfer Outbound Completed webhook
T2 Financial Institution Credit Transfer Outbound Failed webhook
Customer Accounts Transaction Completed webhook

This webhook confirms a T2 financial institution credit transfer outbound payment has completed.

Request body

{
    "Type": "Target2.FICreditTransfer.Outbound.Completed",
    "Version": 1,                                                         
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`InstructionId`	Required Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. Type: `string` Pattern: `[0-9a-zA-Z/\-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+]{1,33}[0-9a-zA-Z\/-?:().,''+])`
`Uetr`	Required Randomly generated UUID to provide an end-to-end reference of a payment transaction. Format: `guid` Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`
`TransactionId`	Required ID of the transaction used to move funds for this payment. Type: `guid` Format: `string` Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`
`PaymentId`	Required ClearBank internal identifier for this payment. Format: `string` Pattern: `[a-zA-Z0-9_-]{0,50}`
`EndToEndId`	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. Format: `string` Pattern: `[0-9a-zA-Z/\-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+]{1,33}[0-9a-zA-Z\/-?:().,''+])`

Example T2 Financial Institution Credit Transfer Outbound Completed webhook request body

  {
  "Type": "Target2.FICreditTransfer.Outbound.Completed",
  "Version": 1,
  "Payload": {
    "EndToEndId": "eb713ec63e714eebaba05c67429224c5",
    "InstructionId": "ea94148253084f7ea2bcd53174f512c5",
    "Uetr": "34d0368b-f0a9-4703-8ff7-60e1fa116695",
    "TransactionId": "df9bb238-65a4-446d-b529-ca48e4542bd2",
    "PaymentId": "Outbound_34d0368bf0a947038ff760e1fa116695"
  },
  "Nonce": 1016256602
}

Example webhook response

{
    "Nonce": 1016256602
}

This webhook confirms a T2 financial institution credit transfer outbound payment has failed.

Request body

{
    "Type": "Target2.FICreditTransfer.Outbound.Failed",
    "Version": 1,                                                         
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`InstructionId`	Required Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. Type: `string` Pattern: `[0-9a-zA-Z/\-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+]{1,33}[0-9a-zA-Z\/-?:().,''+])`
`Uetr`	Required Randomly generated UUID to provide an end-to-end reference of a payment transaction. Format: `guid` Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`
`PaymentId`	Required ClearBank internal identifier for this payment. Format: `string` Pattern: `[a-zA-Z0-9_-]{0,50}`
`EndToEndId`	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. Format: `string` Pattern: `[0-9a-zA-Z/\-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+]{1,33}[0-9a-zA-Z\/-?:().,''+])`
`Errors`	Required A list of reasons why the payment failed. Type: `array` Required `ErrorCode` ISO 20022/ClearBank code for why the payment failed. Type: `string` Max. Length: `4` Min. Length: `1` Required `AdditionalInformation` Text description of why the payment failed. Type: `string`

Example T2 Financial Institution Credit Transfer Outbound Failed webhook request body

  {
  "Type": "Target2.FICreditTransfer.Outbound.Failed",
  "Version": 1,
  "Payload": {
    "EndToEndId": "eb713ec63e714eebaba05c67429224c5",
    "InstructionId": "4088a8a0bde548498d351339b4af71b7",
    "Uetr": "ae2a2872-14c8-4c9e-b68d-1956280d5656",
    "PaymentId": "Outbound_ae2a287214c84c9eb68d1956280d5656",
    "Errors": [
      {
        "Reason": "AM04",
        "AdditionalInformation": "InsufficientFunds"
      }
    ]
  },
  "Nonce": 797785730
}

Example webhook response

{
    "Nonce": 797785730
}

When an inbound T2 payment is received, you'll be notified with one of the below webhooks depending on the payment type.

For institution payments (pacs.009), the T2 scheme does not require IBANs to be provided. We direct any inbound institution payments addressed only to a BIC and not with an IBAN to your Primary Operating Account (this is the first Operating Account created).

This webhook confirms a T2 customer credit transfer inbound payment has completed.

Request body

{
    "Type": "Target2.CustomerCreditTransfer.Inbound.Completed",
    "Version": 1,                                                         
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`PaymentId`	Required ClearBank internal identifier for this payment. Type: `string` Pattern: `[a-zA-Z0-9_-]{0,50}`
`InstructionId`	Required Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. Type: `string` Pattern:`[0-9a-zA-Z\/-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+ ]{1,33}[0-9a-zA-Z\/-?:().,''+])`
`EndToEndId`	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` Pattern:`[0-9a-zA-Z\/-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+ ]{1,33}[0-9a-zA-Z\/-?:().,''+])`
`UnstructuredRemittanceInfo`	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 account's receivable system, in an unstructured form. If not supplied we return `NOTPROVIDED`. Type: `string` Max. Length: `140` Min. Length: `1` Pattern: `^[0-9a-zA-Z\/\\-\\?:\$\$\\.,''\\+](\\|[0-9a-zA-Z\/\\-\\?:\$\$\\.,''\\+]\\|[0-9a-zA-Z\/\\-\\?:\$\$\\.,''\\+ ]{1,138}[0-9a-zA-Z\/\\-\\?:\$\$\\.,''\\+])$`
`Uetr`	Required Randomly generated UUID to provide an end-to-end reference of a payment transaction. Type: `string` Format: `guid` Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`
`TransactionId`	Required ID of the transaction used to move funds for this payment. Type: `string` Format: `guid` Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`
`SettlementAmount`	Required Settlement payment amount. Contains the `Amount` and `Currency`. `Amount`: Settlement payment amount Type: `number` Format: `decimal` `Currency`: Currency of the settlement amount. Type: `string` Max. Length: `3` Min. Length: `3` Pattern: `[A-Z]{3,3}`
`Debtor`	Optional Details about the account holder. Type: `object`. Contains the `Name`, `Bic`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/-?:().,'+!#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/-?:().,'+!#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/-?:().,'+!#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/-?:().,'+!#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `strings` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`DebtorAccount`	Optional Information about the counterpart in a given transaction. Contains the `Iban`. `Iban`: International Bank Account Number associated with the party. Type: `string` Pattern:`[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}`
`DebtorAgent`	Optional Details about the debtor financial institution. Contains the `Iban`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: ``[0-9a-zA-Z\/\\-\\?:\$\$\\.,''\\+!#$%&\\*=^_`\{\
`DebtorAgentAccount`	Optional Information about the counterpart in a given transaction. Contains the `Iban`. `Iban`: International Bank Account Number associated with the party. Type: `string` Pattern:`[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}`
`UltimateDebtor`	Optional Details of the ultimate account debtor. Contains the `Name`, `Bic`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`InitiatingParty`	Optional Details of the party that initiated the payment. Type: `object`. Contains the `Name`, `Bic`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1
`Creditor`	Optional Details of the credited party. Type: `object`. Contains the `Name`, `Bic`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1
`CreditorAccount`	Optional Information about the counterpart in a given transaction. Type: `object`. Contains the `Iban`. `Iban`: International Bank Account Number associated with the party. Type: `string` Pattern:`[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}`
`CreditorAgent`	Optional Details about the creditor financial institution. Type: `object`. Contains the `Iban`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`CreditorAgentAccount`	Optional Information about the counterpart in a given transaction. Type: `object`. Contains the `Iban`. `Iban`: International Bank Account Number associated with the party. Type: `string` Pattern:`[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}`
`UltimateCreditor`	Optional Details of the ultimate creditor. Contains the `Name`, `Bic`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`PreviousInstructingAgents`	Optional Previous instructing agents. Contains the `Name`, `BicFi`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `BicFi`: Business identifier code of the financial institutuion. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`IntermediaryAgent`	Optional Information about the intermediary/correspondent bank. Type: `object`. Contains the `Name`, `Bic`, `Address`, and `Iban`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `strings` MaxItems: `3` Max. Length: `35` Min. Length: `1`

Example T2 Customer Credit Transfer Inbound Completed webhook request body

  {
  "Type": "Target2.CustomerCreditTransfer.Inbound.Completed",
  "Version": 1,
  "Payload": {
    "PaymentId": "Inbound_46e0bf2938aa4e169c2c8497dacd5f58",
    "InstructionId": "9fcec7c82f904b41b6f76afbe4567c47",
    "EndToEndId": "90f1fd7d12c14a0eaa6cff753cdfcca5",
    "UnstructuredRemittanceInfo": "Invoice settlement ref 1904AB3",
    "Uetr": "46e0bf29-38aa-4e16-9c2c-8497dacd5f58",
    "TransactionId": "cf1709fd-f2d9-460e-92d1-e12d269a5dc8",
    "SettlementAmount": {
      "Amount": 1.99,
      "Currency": "EUR"
    },
    "Debtor": {
      "Name": "Org name",
      "Bic": "CLRBNL99XXX",
      "Address": {
        "TownName": "GF58S",
        "Country": "NL",
        "AddressLine": null
      }
    },
    "DebtorAccount": {
      "Iban": "GB26MIDL40051512345674"
    },
    "DebtorAgent": {
      "Name": null,
      "BicFi": "FLORNL2AXXX",
      "Address": null
    },
    "UltimateDebtor": {
      "Name": null,
      "Bic": "CLRBNL99XXX",
      "Address": null
    },
    "InitiatingParty": {
      "Name": null,
      "Bic": "CLRBNL99XXX",
      "Address": null
    },
    "Creditor": {
      "Name": "Org name",
      "Bic": "CLRBNL99XXX",
      "Address": {
        "TownName": "GF58S",
        "Country": "NL",
        "AddressLine": null
      }
    },
    "CreditorAccount": {
      "Iban": "NL61CLRB0128215099"
    },
    "CreditorAgent": {
      "Name": null,
      "BicFi": "CLRBNL99XXX",
      "Address": null
    },
    "CreditorAgentAccount": null,
    "UltimateCreditor": {
      "Name": null,
      "Bic": "CLRBNL99XXX",
      "Address": null
    },
    "PreviousInstructingAgents": [
      {
        "FinancialInstitutionId": {
          "Name": "Previous Instructing Agent 1",
          "BicFi": "CLRBGB22158",
          "Address": {
            "TownName": "98FM4",
            "Country": "NL",
            "AddressLine": null
          }
        },
        "Account": {
          "Iban": "GB26MIDL40051512345674"
        }
      },
      {
        "FinancialInstitutionId": {
          "Name": "Previous Instructing Agent 2",
          "BicFi": "CLRBGB22158",
          "Address": {
            "TownName": "0MK1F",
            "Country": "NL",
            "AddressLine": null
          }
        },
        "Account": {
          "Iban": "GB26MIDL40051512345674"
        }
      },
      {
        "FinancialInstitutionId": {
          "Name": "Previous Instructing Agent 3",
          "BicFi": "CLRBGB22158",
          "Address": {
            "TownName": "TJRVN",
            "Country": "NL",
            "AddressLine": null
          }
        },
        "Account": {
          "Iban": "GB26MIDL40051512345674"
        }
      }
    ],
    "IntermediaryAgents": null
  },
  "Nonce": 1875546561
}

Example webhook response

{
    "Nonce": 1875546561
}

This webhook confirms a T2 return inbound payment has completed.

Request body

{
    "Type": "Target2.PaymentReturn.Inbound.Completed",
    "Version": 1,                                                         
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`PaymentReturnId`	Required ClearBank internal identifier for this payment. Format: `string` Pattern: `[a-zA-Z0-9_-]{0,50}`
`OriginalInstructionId`	Optional Original unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. Type: `string` Pattern: `[0-9a-zA-Z/\-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+]{1,33}[0-9a-zA-Z\/-?:().,''+])`
`OriginalEndToEndId`	Required Original unique identification, as assigned by the original 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:`[0-9a-zA-Z\/-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+ ]{1,33}[0-9a-zA-Z\/-?:().,''+])`
`OriginalUetr`	Required Original randomly generated UUID to provide an end-to-end reference of a payment transaction. Type: `string` Format: `guid` Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`
`TransactionId`	Required ID of the transaction used to move funds for this payment. Type: `string` Format: `guid` Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`
`ReturnReason`	Required Detailed information on the return reason. Contains `Code` and `ReturnReasonAdditionalInformation`. `Code`:Return reason code (as defined in ISO 20022). Type: `string` `ReturnReasonAdditionalInformation`:Description associated with the return reason code. Type: `array` Max items: `2` Item type: `string`
`OriginalSettlementAmount`	Optional Original settlement payment amount. Contains the `Amount` and `Currency`. `Amount`: Settlement payment amount Type: `number` Format: `decimal` `Currency`: Currency of the settlement amount. Type: `string` Max. Length: `3` Min. Length: `3` Pattern: `[A-Z]{3,3}`
`ReturnedSettlementAmount`	Required Returned settlement payment amount. Contains the `Amount` and `Currency`. `Amount`: Settlement payment amount Type: `number` Format: `decimal` `Currency`: Currency of the settlement amount. Type: `string` Max. Length: `3` Min. Length: `3` Pattern: `[A-Z]{3,3}`
`UltimateDebtor`	Optional Details of the ultimate debtor. Contains the `Name`, `Bic`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`UltimateCreditor`	Optional Details of the ultimate creditor. Contains the `Name`, `Bic`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`Creditor`	Optional Details of the credited party. . Contains the `Name`, `Bic`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`CreditorAgent`	Optional Details about the creditor financial institution. . Contains the `Iban`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`Debtor`	Optional Details about the account holder. Contains the `Name`, `Bic`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`InitiatingParty`	Optional Details about the initiating party. Contains the `Name`, `BicFi`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `BicFi`: Business identifier code of the financial institutuion. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`DebtorAgent`	Optional Details about the debtor financial institution. Contains the `Iban`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`PreviousInstructingAgents`	Optional Previous instructing agents. Contains the `Name`, `BicFi`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `BicFi`: Business identifier code of the financial institutuion. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`ReturnOriginator`	Optional Contains the `Name`, `BicFi`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `BicFi`: Business identifier code of the financial institutuion. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1`

Example T2 Payment Return Inbound Completed webhook request body

  {
  "Type": "Target2.PaymentReturn.Inbound.Completed",
  "Version": 1,
  "Payload": {
    "PaymentReturnId": "return_06ba568ffecb4428a71d28573e4747d8",
    "OriginalInstructionId": "111bba959bdd414cae8cf14a9abdba3c",
    "OriginalEndToEndId": "4ecd92df2c524ca7af19f2ec45ef9e7d",
    "OriginalUetr": "4ecd92df-2c52-4ca7-af19-f2ec45ef9e7d",
    "TransactionId": "689c3f2d-5efb-43b7-86b8-9ed1cb5cd2b0",
    "ReturnReason": {
      "Code": "NOOR",
      "ReturnReasonAdditionalInformation": [
        "Original SCT never received"
      ]
    },
    "OriginalSettlementAmount": null,
    "ReturnedSettlementAmount": {
      "Amount": 123.45,
      "Currency": "EUR"
    },
    "UltimateDebtor": null,
    "UltimateCreditor": null,
    "Debtor": {
      "Party": {
        "Name": null,
        "Bic": "CLRBGB22158",
        "Address": null
      },
      "Agent": null
    },
    "DebtorAgent": {
      "Name": null,
      "BicFi": "FLORNL2AXXX",
      "Address": null
    },
    "Creditor": {
      "Party": {
        "Name": null,
        "Bic": "CLRBGB22158",
        "Address": null
      },
      "Agent": null
    },
    "CreditorAgent": {
      "Name": null,
      "BicFi": "CLRBNL99XXX",
      "Address": null
    },
    "InitiatingParty": null,
    "PreviousInstructingAgents": [
      {
        "FinancialInstitutionId": {
          "Name": "Previous Instructing Agent 1",
          "BicFi": "CLRBGB22158",
          "Address": {
            "TownName": "JRQH6",
            "Country": "NL",
            "AddressLine": null
          }
        },
        "Account": null
      },
      {
        "FinancialInstitutionId": {
          "Name": "Previous Instructing Agent 2",
          "BicFi": "CLRBGB22158",
          "Address": {
            "TownName": "4UUXT",
            "Country": "NL",
            "AddressLine": null
          }
        },
        "Account": null
      },
      {
        "FinancialInstitutionId": {
          "Name": "Previous Instructing Agent 3",
          "BicFi": "CLRBGB22158",
          "Address": {
            "TownName": "WI13A",
            "Country": "NL",
            "AddressLine": null
          }
        },
        "Account": null
      }
    ],
    "ReturnOriginator": null
  },
  "Nonce": 741490031
}

Example webhook response

{
    "Nonce": 741490031
}

This webhook confirms a T2 financial institution credit transfer inbound payment has completed.

Request body

{
    "Type": "Target2.FICreditTransfer.Inbound.Completed",
    "Version": 1,                                                         
    "Payload": {...},
    "Nonce":
}

Payload

Element	Description
`PaymentId`	Required ClearBank internal identifier for this payment. Type: `string` Pattern: `[a-zA-Z0-9_-]{0,50}`
`InstructionId`	Required Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. Type: `string` Pattern:`[0-9a-zA-Z\/-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+ ]{1,33}[0-9a-zA-Z\/-?:().,''+])`
`EndToEndId`	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:`[0-9a-zA-Z\/-?:().,''+](\\|[0-9a-zA-Z\/-?:().,''+]\\|[0-9a-zA-Z\/-?:().,''+ ]{1,33}[0-9a-zA-Z\/-?:().,''+])`
`UnstructuredRemittanceInfo`	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 account's receivable system, in an unstructured form. If not supplied we return `NOTPROVIDED`. Type: `string` Max. Length: `140` Min. Length: `1` Pattern: `^[0-9a-zA-Z\/\\-\\?:\$\$\\.,''\\+](\\|[0-9a-zA-Z\/\\-\\?:\$\$\\.,''\\+]\\|[0-9a-zA-Z\/\\-\\?:\$\$\\.,''\\+ ]{1,138}[0-9a-zA-Z\/\\-\\?:\$\$\\.,''\\+])$`
`Uetr`	Required Randomly generated UUID to provide an end-to-end reference of a payment transaction. Type: `string` Format: `guid` Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`
`TransactionId`	Required ID of the transaction used to move funds for this payment. Type: `string` Format: `guid` Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`
`SettlementAmount`	Required Settlement payment amount. Contains the `Amount` and `Currency`. Type: `number` Format: `decimal` Currency of the settlement amount. Type: `string` Max. Length: `3` Min. Length: `3`
`Debtor`	Optional Details about the account holder. Type: `object`. Contains the `Name`, `Bic`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`DebtorAccount`	Optional Information about the counterpart in a given transaction. Type: `object`. Contains the `Iban`. `Iban`: International Bank Account Number associated with the party. Type: `string` Pattern:`[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}`
`Creditor`	Optional Details of the credited party. Type: `object`. Contains the `Name`, `Bic`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/-?:().,'+!#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/-?:().,'+!#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/-?:().,'+!#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/-?:().,'+!#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `strings` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`CreditorAccount`	Optional Information about the counterpart in a given transaction. Type: `object`. Contains the `Iban`. `Iban`: International Bank Account Number associated with the party. Type: `string` Pattern:`[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}`
`CreditorAgent`	Optional Details about the creditor financial institution. Type: `object`. Contains the `Iban`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/-?:().,'+!#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/-?:().,'+!#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/-?:().,'+!#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/-?:().,'+!#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `strings` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`PreviousInstructingAgents`	Optional Previous instructing agents. Contains the `Name`, `BicFi`, and `Address`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `BicFi`: Business identifier code of the financial institutuion. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `string` MaxItems: `3` Max. Length: `35` Min. Length: `1`
`IntermediaryAgent`	Optional Information about the intermediary/correspondent bank. Type: `object`. Contains the `Name`, `Bic`, `Address`, and `Iban`. `Name`: Name by which a party is known and which is usually used to identify that party. Type: `string` Max. Length: `140` Min. Length: `1` `Bic`: Business identifier code of the party. Type: `string` Pattern: `[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}[A-Z0-9]{3,3}` `Address`: Address of the debtor account holder. Contains the `TownName`, `Country`, and `AddressLines`. `TownName`: Name of a built-up area, with defined boundaries, and a local government. Type: `string` Max. Length: `35` Min. Length: `1` Type: `string` Pattern: [0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]](\\|[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]][0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]{1,33}[0-9a-zA-Z/\-\?:\.,'\+ !#$%&\=^_`\{\\|\}~";<>@\[\\\]]) `Country`: Nation with its own government. Type: `string` Pattern: `[A-Z]{2,2}` `AddressLines`: The specific lines of the address. Type: `array` of `strings` MaxItems: `3` Max. Length: `35` Min. Length: `1`

Example T2 Financial Institution Credit Transfer Inbound Completed webhook request body

  {
  "Type": "Target2.FICreditTransfer.Inbound.Completed",
  "Version": 1,
  "Payload": {
    "PaymentId": "Inbound_b42b4f319f36444cb1022c45f1f0a51e",
    "InstructionId": "66807eb11d3749c5854406b837f39336",
    "EndToEndId": "3c4e974e476d411896249a17f03e0e01",
    "UnstructuredRemittanceInfo": "Invoice settlement ref 5729CD3",
    "Uetr": "b42b4f31-9f36-444c-b102-2c45f1f0a51e",
    "TransactionId": "29dfe5b6-b565-498a-b38b-3463b57f032e",
    "SettlementAmount": {
      "Amount": 1.99,
      "Currency": "EUR"
    },
    "Debtor": {
      "Name": "Debtor",
      "Bic": "CLRBDEBTXXX",
      "Address": {
        "TownName": "A1WHI",
        "Country": "NL",
        "AddressLine": null
      }
    },
    "DebtorAccount": {
      "Iban": "GB26MIDL40051512345674"
    },
    "DebtorAgent": {
      "Name": "Debtor Agent",
      "Bic": "CLRBDBTAXXX",
      "Address": {
        "TownName": "JD1G4",
        "Country": "NL",
        "AddressLine": null
      }
    },
    "Creditor": {
      "Name": "Creditor",
      "Bic": "CLRBNL99XXX",
      "Address": {
        "TownName": "QI50K",
        "Country": "NL",
        "AddressLine": null
      }
    },
    "CreditorAccount": {
      "Iban": "NL61CLRB0128215099"
    },
    "CreditorAgent": {
      "Name": "Creditor Agent",
      "Bic": "CLRBNL99XXX",
      "Address": {
        "TownName": "61HZN",
        "Country": "NL",
        "AddressLine": null
      }
    },
    "PreviousInstructingAgents": [
      {
        "FinancialInstitutionId": {
          "Name": "PreviousInstructingAgent1",
          "BicFi": "CLRBPIA1XXX",
          "Address": {
            "TownName": "HZUBZ",
            "Country": "NL",
            "AddressLine": null
          }
        },
        "Account": null
      },
      {
        "FinancialInstitutionId": {
          "Name": "PreviousInstructingAgent2",
          "BicFi": "CLRBPIA2XXX",
          "Address": {
            "TownName": "621J2",
            "Country": "NL",
            "AddressLine": null
          }
        },
        "Account": null
      },
      {
        "FinancialInstitutionId": {
          "Name": "PreviousInstructingAgent3",
          "BicFi": "CLRBPIA3XXX",
          "Address": {
            "TownName": "HQHVI",
            "Country": "NL",
            "AddressLine": null
          }
        },
        "Account": null
      }
    ],
    "IntermediaryAgents": null
  },
  "Nonce": 1220526477
}

Example webhook response

{
    "Nonce": 1220526477
}

These endpoints can be used to simulate payments. You can also use them for automated testing.

Simulate an inbound T2 payment (pacs.008) through the POST /payments/t2-rtgs/v1/inbound/customer-payments endpoint.
Simulate a returned T2 payment (pacs.004) through the POST /payments/t2-rtgs/v1/inbound/payment-returns endpoint.
Simulate a T2 bank-to-bank payment (pacs.009) through the POST /payments/t2-rtgs/v1/inbound/institution-payments endpoint.

Simulate a T2 payment

post/payments/t2-rtgs/v1/inbound/customer-payments

Trigger inbound customer payment request (Pacs008) to simulate a payment being sent from a T2 scheme participent into ClearBank to a ClearBank customer

Parameters

Request Payload (application/json)

paymentIdentification object
header object
value object
debtor object
debtorAgent object
creditor object
creditorAgent object
instructingAgent object
instructedAgent object
ultimateDebtor object
ultimateCreditor object
initiatingParty object
previousInstructingAgent1 object
previousInstructingAgent2 object
previousInstructingAgent3 object
relatedRemittanceInformation object
purposeCode string

request

{
  "paymentIdentification": {
    "instructionId": "string",
    "endToEndId": "string",
    "uetr": "00168b15-e953-4990-a0c1-a37ad64c1587",
    "clearingSystemId": "string"
  },
  "header": {
    "bizMsgId": "string",
    "from": "stringstrin",
    "to": "stringstrin",
    "messageNameId": "string"
  },
  "value": {
    "settlementAmount": 0,
    "settlementCurrency": "str",
    "instructedAmount": 0,
    "instructedCurrency": "string",
    "exchangeRate": 0
  },
  "debtor": {
    "party": {
      "name": "string",
      "address": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "identification": {
        "organisationIdentification": {
          "anyBIC": "stringstrin",
          "lei": "stringstringstringst",
          "other": [
            {
              "identification": "string",
              "schemeName": {
                "code": "stri"
              },
              "issuer": "string"
            }
          ]
        },
        "privateIdentification": {
          "dateAndPlaceOfBirth": {
            "birthDate": "2019-08-24T14:15:22Z",
            "city": "string",
            "country": "st",
            "province": "string"
          },
          "other": [
            {
              "identification": "string",
              "schemeName": {
                "code": "stri"
              },
              "issuer": "string"
            }
          ]
        }
      },
      "countryOfResidence": "st"
    },
    "account": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "stri"
          },
          "issuer": "string"
        }
      },
      "type": {
        "code": "string",
        "proprietary": "string"
      },
      "currency": "string",
      "name": "string",
      "proxy": "string"
    }
  },
  "debtorAgent": {
    "identification": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "account": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "stri"
          },
          "issuer": "string"
        }
      },
      "type": {
        "code": "string",
        "proprietary": "string"
      },
      "currency": "string",
      "name": "string",
      "proxy": "string"
    }
  },
  "creditor": {
    "party": {
      "name": "string",
      "address": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "identification": {
        "organisationIdentification": {
          "anyBIC": "stringstrin",
          "lei": "stringstringstringst",
          "other": [
            {
              "identification": "string",
              "schemeName": {
                "code": "stri"
              },
              "issuer": "string"
            }
          ]
        },
        "privateIdentification": {
          "dateAndPlaceOfBirth": {
            "birthDate": "2019-08-24T14:15:22Z",
            "city": "string",
            "country": "st",
            "province": "string"
          },
          "other": [
            {
              "identification": "string",
              "schemeName": {
                "code": "stri"
              },
              "issuer": "string"
            }
          ]
        }
      },
      "countryOfResidence": "st"
    },
    "account": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "stri"
          },
          "issuer": "string"
        }
      },
      "type": {
        "code": "string",
        "proprietary": "string"
      },
      "currency": "string",
      "name": "string",
      "proxy": "string"
    }
  },
  "creditorAgent": {
    "identification": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "account": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "stri"
          },
          "issuer": "string"
        }
      },
      "type": {
        "code": "string",
        "proprietary": "string"
      },
      "currency": "string",
      "name": "string",
      "proxy": "string"
    }
  },
  "instructingAgent": {
    "bic": "CLRBNL2AXXX",
    "lei": "stringstringstringst"
  },
  "instructedAgent": {
    "bic": "stringstrin",
    "lei": "stringstringstringst"
  },
  "ultimateDebtor": {
    "name": "string",
    "address": {
      "department": "string",
      "subDepartment": "string",
      "streetName": "string",
      "buildingNumber": "string",
      "buildingName": "string",
      "floor": "string",
      "postBox": "string",
      "room": "string",
      "postCode": "string",
      "townName": "string",
      "townLocationName": "string",
      "districtName": "string",
      "countrySubDivision": "string",
      "country": "st",
      "addressLine": [
        "string"
      ]
    },
    "identification": {
      "organisationIdentification": {
        "anyBIC": "stringstrin",
        "lei": "stringstringstringst",
        "other": [
          {
            "identification": "string",
            "schemeName": {
              "code": "stri"
            },
            "issuer": "string"
          }
        ]
      },
      "privateIdentification": {
        "dateAndPlaceOfBirth": {
          "birthDate": "2019-08-24T14:15:22Z",
          "city": "string",
          "country": "st",
          "province": "string"
        },
        "other": [
          {
            "identification": "string",
            "schemeName": {
              "code": "stri"
            },
            "issuer": "string"
          }
        ]
      }
    },
    "countryOfResidence": "string"
  },
  "ultimateCreditor": {
    "name": "string",
    "address": {
      "department": "string",
      "subDepartment": "string",
      "streetName": "string",
      "buildingNumber": "string",
      "buildingName": "string",
      "floor": "string",
      "postBox": "string",
      "room": "string",
      "postCode": "string",
      "townName": "string",
      "townLocationName": "string",
      "districtName": "string",
      "countrySubDivision": "string",
      "country": "st",
      "addressLine": [
        "string"
      ]
    },
    "identification": {
      "organisationIdentification": {
        "anyBIC": "stringstrin",
        "lei": "stringstringstringst",
        "other": [
          {
            "identification": "string",
            "schemeName": {
              "code": "stri"
            },
            "issuer": "string"
          }
        ]
      },
      "privateIdentification": {
        "dateAndPlaceOfBirth": {
          "birthDate": "2019-08-24T14:15:22Z",
          "city": "string",
          "country": "st",
          "province": "string"
        },
        "other": [
          {
            "identification": "string",
            "schemeName": {
              "code": "stri"
            },
            "issuer": "string"
          }
        ]
      }
    },
    "countryOfResidence": "string"
  },
  "initiatingParty": {
    "name": "string",
    "address": {
      "department": "string",
      "subDepartment": "string",
      "streetName": "string",
      "buildingNumber": "string",
      "buildingName": "string",
      "floor": "string",
      "postBox": "string",
      "room": "string",
      "postCode": "string",
      "townName": "string",
      "townLocationName": "string",
      "districtName": "string",
      "countrySubDivision": "string",
      "country": "st",
      "addressLine": [
        "string"
      ]
    },
    "identification": {
      "organisationIdentification": {
        "anyBIC": "stringstrin",
        "lei": "stringstringstringst",
        "other": [
          {
            "identification": "string",
            "schemeName": {
              "code": "stri"
            },
            "issuer": "string"
          }
        ]
      },
      "privateIdentification": {
        "dateAndPlaceOfBirth": {
          "birthDate": "2019-08-24T14:15:22Z",
          "city": "string",
          "country": "st",
          "province": "string"
        },
        "other": [
          {
            "identification": "string",
            "schemeName": {
              "code": "stri"
            },
            "issuer": "string"
          }
        ]
      }
    },
    "countryOfResidence": "string"
  },
  "previousInstructingAgent1": {
    "identification": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "account": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "stri"
          },
          "issuer": "string"
        }
      },
      "type": {
        "code": "string",
        "proprietary": "string"
      },
      "currency": "string",
      "name": "string",
      "proxy": "string"
    }
  },
  "previousInstructingAgent2": {
    "identification": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "account": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "stri"
          },
          "issuer": "string"
        }
      },
      "type": {
        "code": "string",
        "proprietary": "string"
      },
      "currency": "string",
      "name": "string",
      "proxy": "string"
    }
  },
  "previousInstructingAgent3": {
    "identification": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "account": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "stri"
          },
          "issuer": "string"
        }
      },
      "type": {
        "code": "string",
        "proprietary": "string"
      },
      "currency": "string",
      "name": "string",
      "proxy": "string"
    }
  },
  "relatedRemittanceInformation": {
    "remittanceIdentification": "string",
    "relatedRemittanceLocation": [
      {
        "name": "string",
        "postalAddress": {
          "department": "string",
          "subDepartment": "string",
          "streetName": "string",
          "buildingNumber": "string",
          "buildingName": "string",
          "floor": "string",
          "postBox": "string",
          "room": "string",
          "postCode": "string",
          "townName": "string",
          "townLocationName": "string",
          "districtName": "string",
          "countrySubDivision": "string",
          "country": "st",
          "addressLine": [
            "string"
          ]
        }
      }
    ]
  },
  "purposeCode": "string"
}

Code copied

Response (application/json)

202 Accepted
400 Bad Request

Accepted

{
  "paymentId": "string"
}

Code copied

Bad Request

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

Code copied

Associated Webhooks

T2 Customer Credit Transfer Inbound Completed webhook
Customer Accounts Transaction Completed webhook

Simulate a return T2 payment

post/payments/t2-rtgs/v1/inbound/payment-returns

Trigger inbound payment return request (Pacs004) to simulate a payment being returned from a T2 scheme participent into ClearBank to a ClearBank customer

Parameters

Request Payload (application/json)

originalGroupInformation object
originalPaymentIdentification object
returnedAmount object
instructingAgent object
instructedAgent object
returnChain object
returnReason object
header object
originalSettlement object
chargesInformation array

request

{
  "originalGroupInformation": {
    "messageId": "string",
    "messageNameId": "string"
  },
  "originalPaymentIdentification": {
    "endToEndId": "string",
    "uetr": "00168b15-e953-4990-a0c1-a37ad64c1587",
    "instructionId": "string",
    "clearingSystemId": "string"
  },
  "returnedAmount": {
    "settlementAmount": 0,
    "settlementCurrency": "str",
    "instructedAmount": 0,
    "instructedCurrency": "string",
    "exchangeRate": 0
  },
  "instructingAgent": {
    "bic": "CLRBNL2AXXX",
    "lei": "stringstringstringst"
  },
  "instructedAgent": {
    "bic": "stringstrin",
    "lei": "stringstringstringst"
  },
  "returnChain": {
    "debtor": {
      "party": {
        "name": "string",
        "address": {
          "department": "string",
          "subDepartment": "string",
          "streetName": "string",
          "buildingNumber": "string",
          "buildingName": "string",
          "floor": "string",
          "postBox": "string",
          "room": "string",
          "postCode": "string",
          "townName": "string",
          "townLocationName": "string",
          "districtName": "string",
          "countrySubDivision": "string",
          "country": "st",
          "addressLine": [
            "string"
          ]
        },
        "identification": {
          "organisationIdentification": {
            "anyBIC": "stringstrin",
            "lei": "stringstringstringst",
            "other": [
              {
                "identification": "string",
                "schemeName": {
                  "code": "stri"
                },
                "issuer": "string"
              }
            ]
          },
          "privateIdentification": {
            "dateAndPlaceOfBirth": {
              "birthDate": "2019-08-24T14:15:22Z",
              "city": "string",
              "country": "st",
              "province": "string"
            },
            "other": [
              {
                "identification": "string",
                "schemeName": {
                  "code": "stri"
                },
                "issuer": "string"
              }
            ]
          }
        },
        "countryOfResidence": "st"
      },
      "agent": {
        "bicFI": "stringstrin",
        "lei": "stringstringstringst",
        "name": "string",
        "postalAddress": {
          "department": "string",
          "subDepartment": "string",
          "streetName": "string",
          "buildingNumber": "string",
          "buildingName": "string",
          "floor": "string",
          "postBox": "string",
          "room": "string",
          "postCode": "string",
          "townName": "string",
          "townLocationName": "string",
          "districtName": "string",
          "countrySubDivision": "string",
          "country": "st",
          "addressLine": [
            "string"
          ]
        },
        "clearingSystemMemberId": {
          "code": "string",
          "memberId": "string"
        }
      }
    },
    "creditor": {
      "party": {
        "name": "string",
        "address": {
          "department": "string",
          "subDepartment": "string",
          "streetName": "string",
          "buildingNumber": "string",
          "buildingName": "string",
          "floor": "string",
          "postBox": "string",
          "room": "string",
          "postCode": "string",
          "townName": "string",
          "townLocationName": "string",
          "districtName": "string",
          "countrySubDivision": "string",
          "country": "st",
          "addressLine": [
            "string"
          ]
        },
        "identification": {
          "organisationIdentification": {
            "anyBIC": "stringstrin",
            "lei": "stringstringstringst",
            "other": [
              {
                "identification": "string",
                "schemeName": {
                  "code": "stri"
                },
                "issuer": "string"
              }
            ]
          },
          "privateIdentification": {
            "dateAndPlaceOfBirth": {
              "birthDate": "2019-08-24T14:15:22Z",
              "city": "string",
              "country": "st",
              "province": "string"
            },
            "other": [
              {
                "identification": "string",
                "schemeName": {
                  "code": "stri"
                },
                "issuer": "string"
              }
            ]
          }
        },
        "countryOfResidence": "st"
      },
      "agent": {
        "bicFI": "stringstrin",
        "lei": "stringstringstringst",
        "name": "string",
        "postalAddress": {
          "department": "string",
          "subDepartment": "string",
          "streetName": "string",
          "buildingNumber": "string",
          "buildingName": "string",
          "floor": "string",
          "postBox": "string",
          "room": "string",
          "postCode": "string",
          "townName": "string",
          "townLocationName": "string",
          "districtName": "string",
          "countrySubDivision": "string",
          "country": "st",
          "addressLine": [
            "string"
          ]
        },
        "clearingSystemMemberId": {
          "code": "string",
          "memberId": "string"
        }
      }
    },
    "debtorAgent": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "ultimateDebtor": {
      "name": "string",
      "address": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "identification": {
        "organisationIdentification": {
          "anyBIC": "stringstrin",
          "lei": "stringstringstringst",
          "other": [
            {
              "identification": "string",
              "schemeName": {
                "code": "stri"
              },
              "issuer": "string"
            }
          ]
        },
        "privateIdentification": {
          "dateAndPlaceOfBirth": {
            "birthDate": "2019-08-24T14:15:22Z",
            "city": "string",
            "country": "st",
            "province": "string"
          },
          "other": [
            {
              "identification": "string",
              "schemeName": {
                "code": "stri"
              },
              "issuer": "string"
            }
          ]
        }
      },
      "countryOfResidence": "string"
    },
    "initiatingParty": {
      "party": {
        "name": "string",
        "address": {
          "department": "string",
          "subDepartment": "string",
          "streetName": "string",
          "buildingNumber": "string",
          "buildingName": "string",
          "floor": "string",
          "postBox": "string",
          "room": "string",
          "postCode": "string",
          "townName": "string",
          "townLocationName": "string",
          "districtName": "string",
          "countrySubDivision": "string",
          "country": "st",
          "addressLine": [
            "string"
          ]
        },
        "identification": {
          "organisationIdentification": {
            "anyBIC": "stringstrin",
            "lei": "stringstringstringst",
            "other": [
              {
                "identification": "string",
                "schemeName": {
                  "code": "stri"
                },
                "issuer": "string"
              }
            ]
          },
          "privateIdentification": {
            "dateAndPlaceOfBirth": {
              "birthDate": "2019-08-24T14:15:22Z",
              "city": "string",
              "country": "st",
              "province": "string"
            },
            "other": [
              {
                "identification": "string",
                "schemeName": {
                  "code": "stri"
                },
                "issuer": "string"
              }
            ]
          }
        },
        "countryOfResidence": "st"
      },
      "agent": {
        "bicFI": "stringstrin",
        "lei": "stringstringstringst",
        "name": "string",
        "postalAddress": {
          "department": "string",
          "subDepartment": "string",
          "streetName": "string",
          "buildingNumber": "string",
          "buildingName": "string",
          "floor": "string",
          "postBox": "string",
          "room": "string",
          "postCode": "string",
          "townName": "string",
          "townLocationName": "string",
          "districtName": "string",
          "countrySubDivision": "string",
          "country": "st",
          "addressLine": [
            "string"
          ]
        },
        "clearingSystemMemberId": {
          "code": "string",
          "memberId": "string"
        }
      }
    },
    "creditorAgent": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "ultimateCreditor": {
      "name": "string",
      "address": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "identification": {
        "organisationIdentification": {
          "anyBIC": "stringstrin",
          "lei": "stringstringstringst",
          "other": [
            {
              "identification": "string",
              "schemeName": {
                "code": "stri"
              },
              "issuer": "string"
            }
          ]
        },
        "privateIdentification": {
          "dateAndPlaceOfBirth": {
            "birthDate": "2019-08-24T14:15:22Z",
            "city": "string",
            "country": "st",
            "province": "string"
          },
          "other": [
            {
              "identification": "string",
              "schemeName": {
                "code": "stri"
              },
              "issuer": "string"
            }
          ]
        }
      },
      "countryOfResidence": "string"
    },
    "previousInstructingAgent1": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "previousInstructingAgent2": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "previousInstructingAgent3": {
      "bicfi": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "intermediaryAgent1": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "intermediaryAgent2": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "intermediaryAgent3": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    }
  },
  "returnReason": {
    "reason": {
      "code": "AC01",
      "additionalInformation": [
        "string"
      ]
    },
    "originator": {
      "name": "string",
      "address": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "identification": {
        "organisationIdentification": {
          "anyBIC": "stringstrin",
          "lei": "stringstringstringst",
          "other": [
            {
              "identification": "string",
              "schemeName": {
                "code": "stri"
              },
              "issuer": "string"
            }
          ]
        },
        "privateIdentification": {
          "dateAndPlaceOfBirth": {
            "birthDate": "2019-08-24T14:15:22Z",
            "city": "string",
            "country": "st",
            "province": "string"
          },
          "other": [
            {
              "identification": "string",
              "schemeName": {
                "code": "stri"
              },
              "issuer": "string"
            }
          ]
        }
      },
      "countryOfResidence": "string"
    }
  },
  "header": {
    "bizMsgId": "string",
    "from": "stringstrin",
    "to": "stringstrin",
    "messageNameId": "string"
  },
  "originalSettlement": {
    "originalSettlementAmount": {
      "amount": 0,
      "currency": "str"
    },
    "originalSettlementDate": "2019-08-24T14:15:22Z"
  },
  "chargesInformation": [
    {
      "amount": {
        "amount": 0,
        "currency": "str"
      },
      "agent": {
        "bicFI": "stringstrin",
        "lei": "stringstringstringst",
        "name": "string",
        "postalAddress": {
          "department": "string",
          "subDepartment": "string",
          "streetName": "string",
          "buildingNumber": "string",
          "buildingName": "string",
          "floor": "string",
          "postBox": "string",
          "room": "string",
          "postCode": "string",
          "townName": "string",
          "townLocationName": "string",
          "districtName": "string",
          "countrySubDivision": "string",
          "country": "st",
          "addressLine": [
            "string"
          ]
        },
        "clearingSystemMemberId": {
          "code": "string",
          "memberId": "string"
        }
      }
    }
  ]
}

Code copied

Response (application/json)

202 Accepted
400 Bad Request

Accepted

{
  "paymentId": "string"
}

Code copied

Bad Request

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

Code copied

Associated Webhooks

T2 Payment Return Inbound Completed webhook
Customer Accounts Transaction Completed webhook

Simulate a T2 FI payment

post/payments/t2-rtgs/v1/inbound/institution-payments

Trigger inbound financial institution payment request (Pacs009) to simulate a payment being sent from a T2 scheme participent into ClearBank to a ClearBank customer

Parameters

Request Payload (application/json)

paymentIdentification object
header object
value object
debtor object
creditor object
creditorAgent object
instructingAgent object
instructedAgent object
debtorAgent object
previousInstructingAgent1 object
previousInstructingAgent2 object
previousInstructingAgent3 object
purposeCode string

request

{
  "paymentIdentification": {
    "instructionId": "string",
    "endToEndId": "string",
    "uetr": "00168b15-e953-4990-a0c1-a37ad64c1587",
    "clearingSystemId": "string"
  },
  "header": {
    "bizMsgId": "string",
    "from": "stringstrin",
    "to": "stringstrin",
    "messageNameId": "string"
  },
  "value": {
    "settlementAmount": 0,
    "settlementCurrency": "str"
  },
  "debtor": {
    "identification": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "account": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "stri"
          },
          "issuer": "string"
        }
      },
      "type": {
        "code": "string",
        "proprietary": "string"
      },
      "currency": "string",
      "name": "string",
      "proxy": "string"
    }
  },
  "creditor": {
    "identification": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "account": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "stri"
          },
          "issuer": "string"
        }
      },
      "type": {
        "code": "string",
        "proprietary": "string"
      },
      "currency": "string",
      "name": "string",
      "proxy": "string"
    }
  },
  "creditorAgent": {
    "identification": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "account": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "stri"
          },
          "issuer": "string"
        }
      },
      "type": {
        "code": "string",
        "proprietary": "string"
      },
      "currency": "string",
      "name": "string",
      "proxy": "string"
    }
  },
  "instructingAgent": {
    "bic": "CLRBNL2AXXX",
    "lei": "stringstringstringst"
  },
  "instructedAgent": {
    "bic": "stringstrin",
    "lei": "stringstringstringst"
  },
  "debtorAgent": {
    "identification": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "account": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "stri"
          },
          "issuer": "string"
        }
      },
      "type": {
        "code": "string",
        "proprietary": "string"
      },
      "currency": "string",
      "name": "string",
      "proxy": "string"
    }
  },
  "previousInstructingAgent1": {
    "identification": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "account": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "stri"
          },
          "issuer": "string"
        }
      },
      "type": {
        "code": "string",
        "proprietary": "string"
      },
      "currency": "string",
      "name": "string",
      "proxy": "string"
    }
  },
  "previousInstructingAgent2": {
    "identification": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "account": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "stri"
          },
          "issuer": "string"
        }
      },
      "type": {
        "code": "string",
        "proprietary": "string"
      },
      "currency": "string",
      "name": "string",
      "proxy": "string"
    }
  },
  "previousInstructingAgent3": {
    "identification": {
      "bicFI": "stringstrin",
      "lei": "stringstringstringst",
      "name": "string",
      "postalAddress": {
        "department": "string",
        "subDepartment": "string",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "floor": "string",
        "postBox": "string",
        "room": "string",
        "postCode": "string",
        "townName": "string",
        "townLocationName": "string",
        "districtName": "string",
        "countrySubDivision": "string",
        "country": "st",
        "addressLine": [
          "string"
        ]
      },
      "clearingSystemMemberId": {
        "code": "string",
        "memberId": "string"
      }
    },
    "account": {
      "identification": {
        "iban": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "stri"
          },
          "issuer": "string"
        }
      },
      "type": {
        "code": "string",
        "proprietary": "string"
      },
      "currency": "string",
      "name": "string",
      "proxy": "string"
    }
  },
  "purposeCode": "string"
}

Code copied

Response (application/json)

202 Accepted
400 Bad Request

Accepted

{
  "paymentId": "string"
}

Code copied

Bad Request

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

Code copied

Associated Webhooks

T2 Financial Institution Credit Transfer Inbound Completed webhook
Customer Accounts Transaction Completed webhook

T2

T2

Payment types

Operating hours

Sending a T2 payment

Send a T2 payment

Parameters

Request Payload (application/json)

Response (application/json)

Associated Webhooks

Returning a T2 payment

Return a T2 payment

Parameters

Request Payload (application/json)

Response (application/json)

Associated Webhooks

Sending a T2 payment to an institution

Send a T2 payment to an institution

Parameters

Request Payload (application/json)

Response (application/json)

Associated Webhooks

Receiving T2 payments

T2 simulation endpoints

Simulate a T2 payment

Parameters

Request Payload (application/json)

Response (application/json)

Associated Webhooks

Simulate a return T2 payment

Parameters

Request Payload (application/json)

Response (application/json)

Associated Webhooks

Simulate a T2 FI payment

Parameters

Request Payload (application/json)

Response (application/json)

Associated Webhooks