Ask us anything. We're here to help.

2020-12-15: Withdrawals API & WebSocket Updates

These are upcoming changes that will be released when all customers have made the necessary changes.

Update: these changes are being fully released on Tuesday, December 15th, 2020.

Removal of "participant_name" from WebSocket Balance Updates

We are removing the name field as it will enhance WebSocket performance and allows us to improve security by anonymizing clients. We recommend that you use the participant_code to identify Zero Hash participants going forward.

Updated Endpoints

POST /withdrawals/requests

We have recently added logic to automatically convert certain BCH and LTC addresses during a withdrawal request.

  • BCH: Since we currently only support the Cash Addr format for BCH, a withdrawal submission in any legacy format will result in an automatic conversion. 
  • LTC: If a valid P2SH address prefixed with "3" is submitted (or "2" in test environments), we will convert it to the newer P2SH standard with an "M" prefix. 

In both instances, the address field will contain the converted address and the new submitted_address field will contain the originally submitted address. This field will be null if conversions do not apply.

GET /withdrawals/digital_asset_addresses

  • created_timestamp will be renamed to last_update to reflect a more accurate timestamp name
  • participant_code will be added, to show the owner of the account
  • submitted_address will be added, to provide an audit on any converted addresses
  • locked will be removed as this feature is deprecated

GET /withdrawals/fiat_accounts

  • created_timestamp will be renamed to last_update to reflect a more accurate timestamp name
  • participant_code will be added, to show the owner of the account
  • locked will be removed as this feature is deprecated

New Endpoints

GET /withdrawals/digital_asset_addresses/:id

When querying for a specific digital asset withdrawal address, you will see all details related to that specific account. As a platform operator, you can query for any of your customer's accounts as well.

Here is an example response for GET /withdrawals/digital_asset_addresses/:id (identical to GET /withdrawals/digital_asset_addresses):

{
"message": {
"withdrawal_account_id": 123,
"name": "Fund ABC Wallet",
"address": "M9zjMhjaPfwaeyeH2SY6aWyGqdTS9feg8Z",
"status": "APPROVED",
"limit": 1000,
"asset": "LTC",
"last_update": 1554395972174,
"submitted_address": "33nb3pKcSZ69rUNNvZYkksisWvrzCmi3Jt",
"participant_code": "ABCDEF"
}
}

GET /withdrawals/fiat_accounts/:id

We are adding dedicated endpoints so that clients can filter responses by a specific withdrawal_account_id. Here is an example response for GET/withdrawals/digital_asset_addresses/:id (identical to GET/withdrawals/digital_asset_addresses):

{
"message":{
"withdrawal_account_id":286,
"name":"Primary (1234)",
"status":"PENDING_CREATION",
"asset":"USD",
"limit":750000,
"type":"DOMESTIC_FIAT",
"beneficiary_name":"John Doe",
"account_number":"1231234",
"bank_name":"BMO Harris",
"routing_number":"07102343",
"swift_code":null,
"recipient_instructions":null,
"intermediary_bank_name":null,
"intermediary_bank_code_type":null,
"intermediary_bank_code":null,
"intermediary_bank_account_number":null,
"correspondent_bank_name":null,
"correspondent_bank_code_type":null,
"correspondent_bank_code":null,
"correspondent_bank_account_number":null,
"last_update":1571175076187,
"participant_code": "ABCDEF"
}
}

Check out the updated API docs here and feel free to reach out to support@seedcx.com with any questions or concerns.