OAuth 2.0 client-credentials, Bearer-token REST API for BCB Group accounts, balances, transactions, beneficiaries, BLINC members, payment authorisation, virtual IBAN accounts, bank lookup and signed webhooks. Sandbox (UAT) and Production environments.
{
"openapi": "3.0.0",
"info": {
"title": "BCB Group Payments API",
"description": "This is the api documentation for the BCB Group Payments API",
"version": "1.0.0",
"contact": {}
},
"servers": [
{
"url": "https://api.bcb.group",
"description": "Production"
},
{
"url": "https://api.uat.bcb.group",
"description": "Sandbox"
}
],
"paths": {
"/v4/accounts/balance/{accountId}": {
"get": {
"summary": "Balance",
"description": "Get the balance for an account",
"operationId": "Accounts_BalanceV4",
"responses": {
"200": {
"description": "The balance was retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "The balance for the account was not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"parameters": [
{
"name": "accountId",
"in": "path",
"required": true,
"description": "The account id",
"schema": {
"example": 123,
"type": "integer",
"default": ""
}
}
],
"tags": [
"Accounts"
],
"security": [
{
"bearer": []
}
]
}
},
"/v3/accounts": {
"get": {
"summary": "Accounts",
"description": "List Accounts",
"operationId": "Accounts_ListAccountsV3",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"examples": {
"Success": {
"summary": "Success",
"value": [
{
"id": 378,
"counterparty_id": 483,
"aid": "A01-CX00000101",
"cid": "CX00000101",
"account_type": "Wallet",
"ccy": "BTC",
"host_name": "BCB Group",
"host_hub": "",
"host_location": "",
"node_name": "BCB Payments Ltd",
"node_address": "3LxDswEWKC3mJewRYs44xr3qNBqXMwhszo",
"node_location": "",
"node_country": "",
"node_subaddress": "",
"iban": "",
"account_label": "LNS 5 BTC hszo",
"description": "BCB Payments Ltd, 3LxDswEWKC3mJewRYs44xr3qNBqXMwhszo, BTC",
"bcb_controlled": 1,
"settlement_reference": "",
"created_at": "2018-12-28T14:42:44.000Z",
"updated_at": "2019-01-24T21:26:27.000Z",
"partner_id": 4,
"email": "otc@bcbgroup.io",
"reporting_ccy": "GBP",
"pid": "P01061701",
"partner_name": "BCB Direct"
},
{
"id": 383,
"counterparty_id": 483,
"aid": "A02-CX00000101",
"cid": "CX00000101",
"account_type": "Bank",
"ccy": "CHF",
"host_name": "Credit Suisse",
"host_hub": "Zurich",
"host_location": "Lake View, Zurich, CH 2001, Switzerland",
"node_name": "Best Swiss OTC LLC",
"node_address": "6013354000",
"node_location": "",
"node_country": "CH",
"node_subaddress": "",
"iban": "CH04NWBK53616776013354",
"account_label": "Best Swiss CHF Main Account",
"description": "Best Swiss, Credit Suisse CH04NWBK53616776013354, CHF",
"bcb_controlled": 0,
"settlement_reference": "",
"created_at": "2018-12-28T14:42:44.000Z",
"updated_at": "2018-12-28T14:42:44.000Z",
"partner_id": 4,
"email": "otc@bestswiss.io",
"reporting_ccy": "CHF",
"pid": "P01061701",
"partner_name": "Best Swiss OTC"
}
]
}
},
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"text/html": {
"schema": {
"type": "string",
"example": "Invalid token"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/html": {
"schema": {
"type": "string",
"example": "Internal Server Error"
}
}
}
}
},
"parameters": [
{
"name": "counterparty_id",
"in": "query",
"required": false,
"description": "Limit accounts by Counterparty ID",
"schema": {
"type": "integer",
"default": ""
}
},
{
"name": "id",
"in": "query",
"required": false,
"description": "Limit result set to a specific Account ID",
"schema": {
"type": "integer",
"default": ""
}
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Limit result set for server-side paging",
"schema": {
"type": "integer",
"default": ""
}
},
{
"name": "pageToken",
"in": "query",
"required": false,
"description": "Offset result set when paging",
"schema": {
"type": "integer",
"default": "0"
}
}
],
"tags": [
"Accounts"
],
"security": [
{
"bearer": []
}
]
}
},
"/v3/accounts/{accountId}/transactions/{transactionId}": {
"get": {
"summary": "Transaction Detail",
"description": "List details of a transaction within user permissions",
"operationId": "Accounts_TransactionDetailV3",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"examples": {
"Success": {
"summary": "Success",
"value": {
"tx_id": "7b73263d-65dc-11e9-b39c-42010a8400a9",
"account_id": 539,
"blinc_id": null,
"network": "FPS",
"value_date": "2019-04-23T14:28:26.000Z",
"credit": 0,
"details": {
"bic": null,
"iban": "GB41CLRB04054100000033",
"blinc_id": null,
"reference": "BCB Pay 53135 GBP",
"sort_code": "040541",
"account_name": "BCB Payments Ltd",
"account_number": "00000033",
"counterparty_reference": "BCB Pay 53135 GBP",
"endToEndIdentifier": "fcb60b45a4b94371b7cf2321ec318117",
"nonce": 1598455372829
},
"ticker": "GBP",
"amount": 5858.94,
"approved": 1,
"notes": null,
"source_name": "clearbank"
}
}
},
"schema": {
"$ref": "#/components/schemas/TransactionDetailResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"text/html": {
"schema": {
"type": "string",
"example": "Invalid token"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/html": {
"schema": {
"type": "string",
"example": "Forbidden"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/html": {
"schema": {
"type": "string",
"example": "Not Found"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/html": {
"schema": {
"type": "string",
"example": "Internal Server Error"
}
}
}
}
},
"parameters": [
{
"name": "accountId",
"in": "path",
"required": true,
"description": "The account id",
"schema": {
"example": 123,
"type": "integer",
"default": ""
}
},
{
"in": "path",
"name": "transactionId",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"Accounts"
],
"security": [
{
"bearer": []
}
]
}
},
"/v3/accounts/{accountId}/transactions": {
"get": {
"summary": "Transactions",
"description": "List Account Transactions",
"operationId": "Accounts_TransactionsV3",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"examples": {
"Success": {
"summary": "Success",
"value": [
{
"tx_id": "7b73263d-65dc-11e9-b39c-42010a8400a9",
"account_id": 539,
"blinc_id": null,
"network": "FPS",
"value_date": "2019-04-23T14:28:26.000Z",
"credit": 0,
"details": {
"bic": null,
"iban": "GB41CLRB04054100000033",
"blinc_id": null,
"reference": "BCB Pay 53135 GBP",
"sort_code": "040541",
"account_name": "BCB Payments Ltd",
"account_number": "00000033",
"counterparty_reference": "BCB Pay 53135 GBP",
"endToEndIdentifier": "fcb60b45a4b94371b7cf2321ec318117",
"nonce": 1598455372829
},
"ticker": "GBP",
"amount": 5858.94,
"approved": 1,
"notes": null,
"source_name": "clearbank"
},
{
"tx_id": "38aa62fa-653e-11e9-b39c-42010a8400a9",
"account_id": 539,
"blinc_id": null,
"network": "FPS",
"value_date": "2019-04-22T19:35:37.000Z",
"credit": 1,
"details": {
"bic": null,
"iban": "GB41CLRB04054100000033",
"blinc_id": null,
"reference": "BCB Pay 53135 GBP",
"sort_code": "040541",
"account_name": "BCB Payments Ltd",
"account_number": "00000033",
"counterparty_reference": "BCB Pay 53135 GBP",
"endToEndIdentifier": "fcb60b45a4b94371b7cf2321ec318117",
"nonce": 1623419032251
},
"ticker": "GBP",
"amount": 8280,
"approved": 1,
"notes": null,
"source_name": "clearbank"
}
]
}
},
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Transaction"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"text/html": {
"schema": {
"type": "string",
"example": "Invalid token"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/html": {
"schema": {
"type": "string",
"example": "Forbidden"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"text/html": {
"schema": {
"type": "string",
"example": "Not Found"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/html": {
"schema": {
"type": "string",
"example": "Internal Server Error"
}
}
}
}
},
"parameters": [
{
"name": "accountId",
"in": "path",
"required": true,
"description": "The account id",
"schema": {
"example": 123,
"type": "integer",
"default": ""
}
},
{
"name": "dateFrom",
"in": "query",
"required": false,
"description": "The date to get results from",
"schema": {
"type": "string",
"format": "date",
"default": ""
}
},
{
"name": "dateTo",
"in": "query",
"required": false,
"description": "The date to get results to",
"schema": {
"type": "string",
"format": "date",
"default": ""
}
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Limit result set for server-side paging",
"schema": {
"type": "integer",
"default": ""
}
},
{
"name": "pageToken",
"in": "query",
"required": false,
"description": "Offset result set when paging",
"schema": {
"type": "integer",
"default": ""
}
}
],
"tags": [
"Accounts"
],
"security": [
{
"bearer": []
}
]
}
},
"/v1/payments/{accountId}/verification-of-payee/{end2endId}/approve": {
"post": {
"summary": "VOP Approve",
"description": "Approve a payment where the beneficiary name does not match the name on the account",
"operationId": "Payments_VerificationOfPayeeApproveV1",
"responses": {
"200": {
"description": "The unverified payment was approved successfully."
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerificationOfPayeeErrorResponse"
}
}
}
},
"404": {
"description": "No unverified payment was found for this account with the given end-to-end id.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerificationOfPayeeErrorResponse"
}
}
}
},
"409": {
"description": "The payment is not unverified.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerificationOfPayeeErrorResponse"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "accountId",
"schema": {
"type": "integer"
},
"required": true,
"description": "The account id"
},
{
"in": "path",
"name": "end2endId",
"schema": {
"type": "string"
},
"required": true,
"description": "The end-to-end id of the payment"
}
],
"tags": [
"Payments"
],
"security": [
{
"bearer": []
}
]
}
},
"/v1/bank-lookup": {
"get": {
"summary": "Bank Lookup",
"description": "Retrieve the bank code (BIC) of the bank holding an account from its IBAN",
"operationId": "Tools_BankLookup",
"parameters": [
{
"name": "iban",
"required": true,
"in": "query",
"description": "The IBAN used to identify the associated bank code.",
"schema": {
"example": "DE89370400440532013000",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The BIC was resolved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BankLookupResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "No BIC could be found for the given IBAN",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"Tools"
],
"security": [
{
"bearer": []
}
]
}
},
"/v4/accounts": {
"post": {
"summary": "Create Beneficiary",
"description": "Create a new beneficiary",
"operationId": "Beneficiaries_CreateBeneficiaryV4",
"responses": {
"200": {
"description": "Success"
},
"401": {
"description": "Unauthorized",
"content": {
"text/html": {
"schema": {
"type": "string",
"example": "Invalid token"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/html": {
"schema": {
"type": "string",
"example": "Forbidden"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"text/html": {
"schema": {
"type": "string",
"example": "Internal Server Error"
}
}
}
}
},
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateBeneficiaryRequest"
},
"examples": {
"Wallet": {
"summary": "Wallet",
"value": "Account Type: Wallet\n{ \n counterparty_id: 'YOUR_COUNTERPARTY_ID' (NOT CID) (MANDATORY), \n cid: 'YOUR CID' (MANDATORY),\n name: 'NAME' (MANDATORY),\n account_type: 'Wallet' (MANDATORY),\n ccy: 'BTC' (MANDATORY),\n host_name: 'NULL' (DO NOT FILL),\n host_hub: 'NULL' (DO NOT FILL),\n host_location: 'NULL' (DO NOT FILL),\n host_country: 'NULL' (DO NOT FILL),\n node_name: 'ACCOUNT NAME' (MANDATORY),\n node_address: 'WALLET ADDRESS' (MANDATORY),\n node_location_line_1: 'Beneficiary Address Line 1' (MANDATORY),\n node_location_line_2: 'Beneficiary Address Line 2' (OPTIONAL),\n node_location_line_3: 'Beneficiary Address Line 3' (OPTIONAL),\n node_location_city: 'Beneficiary Address City' (MANDATORY),\n node_location_region: 'Beneficiary Address Region' (OPTIONAL),\n node_location_postcode: 'Beneficiary Address Postcode' (OPTIONAL),\n node_country: 'CC' (MANDATORY - COUNTRY ISO CODE - 2 letters),\n node_type: 'individual' (MANDATORY - individual or corporate),\n iban: 'NULL' (DO NOT FILL),\n bic: 'NULL' (DO NOT FILL),\n account_label: 'NAME - CCY' (OPTIONAL),\n payment_type: 'NULL' (DO NOT FILL),\n email: 'BENEFICIARY EMAIL' (OPTIONAL),\n bcb_controlled: 1 (MANDATORY - ALWAYS 1),\n settlement_reference: ''(OPTIONAL),\n is_beneficiary: 1 (MANDATORY - ALWAYS 1)\n}"
},
"Any CCY excluding USD - AU & NZ": {
"summary": "Any CCY excluding USD - AU & NZ",
"value": "/**\n * CCY: Any CCY excluding USD\n * Country: AU & NZ\n * Account Type: Bank\n */\n{ \n counterparty_id: 'YOUR_COUNTERPARTY_ID' (NOT CID) (MANDATORY), \n cid: 'YOUR CID' (MANDATORY),\n name: 'NAME' (MANDATORY),\n account_type: 'Bank' (MANDATORY),\n ccy: 'AUD' (MANDATORY - CCY ISO CODE - 3 letters),\n host_name: 'BANK NAME' (OPTIONAL),\n host_hub: 'BSB NUMBER' (OPTIONAL),\n host_location: 'BANK ADDRESS' (OPTIONAL),\n host_country: 'AU' (MANDATORY - COUNTRY ISO CODE - 2 letters),\n node_name: 'ACCOUNT NAME' (MANDATORY),\n node_address: 'ACCOUNT NUMBER' (MANDATORY),\n node_location_line_1: 'Beneficiary Address Line 1' (MANDATORY),\n node_location_line_2: 'Beneficiary Address Line 2' (OPTIONAL),\n node_location_line_3: 'Beneficiary Address Line 3' (OPTIONAL),\n node_location_city: 'Beneficiary Address City' (MANDATORY),\n node_location_region: 'Beneficiary Address Region' (OPTIONAL),\n node_location_postcode: 'Beneficiary Address Postcode' (OPTIONAL),\n node_country: 'CC' (MANDATORY - COUNTRY ISO CODE - 2 letters),\n node_type: 'individual' (MANDATORY - individual or corporate),\n iban: 'NULL'(DO NOT FILL),\n bic: 'BIC'(MANDATORY),\n account_label: 'NAME - CCY' (OPTIONAL),\n payment_type: 'FPS' (OPTIONAL),\n email: 'BENEFICIARY EMAIL' (OPTIONAL),\n bcb_controlled: 1 (MANDATORY - ALWAYS 1),\n settlement_reference: ''(OPTIONAL),\n is_beneficiary: 1 (MANDATORY - ALWAYS 1)\n}"
},
"USD Any IBAN country (Including GB)": {
"summary": "USD Any IBAN country (Including GB)",
"value": "/**\n * CCY: USD\n * Country: Any IBAN country (Including GB)\n * Account Type: Bank\n */\n{ \n counterparty_id: 'YOUR_COUNTERPARTY_ID' (NOT CID) (MANDATORY), \n cid: 'YOUR CID' (MANDATORY),\n name: 'NAME' (MANDATORY),\n account_type: 'Bank' (MANDATORY),\n ccy: 'USD' (MANDATORY - CCY ISO CODE - 3 letters),\n host_name: 'BANK NAME' (MANDATORY),\n host_hub: 'NULL' (DO NOT FILL),\n host_location: 'BANK ADDRESS' (MANDATORY),\n host_country: 'SG' (MANDATORY - COUNTRY ISO CODE - 2 letters),\n node_name: 'ACCOUNT NAME' (MANDATORY),\n node_address: 'NULL' (DO NOT FILL),\n node_location_line_1: 'Beneficiary Address Line 1' (MANDATORY),\n node_location_line_2: 'Beneficiary Address Line 2' (OPTIONAL),\n node_location_line_3: 'Beneficiary Address Line 3' (OPTIONAL),\n node_location_city: 'Beneficiary Address City' (MANDATORY),\n node_location_region: 'Beneficiary Address Region' (OPTIONAL),\n node_location_postcode: 'Beneficiary Address Postcode' (OPTIONAL),\n node_country: 'CC' (MANDATORY - COUNTRY ISO CODE - 2 letters),\n node_type: 'individual' (MANDATORY - individual or corporate),\n iban: 'IBAN'(MANDATORY),\n bic: 'BIC'(MANDATORY),\n account_label: 'NAME - CCY' (OPTIONAL),\n payment_type: 'FPS' (OPTIONAL),\n email: 'BENEFICIARY EMAIL' (OPTIONAL),\n bcb_controlled: 1 (MANDATORY - ALWAYS 1),\n settlement_reference: ''(OPTIONAL),\n is_beneficiary: 1 (MANDATORY - ALWAYS 1)\n}"
},
"USD Any non-IBAN country": {
"summary": "USD Any non-IBAN country",
"value": "/**\n * CCY: USD\n * Country: Any non-IBAN country\n * Account Type: Bank\n */\n{ \n counterparty_id: 'YOUR_COUNTERPARTY_ID' (NOT CID) (MANDATORY), \n cid: 'YOUR CID' (MANDATORY),\n name: 'NAME' (MANDATORY),\n account_type: 'Bank' (MANDATORY),\n ccy: 'USD' (MANDATORY - CCY ISO CODE - 3 letters),\n host_name: 'BANK NAME' (MANDATORY),\n host_hub: 'NATIONAL CLEARING CODE' (OPTIONAL),\n host_location: 'BANK ADDRESS' (MANDATORY),\n host_country: 'SG' (MANDATORY - COUNTRY ISO CODE - 2 letters),\n node_name: 'ACCOUNT NAME' (MANDATORY),\n node_address: 'ACCOUNT NUMBER' (MANDATORY),\n node_location_line_1: 'Beneficiary Address Line 1' (MANDATORY),\n node_location_line_2: 'Beneficiary Address Line 2' (OPTIONAL),\n node_location_line_3: 'Beneficiary Address Line 3' (OPTIONAL),\n node_location_city: 'Beneficiary Address City' (MANDATORY),\n node_location_region: 'Beneficiary Address Region' (OPTIONAL),\n node_location_postcode: 'Beneficiary Address Postcode' (OPTIONAL),\n node_country: 'CC' (MANDATORY - COUNTRY ISO CODE - 2 letters),\n node_type: 'individual' (MANDATORY - individual or corporate),\n iban: 'NULL'(DO NOT FILL),\n bic: 'BIC'(MANDATORY),\n account_label: 'NAME - CCY' (OPTIONAL),\n payment_type: 'FPS' (OPTIONAL),\n email: 'BENEFICIARY EMAIL' (OPTIONAL),\n bcb_controlled: 1 (MANDATORY - ALWAYS 1),\n settlement_reference: ''(OPTIONAL),\n is_beneficiary: 1 (MANDATORY - ALWAYS 1)\n}{}"
},
"USD - US": {
"summary": "USD - US",
"value": "/**\n * CCY: USD\n * Country: US\n * Account Type: Bank\n */\n{ \n counterparty_id: 'YOUR_COUNTERPARTY_ID' (NOT CID) (MANDATORY), \n cid: 'YOUR CID' (MANDATORY),\n name: 'NAME' (MANDATORY),\n account_type: 'Bank' (MANDATORY),\n ccy: 'USD' (MANDATORY - CCY ISO CODE - 3 letters),\n host_name: 'BANK NAME' (OPTIONAL),\n host_hub: 'FEDWIRE ROUTING NUMBER' (MANDATORY),\n host_location: 'BANK ADDRESS' (OPTIONAL),\n host_country: 'US' (MANDATORY - COUNTRY ISO CODE - 2 letters),\n node_name: 'ACCOUNT NAME' (MANDATORY),\n node_address: 'ACCOUNT NUMBER' (MANDATORY),\n node_location_line_1: 'Beneficiary Address Line 1' (MANDATORY),\n node_location_line_2: 'Beneficiary Address Line 2' (OPTIONAL),\n node_location_line_3: 'Beneficiary Address Line 3' (OPTIONAL),\n node_location_city: 'Beneficiary Address City' (MANDATORY),\n node_location_region: 'Beneficiary Address Region' (OPTIONAL),\n node_location_postcode: 'Beneficiary Address Postcode' (OPTIONAL),\n node_country: 'CC' (MANDATORY - COUNTRY ISO CODE - 2 letters),\n node_type: 'individual' (MANDATORY - individual or corporate),\n iban: 'NULL'(DO NOT FILL),\n bic: 'NULL'(DO NOT FILL),\n account_label: 'NAME - CCY' (OPTIONAL),\n payment_type: 'FPS' (OPTIONAL),\n email: 'BENEFICIARY EMAIL' (OPTIONAL),\n bcb_controlled: 1 (MANDATORY - ALWAYS 1),\n settlement_reference: ''(OPTIONAL),\n is_beneficiary: 1 (MANDATORY - ALWAYS 1)\n}"
},
"Any CCY excluding USD - CA": {
"summary": "Any CCY excluding USD - CA",
"value": "/**\n * CCY: Any CCY excluding USD\n * Country: CA\n * Account Type: Bank\n */\n{ \n counterparty_id: 'YOUR_COUNTERPARTY_ID' (NOT CID) (MANDATORY), \n cid: 'YOUR CID' (MANDATORY),\n name: 'NAME' (MANDATORY),\n account_type: 'Bank' (MANDATORY),\n ccy: 'CAD' (MANDATORY - CCY ISO CODE - 3 letters),\n host_name: 'BANK NAME' (OPTIONAL),\n host_hub: 'CANADIAN ROUTING NUMBER' (OPTIONAL),\n host_location: 'BANK ADDRESS' (OPTIONAL),\n host_country: 'CA' (MANDATORY - COUNTRY ISO CODE - 2 letters),\n node_name: 'ACCOUNT NAME' (MANDATORY),\n node_address: 'ACCOUNT NUMBER' (MANDATORY),\n node_location_line_1: 'Beneficiary Address Line 1' (MANDATORY),\n node_location_line_2: 'Beneficiary Address Line 2' (OPTIONAL),\n node_location_line_3: 'Beneficiary Address Line 3' (OPTIONAL),\n node_location_city: 'Beneficiary Address City' (MANDATORY),\n node_location_region: 'Beneficiary Address Region' (OPTIONAL),\n node_location_postcode: 'Beneficiary Address Postcode' (OPTIONAL),\n node_country: 'CC' (MANDATORY - COUNTRY ISO CODE - 2 letters),\n node_type: 'individual' (MANDATORY - individual or corporate),\n iban: 'NULL'(DO NOT FILL),\n bic: 'BIC'(MANDATORY),\n account_label: 'NAME - CCY' (OPTIONAL),\n payment_type: 'FPS' (OPTIONAL),\n email: 'BENEFICIARY EMAIL' (OPTIONAL),\n bcb_controlled: 1 (MANDATORY - ALWAYS 1),\n settlement_reference: ''(OPTIONAL),\n is_beneficiary: 1 (MANDATORY - ALWAYS 1)\n}"
},
"Any non-IBAN country excluding AU & NZ & CA & US": {
"summary": "Any non-IBAN country excluding AU & NZ & CA & US",
"value": "/**\n * CCY: Any CCY excluding USD\n * Country: Any non-IBAN country excluding AU & NZ & CA & US\n * Account Type: Bank\n */\n{ \n counterparty_id: 'YOUR_COUNTERPARTY_ID' (NOT CID) (MANDATORY), \n cid: 'YOUR CID' (MANDATORY),\n name: 'NAME' (MAND
# --- truncated at 32 KB (163 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bcb-group/refs/heads/main/openapi/bcb-group-payments-openapi.json