v1

latestOpenAPI 3.0.02026-07-242444105.9 KB

Payments

Authorise Payment

Make a Payment

post/v5/payments/authorise

Request body

counterparty_idinteger required

YOUR_COUNTERPARTY_ID

sender_account_idstring required

YOUR_ACCOUNT_ID

ccystring required

ISO4217 currency code EG: GBP

amountstring required

referencestring required

reasonstring required

notesstring

This information is not relayed on the payment

preferred_scheme'AUTO' | 'BLINC' | 'INTERNAL' required

AUTO > for external payments BLINC > for payments inside BLINC network, must use BLINC accounts INTERNAL > for payments between BCB accounts of the same counterparty

noncestring required

Nonce field ensures that payment requests can only be processed once, If the nonce for a payment request is not unique for the account then it will be rejected.

beneficiary_account_idinteger

beneficiary_namestring

beneficiary_address_line_1string

beneficiary_address_line_2string

beneficiary_address_line_3string

beneficiary_citystring

beneficiary_regionstring

beneficiary_postcodestring

beneficiary_countrystring

beneficiary_account_numberstring

beneficiary_sort_codestring

beneficiary_bicstring

beneficiary_ibanstring

beneficiary_routing_numberstring

beneficiary_wire_routingstring

beneficiary_swift_codestring

beneficiary_national_clearing_codestring

beneficiary_institutionstring

beneficiary_branchstring

beneficiary_lei_codestring

Mandatory for CHAPS

beneficiary_bank_namestring

beneficiary_bank_addressstring

beneficiary_bank_countrystring

Response

Success

endToEndIdentificationstring required

transactionIdstring required

noncestring required

responsestring required

Example response

[
  {
    "endToEndIdentification": "PaymentEndToEndIdentification",
    "transactionId": "PaymentTransactionId",
    "nonce": "PaymentNonce",
    "response": "Accepted"
  }
]