API 2.0 Spec Updates

Overview

We are making some minor updates across a number of our endpoints based off of customer feedback to help streamline both integration and transaction flows when live. Please let us know if you have any questions.

Version Impacted: V2.0

Date Effective: 21 of June

Impacted Endpoints:

• Accounts
• Trades
• Wallets
• Payments

Changes to Accounts

We've made a number of tweaks to our accounts endpoints to help streamline the onboarding process and hopefully reduce integration effort.

• We've added a new field countryOfBirth to our account endpoints to help streamline the KYC process for new accounts
• To help reduce integration effort, we've removed separate status tracking of Authorised Representatives, instead bundling this up under the account that owns the authorised representative.
• We have removed the ability to add an authorised representative to an individual account. We will be adding this feature back in at a later date if there is demand.

Changes to Trade

A fairly minor one for trade, where we've altered the POST/Trade/Spot endpoint to just be POST/Trade. This helps avoid some confusion around the trade tenor.

Changes to Wallets

We've made a few updates to Wallets and their associated Payins help improve the clarity around their use.

• We've shifted the domicile parameter to now live against the wallet (rather than the payin address). This more accurately represents the flows of funds.
• We've changed the totalBalance field to now be called cashBalance. This now more accurately describes this field, which is the true cash balance of the wallet.

Changes to Payments

• We've created a new endpoint GET/payment/reasonCodes. This enables the retrieval of Reason Codes that can be used for each country when making a payment.
• Also changing in the Payments space is a new field called accountType. This field is only required when making a payout to certain countries.
• Another field we've added is the countryOfResidence to the Recipient. This field is only required whem making a payout to an Individual in certain countries.

General Quality of Life Updates

In addition to the above, we've made some tweaks around the edges of the spec to fix up some errors and help improve readability.

• Fixed an issue where ENUMs were not correctly displaying their available values in the API Spec.
• Added in webhookSecret into the webhook response
• Updated the webhook example payload to include the full list of possible options
• Updated the payload for POST/Wallet too more easily see the ability to create a wallet and payin address at the same time.

📘

Got Questions?

Got questions or concerns about this change? Head over to our Discussion Board and leave us a note.