Make an agency or correspondent banking payment

Overview

The endpoint is used for initiating a agency or correspondent banking payment. The tables below describes each parameter and provides examples.

📘

From the start of November 2026, applicable payment schemes will require Town Name and Country Code in dedicated address fields. Existing address requirements continue to apply.

Duplicate check using idempotency key

We have enhanced our duplicate checks by extending all payment initiation endpoints to accept an idempotency key header. The key can prevent the same payment from getting initiated more than once, for example in case of connectivity issues. The idempotency key, provided by you, needs to be unique and maximum 100 characters. The key will be valid for 10 days.

If the idempotency key is more than 100 characters, the endpoint will return a "400 Bad Request".

If the idempotency key is not unique (if the key has been used for the initiation of a previous payment within the past 10 days), the endpoint will return a "409 Conflict" and return the paymentId of the payment, for which the idempotency key was previously used.

This key will not be exposed in any report or endpoint.

Content specification

Content specifications header

ParameterRequiredAllowed inputDescriptionExample
X-MessageReferenceOptionalStringUnique reference of the HTTP request. If left blank this field will be populated with a GUID6198eb60-d1dd-4aad-9bbd-b01a49214e62
Idempotency-KeyOptionalStringUnique value generated by the user which the API uses to recognize subsequent retries of the same request. This field is limited to a maximum of 100 characters, if not upheld the API will return with an error 400 - Bad Request2b7b05ad-4411-4a19-8c95-2508b17e0fd8

Content specifications body

ParameterRequiredAllowed inputDescriptionExampleMT103 fields
instrIdOptionalMaximum length: 35
Allowed characters*
Illegal characters**
Reference, which can be used for your own reconciliation.
Available in the reconciliation and rejection reports under the property called UserReferenceNumber.
This field is not included in the payment details sent to the creditor.
ABCDEFGHIJKL20
requestedExecutionDateMandatoryYYYY-MM-DDThe date on which you want your payment to be processed2021-12-0532A
debtorAccount
accountMandatoryIBAN or account numberAccount number issued by you, which will be sent to the creditor as the debtor accountIE29AIBK9311521234567850K
financialInstitutionMandatory if Debtor Account is not an IBAN. Optional otherwiseBank Identifier Code (BIC) or a National Clearing Code (NCC)Financial Institution where debtorAccount residesABCDIEXXXXX or SC08300252A
countryMandatory if Debtor Account is not an IBAN. Optional otherwiseISO Country CodeCountry of financial institution, where debtorAccount residesIEn/a
debtorNameMandatory if ultimateDebtorName is not provided.
Optional otherwise
Maximum length: 35
Allowed characters*
Illegal characters**
Legal name of debtorDebtor Name50K
debtorAddress
line1Mandatory if ultimateDebtorAddressLine1 is not provided.
Optional otherwise
Maximum length: 35
Allowed characters*
Illegal characters**
Line 1 detailing the address of the debtorAddress line 150K
line2OptionalMaximum length: 35
Allowed characters*
Illegal characters**
Line 2 detailing the address of the debtorAddress line 250K
line3OptionalMaximum length: 35
Allowed characters*
Illegal characters**
Line 3 detailing the address of the debtor
3rd address line also referred to as “city field”. Fill with Country as Alpha 2 ISO 3166-1 and city name with postal code
IE – Dublin, D02 RF2950K
debtorCountryMandatory unless provided under the Ultimate Debtor country.

Country representation

Format: Alpha 2 ISO 3166-1

Country code of the debtorDE50K
(coming soon) debtorTownMandatory unless provided under the corresponding Ultimate Debtor town.Maximum length: 35Town name of the debtorBerlin
ultimateDebtorNameMandatory if debtorName is not provided
Optional elsewise
If populated, it will be carried forward as the debtor name
Maximum length: 35
Allowed characters*
Illegal characters**
Legal name of ultimate debtorUltimate debtor name50K
ultimateDebtorAddress
line1Mandatory if debtorAddressLine1 is not provided
Optional elsewise
If populated, it will be carried forward as the debtor address
Maximum length: 35
Allowed characters*
Illegal characters**
Line 1 detailing the address of the ultimate debtor addressAddress line 150K
line2OptionalMaximum length: 35
Allowed characters*
Illegal characters**
Line 2 detailing the address of the ultimate debtor addressAddress line 250K
line3OptionalMaximum length: 35
Allowed characters*
Illegal characters**
Line 3 detailing the address of the ultimate debtor address
3rd address line also referred to as city field. Fill with Country as Alpha 2 ISO 3166-1 and city name with postal code
IE – Dublin, D02 RF2950K
ultimateDebtorCountryMandatory unless provided under the corresponding Debtor country.

Country representation

Format: Alpha 2 ISO 3166-1

Country code of the ultimate debtorIE50K
(coming soon) ultimateDebtorTownMandatory unless provided under the corresponding Ultimate Debtor town.Maximum length: 35Town of the ultimate debtorDublin
debtorAgentFinancialInstitutionMandatoryBank Identifier Code (BIC)Your BICABCDIEXXXXX52A
debtorAgentAccountMandatoryIBAN or account number

Your account, within BC Connect, used for settlement of the payment (your Nostro account)

Account number can be provided for branches not supporting IBANs

DK111111111111111153B
currencyOfTransferoptionalFormat of Alpha 3 ISO 4217credit currency (if different from debit currency). Applicable when multi-currency payment is intended.GBP32A
amount
currencyMandatoryFormat of Alpha 3 ISO 4217Currency of the amount. Only supported currencies allowedEUR32A, 33B
amountMandatoryMust be larger than zero and formatted without the one thousand separator using a full stop ‘.’ as the decimal separator. Must conform with allowed number of decimals for selected Amount CurrencyInstructed amountValid examples (GBP): 100 or 100. or 100.00. Invalid examples (GBP): 1,100 or 1,100.00 or 1100.00032A, 33B
chargeBearerMandatory"SHA", "OUR" or "BEN"Determines which of the parties will be charged the payment fee.
We will either carry the instructed charge bearer value forward, or overwrite the value, before executing the payment. This depends on the client’s “charge bearer setup”, and the payment rail used to execute the payment.
SHA71A
remittanceInformation
line1OptionalMaximum length: 35. Allowed characters . Illegal characters TruncationLine 1 of the textual information passed from Debtor to Creditor as part of the transferFree text field70
line2OptionalMaximum length: 35. Allowed characters*. Illegal characters**Line 2 of the textual information passed from Debtor to Creditor as part of the transferFree text field70
line3OptionalMaximum length: 35. Allowed characters*. Illegal characters**Line 3 of the textual information passed from Debtor to Creditor as part of the transferFree text field70
line4OptionalMaximum length: 35
Allowed characters*
Illegal characters**
Line 4 of the textual information passed from Debtor to Creditor as part of the transferFree text field70
CreditorIdMandatory if creditorAccount is left blankGUIDID of the creditor if they are created as a pre-defined beneficiary3d7279c9-bca2-444f-a872-a8dc042f1c63n/a
creditorAccount
accountMandatory, unless CreditorId is populatedIBAN or account numberAccount of the creditor that will receive funds. Can be either an account number or an International Bank Account Number (IBAN).DK598900000005432159
financialInstitutionMandatory if Creditor Account is not an IBAN and CreditorId is not populated. Optional otherwiseCan be either a Bank Identifier Code (BIC) or a National Clearing Code.Supported National Clearing Codes:UK – Sort Code requires prefix with ‘SC’ followed by the 6-digit sort code.US – Fedwire Code requires prefix with ‘FW’ followed by 9-digit Fedwire/ABAFinancial Institution where Creditor Account residesWIREDEMM or SC12345657A
countryMandatory if Creditor Account is not an IBAN and CreditorId is not populated. Optional otherwiseISO Country CodeCountry of receiver’s bankDEn/a
creditorNameMandatory if payment targets institutions other than usMaximum length: 35. Allowed characters*. Illegal characters**Legal name of creditorBeneficiary name59
creditorAddress
line1Mandatory if payment targets institutions other than us. Optional otherwiseMaximum length: 35. Allowed characters*. Illegal characters**Line 1 detailing the address of the CreditorAddress line 159
line2OptionalMaximum length: 35. Allowed characters*. Illegal characters**Line 2 detailing the address of the CreditorAddress line 259
line3OptionalMaximum length: 35. Allowed characters*. Illegal characters**Line 3 detailing the address of the Creditor. 3rd address line also referred to as city field. Fill with Country as Alpha 2 ISO 3166-1 and city name with postal codeDE – 10117 Berlin59
(coming soon) creditorCountryMandatory

Country representation

Format: Alpha 2 ISO 3166-1

Country code of the creditorDE
(coming soon) creditorTownMandatoryMaximum length: 35.Town of the creditorBerlin
clearingNetworkOptionalOnly allowed values: "SEPAINST", "SEPA" or "T2"Use this parameter to select the payment rail to be used for executing the paymentSEPAINSTn/a
purposeCodeConditional

Purpose code For CNH payments going to China: “GOD”, “STR”, “CTF” or “OTF”

For Wero Refunds:
"REFU" or "IPRT"

Purpose code is mandatory for CNH payments going to China or for Wero RefundsGODn/a
categoryPurposeCodeConditional"EPI"Category purpose code is mandatory for Wero RefundsEPIn/a
fxQuoteIDOptionalUse the pre-fectched FX quote from Get an FX Quote endpoint.n/a
serviceLevelsOptionalOnly allowed values: "INST", "NURG", "URGP"Use this parameter to select the payment rail(s) to be used for executing the payment. You can specify one or more values.["INST","URGP"]n/a

*Characters allowed:

a b c d e f g h i j k l m n o p q r s t u v w x y z

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

0 1 2 3 4 5 6 7 8 9

/ - ? : ( ) . , ' + _

Space

**Illegal characters:

  • Field only composed of blank characters (space)
  • First character is colon (:) or hyphen (-)

***Truncation:
For remittance information, maximum 140 characters allowed collectively from line 1 to line 4. The characters exceeding 140 characters will be discarded.

Body Params

Payment instruction

Payment creation request object for agency banking

string | null

An identification, as assigned by an instructing party for an instructed party,
to unambiguously identify the instruction.

Condition: Optional

string
required

Date representation

Format: ISO 8601 | YYYY-MM-DD

Example: 2001-01-28

debtorAccount
object
required

External Debtor Account that will be sent to the creditor.

string | null

Legal name of debtor

Condition: Conditional

Mandatory if ultimateDebtorName is not provided Optional if ultimateDebtorName is provided

debtorAddress

A postal address

string | null

Name of the city, town, or locality of the address.

string | null

Two-letter country code identifying the country of the address (e.g., DE, FR).

string | null

Legal name of ultimate debtor

Condition: Conditional

Mandatory if debtorName is not provided Optional if debtorName is provided

ultimateDebtorAddress

A postal address

string | null

Name of the city, town, or locality of the address.

string | null

Two-letter country code identifying the country of the address (e.g., DE, FR).

string
required

Financial Institution code (BIC) for the ordering client

string
required

Account with Banking Circle on which the payments are settled.

string | null

Currency of the amount that will be remitted to the creditor.

If not provided, amount.Currency will be used as currencyOfTransfer.

amount
object
required

An amount

string
required

Who will be charged with the payment fee.
Only supported value currently is "SHA" - Shared expense.

remittanceInformation
object

Information shared between debtor and creditor

Unstructured free text

uuid | null

Reference to a predefined creditor

Condition: Conditional

Either creditorId is provided Or creditorAccount, creditorName and creditorAddress properties are provided

creditorAccount
object

Account of the creditor

Condition: Mandatory

string | null

Name of the creditor

Condition: Conditional

Mandatory if payment targets institutions other than Banking Circle Optional if payment target institution is Banking Circle

string | null

Name of the city, town, or locality of the address.

string | null

Two-letter country code identifying the country of the address (e.g., DE, FR).

creditorAddress

A postal address

string | null

A clearing network a payment will be routed through.

Example:
* SEPAINST, SEPA, T2

prioritizedClearingNetworks
array of strings | null

A prioritized list of clearing networks a payment shall be routed through.
Possible values in this list: SEPAINST, SEPA, T2

prioritizedClearingNetworks
serviceLevels
array of strings | null

A prioritized list of service levels indicating the urgency of the payment.
Possible values in this list:

INST - Instant INST_STRICT - Instant Strict
URGP - Urgent NURG - Not Urgent

serviceLevels
string | null

Underlying reason for the payment transaction

string | null

Specifies the high-level purpose of the instruction based on a set of pre-defined categories

uuid | null

Unique identifier of the quote, previously retrieved through "fx/rates" endpoint.
Optional field only used in case of FX RFQ flow

Headers
string
string

Unique reference of the HTTP request.
If left blank this field will be populated with a GUID without dashes.
This field is limited to a maximum of 35 characters, if not upheld the API will return with an error 400 - Bad Request.
Example: 6198eb60-d1dd-4aad-9bbd-b01a49214e62

string

Unique value generated by the user which the API uses to recognize subsequent retries of the same request.
This field is limited to a maximum of 100 characters, if not upheld the API will return with an error 400 - Bad Request.
Example: 2b7b05ad-4411-4a19-8c95-2508b17e0fd8

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json