# Create Bank Relationship
Creates a Bank Relationship for an Account.
# OpenAPI definition
```json
{
"info": {
"title": "Webull Open API Reference",
"description": "application.yml\\ncom\\ni18n\\nMETA-INF\\nstatic\\n\\r\\n",
"contact": {
"name": "",
"url": "",
"email": ""
},
"version": "2.0",
"x-logo": {
"url": "static/png/logo.png"
}
},
"servers": [
{
"url": "https://broker-api.sandbox.webull.com"
}
],
"path": "/broker/funding/bank-relationships/create",
"method": "post",
"tags": [
"funding"
],
"description": "Creates a Bank Relationship for an Account.",
"operationId": "createBankRelationship",
"parameters": [
{
"name": "x-app-key",
"in": "header",
"description": "A unique identifier issued to a developer for accessing an application's API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-app-secret",
"in": "header",
"description": "A unique key issued to developers to access the application's API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-timestamp",
"in": "header",
"description": "Timestamp of the request, follows ISO8601 format: YYYY-MM-DDThh:mm:ssZ, e.g. 2023-07-16T19:23:51Z, only supports UTC time zone.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-signature-version",
"in": "header",
"description": "Signature algorithm version, default is 1.0.",
"required": true,
"schema": {
"type": "string",
"default": "1.0"
},
"examples": {
"1.0": {
"value": "1.0"
}
}
},
{
"name": "x-signature-algorithm",
"in": "header",
"description": "Signature algorithm, default is HMAC-SHA1.",
"required": true,
"schema": {
"type": "string",
"default": "HMAC-SHA1"
},
"examples": {
"HMAC-SHA1": {
"value": "HMAC-SHA1"
}
}
},
{
"name": "x-signature-nonce",
"in": "header",
"description": "Signature unique random number.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-version",
"in": "header",
"description": "API interface version. Supported values: `v2`, `v3`.",
"required": true,
"schema": {
"type": "string",
"default": "v3"
},
"examples": {
"v3": {
"value": "v3"
}
}
},
{
"name": "x-signature",
"in": "header",
"description": "A signature is a unique digital fingerprint, typically encrypted, that verifies the authenticity and integrity of a message or transaction, ensuring it has not been tampered with during transmission.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"account_id",
"bank_account_name",
"bank_account_number",
"bank_code",
"bank_code_type",
"client_request_id"
],
"type": "object",
"properties": {
"client_request_id": {
"type": "string",
"description": "Client Request ID, unique for each request.
Maximum length is 32 characters.
Allowed characters: letters (A–Z, a–z), digits (0–9), hyphen (-), underscore (_).",
"example": "89JGKD4S1VI5UU6L3K8NU10IA"
},
"account_id": {
"type": "string",
"description": "Account identifier.",
"example": "J6HA4EBQRQFJD2J6NQH0F7M649"
},
"bank_name": {
"type": "string",
"description": "Required if bank_code_type = BIC, Name of recipient bank"
},
"bank_code": {
"type": "string",
"description": "Alphanumeric ABA RTN (Routing Number)"
},
"bank_code_type": {
"type": "string",
"description": "ABA (US based bank accounts)、BIC",
"example": "ABA",
"enum": [
"ABA",
"BIC"
]
},
"bank_account_name": {
"type": "string",
"description": "Name of the bank account holder, as registered with the bank",
"example": "ABA"
},
"bank_account_number": {
"type": "string",
"description": "Bank account number."
},
"country": {
"type": "string",
"description": "Required if bank_code_type = BIC, The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)."
},
"state_province": {
"type": "string",
"description": "Required if bank_code_type = BIC"
},
"postal_code": {
"type": "string",
"description": "Required if bank_code_type = BIC"
},
"city": {
"type": "string",
"description": "Required if bank_code_type = BIC"
},
"intermediary_bank_details": {
"type": "object",
"properties": {
"intermediary_bank_name": {
"type": "string",
"description": "This is an optional field;it is only required if an intermediary bank is involved in the transfer.\n\nIntermediary Bank Name"
},
"intermediary_bank_code": {
"type": "string",
"description": "This is an optional field;it is only required if an intermediary bank is involved in the transfer.\n\nAlphanumeric ABA RTN (Routing Number)"
},
"intermediary_bank_account_number": {
"type": "string",
"description": "This is an optional field;it is only required if an intermediary bank is involved in the transfer.\n\nBank account number.",
"example": "****6789"
},
"intermediary_bank_address": {
"type": "string",
"description": "This is an optional field;it is only required if an intermediary bank is involved in the transfer.\n\nBank Address.",
"example": "****6789"
}
},
"description": "Intermediary bank details.",
"title": "IntermediaryBank"
}
},
"description": "create bank relationship",
"title": "CreateBankRelationshipRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"required": [
"bank_account_name",
"bank_account_number",
"bank_code",
"bank_code_type",
"bank_relationship_id",
"client_request_id",
"create_time",
"status",
"update_time"
],
"type": "object",
"properties": {
"client_request_id": {
"type": "string",
"description": "Client Request ID, unique for each request.
Maximum length is 32 characters.
Allowed characters: letters (A–Z, a–z), digits (0–9), hyphen (-), underscore (_).",
"example": "89JGKD4S1VI5UU6L3K8NU10IA"
},
"bank_relationship_id": {
"type": "string",
"description": "Relationship ID",
"example": "89JGKD4LKIVI5UU6L3KHNU10IA"
},
"bank_code": {
"type": "string",
"description": "Alphanumeric ABA RTN (Routing Number)"
},
"bank_name": {
"type": "string",
"description": "Bank name"
},
"bank_account_name": {
"type": "string",
"description": "Name of the bank account holder, as registered with the bank",
"example": "ABA"
},
"bank_account_number": {
"type": "string",
"description": "Bank account number"
},
"bank_code_type": {
"type": "string",
"description": "ABA (US based bank accounts)、BIC",
"example": "ABA",
"enum": [
"ABA",
"BIC"
]
},
"country": {
"type": "string",
"description": "Only for Non-US based bank accounts, The value must be a valid ISO 3166-1 alpha-3 country code in uppercase format (3-letter code)."
},
"state_province": {
"type": "string",
"description": "Only for Non-US based bank accounts"
},
"postal_code": {
"type": "string",
"description": "Only for Non-US based bank accounts"
},
"city": {
"type": "string",
"description": "Only for Non-US based bank accounts"
},
"status": {
"type": "string",
"description": "Status",
"example": "APPROVED",
"enum": [
"APPROVED"
]
},
"intermediary_bank_details": {
"type": "object",
"properties": {
"intermediary_bank_name": {
"type": "string",
"description": "This is an optional field;it is only required if an intermediary bank is involved in the transfer.\n\nIntermediary Bank Name"
},
"intermediary_bank_code": {
"type": "string",
"description": "This is an optional field;it is only required if an intermediary bank is involved in the transfer.\n\nAlphanumeric ABA RTN (Routing Number)"
},
"intermediary_bank_account_number": {
"type": "string",
"description": "This is an optional field;it is only required if an intermediary bank is involved in the transfer.\n\nBank account number.",
"example": "****6789"
},
"intermediary_bank_address": {
"type": "string",
"description": "This is an optional field;it is only required if an intermediary bank is involved in the transfer.\n\nBank Address.",
"example": "****6789"
}
},
"description": "Intermediary bank details.",
"title": "IntermediaryBank"
},
"create_time": {
"type": "string",
"description": "UTC time, format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
"example": "2025-01-05T22:59:59.012Z"
},
"update_time": {
"type": "string",
"description": "UTC time, format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
"example": "2025-01-05T22:59:59.012Z"
}
},
"title": "BankRelationshipResult"
}
}
}
},
"401": {
"description": "Unauthorized: Authentication required",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code",
"example": "UNAUTHORIZED"
},
"message": {
"type": "string",
"description": "Error message",
"example": "Insufficient permission"
}
}
}
}
}
},
"417": {
"description": "A business logic error triggered when the request cannot be processed due to domain-specific constraints.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code",
"example": "INVALID_PARAMETER"
},
"message": {
"type": "string",
"description": "Error message",
"example": "Parameter error, phone"
}
}
}
}
}
},
"500": {
"description": "Internal Server Error.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code",
"example": "SYSTEM_ERROR"
},
"message": {
"type": "string",
"description": "Error message",
"example": "Internal Server Error"
}
}
}
}
}
}
},
"jsonRequestBodyExample": {
"client_request_id": "89JGKD4S1VI5UU6L3K8NU10IA",
"account_id": "J6HA4EBQRQFJD2J6NQH0F7M649",
"bank_name": "string",
"bank_code": "string",
"bank_code_type": "ABA",
"bank_account_name": "ABA",
"bank_account_number": "string",
"country": "string",
"state_province": "string",
"postal_code": "string",
"city": "string",
"intermediary_bank_details": {
"intermediary_bank_name": "string",
"intermediary_bank_code": "string",
"intermediary_bank_account_number": "****6789",
"intermediary_bank_address": "****6789"
}
},
"postman": {
"name": "Create Bank Relationship",
"description": {
"content": "Creates a Bank Relationship for an Account.",
"type": "text/plain"
},
"url": {
"path": [
"broker",
"funding",
"bank-relationships",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"disabled": false,
"description": {
"content": "(Required) A unique identifier issued to a developer for accessing an application's API.",
"type": "text/plain"
},
"key": "x-app-key",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) A unique key issued to developers to access the application's API.",
"type": "text/plain"
},
"key": "x-app-secret",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Timestamp of the request, follows ISO8601 format: YYYY-MM-DDThh:mm:ssZ, e.g. 2023-07-16T19:23:51Z, only supports UTC time zone.",
"type": "text/plain"
},
"key": "x-timestamp",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Signature algorithm version, default is 1.0.",
"type": "text/plain"
},
"key": "x-signature-version",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Signature algorithm, default is HMAC-SHA1.",
"type": "text/plain"
},
"key": "x-signature-algorithm",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Signature unique random number.",
"type": "text/plain"
},
"key": "x-signature-nonce",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) API interface version. Supported values: `v2`, `v3`.",
"type": "text/plain"
},
"key": "x-version",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) A signature is a unique digital fingerprint, typically encrypted, that verifies the authenticity and integrity of a message or transaction, ensuring it has not been tampered with during transmission.",
"type": "text/plain"
},
"key": "x-signature",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
}
}
}
```