本指南演示如何使用推送通知和 API 調用來核對 Currencycloud 賬戶收到的資金。
本指南假設您正在使用我們的 Currencycloud Spark 產品,您的客戶向他們的客戶提供結算詳細資料,並且您支援子賬戶。有關子賬戶活動的更多資訊,請參閱我們的子賬戶活動指南。
第 1 步:登入
請參閱身份驗證指南,以獲取有關如何啟動新 API 會話的說明。
第 2 步:查找注資/SSI 詳細資料
透過調用查找注資賬戶 /v2/funding_accounts/find 端點,針對您的客戶想要接收資金的特定貨幣,查找必要的結算賬戶詳細資料。
在下面的示例中,我們透過傳遞 payment_type
為「常規」、currency
為「EUR」以及適當的客戶 account-id
(子賬戶 id)作為查詢參數,查找用於託收/注資歐元的賬戶詳細資料。
請求:
參數名稱 | 參數類型 | 示例值 |
---|---|---|
X-Auth-Token | 標頭 | ea6d13c7bc50feb46cf978d137bc01a2 |
payment_type | 查詢字串 | 常規 |
currency | 查詢字串 | EUR |
account_id | 查詢字串 | 156d8d0e-2f05-4ffc-b7da-2b0be576bbb0 |
回應:
{ "funding_accounts": [ { "id":"9159cd45-ee3d-4e58-b2d7-00c5a68600c1", "account_id":"156d8d0e-2f05-4ffc-b7da-2b0be576bbb0", "account_number":"GB01TCCL06642902435207", "account_number_type": "iban", "account_holder_name":"Jimmy's Burritos_store 1", "bank_name":"The Currency Cloud Limited", "bank_address":"12 Steward Street, The Steward Building, London, E1 6FQ, GB", "bank_country":"GB", "currency":"EUR", "payment_type": "regular", "routing_code":"TCCLGB31", "routing_code_type": "bic_swift", "created_at":"2021-02-02T15:22:22+00:00", "updated_at":"2021-02-02T15:22:22+00:00" } ], "pagination": { "total_entries":1, "total_pages":1, "current_page":1, "per_page":25, "previous_page": -1, "next_page": -1, "order": "created_at", "order_asc_desc": "asc" } }
根據上述回應,我們可以使用必要的 IBAN 和銀行資訊,將歐元適當地存入相應的 Currencycloud 賬戶。由於 payment_type
參數設定為「常規」,因此將資金匯入賬戶的個人或公司將能夠使用位於 EEA 區域某處的本地銀行賬戶使用本地 SEPA 網絡。
請記住,這些結算指示可由您的客戶使用,或者您的客戶可直接將這些詳細資料傳送給他們的客戶(也就是第四方),這取決於您與 Currencycloud 之間的賬戶結構/合規模式。
第 3 步:使用推送通知
資金結算到 Currencycloud 賬戶後,您就可以接收表明資金已到賬的注資推送通知。此訊息可在您的應用程式中自訂和顯示。請參閱我們的推送通知頁面,以獲取更多詳細資訊。
注資交易
下圖展示了注資交易詳情。
下面是上圖中描述的「待處理」和「已完成」狀態推送通知的示例,以我們當前向賬戶注資歐元為例。
訊息標頭
Content-Length:675 Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3 Accept: */* User-Agent:Ruby Host: webhook.site x-hmac-digest-sha-512 e7ace9c29306a82b25bdb764f60f583aeb9145e17c06572640a2953c243e97e19dde7e5cf00b10e60e5ede255b5c91c09312dbec58b7f695d9801fa90514a1dd Content-Type: text/plain
通知類型:現金管理器交易待處理通知
推送通知:
{ "header": { "message_type": "cash_manager_transaction", "notification_type": "pending_cash_manager_transaction_notification" }, "body": { "id":"1b5d9096-74ef-4988-9d12-62662ee0e2a8", "balance_id":"2e6056ce-660f-4b4c-9470-27d8706f08ed", "account_id":"156d8d0e-2f05-4ffc-b7da-2b0be576bbb0", "currency":"EUR", "amount":"1000.00", "balance_amount": null, "type": "credit", "related_entity_type": "inbound_funds", "related_entity_id":"1f453dcb-05c3-4320-806f-2c86d0fe6ed2", "related_entity_short_reference":"IF-20210409-VMN9TQ", "status": "pending", "reason": "", "settles_at": null, "created_at":"2021-04-09T16:57:55+00:00", "updated_at":"2021-04-09T16:57:55+00:00", "completed_at": null, "action": "funding" } }
通知類型:現金管理器交易通知
推送通知:
{ "header": { "message_type": "cash_manager_transaction", "notification_type": "cash_manager_transaction_notification" }, "body": { "id":"1b5d9096-74ef-4988-9d12-62662ee0e2a8", "balance_id":"2e6056ce-660f-4b4c-9470-27d8706f08ed", "account_id":"156d8d0e-2f05-4ffc-b7da-2b0be576bbb0", "currency":"EUR", "amount":"10000.00", "balance_amount":"1000010000.00", "type": "credit", "related_entity_type": "inbound_funds", "related_entity_id":"1f453dcb-05c3-4320-806f-2c86d0fe6ed2", "related_entity_short_reference":"IF-20210409-VMN9TQ", "status": "completed", "reason": "", "settles_at":"2021-04-09T16:57:58+00:00", "created_at":"2021-04-09T16:57:55+00:00", "updated_at":"2021-04-09T16:57:58+00:00", "completed_at":"2021-04-09T16:57:58+00:00", "action": "funding" } }
第 4 步(選擇性):檢索交易詳情
從報告的角度來看,您可以在主賬戶或子賬戶層級下拉交易活動。如果我們要從上述收到的推送通知中查找注資交易,我們可以調用查找交易 /v2/transactions/find 端點。
在下面的示例中,我們使用(從上述推送通知中解析出的)currency
、amount
和 related_entity_id
作為查詢參數。
請求:
參數名稱 | 參數類型 | 示例值 |
---|---|---|
X-Auth-Token | 標頭 | ea6d13c7bc50feb46cf978d137bc01a2 |
currency | 查詢字串 | EUR |
amount | 查詢字串 | 10000.00 |
related_entity_id | 查詢字串 | 1f453dcb-05c3-4320-806f-2c86d0fe6ed2 |
回應:
{ "transactions": [ { "id":"1b5d9096-74ef-4988-9d12-62662ee0e2a8", "balance_id":"2e6056ce-660f-4b4c-9470-27d8706f08ed", "account_id":"156d8d0e-2f05-4ffc-b7da-2b0be576bbb0", "currency":"EUR", "amount":"10000.00", "balance_amount":"1000010000.00", "type": "credit", "related_entity_type": "inbound_funds", "related_entity_id":"1f453dcb-05c3-4320-806f-2c86d0fe6ed2", "related_entity_short_reference":"IF-20210409-VMN9TQ", "status": "completed", "reason": "", "settles_at":"2021-04-09T16:57:58+00:00", "created_at":"2021-04-09T16:57:55+00:00", "updated_at":"2021-04-09T16:57:58+00:00", "completed_at":"2021-04-09T16:57:58+00:00", "action": "funding" } ], "pagination": { "total_entries":1, "total_pages":1, "current_page":1, "per_page":25, "previous_page": -1, "next_page": -1, "order": "default", "order_asc_desc": "asc" } }
第 5 步(選擇性):檢索支付方詳細資料
支付方 API /v2/transactions/sender/{id} 提供入賬支付的可視性,有助於各種支付軌道之間進行對賬。結合推送通知,可提供自動化即時對賬功能。下面是使用從第 3 步解析出的 UUID 作為 URI 路徑的示例。
請求:
參數名稱 | 參數類型 | 示例值 |
---|---|---|
X-Auth-Token |
標頭 | ea6d13c7bc50feb46cf978d137bc01a2 |
id |
路徑 | 1f453dcb-05c3-4320-806f-2c86d0fe6ed2 |
回應:
{
"id":"1f453dcb-05c3-4320-806f-2c86d0fe6ed2",
"amount":"12000.00",
"currency":"EUR",
"additional_information":"Payment to CC",
"value_date":"2021-05-25T00:00:00+00:00",
"sender":"John Smith;100 Bishopsgate, London, EC2M 1GT;GB;GB29NWBK60161331926819;NWBKGB2L;",
"receiving_account_number": null,
"receiving_account_iban":"GB41TCCL04140419897139",
"created_at":"2021-05-25T06:38:09+00:00",
"updated_at":"2021-05-25T06:38:13+00:00"
}
解釋:
欄位 | 解釋 |
---|---|
additional_information |
支付方和匯款銀行提供的支付參考。 |
sender |
支付方 IBAN、BIC、姓名和地址按以下格式顯示:{sender.name};{sender.address};{sender.country};{sender.account_number} or {sender.iban};{sender.bic};{sender.routing_code} 。可能無法提供所有欄位,具體取決於從匯款銀行收到的資料。 |
receiving_account_number |
接收付款的虛擬銀行賬戶詳細資料。在上面的示例中,使用了 IBAN 而非賬戶號碼,因此顯示為空 。 |
receiving_account_iban |
接收付款的虛擬賬戶。在上面的示例中,資金已匯入賬戶:GB41TCCL04140419897139 。 |