High Value International Payments

Overview

You can now send single or bulk high value payments overseas in currencies other than GBP. To be able to initiate high value international payments, we will need you to first fund your SIM account while integrating with our API in the simulation environment. As part of our fund assessment control framework, you will not be able to initiate high value international payments without doing so.

ClearBank accepts inbound and outbound Euro payments via the TARGET2 scheme only. Inbound payments which are processed via any other scheme apart from TARGET2 will not be accepted by ClearBank. Non-EUR high value international payments are settled according to cut-off times specific to the currency in which the payment is made.

For more information about the countries that you can send high value payments to, currencies supported by ClearBank and currency cut-off times, please speak to your Relationship Manager.

Fund your account in the simulation environment

post/v1/mccy/inboundpayment/{accountUniqueId}

This endpoint is meant for the simulation environment only as it enables you to make an inbound payment into your account in our simulation environment.

Parameters

  • accountUniqueId string, path, Required

    The unique identifier for the account. This will be the currency supported by the account e.g., EUR.

Request Payload (application/json)

  • instructedCurrency string, Required

    Currency of the instructed payment. This is the three-letter ISO currency code.

  • instructedAmount number, Required

    Instructed payment amount.

  • reference string

    Reference provided by the ultimate debtor for the payment.

    Minimum length
    0
    Maximum length
    140
  • endToEndId string

    Unique identifier supplied by you in your API request to simulate the sending bank’s reference.

    Minimum length
    0
    Maximum length
    15
  • ultimateCreditor object, Required

    Information about the ultimate creditor of the transaction.

  • ultimateDebtor object

    Information about the ultimate debtor of the transaction.

request

{
  "instructedCurrency": "EUR",
  "instructedAmount": 1000,
  "reference": "12345678",
  "endToEndId": "87654321",
  "ultimateCreditor": {
    "iban": "GB14BARC20031838591122",
    "name": "Rob Robinson",
    "address": "1 High St Northleach Gloucestershire"
  },
  "ultimateDebtor": {
    "identifier": "IR14BARC20031838591122",
    "name": "Joe Bloggs",
    "address": "2 Main St London"
  }
}
Code copied

Response (application/json)

  • 201 Successful operation
  • 400 Bad Request. Check query parameters
  • 404 Not Found. AccountUniqueId not recognized

Successful operation

{
  "transactionId": "string",
  "instructedCurrency": "string",
  "instructedAmount": 0,
  "reference": "string",
  "endToEndId": "string",
  "ultimateCreditorIBAN": "string",
  "ultimateCreditorName": "string",
  "ultimateDebtorIdentifier": "string",
  "ultimateDebtorName": "string",
  "timestampCreated": "2021-12-11T10:54:44Z",
  "bankRefSearchable": "string"
}
Code copied

Bad Request. Check query parameters

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

Not Found. AccountUniqueId not recognized

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

Initiate a payment

post/v1/mccy/payments

This endpoint is used to initiate payments.

Parameters

    Request Payload (application/json)

    • batchId string

      Unique identifier for the batch in which the payment is being submitted.

    • currencyCode string, Required

      Three-letter ISO currency code for the outbound payment.

      Minimum length
      3
      Maximum length
      3
    • transactions array, Required

      Array of transactions.

    request

    {
      "batchId": "string",
      "currencyCode": "EUR",
      "transactions": [
        {
          "endToEndId": "string",
          "reference": "string",
          "amount": 0,
          "creditor": {
            "name": "string",
            "address": {
              "addressLine1": "string",
              "addressLine2": "string",
              "addressLine3": "string",
              "postCode": "string",
              "country": "st"
            },
            "bic": "string",
            "identification": {
              "organisationIdentification": {
                "Other": {
                  "identification": "string",
                  "schemeName": {
                    "code": "stri",
                    "proprietary": "string"
                  },
                  "issuer": "string"
                }
              },
              "privateIdentification": {
                "dateAndPlaceOfBirth": {
                  "dateOfBirth": "2021-12-11",
                  "cityOfBirth": "string",
                  "countryOfBirth": "st"
                },
                "other": {
                  "identification": "string",
                  "schemeName": {
                    "code": "stri",
                    "proprietary": "string"
                  }
                }
              }
            },
            "countryOfResidence": "st",
            "contactDetails": {
              "name": "string",
              "emailAddress": "string"
            },
            "iban": "string",
            "accountNumber": "string",
            "schemeName": {
              "code": "stri",
              "proprietary": "string"
            }
          },
          "debtorName": "string",
          "debtorAddress": {
            "addressLine1": "string",
            "addressLine2": "string",
            "addressLine3": "string",
            "postCode": "string",
            "country": "st"
          },
          "debtorBic": "string",
          "debtorPrivateIdentification": {
            "dateAndPlaceOfBirth": {
              "dateOfBirth": "2021-12-11",
              "cityOfBirth": "string",
              "countryOfBirth": "st"
            },
            "other": {
              "identification": "string",
              "schemeName": {
                "code": "stri",
                "proprietary": "string"
              }
            }
          },
          "accountIdentifier": {
            "kind": "AccountId",
            "identifier": "string"
          },
          "debtorAccountCurrency": "str",
          "intermediaryAgent": {
            "FinancialInstitutionIdentification": {
              "bic": "string",
              "aba": "string",
              "name": "string",
              "addressDetails": {
                "addressLine1": "string",
                "addressLine2": "string",
                "addressLine3": "string",
                "postCode": "string",
                "country": "st"
              }
            }
          },
          "creditorAgent": {
            "FinancialInstitutionIdentification": {
              "bic": "string",
              "aba": "string",
              "clearingSystemIdCode": "string",
              "memberId": "string",
              "name": "string",
              "addressDetails": {
                "addressLine1": "string",
                "addressLine2": "string",
                "addressLine3": "string",
                "postCode": "string",
                "country": "st"
              }
            },
            "branchId": "string"
          },
          "instructionForDebtorAgent": "string",
          "purpose": {
            "code": "stri",
            "proprietary": "string"
          },
          "remittanceInformation": {
            "additionalRemittanceInformation": "string"
          },
          "ultimateCreditor": {
            "name": "string",
            "address": {
              "addressLine1": "string",
              "addressLine2": "string",
              "addressLine3": "string",
              "postCode": "string",
              "country": "st"
            },
            "bic": "string",
            "identification": {
              "organisationIdentification": {
                "Other": {
                  "identification": "string",
                  "schemeName": {
                    "code": "stri",
                    "proprietary": "string"
                  },
                  "issuer": "string"
                }
              },
              "privateIdentification": {
                "dateAndPlaceOfBirth": {
                  "dateOfBirth": "2021-12-11",
                  "cityOfBirth": "string",
                  "countryOfBirth": "st"
                },
                "other": {
                  "identification": "string",
                  "schemeName": {
                    "code": "stri",
                    "proprietary": "string"
                  }
                }
              }
            }
          }
        }
      ]
    }
    Code copied

    Response (application/json)

    • 202 Accepted
    • 400 Bad Request
    • 404 Not Found
    • 409 Conflict
    • 422 Unprocessable Entity
    • 500 Server Error
    • 503 Server Error

    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

    Conflict

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

    Unprocessable Entity

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

    Associated Webhooks