[Completed: 2022-07-11] Changing platform keys to unique, four-letter codes

On July 11, 2022 we will be replacing the current platformKey values (such as xero, quickbooksdesktop, sageone) with unique, four-letter codes. The new codes will be used by all endpoints that require or return a platform key.

This is to remove the platform key's dependence on a platform's display name, which may change from time to time and is outside Codat's control.

Note: This change was previously announced, and subsequently delayed, in 2021.

Action required

Update any code which interacts with any of the impacted endpoints to use the new keys.

If you'd like to test your code before this change goes live, you can either:

  • enable the new behaviour for a request by adding useDefaultKeys=false to the query string you send to any of the impacted endpoints, or
  • contact our support team and request for the change to be enabled on one or all of your Codat accounts.

Expected impact if no action is taken

If your code expects the old keys, it will cease to work from July 11, 2022. Additionally, if your code sends old keys to impacted endpoints, you'll get either a 400: The specified PlatformKey ({key}) is not valid error or a 404: No integration was found with key {key} error depending on the endpoint you're sending an old key to.

Additional information

Impacted endpoints

Key mappings

Accounting (sandbox)

NameOld keyNew key
Codat Sandboxsandboxmqjo
QuickBooks Online Sandboxquickbooksonlinesandboxndsk

Accounting (live)

NameOld keyNew key
Clear Booksclearbooksjhch
Dynamics 365 Business Centraldynamics365businesscentraltrji
Exact (Netherlands)exactnetherlandsqudb
Exact (UK)exactpbbf
FreeAgentfreeagentfbrh
FreshBooksfreshbooksvxvy
KashFlowkashflowwvzu
MYOB AccountRight and Essentialsmyobaccountright
myobessentials
pdvj
Oracle NetSuitenetsuiteakxx
Pandlepandlevjms
QuickBooks Desktopquickbooksdesktoppqsw
QuickBooks Onlinequickbooksonlineqhyg
Sage 50 (UK)sage50hbql
Sage 200cloudsage200cloudjcrp
Sage Intacctsageintacctknfz
Sage Business Cloud Accountingsageonetgff
Wavewavepbtz
Xeroxerogbol
Zoho Bookszohobooksrwuv

Commerce (sandbox)

NameOld keyNew key
Codat Commerce Sandboxcommercesandboxaiwb
Stripe Teststripetestyzth

Commerce (live)

NameOld keyNew key
Amazon Seller Centralamazonsellercentralqkdj
BigCommercebigcommercevqzp
Clovercloverfqly
Molliemolliedxfw
PayPalpaypalgvom
PrestaShopprestashopzgbz
Shopifyshopifyfztf
Squaresquarezsth
Stripestripeexgd
SumUpsumuppshf
WooCommercewoocommerceltpp
Zettleizettlegougxp

Banking (sandbox)

NameOld keyNew key
Codat Banking Sandboxbankingsandboxqhnd
TrueLayer Demo Bankdemobank_truelayersyin

Banking (live)

NameOld keyNew key
Plaidplaidsuuo
Allied Irish Bank Corporateaib_corporate_ukyqyd
Allied Irish Banksaib_iemqqy
Allied Irish Banks Businessaib_business_iehftm
Amexamex_ukevqv
Banco Bilbao Vizcaya Argentariabbva_esdtff
Banco BPMbancobpm_itthnn
Banco de Sabadellbancodesabadell_esxjhq
Banco Santandersantander_eswnfg
Bank of Irelandbankofireland_ieyhlt
Bank of Ireland Businessbankofireland_business_ielyhq
Bank of Scotlandbos_ukzwab
Bank of Scotland Businessbos_business_uklvxw
Banque Populairebanquepopulaire_frtpyh
Barclaycardbarclaycard_ukqdlq
Barclaysbarclays_ukrbxl
Barclays Businessbarclays_business_ukjopr
BNP Paribasbnpparibas_frbsdr
Caisse d'Epargnecaissedepargne_frvrfk
Caixacaixa_esvksz
Capital Onecapitalone_uktqsf
Chelsea Building Societychelseabuildingsociety_ukbypc
Comdirectcomdirect_depvfv
Commerzbankcommerzbank_dezsqs
Coopcoop_ukexne
Credit Agricolecreditagricole_frzcgh
Credit Mutuelcreditmutuel_frztlw
Danske Bankdanskebank_ukrmdk
Danske Bank Businessdanskebank_business_ukhstz
Deutsche Bankdeutschebank_debvsk
First Directfirst_direct_ukzgto
Halifaxhalifax_ukmbkg
Hello bank!hellobank_frvmys
HSBChsbc_ukryvk
HSBC Businesshsbc_business_ukmhzc
HypoVereinsbankhypovereinsbank_deycdt
ING Germanying_dedxmc
ING Polanding_plrlnb
Intesa San Paolointesasanpaolo_itvdng
Lloydslloyds_ukjdze
Lloyds Businesslloyds_business_ukeyqo
Lloyds Commerciallloyds_commercial_ukscxl
Marks and Spencerms_ukioei
mBankmbank_plslmx
MBNAmbnakmtu
MetroBankmetro_ukigxq
Monzomonzo_uktrmk
NatWestnatwest_ukisdq
Nationwidenationwide_ukcghu
NatWest Businessnatwest_business_ukncmp
PermanentTSBptsb_iepskn
Poste Italianeposteitaliane_itqvvk
RBSrbs_uksqqe
Revolutrevolutgbhu
Revolut Francerevolut_frftxj
Revolut Germanyrevolut_derjbk
Revolut Irelandrevolut_iehnnk
Revolut Italyrevolut_itwpkn
Revolut Spainrevolut_eszwbb
Royal Bank of Scotland Businessrbs_business_uktzvy
Santandersantander_uklrfp
Santander Bank Polskasantander_plvdcw
SEB Banksebbank_ltpkxy
Societe Generalesocietegenerale_frjwmd
Sparkassesparkasse_deckgw
Starlingstarling_ukmgxb
SwedBank Lithuaniaswedbank_ltflxm
Tesco Banktescobank_uknjvn
Tideujxxcbjq
TSBtsb_ukcebt
Ulster Bank Irelandulster_ieektr
Ulster Bank UKulster_ukysyd
Ulster Businessulster_business_ukbbmg
Unicreditunicreditkblh
Virgin Moneyvirginmoney_ukpqmj
Wisewise_ukjxsm
Wise Francewise_frlywm
Wise Germanywise_detjjx
Wise Irelandwise_iehrfq
Wise Italywise_itztbs
Wise Spainwise_eswbqx
Yorkshire Building Societyyorkshirebuildingsociety_ukhhqr