Make a payment

post

https://www.bankingcircleconnect.com/api/v1/payments/singles

The endpoint is used for initiating a single payment.

Body Params

Payment instruction

requestedExecutionDate

string

required

Date representation
Format: ISO 8601 | YYYY-MM-DD
Example: 2001-01-28

fxQuoteId

uuid | null

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

debtorAccount

object

required

Account of the debtor

debtorViban

object

Viban of the debtor

debtorReference

string | null

Debtor own reference.
In case of machine-to-machine may be an identifier of your own system.
Purely for own reference -> Is not part of the resulting payment

debtorNarrativeToSelf

string | null

Debtor own narrative.
Purely for own reference -> Is not part of the resulting payment

currencyOfTransfer

string

required

Currency of the amount that will be remitted to the creditor

amount

object

required

An amount

chargeBearer

string

required

Who will be charged with the payment fee
Supported values are:
"BEN" - Beneficiary bears Transaction charges"
"OUR" - Ordering customer bears Transaction charges
"SHA" - Transaction charges to be shared

remittanceInformation

object

Information shared between debtor and creditor
Unstructured free text

creditorId

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: Conditional
* Either creditorId is provided * Or creditorAccount is provided

creditorName

string | null

Name of the creditor
Condition: Conditional
* Either creditorId is provided * Or creditorName is provided

creditorAddress

A postal address

clearingNetwork

string | null

A clearing network a payment will be routed through. Possible values: 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

List`1

serviceLevels

array of strings | null

A prioritized list of service levels indicating the urgency of the payment. Possible values in this list:
* INST - Instant * URGP - Urgent * NURG - Not Urgent

List`1

purposeCode

string | null

Underlying reason for the payment transaction

categoryPurposeCode

string | null

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

creditorProxyAccount

object

Proxy information used for resolving creditor account Currently only supports PayID proxy type

Headers

X-Verification-Nonce

string

X-MessageReference

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

Idempotency-Key

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

201Created

400Bad request. Request is not correctly formulated. Goes for both Header, Query and Body. Verify the error description and properties.

403Forbidden. The server understood the request, but is refusing it or the access is not allowed, i.e. if resource exists but calling user does not have rights to access it.

404Not found. There is no resource behind the URL, i.e. requesting data on an account that does not exist.

409Conflict. Idempotency-key violation. Request being handled.

500Internal Server Error. Something unexpected happened on BC Connect side.