Make a payment

The endpoint is used for initiating a single payment.

Overview

This endpoint processes individual payments one at a time. It is suitable for use cases where payments are handled individually, such as companies with low payment volumes or systems that process payments individually in near-real time (interactive processing).

If your company deals with small amounts of payments at low frequencies, the Single Payments endpoint is the appropriate choice.

Duplicate checks

All single payments submitted via the Single Payments API undergo a duplicate check to ensure that the same payment is not processed twice.

If two single payments with the same amount/currency, beneficiary name and address, debtor reference and execution date are submitted, the second payment will be rejected. The second payment will initially be placed in a PendingProcessing state before being rejected.

Occasionally, two single payments may run simultaneously and bypass the duplicate check due to parallel processing.

The endpoint supports idempotency keys.

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

Parameter

Required

Allowed input

Description

Example

requestedExecutionDate

Mandatory

YYYY-MM-DD

The date on which you would like your payment to be processed and debited from your Debtor Account

05/12/2021

fxQuoteId

Optional

GUID

The quote id which includes exchange rate, currency pair and expiry time

53c7b2c3-d013-4dd7-82ee-458dbc41b2b5

debtorAccount

account

Mandatory

IBAN or account

Account from which funds will be debited

DK1111111111111111

financialInstitution

Mandatory if Debtor Account is not an IBAN. Optional otherwise

Bank Identifier Code (BIC) or a National Clearing Code (NCC)

Financial Institution where Debtor Account resides

SXPYDKKKXXX or SC083002

country

Mandatory if Debtor Account is not an IBAN. Optional otherwise

ISO Country Code

Country of sender’s bank

DK

debtorViban

Optional

IBAN

VIBAN belonging to the chosen account. This field should be populated if you wish to use funds from a specific VIBAN

DK1111111111111111

debtorReference

Optional

Maximum length: 35. Allowed characters*

Own reference which can be used for your own reconciliation. This value can be found on the reconciliation and rejection reports under User Reference. This field is purely for own reference, i.e. it is not part of the resulting payment

Debtor reference from your system

debtorNarrativeToSelf

Optional

Maximum length: 35. Allowed characters*

Dual purpose. Narrative to self: This field is purely for your own reference, i.e. it is not part of the resulting payment

Free text field

currencyOfTransfer

Mandatory

Format of Alpha 3 ISO 4217

Currency of the amount that will be transferred to the creditor. Only supported currencies allowed

EUR

amount

currency

Mandatory

Format of Alpha 3 ISO 4217

Currency of the amount. Only supported currencies allowed

EUR

amount

Mandatory

Must 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 Currency

Instructed amount

Valid examples (GBP): 100 or 100. or 100.00. Invalid examples (GBP): 1,100 or 1,100.00 or 1100.000

chargeBearer

Mandatory

"SHA", "OUR" or "BEN"

Determines which of the parties will be charged the payment fee.
BC Connect 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.

SHA

remittanceInformation

line1

Optional

Maximum length: 35. Allowed characters*. Illegal characters**

Line 1 of the textual information passed from Debtor to Creditor as part of the transfer. Purpose code required for AED and SAR payments in this field.

Free text field

line2

Optional

Maximum length: 35. Allowed characters*. Illegal characters**

Line 2 of the textual information passed from Debtor to Creditor as part of the transfer

Free text field

line3

Optional

Maximum length: 35. Allowed characters*. Illegal characters**

Line 3 of the textual information passed from Debtor to Creditor as part of the transfer

Free text field

CreditorId

Mandatory if creditorAccount is left blank

GUID

ID of the creditor if they are created as a pre-defined beneficiary

3d7279c9-bca2-444f-a872-a8dc042f1c63

creditorAccount

account

Mandatory, unless CreditorId is populated

IBAN or account number

Account of the creditor that will receive funds. Can be either an account number or an International Bank Account Number (IBAN).

DK5989000000054321

financialInstitution

Mandatory if CreditorAccount is not an IBAN, and CreditorId is not populated.

Can 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/ABA. DK - Registration number requires prefix with 'DK' followed by 4-digit Registration number. 'AU' followed by a 6 digit BSB number

Financial Institution where Creditor Account resides

WIREDEMM or SC123456

country

Mandatory if Creditor Account is not an IBANAnd CreditorId is not populatedOptional otherwise

ISO Country Code

Country of receiver’s bank

DE

creditorName

Mandatory if payment targets institutions other than BC

Maximum length: 35. Allowed characters*. Illegal characters**

Legal name of creditor

Beneficiary name

creditorAddress

line1

Mandatory if payment targets institutions other than BC

Maximum length: 35. Allowed characters*. Illegal characters**

Line 1 detailing the address of the Creditor

Address line 1

line2

Optional

Maximum length: 35. Allowed characters*. Illegal characters**

Line 2 detailing the address of the Creditor

Address line 2

line3

Optional

Maximum 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 code

Address line 3

clearingNetwork

Optional

Only allowed values: "SEPAINST", "SEPA" or "T2"

Use this parameter to select the payment rail to be used for executing the payment

SEPAINST

purposeCode

Conditional

“GOD”, “STR”, “CTF” or “OTF”

Purpose code is mandatory for CNH payments going to China

GOD

*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 (-)
Language
Credentials
Bearer