Skip to main content
Version: 4.0

Code and Formats

Status Code

StatusCode provides different status during prepare() and play() api invocation through onPrepareListener and onCompleteListener of sdk.

StatusCodeDescriptionStep to ResolveMethod where it can occur
SUCCESSSuccess event of prepare() and play()onPrepareListener.onPrepared(), onCompleteListener.onComplete()
SUCCESS_WITH_UPGRADE_FAILUREError occurred when remote upgrade has failed and embedded assets are used for playbackonCompleteListener.onComplete()
ERROR_WHILE_PREPARINGError occurred during resource preparation in prepare()call prepare() with different SonicTypeonPrepareListener.onPrepared()
ERROR_WHILE_PREPARING_SOUNDError occurred during resource preparation of sound in prepare() with SonicType.SOUND_AND_ANIMATION. If you avoid error and still call play() then it will play only animation.call prepare() with SonicType.ANIMATION_ONLYonPrepareListener.onPrepared()
ERROR_WHILE_PREPARING_ANIMATIONError occurred during resource preparation of animation in prepare() with SonicType.SOUND_AND_ANIMATION. If you avoid error and still call play() then it will play only soundcall prepare() with SonicType.SOUND_ONLYonPrepareListener.onPrepared()
ERROR_WHILE_PREPARING_HAPTICSError occurred during resource preparation of haptics data for haptics feedback in prepare() with sonicTypeonPrepareListener.onPrepared()
ERROR_ALREADY_PLAYINGError occurred when sonic is already playingonCompleteListener.onComplete()
ERROR_WHILE_PLAYINGError occurred while playing sonic animation and sound or both in play()call prepare() with different SonicTypeonCompleteListener.onComplete()
ERROR_WHILE_PLAYING_SOUNDError occurred while playing sonic sound in play(). If prepare() is invoked with SonicType.SOUND_AND_ANIMATION and failed with ERROR_WHILE_PREPARING_SOUND.call prepare() with a SonicType.ANIMATION_ONLYonCompleteListener.onComplete()
ERROR_WHILE_PLAYING_ANIMATIONError occurred while playing sonic animation in play(). If prepare() is invoked with SonicType.SOUND_AND_ANIMATION and failed with ERROR_WHILE_PREPARING_ANIMATION.call prepare() with SonicType.SOUND_ONLYonCompleteListener.onComplete()
ERROR_NOT_PREPAREDError occurred when play() is called without invoking prepare() or ERROR_WHILE_PREPARING received in prepare()call prepare() with different SonicTypeonCompleteListener.onComplete()
ERROR_WHILE_PLAYING_HAPTICSError occurred while playing haptics feedback in play(). If prepare() is invoked when (isHapticsSupportedForCue == true && isHapticsSupportedByDevice == true && isHapticsEnabled == true) and failed with ERROR_WHILE_PREPARING_HAPTICSonCompleteListener.onComplete()

\

CopiedCountry Codes

To initialize sonic merchant country code needs to be provided and this information can be referred from the below grid.

Country Code should be referred from Country Code column.

CountryCountry Code
AMERICAN SAMOAASM
AUSTRALIAAUS
BANGLADESHBGD
BHUTANBTN
BRUNEI DARUSSALAMBRN
CAMBODIAKHM
CHINACHN
COOK ISLANDSCOK
FIJIFJI
FRENCH POLYNESIAPYF
GUAMGUM
HONG KONGHKG
INDIAIND
INDONESIAIDN
JAPANJPN
KIRIBATIKIR
KOREA$ REPUBLIC OFKOR
LAO PEOPLE’S DEMOCRATIC REPUBLAO
MACAOMAC
MALAYSIAMYS
MALDIVESMDV
MARSHALL ISLANDSMHL
MICRONESIA$FEDERATED STATES OFFSM
MONGOLIAMNG
MYANMARMMR
NEPALNPL
NEW CALEDONIANCL
NEW ZEALANDNZL
NORTHERN MARIANA ISLANDSMNP
PALAUPLW
PAPUA NEW GUINEAPNG
PHILIPPINESPHL
SAMOAWSM
SINGAPORESGP
SOLOMON ISLANDSSLB
SRI LANKALKA
TAIWANTWN
THAILANDTHA
TONGATON
U.S. MINOR OUTLYING ISLANDSUMI
VANUATUVUT
VIET NAMVNM
WALLIS AND FUTUNAWLF
CANADACAN
SAINT PIERRE AND MIQUELONSPM
ALAND ISLANDSALA
ALBANIAALB
ANDORRAAND
ARMENIAARM
AUSTRIAAUT
AZERBAIJANAZE
BELARUSBLR
BELGIUMBEL
BOSNIA AND HERZEGOVINABIH
BULGARIABGR
CROATIAHRV
CYPRUSCYP
CZECH REPUBLICCZE
DENMARKDNK
ESTONIAEST
FALKLAND ISLANDS (MALVINAS)FLK
FAROE ISLANDSFRO
FINLANDFIN
FRANCEFRA
FRENCH GUIANAGUF
GEORGIAGEO
GERMANYDEU
GIBRALTARGIB
GREECEGRC
GREENLANDGRL
GUADELOUPEGLP
GUERNSEYGGY
HOLY SEE (VATICAN CITY STATE)VAT
HUNGARYHUN
ICELANDISL
IRELANDIRL
ISLE OF MANIMN
ISRAELISR
ITALYITA
JERSEYJEY
KAZAKHSTANKAZ
KOSOVOBRB
KYRGYZSTANKGZ
LATVIALVA
LIECHTENSTEINLIE
LITHUANIALTU
LUXEMBOURGLUX
MACEDONIAMKD
MALTAMLT
MARTINIQUEMTQ
MAYOTTEMYT
MOLDOVA$ REPUBLIC OFMDA
MONACOMCO
MONTENEGROMNE
NETHERLANDSNLD
NORWAYNOR
POLANDPOL
PORTUGALPRT
REUNIONREU
ROMANIAROU
RUSSIAN FEDERATIONRUS
SAINT BARTHELEMYBLM
SAINT MARTIN FRENCH PARTMAF
SAN MARINOSMR
SERBIASRB
SLOVAKIASVK
SLOVENIASVN
SPAINESP
SWEDENSWE
SWITZERLANDCHE
TAJIKISTANTJK
TURKEYTUR
TURKMENISTANTKM
UKRAINEUKR
UNITED KINGDOMGBR
UZBEKISTANUZB
ANGUILLAAIA
ANTIGUA AND BARBUDAATG
ARGENTINAARG
ARUBAABW
BAHAMASBHS
BARBADOSBRB
BELIZEBLZ
BERMUDABMU
BOLIVIA$PLURINATIONAL STATE OFBOL
BONAIRE$SAINT EUSTATIUS & SABABES
BRAZILBRA
CAYMAN ISLANDSCYM
CHILECHL
COLOMBIACOL
COSTA RICACRI
CUBACUB
CURACAOCUW
DOMINICADMA
DOMINICAN REPUBLICDOM
ECUADORECU
EL SALVADORSLV
GRENADAGRD
GUATEMALAGTM
GUYANAGUY
HAITIHTI
HONDURASHND
JAMAICAJAM
MEXICOMEX
MONTSERRATMSR
NETHERLANDS ANTILLESANT
NICARAGUANIC
PANAMAPAN
PARAGUAYPRY
PERUPER
PUERTO RICOPRI
SAINT KITTS AND NEVISKNA
SAINT LUCIALCA
SINT MAARTEN (DUTCH PART)SXM
ST. VINCENT AND THE GRENADINESVCT
SURINAMESUR
TRINIDAD AND TOBAGOTTO
TURKS AND CAICOS ISLANDSTCA
URUGUAYURY
VIRGIN ISLANDS$ BRITISHVGB
VIRGIN ISLANDS$ U.S.VIR
AFGHANISTANAFG
ALGERIADZA
ANGOLAAGO
BAHRAINBHR
BENINBEN
BOTSWANABWA
BRITISH INDIAN OCEAN TERRITORYIOT
BURKINA FASOBFA
BURUNDIBDI
CAMEROONCMR
CAPE VERDECPV
CENTRAL AFRICAN REPUBLICCAF
CHADTCD
CONGOCOG
CONGO$ DEMOCRATIC REPUBLIC OFCOD
COTE D’IVOIRECIV
DJIBOUTIDJI
EGYPTEGY
EQUATORIAL GUINEAGNQ
ETHIOPIAETH
GABONGAB
GAMBIAGMB
GHANAGHA
GUINEAGIN
GUINEA-BISSAUGNB
IRAQIRQ
JORDANJOR
KENYAKEN
KUWAITKWT
LEBANONLBN
LESOTHOLSO
LIBERIALBR
MADAGASCARMDG
MALAWIMWI
MALIMLI
MAURITANIAMRT
MAURITIUSMUS
MOROCCOMAR
MOZAMBIQUEMOZ
NAMIBIA
NIGERNER
NIGERIANGA
OMANOMN
PAKISTANPAK
PALESTINIAN TERRITORY$OCCUPIEDPSE
QATARQAT
REPUBLIC OF SOUTH SUDANSSD
RWANDARWA
SAUDI ARABIASAU
SENEGALSEN
SEYCHELLESSYC
SIERRA LEONESLE
SOMALIASOM
SOUTH AFRICAZAF
SWAZILANDSWZ
TANZANIA$ UNITED REPUBLIC OFTZA
TOGOTGO
TUNISIATUN
UGANDAUGA
UNITED ARAB EMIRATESARE
YEMENYEM
ZAMBIAZMB
ZIMBABWEZWE
UNITED STATESUSA