Make an agency or correspondent banking payment

post

https://www.bankingcircleconnect.com/api/v1/payments/fi-to-fi-customer-credit-transfer-initiation

Body Params

Payment instruction

instrId

string | null

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

requestedExecutionDate

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.

debtorName

string | null

Legal name of debtor
Condition: Conditional
* Mandatory if ultimateDebtorName is not provided * Optional if ultimateDebtorName is provided

debtorAddress

A postal address

debtorCountry

string | null

Country code of the debtor.

ultimateDebtorName

string | null

Legal name of ultimate debtor
Condition: Conditional
* Mandatory if debtorName is not provided * Optional if debtorName is provided

ultimateDebtorAddress

A postal address

ultimateDebtorCountry

string | null

Country code of the ultimate debtor.

debtorAgentFinancialInstitution

string

required

Financial Institution code (BIC) for the ordering client

debtorAgentAccount

string

required

Account with Banking Circle on which the payments are settled.

currencyOfTransfer

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

chargeBearer

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

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: Mandatory

creditorName

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

creditorAddress

A postal address

clearingNetwork

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

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

fxQuoteId

uuid | null

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

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.