Skip to content
Company Bank Account

Add Company Bank Account

Add Company Bank Account.

Request parameters

  • Required: nature_type (Nature Type), currency (Currency), account_name (Account Name), region (Region), bank_id (Bank ID), bank_account (Bank Account), bank_name (Bank Name), bank_region (Bank Region), swift_code (Swift Code), bank_addr (Bank Address), simple_name (Simple Name), deposit_types (Deposit Types), withdraw_types (Withdraw Types), version (Version)
  • Optional: bank_code (Bank Code), connect_customer_id (Connect Customer ID), net_customer_id (Net Customer ID), intermediary_swift_code (Intermediary Swift Code), support_exchange (Support Exchange), remark (Remark)
  • See each field for its format, allowed values, and business meaning.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

POSThttps://b-api.longbridge.xyz/atm/lb/bankaccount

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Request body application/json

nature_typestringrequired

Specifies Nature Type. This field is required.

currencystringrequired

Currency code used for this request. This field is required.

account_namestringrequired

Specifies Account Name. This field is required.

regionstringrequired

Specifies Region. This field is required.

bank_idstringrequired

Bank ID associated with this request.

bank_accountstringrequired

Specifies Bank Account. This field is required.

bank_codestring

Specifies Bank Code.

bank_namestringrequired

Specifies Bank Name. This field is required.

bank_regionstringrequired

Specifies Bank Region. This field is required.

swift_codestringrequired

Specifies Swift Code. This field is required.

bank_addrstringrequired

Specifies Bank Address. This field is required.

connect_customer_idstring

Connect Customer ID associated with this request.

net_customer_idstring

Net Customer ID associated with this request.

simple_namestringrequired

Specifies Simple Name. This field is required.

intermediary_swift_codestring

Specifies Intermediary Swift Code.

deposit_typesarray<string>required

Array elements {name, id}; items with empty name/id are filtered out before submission.

withdraw_typesarray<string>required

Array elements {name, id, support_bank}; items with empty name/id are filtered out before submission.

support_exchangestring

Specifies Support Exchange.

Allowed values:

  • yes - Yes
  • no - No

yes · Yesno · No

remarkstring

Specifies Remark.

versionnumberrequired

Always pass 1, for compatibility with the legacy interface.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs