Primer's currency policy

The amount field in the Primer APIs is in minor units i.e. the smallest unit of a currency.

A currency can either have 0, 2 or 3 minor units. For example:

  • JPY has 0 minor units, so to create a payment for 1000 JPY, amount should equal 1000
  • USD has 2 minor units, so to create a payment for 10.00 USD, amount should equal 1000
  • IQD has 3 minor units, so to create a payment for 1.000 IQD, amount should equal 1000

Supported currencies

The following currencies are disabled by default and require your Primer account to be "gated in" in order to use them:

BHD, BIF, CLP, CVE, GNF, HUF, IDR, INR, ISK, KHR, KMF, MMK, PYG, RWF, SAR, UGX, VED, VES, VND, XOF, XPF

If you try to use one of these currencies without being gated in, you will receive the following API validation error message:

12345678
{    "error": {        "errorId": "DisabledCurrencyError",        "description": "HUF is a disabled currency",        "recoverySuggestion": "To enable, please speak to your Customer Success Manager or our Service Desk https://primerapi.atlassian.net/servicedesk/customer/portal/11.",        "diagnosticsId": "9942005157443145021"    }}
json
copy

To be gated in, speak to your Customer Success Manager or raise a ticket on our JIRA Service Desk.  If you don’t have access, please contact your account administrator for assistance.

See below for the supported currencies and the number of minor units supported per currency.

CodeNameNumber of minor units
AEDUAE Dirham2
AFNAfghani2
ALLLek2
AMDArmenian Dram2
ANGNetherlands Antillean Guilder2
AOAKwanza2
ARSArgentine Peso2
AUDAustralian Dollar2
AWGAruban Florin2
AZNAzerbaijanian Manat2
BAMConvertible Mark2
BBDBarbados Dollar2
BDTTaka2
BGNBulgarian Lev2
BHDBahraini Dinar3
BIFBurundi Franc0
BMDBermudian Dollar2
BNDBrunei Dollar2
BOBBoliviano2
BOVMvdol2
BRLBrazilian Real2
BSDBahamian Dollar2
BTNNgultrum2
BWPPula2
BYNBelarusian Ruble2
BZDBelize Dollar2
CADCanadian Dollar2
CDFCongolese Franc2
CHEWIR Euro2
CHFSwiss Franc2
CHWWIR Franc2
CLPChilean Peso0
CNYYuan Renminbi2
COPColombian Peso2
COUUnidad de Valor Real2
CRCCosta Rican Colon2
CUCPeso Convertible2
CUPCuban Peso2
CVECape Verde Escudo2
CZKCzech Koruna2
DJFDjibouti Franc0
DKKDanish Krone2
DOPDominican Peso2
DZDAlgerian Dinar2
EGPEgyptian Pound2
ERNNakfa2
ETBEthiopian Birr2
EUREuro2
FJDFiji Dollar2
FKPFalkland Islands Pound2
GBPPound Sterling2
GELLari2
GHSGhana Cedi2
GIPGibraltar Pound2
GMDDalasi2
GNFGuinea Franc0
GTQQuetzal2
GYDGuyana Dollar2
HKDHong Kong Dollar2
HNLLempira2
HRKCroatian Kuna2
HTGGourde2
HUFForint2
IDRRupiah2
ILSNew Israeli Sheqel2
INRIndian Rupee2
IQDIraqi Dinar3
IRRIranian Rial2
ISKIceland Krona0
JMDJamaican Dollar2
JODJordanian Dinar3
JPYYen0
KESKenyan Shilling2
KGSSom2
KHRRiel2
KMFComoro Franc0
KPWNorth Korean Won2
KRWWon0
KWDKuwaiti Dinar3
KYDCayman Islands Dollar2
KZTTenge2
LAKKip2
LBPLebanese Pound2
LKRSri Lanka Rupee2
LRDLiberian Dollar2
LSLLoti2
LYDLibyan Dinar3
MADMoroccan Dirham2
MDLMoldovan Leu2
MKDDenar2
MMKKyat2
MNTTugrik2
MOPPataca2
MURMauritius Rupee2
MVRRufiyaa2
MWKKwacha2
MXNMexican Peso2
MXVMexican Unidad de Inversion (UDI)2
MYRMalaysian Ringgit2
MZNMozambique Metical2
NADNamibia Dollar2
NGNNaira2
NIOCordoba Oro2
NOKNorwegian Krone2
NPRNepalese Rupee2
NZDNew Zealand Dollar2
OMRRial Omani3
PABBalboa2
PENNuevo Sol2
PGKKina2
PHPPhilippine Peso2
PKRPakistan Rupee2
PLNZloty2
PYGGuarani0
QARQatari Rial2
RONNew Romanian Leu2
RSDSerbian Dinar2
RUBRussian Ruble2
RWFRwanda Franc0
SARSaudi Riyal2
SBDSolomon Islands Dollar2
SCRSeychelles Rupee2
SDGSudanese Pound2
SEKSwedish Krona2
SGDSingapore Dollar2
SHPSaint Helena Pound2
SLELeone2
SOSSomali Shilling2
SRDSurinam Dollar2
SSPSouth Sudanese Pound2
STNDobra2
SVCEl Salvador Colon2
SYPSyrian Pound2
SZLLilangeni2
THBBaht2
TJSSomoni2
TMTTurkmenistan New Manat2
TNDTunisian Dinar3
TOPPa’anga2
TRYTurkish Lira2
TTDTrinidad and Tobago Dollar2
TWDNew Taiwan Dollar2
TZSTanzanian Shilling2
UAHHryvnia2
UGXUganda Shilling0
USDUS Dollar2
UYUPeso Uruguayo2
UZSUzbekistan Sum2
VEDDigital Bolivar2
VESSovereign Bolivar2
VNDDong0
VUVVatu0
WSTTala2
XAFCFA Franc BEAC0
XCDEast Caribbean Dollar2
XFUUIC-Franc2
XOFCFA Franc BCEAO0
XPFCFP Franc0
YERYemeni Rial2
ZARRand2
ZMWZambian Kwacha2
ZWLZimbabwe Dollar2