查看餘額

本指南介紹如何查看您在 Currencycloud 賬戶中持有的各種外幣金額。

工作流程圖

集成指南

第 1 步：登入

請參閱身份驗證指南，以獲取有關啟動新 API 會話的說明。

第 2 步：查看特定貨幣的餘額

若要查詢您在 Currencycloud 主賬戶中持有多少歐元，請調用獲取餘額端點 - /v2/balances/{currency},，傳遞 EUR 作為貨幣路徑參數。

GET /v2/balances/EUR
X-Auth-Token: ea6d13c7bc50feb46cf978d137bc01a2

以下回應顯示您的 Currencycloud 主賬戶中持有 15,458.12 歐元。

HTTP/1.1 200 OK
Content-Type: application/json
{
  "id": "ad6411db-1e00-44fd-b4e8-194c74cf2f83",
  "account_id": "d22073a6-4c56-4980-8699-504b0c70003f",
  "currency":"EUR",
  "amount":"15458.12",
  "created_at":"2021-12-10T16:05:20+00:00",
  "updated_at":"2021-12-10T16:05:20+00:00"
}  

若要獲取客戶子賬戶的餘額，只需透過 on_behalf_of 查詢字串參數提供子賬戶 UUID 即可。

GET /v2/balances/EUR?on_behalf_of=d5eba0d5-ef7e-48c9-9a19-44638e2470c2
X-Auth-Token: ea6d13c7bc50feb46cf978d137bc01a2

第 3 步：獲取詳細貨幣餘額

另外，查找餘額端點 /v2/balances/find 將告訴您 Currencycloud 主賬戶中持有的所有外幣的價值。

GET /v2/balances/find
X-Auth-Token: ea6d13c7bc50feb46cf978d137bc01a2  

以下回應顯示您在 Currencycloud 主賬戶中持有 10,750.00 英鎊、1,500.24 美元和 15,458.12 歐元。

{
  "balances": [
    {
      "id": "c52128a4-3918-40dc-a92a-7225cef3a4a6",
      "account_id": "d22073a6-4c56-4980-8699-504b0c70003f",
      "currency":"GBP",
      "amount":"10750.00",
      "created_at":"2021-12-10T16:05:19+00:00",
      "updated_at":"2021-12-10T16:05:19+00:00"
    },
    {
      "id":"349a2b87-9455-4808-9e68-515daf1f7298",
      "account_id": "d22073a6-4c56-4980-8699-504b0c70003f",
      "currency":"USD",
      "amount":"1550.24",
      "created_at":"2021-12-10T16:05:19+00:00",
      "updated_at":"2021-12-10T16:05:19+00:00"
    },
    {
      "id": "ad6411db-1e00-44fd-b4e8-194c74cf2f83",
      "account_id": "d22073a6-4c56-4980-8699-504b0c70003f",
      "currency":"EUR",
      "amount":"15458.12",
      "created_at":"2021-12-10T16:05:20+00:00",
      "updated_at":"2021-12-10T16:05:20+00:00"
    }
  ],
  "pagination": {
    "total_entries":3,
    "total_pages":1,
    "current_page":1,
    "per_page":25,
    "previous_page": -1,
    "next_page": -1,
    "order": "created_at",
    "order_asc_desc": "asc"
  }
}   

若要獲取任何客戶子賬戶的餘額，只需透過 on_behalf_of 查詢字串參數提供子賬戶 UUID 即可。有關使用 on_behalf_of 的進一步資訊，請參閱我們的子賬戶活動指南。

GET /v2/balances/find?on_behalf_of=d5eba0d5-ef7e-48c9-9a19-44638e2470c2
X-Auth-Token: ea6d13c7bc50feb46cf978d137bc01a2