Authorise Payment

post

https://api.bcb.group/v5/payments/authorise

Each payment type requires a different payload, depending on the requirements of the scheme and currency. Check the examples on the right to see the different supported transfers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

counterparty_id

integer

required

YOUR_COUNTERPARTY_ID

sender_account_id

string

required

YOUR_ACCOUNT_ID

ccy

string

required

ISO4217 currency code EG: GBP

amount

string

required

reference

string

required

reason

string

required

notes

string

This information is not relayed on the payment

preferred_scheme

string

enum

required

Defaults to AUTO

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

Allowed:

nonce

string

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_id

integer

beneficiary_name

string

beneficiary_address_line_1

string

beneficiary_address_line_2

string

beneficiary_address_line_3

string

beneficiary_city

string

beneficiary_region

string

beneficiary_postcode

string

beneficiary_country

string

beneficiary_account_number

string

beneficiary_sort_code

string

beneficiary_bic

string

beneficiary_iban

string

beneficiary_routing_number

string

beneficiary_wire_routing

string

beneficiary_swift_code

string

beneficiary_national_clearing_code

string

beneficiary_institution

string

beneficiary_branch

string

beneficiary_lei_code

string

Mandatory for CHAPS

beneficiary_bank_name

string

beneficiary_bank_address

string

beneficiary_bank_country

string

intermediary_bank

object

Only valid for USD SWIFT

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

200Success

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error