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 equal1000
- USD has 2 minor units, so to create a payment for 10.00 USD,
amount
should equal1000
- IQD has 3 minor units, so to create a payment for 1.000 IQD,
amount
should equal1000
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" }}
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.
Code | Name | Number of minor units |
---|---|---|
AED | UAE Dirham | 2 |
AFN | Afghani | 2 |
ALL | Lek | 2 |
AMD | Armenian Dram | 2 |
ANG | Netherlands Antillean Guilder | 2 |
AOA | Kwanza | 2 |
ARS | Argentine Peso | 2 |
AUD | Australian Dollar | 2 |
AWG | Aruban Florin | 2 |
AZN | Azerbaijanian Manat | 2 |
BAM | Convertible Mark | 2 |
BBD | Barbados Dollar | 2 |
BDT | Taka | 2 |
BGN | Bulgarian Lev | 2 |
BHD | Bahraini Dinar | 3 |
BIF | Burundi Franc | 0 |
BMD | Bermudian Dollar | 2 |
BND | Brunei Dollar | 2 |
BOB | Boliviano | 2 |
BOV | Mvdol | 2 |
BRL | Brazilian Real | 2 |
BSD | Bahamian Dollar | 2 |
BTN | Ngultrum | 2 |
BWP | Pula | 2 |
BYN | Belarusian Ruble | 2 |
BZD | Belize Dollar | 2 |
CAD | Canadian Dollar | 2 |
CDF | Congolese Franc | 2 |
CHE | WIR Euro | 2 |
CHF | Swiss Franc | 2 |
CHW | WIR Franc | 2 |
CLP | Chilean Peso | 0 |
CNY | Yuan Renminbi | 2 |
COP | Colombian Peso | 2 |
COU | Unidad de Valor Real | 2 |
CRC | Costa Rican Colon | 2 |
CUC | Peso Convertible | 2 |
CUP | Cuban Peso | 2 |
CVE | Cape Verde Escudo | 2 |
CZK | Czech Koruna | 2 |
DJF | Djibouti Franc | 0 |
DKK | Danish Krone | 2 |
DOP | Dominican Peso | 2 |
DZD | Algerian Dinar | 2 |
EGP | Egyptian Pound | 2 |
ERN | Nakfa | 2 |
ETB | Ethiopian Birr | 2 |
EUR | Euro | 2 |
FJD | Fiji Dollar | 2 |
FKP | Falkland Islands Pound | 2 |
GBP | Pound Sterling | 2 |
GEL | Lari | 2 |
GHS | Ghana Cedi | 2 |
GIP | Gibraltar Pound | 2 |
GMD | Dalasi | 2 |
GNF | Guinea Franc | 0 |
GTQ | Quetzal | 2 |
GYD | Guyana Dollar | 2 |
HKD | Hong Kong Dollar | 2 |
HNL | Lempira | 2 |
HRK | Croatian Kuna | 2 |
HTG | Gourde | 2 |
HUF | Forint | 2 |
IDR | Rupiah | 2 |
ILS | New Israeli Sheqel | 2 |
INR | Indian Rupee | 2 |
IQD | Iraqi Dinar | 3 |
IRR | Iranian Rial | 2 |
ISK | Iceland Krona | 0 |
JMD | Jamaican Dollar | 2 |
JOD | Jordanian Dinar | 3 |
JPY | Yen | 0 |
KES | Kenyan Shilling | 2 |
KGS | Som | 2 |
KHR | Riel | 2 |
KMF | Comoro Franc | 0 |
KPW | North Korean Won | 2 |
KRW | Won | 0 |
KWD | Kuwaiti Dinar | 3 |
KYD | Cayman Islands Dollar | 2 |
KZT | Tenge | 2 |
LAK | Kip | 2 |
LBP | Lebanese Pound | 2 |
LKR | Sri Lanka Rupee | 2 |
LRD | Liberian Dollar | 2 |
LSL | Loti | 2 |
LYD | Libyan Dinar | 3 |
MAD | Moroccan Dirham | 2 |
MDL | Moldovan Leu | 2 |
MKD | Denar | 2 |
MMK | Kyat | 2 |
MNT | Tugrik | 2 |
MOP | Pataca | 2 |
MUR | Mauritius Rupee | 2 |
MVR | Rufiyaa | 2 |
MWK | Kwacha | 2 |
MXN | Mexican Peso | 2 |
MXV | Mexican Unidad de Inversion (UDI) | 2 |
MYR | Malaysian Ringgit | 2 |
MZN | Mozambique Metical | 2 |
NAD | Namibia Dollar | 2 |
NGN | Naira | 2 |
NIO | Cordoba Oro | 2 |
NOK | Norwegian Krone | 2 |
NPR | Nepalese Rupee | 2 |
NZD | New Zealand Dollar | 2 |
OMR | Rial Omani | 3 |
PAB | Balboa | 2 |
PEN | Nuevo Sol | 2 |
PGK | Kina | 2 |
PHP | Philippine Peso | 2 |
PKR | Pakistan Rupee | 2 |
PLN | Zloty | 2 |
PYG | Guarani | 0 |
QAR | Qatari Rial | 2 |
RON | New Romanian Leu | 2 |
RSD | Serbian Dinar | 2 |
RUB | Russian Ruble | 2 |
RWF | Rwanda Franc | 0 |
SAR | Saudi Riyal | 2 |
SBD | Solomon Islands Dollar | 2 |
SCR | Seychelles Rupee | 2 |
SDG | Sudanese Pound | 2 |
SEK | Swedish Krona | 2 |
SGD | Singapore Dollar | 2 |
SHP | Saint Helena Pound | 2 |
SLE | Leone | 2 |
SOS | Somali Shilling | 2 |
SRD | Surinam Dollar | 2 |
SSP | South Sudanese Pound | 2 |
STN | Dobra | 2 |
SVC | El Salvador Colon | 2 |
SYP | Syrian Pound | 2 |
SZL | Lilangeni | 2 |
THB | Baht | 2 |
TJS | Somoni | 2 |
TMT | Turkmenistan New Manat | 2 |
TND | Tunisian Dinar | 3 |
TOP | Pa’anga | 2 |
TRY | Turkish Lira | 2 |
TTD | Trinidad and Tobago Dollar | 2 |
TWD | New Taiwan Dollar | 2 |
TZS | Tanzanian Shilling | 2 |
UAH | Hryvnia | 2 |
UGX | Uganda Shilling | 0 |
USD | US Dollar | 2 |
UYU | Peso Uruguayo | 2 |
UZS | Uzbekistan Sum | 2 |
VED | Digital Bolivar | 2 |
VES | Sovereign Bolivar | 2 |
VND | Dong | 0 |
VUV | Vatu | 0 |
WST | Tala | 2 |
XAF | CFA Franc BEAC | 0 |
XCD | East Caribbean Dollar | 2 |
XFU | UIC-Franc | 2 |
XOF | CFA Franc BCEAO | 0 |
XPF | CFP Franc | 0 |
YER | Yemeni Rial | 2 |
ZAR | Rand | 2 |
ZMW | Zambian Kwacha | 2 |
ZWL | Zimbabwe Dollar | 2 |