跳轉到

轉帳 Transfer

建立轉帳交易

POST https://connect.cabital.com/api/v1/accounts/{account_id}/transfers

在 Cabital 與合作方的同名帳戶之間進行轉帳。

用戶帳號狀態條件

  • 已綁定
  • 已通過實名認證

請求 Path 參數

參數 必填 說明
account_id 是 Cabital 提供的帳號 ID

請求 Body 參數

類型：application/json

參數 必填 類型 說明
symbol 是 string 轉帳交易的幣種
amount 是 string 轉帳交易的金額
direction 是 string 轉帳交易的方向，以 Cabital 為中心的資金流向：
  • CREDIT：合作方 → Cabital
  • DEBIT：Cabital → 合作方
otp 視情況 string 用戶在 Cabital 所設定的 Google Authenticator 驗證碼，為 6 位數字
當 direction 為 DEBIT 時，此參數為必填
conversion_id 否 string 當需要將兌換和轉帳以一個步驟讓用戶完成時，可以帶入兌換交易 ID 方便日後對帳使用
external_id 否 string 合作方提供的交易 ID，若此值重複將會拒絕轉帳交易

返回參數

注意事項：

轉帳交易的狀態 status 應不會在 PROCESSING 停留太久。若一筆轉帳交易長時間處於 PROCESSING 狀態，則需要人工介入。

  • 若此筆交易合作方已上帳，將手動切換狀態為 SUCCESS。
  • 若此筆交易合作方尚未上帳，將手動切換狀態 CANCEL。
參數 類型 說明
transfer_id string 轉帳交易的 ID
instruction_id string 轉帳交易請求 ID，此為對帳用
external_id string 合作方提供的交易 ID
instructed_amount string 轉帳交易的金額（含手續費）
customer_fee string 收取用戶的轉帳手續費
actual_amount string 轉帳交易扣除手續費的金額
status string 轉帳交易的狀態
  • PROCESSING： 轉帳交易對帳中
  • SUCCESS： 轉帳交易成功
  • FAILED： 轉帳交易失敗
  • CANCEL： 轉帳交易已取消

範例

請求數據

curl -X POST "http://connect.cabital.com/api/v1/accounts/6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c/transfers"
-d '{
    "amount": "1002.865942",
    "symbol": "USDT",
    "direction": "DEBIT",
    "conversion_id": "d81adf6d-0322-41d7-8c32-669203e35f11",
    "external_id": "adb8f31d-7a71-4003-85d7-3ac58158461f"
}'

返回數據

1
2
3
4
5
6
7
8
9
{
  "transfer_id": "4c416854-8970-4838-99ad-febc437ac81d",
  "status": "SUCCESS",
  "instructed_amount": "1002.865942",
  "customer_fee": "0.99",
  "actual_amount": "1001.875942",
  "external_id": "adb8f31d-7a71-4003-85d7-3ac58158461f",
  "instruction_id": "3a344f80-f057-4841-b186-7a1daa0b8390"
}

確認轉帳結果

PUT https://connect.cabital.com/api/v1/accounts/{account_id}/transfers/{transfer_id}

當用戶在 Cabital 用戶端上發起的轉帳，Cabital 會透過 Webhook 通知合作方。合作方上帳處理完成後應透過此 API 將處理的結果更新給 Cabital。

請注意

若是透過建立轉帳交易 API 建立的轉帳交易，不需要再調用此 API

用戶帳號狀態條件

  • 已綁定
  • 已通過實名認證

請求 Path 參數

參數 必填 說明
account_id 是 Cabital 提供的帳號 ID
transfer_id 是 轉帳交易 ID

請求 Body 參數

類型：application/json

參數 必填 類型 說明
status 是 string 轉帳交易的結果
  • SUCCESS： 轉帳交易成功
  • FAILED： 轉帳交易失敗
  • CANCEL： 轉帳交易已取消
external_id 是 string 合作方提供的交易 ID，若此值重複將會拒絕轉帳交易
handle_time 是 timestamp 轉帳交易處理時間
code 否 string 當 status 為 FAILED 或 CANCEL，需要提供錯誤代碼
message 否 string 當 status 為 FAILED 或 CANCEL，需要提供錯誤訊息

返回參數

若返回 HTTP 狀態碼為 200 OK，則表示 Cabital 已接收結果，不需再重試。

範例

請求數據

curl -X PUT "http://connect.cabital.com/api/v1/accounts/transfers/30643636-3162-6564-3563-373064383332"
-d '{
    "status": "SUCCESS",
    "external_id": "12345",
    "handle_time": 1658485881
}'

返回數據

1
{}

以帳號 ID 查詢轉帳交易列表

GET https://connect.cabital.com/api/v1/accounts/{account_id}/transfers

用戶帳號狀態條件

  • 已綁定
  • 已通過實名認證

請求 Path 參數

參數 必填 說明
account_id 是 Cabital 提供的帳號 ID

請求 Query 參數

參數 必填 類型 說明
direction 否 string 轉帳交易的方向，以 Cabital 為中心的資金流向：
  • CREDIT：合作方 → Cabital
  • DEBIT：Cabital → 合作方
symbol 否 string 轉帳交易的幣種
has_conversion 否 boolean 轉帳交易是否有包含兌換交易
cursor 否 string 分頁游標值 ，預設值為 -1
page_size 否 integer 返回的轉帳交易筆數
預設值為 10，數值範圍為 1 至 30
created_from 否 timestamp 轉帳交易起始時間戳記
created_to 否 timestamp 轉帳交易結束時間戳記

返回參數

參數 類型 說明
account_id string Cabital 提供的帳號 ID
user_ext_ref string 合作方提供的帳號 ID
transfer_id string 轉帳交易的 ID
instruction_id string 轉帳交易請求 ID，此為對帳用
symbol string 轉帳交易的幣種
direction string 轉帳交易的方向，以 Cabital 為中心的資金流向：
  • CREDIT：合作方 → Cabital
  • DEBIT：Cabital → 合作方
external_id string 合作方提供的交易 ID
conversion_id string 當需要將兌換和轉帳以一個步驟讓用戶完成時，可以帶入兌換交易 ID 方便日後對帳使用
instructed_amount string 轉帳交易的金額（含手續費）
customer_fee string 收取用戶的轉帳手續費
actual_amount string 轉帳交易扣除手續費的金額
status string 轉帳交易的狀態
  • PROCESSING： 轉帳交易對帳中
  • SUCCESS： 轉帳交易成功
  • FAILED： 轉帳交易失敗
  • CANCEL： 轉帳交易已取消
created_at timestamp 轉帳交易建立時間戳記
transfer_by string 轉帳交易的發起方
  • PARTNER： 合作方
  • CUSTOMER： 用戶

範例

請求數據

curl "https://connect.cabital.com/api/v1/accounts/6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c/transfers"

返回數據

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
  "pagination_response": {
    "cursor": "-1"
  },
  "transfers":[
    {
      "transfer_id": "4c416854-8970-4838-99ad-febc437ac81d",
      "account_id": "6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c",
      "instructed_amount": "1002.865",
      "customer_fee": "2.5",
      "actual_amount": "1000.365",
      "symbol": "USDT",
      "direction": "DEBIT",
      "conversion_id": "d81adf6d-0322-41d7-8c32-669203e35f11",
      "external_id": "adb8f31d-7a71-4003-85d7-3ac58158461f",
      "user_ext_ref": "bc6b32a7-414e-46e4-a8c4-901568ad51e2",
      "created_at": 1633445162,
      "status": "SUCCESS",
      "transfer_by": "PARTNER"
    },
    {
      "transfer_id": "4c416854-8971-4838-99ad-febc437ac81d",
      "account_id": "6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c",
      "instructed_amount": "2.865",
      "customer_fee": "2.5",
      "actual_amount": "0.365",
      "symbol": "BTC",
      "direction": "CREDIT",
      "external_id": "adb8f31d-7a71-4003-85d7-3ac58158461f",
      "user_ext_ref": "c66768c2-9d1a-4cd9-a255-16de265624ae",
      "created_at": 1633445160,
      "status": "SUCCESS",
      "transfer_by": "CUSTOMER"
    }
  ]
}

以合作方帳號 ID 查詢轉帳交易列表

GET https://connect.cabital.com/api/v1/userextref/{user_ext_ref}/transfers

用戶帳號狀態條件

  • 已綁定
  • 已通過實名認證

請求 Path 參數

參數 必填 說明
user_ext_ref 是 合作方提供的帳號 ID

請求 Query 參數

參數 必填 類型 說明
direction 否 string 轉帳交易的方向，以 Cabital 為中心的資金流向：
  • CREDIT：合作方 → Cabital
  • DEBIT：Cabital → 合作方
symbol 否 string 轉帳交易的幣種
has_conversion 否 boolean 轉帳交易是否有包含兌換交易
cursor 否 string 分頁游標值，預設值為 -1
page_size 否 integer 返回的轉帳交易筆數
預設值為 10，數值範圍為 1 至 30
created_from 否 timestamp 轉帳交易起始時間戳記
created_to 否 timestamp 轉帳交易結束時間戳記

返回參數

參數 類型 說明
account_id string Cabital 提供的帳號 ID
user_ext_ref string 合作方提供的帳號 ID
transfer_id string 轉帳交易的 ID
instruction_id string 轉帳交易請求 ID，此為對帳用
symbol string 轉帳交易的幣種
direction string 轉帳交易的方向，以 Cabital 為中心的資金流向：
  • CREDIT：合作方 → Cabital
  • DEBIT：Cabital → 合作方
external_id string 合作方提供的交易 ID
conversion_id string 當需要將兌換和轉帳以一個步驟讓用戶完成時，可以帶入兌換交易 ID 方便日後對帳使用
instructed_amount string 轉帳交易的金額（含手續費）
customer_fee string 收取用戶的轉帳手續費
actual_amount string 轉帳交易扣除手續費的金額
status string 轉帳交易的狀態
  • PROCESSING： 轉帳交易對帳中
  • SUCCESS： 轉帳交易成功
  • FAILED： 轉帳交易失敗
  • CANCEL： 轉帳交易已取消
created_at timestamp 轉帳交易建立時間戳記
transfer_by string 轉帳交易的發起方
  • PARTNER： 合作方
  • CUSTOMER： 用戶

範例

請求數據

curl "https://connect.cabital.com/api/v1/userextref/6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c/transfers"

返回數據

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
  "pagination_response": {
    "cursor": "-1"
  },
  "transfers":[
    {
      "transfer_id": "4c416854-8970-4838-99ad-febc437ac81d",
      "account_id": "1f30d577-982a-4091-96e0-af3819fcd412",
      "instructed_amount": "1002.865",
      "customer_fee": "2.5",
      "actual_amount": "1000.365",
      "symbol": "USDT",
      "direction": "DEBIT",
      "conversion_id": "d81adf6d-0322-41d7-8c32-669203e35f11",
      "external_id": "adb8f31d-7a71-4003-85d7-3ac58158461f",
      "user_ext_ref": "6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c",
      "created_at": 1633445162,
      "status": "SUCCESS",
      "transfer_by": "PARTNER"
    },
    {
      "transfer_id": "4c416854-8971-4838-99ad-febc437ac81d",
      "account_id": "bbdde6e2-25e0-4eab-a31d-37142e34c2ee",
      "instructed_amount": "2.865",
      "customer_fee": "2.5",
      "actual_amount": "0.365",
      "symbol": "BTC",
      "direction": "CREDIT",
      "external_id": "adb8f31d-7a71-4003-85d7-3ac58158461f",
      "user_ext_ref": "6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c",
      "created_at": 1633445160,
      "status": "SUCCESS",
      "transfer_by": "CUSTOMER"
    }
  ]
}

以轉帳交易 ID 取得單一轉帳交易詳細資訊

GET https://connect.cabital.com/api/v1/transfers/{transfer_id}

請求 Path 參數

參數 必填 說明
transfer_id 是 轉帳交易的 ID

返回參數

參數 類型 說明
account_id string Cabital 提供的帳號 ID
user_ext_ref string 合作方提供的帳號 ID
transfer_id string 轉帳交易的 ID
instruction_id string 轉帳交易請求 ID，此為對帳用
symbol string 轉帳交易的幣種
direction string 轉帳交易的方向，以 Cabital 為中心的資金流向：
  • CREDIT：合作方 → Cabital
  • DEBIT：Cabital → 合作方
external_id string 合作方提供的交易 ID
conversion_id string 當需要將兌換和轉帳以一個步驟讓用戶完成時，可以帶入兌換交易 ID 方便日後對帳使用
instructed_amount string 轉帳交易的金額（含手續費）
customer_fee string 收取用戶的轉帳手續費
actual_amount string 轉帳交易扣除手續費的金額
status string 轉帳交易的狀態
  • PROCESSING： 轉帳交易對帳中
  • SUCCESS： 轉帳交易成功
  • FAILED： 轉帳交易失敗
  • CANCEL： 轉帳交易已取消
created_at timestamp 轉帳交易建立時間戳記
transfer_by string 轉帳交易的發起方
  • PARTNER： 合作方
  • CUSTOMER： 用戶

範例

請求數據

curl "https://connect.cabital.com/api/v1/transfers/4c416854-8970-4838-99ad-febc437ac81d"

返回數據

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "transfer_id": "4c416854-8970-4838-99ad-febc437ac81d",
  "account_id": "6d92e7b4-715c-4ce3-a028-19f1c8c9fa6c",
  "instructed_amount": "1002.865",
  "customer_fee": "2.5",
  "actual_amount": "1000.365",
  "symbol": "USDT",
  "direction": "DEBIT",
  "conversion_id": "d81adf6d-0322-41d7-8c32-669203e35f11",
  "external_id": "adb8f31d-7a71-4003-85d7-3ac58158461f",
  "user_ext_ref": "6d3654ac-5f8b-4202-af20-6ab3a7f44d78",
  "created_at": 1633445162,
  "status": "SUCCESS",
  "transfer_by": "PARTNER"
}

以合作方轉帳交易 ID 取得單一轉帳交易詳細資訊

GET https://connect.cabital.com/api/v1/recon/transfers/{external_id}

請求 Path 參數

參數 必填 說明
external_id 是 合作方提供的交易 ID

返回參數

參數 類型 說明
account_id string Cabital 提供的帳號 ID
user_ext_ref string 合作方提供的帳號 ID
transfer_id string 轉帳交易的 ID
instruction_id string 轉帳交易請求 ID，此為對帳用
symbol string 轉帳交易的幣種
direction string 轉帳交易的方向，以 Cabital 為中心的資金流向：
  • CREDIT：合作方 → Cabital
  • DEBIT：Cabital → 合作方
external_id string 合作方提供的交易 ID
conversion_id string 當需要將兌換和轉帳以一個步驟讓用戶完成時，可以帶入兌換交易 ID 方便日後對帳使用
instructed_amount string 轉帳交易的金額
customer_fee string 收取用戶的轉帳手續費
actual_amount string 轉帳交易扣除手續費的金額
status string 轉帳交易的狀態
  • PROCESSING： 轉帳交易對帳中
  • SUCCESS： 轉帳交易成功
  • FAILED： 轉帳交易失敗
  • CANCEL： 轉帳交易已取消
created_at timestamp 轉帳交易建立時間戳記

範例

請求數據

curl "https://connect.cabital.com/api/v1/recon/transfers/adb8f31d-7a71-4003-85d7-3ac58158461f"

返回數據

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
    "transfer_id": "eca83642-0e70-41f2-beee-ebdafe332a2d",
    "external_id": "adb8f31d-7a71-4003-85d7-3ac58158461f",
    "status": "SUCCESS",
    "direction": "CREDIT",
    "symbol": "USDT",
    "instructed_amount": "200",
    "customer_fee": "0",
    "actual_amount": "200",
    "created_at": 1661307719,
    "instruction_id": "21ef34f2-fd3e-4d42-9143-15f48b1a00ad",
    "account_id": "614bebe5-b9a5-433a-99c5-59d637617cbb",
    "user_ext_ref": "latibac_user_1656053354",
    "transfer_by": "PARTNER"
}