Skip to main content
POST

Authorizations

BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Body

application/json

The request body to create a bank withdrawal.

request_id
string
required

The request ID that is used to track a bank withdrawal request. The request ID is provided by you and must be unique.

Example:

"123e457-e89b-12d3-a456-426614174004"

source_bank_account_id
string
required

The source bank account ID. The destination bank account must be tagged as VA. Cobo uses the mapped VA account to initiate the withdrawal.

Example:

"dst_ba_1234567890"

target_bank_account_id
string
required

The target bank account ID that receives the bank withdrawal.

Example:

"dst_ba_0987654321"

currency
string
required

The fiat currency of the bank withdrawal.

Example:

"USD"

amount
string
required

The bank withdrawal amount.

Example:

"100.00"

remark
string

The remark for the bank withdrawal.

Example:

"Withdraw funds from VA to payout bank account"

Response

The bank withdrawal was successfully created.

bank_withdrawal_id
string
required

The bank withdrawal ID generated by Cobo.

Example:

"123e4567-e89b-12d3-a456-426614174000"

request_id
string
required

The request ID provided by you when creating the bank withdrawal.

Example:

"123e457-e89b-12d3-a456-426614174004"

source_bank_account_id
string
required

The source bank account ID. The destination bank account must be tagged as VA.

Example:

"dst_ba_1234567890"

target_bank_account_id
string
required

The target bank account ID that receives the bank withdrawal.

Example:

"dst_ba_0987654321"

currency
string
required

The fiat currency of the bank withdrawal.

Example:

"USD"

amount
string
required

The bank withdrawal amount.

Example:

"100.00"

status
enum<string>
required

The status of the bank withdrawal:

  • Pending: The bank withdrawal has been created and is awaiting processing.
  • Processing: The bank withdrawal is being processed.
  • Completed: The bank withdrawal has been completed.
  • Failed: The bank withdrawal failed.
Available options:
Pending,
Processing,
Completed,
Failed
Example:

"Pending"

created_timestamp
integer
required

The creation time of the bank withdrawal, represented as a UNIX timestamp in seconds.

Example:

1744689600

remark
string

The remark for the bank withdrawal.

Example:

"Withdraw funds from VA to payout bank account"

failed_reason
string

The reason why the bank withdrawal failed.

Example:

"The target bank account is invalid."