Parameter type description
The JSON posts that are sent to our API consists of several input parameters which are listed on this page.
String - The parameter type string is limited to 128 characters and you are able to find a complete list of all supported characters here. The only exception from this is Cherckout.URL which support up to 256 characters.
Int - The parameter type int has a maximum value of 2,147,483,647. Supported fields (noted with asterisks below) have a minimum value of -2,147,483,648.
Decimal - The parameter type decimal has a maximum value of 79,228,162,514,264,337,593,543,950,335. Supported fields (noted with asterisks below) have a minimum value of -79,228,162,514,264,337,593,543,950,335.
Items
Parameter | Type | Description |
---|---|---|
reference | string |
The order item reference is usually the SKU (stock keeping unit) of the product. |
name | string |
Define the name of the product. |
quantity | decimal |
Quantity of the specific product in the order. The value '1' will be intepreted as '1'. |
unit | string |
Indicate the defined unit of measurement for the product. |
unitPrice* | int | Price of each product unit. This value should always be sent excluding VAT. |
taxRate | int |
Indicate the VAT rate of the product. The value '2500' is intepreted as 25%. The parameter value must be included in your request for the VAT to be displayed correctly in Easy administration. Please note that we do not validate that the tax calculation is correct. 'taxRate' support a value larger or equal to 0. |
taxAmount* | int |
This is the total VAT amount for the order line. '10000' is interpreted as '100.00'. The parameter value must be included in your request for the VAT to be displayed correctly in Easy administration. Please note that we do not validate that the tax calculation is correct. |
grossTotalAmount* | int |
Order line total amount including VAT. '10000' is interpeted as '100.00'. This is the order line parameter we validate when verifying that the total amount for the order is correct. |
netTotalAmount* | int |
Order line total amount excluding VAT. '10000' is interpeted as '100.00'. |
* Negative values are allowed for marked parameters. A min value of -2,147,483,648 is now allowed in the fields.
Order
Parameter | Type | Description |
---|---|---|
amount | int |
Total amount for the order including VAT. Please note that the order amount must match the sum of all 'grossTotalAmount' parameters in order. '10000' is interpeted as '100.00'. |
currency | string |
Currency of the amount. Use the 3-letter (ISO-4217 code.) |
reference | string |
Maximum 27 characters for Invoice Payments. Order ID which will be visible in Easy administration. |
Checkout
Parameter | Type | Description |
---|---|---|
url | string |
This is the URL where the checkout is located at, and where we will send the user after they have performed a 3-D Secure verification. Example: https://mydomain.com/checkout The domain will be validated when the checkout is initialized. The host in the parameter value must match the host where the checkout is initialized. Read more about the checkout integration in our integration guide. |
termsUrl | string |
This is the URL where the terms and conditions should be located at. The link will be visible in the checkout. Example: https://mydomain.com/terms |
ShippingCountries | string |
To specify the shipping countries, the merchant can extend the operation for creating payment with the following input. Example: "ShippingCountries" : [{"countryCode":"SSS"},{"countryCode":"SWE"}] If a country is not in the list, the merchant will be notified with the following error message. { "errors": { "checkout.ShippingCountries": [ "[SSS] as shipping country not supported " ] } } |
consumerType | string |
This option is used to enable B2B and B2C functionality in the checkout. The example shows how to enable B2B and have B2C be shown by default. Example: "consumerType": {"supportedTypes": [ "B2C", "B2B" ],"default": "B2C"} |
Supported Countries
Country | ISO Code | Phone Prefix |
---|---|---|
Afghanistan | AFG | 93 |
Albania | ALB | 355 |
Algeria | DZA | 213 |
Andorra | AND | 376 |
Angola | AGO | 244 |
Antigua & Barbuda | ATG | 1 |
Argentina | ARG | 54 |
Armenia | ARM | 374 |
Australia | AUS | 61 |
Austria | AUT | 43 |
Azerbaijan | AZE | 994 |
Bahamas | BHS | 1 |
Bahrain | BHR | 973 |
Bangladesh | BGD | 880 |
Barbados | BRB | 1 |
Belarus | BLR | 375 |
Belgium | BEL | 32 |
Belize | BLZ | 501 |
Benin | BEN | 229 |
Bhutan | BTN | 975 |
Bolivia | BOL | 591 |
Bosnia | BIH | 387 |
Botswana | BWA | 267 |
Brazil | BRA | 55 |
Brunei | BRN | 673 |
Bulgaria | BGR | 359 |
Burkina Faso | BFA | 226 |
Burundi | BDI | 257 |
Cambodia | KHM | 855 |
Cameroon | CMR | 237 |
Canada | CAN | 1 |
Cape Verde | CPV | 238 |
Central African Republic | CAF | 236 |
Chad | TCD | 235 |
Chile | CHL | 56 |
China | CHN | 86 |
Colombia | COL | 57 |
Comoros | COM | 269 |
Congo - Brazzaville | COG | 242 |
Congo - Kinshasa | COD | 243 |
Costa Rica | CRI | 506 |
Côte d’Ivoire | CIV | 225 |
Croatia | HRV | 385 |
Cuba | CUB | 53 |
Cyprus | CYP | 357 |
Czechia | CZE | 420 |
Denmark | DNK | 45 |
Djibouti | DJI | 253 |
Dominica | DMA | 1 |
Dominican Republic | DOM | 1 |
Ecuador | ECU | 593 |
Egypt | EGY | 20 |
El Salvador | SLV | 503 |
Equatorial Guinea | GNQ | 240 |
Eritrea | ERI | 291 |
Estonia | EST | 372 |
Ethiopia | ETH | 251 |
Fiji | FJI | 679 |
Finland | FIN | 358 |
France | FRA | 33 |
Gabon | GAB | 241 |
Gambia | GMB | 220 |
Georgia | GEO | 995 |
Germany | DEU | 49 |
Ghana | GHA | 233 |
Greece | GRC | 30 |
Greenland | GRL | 299 |
Grenada | GRD | 1 |
Guatemala | GTM | 502 |
Guinea-Bissau | GNB | 245 |
Guinea | GIN | 224 |
Guyana | GUY | 592 |
Haiti | HTI | 509 |
Honduras | HND | 504 |
Hong Kong | HKG | 852 |
Hungary | HUN | 36 |
Iceland | ISL | 354 |
India | IND | 91 |
Indonesia | IDN | 62 |
Iran | IRN | 98 |
Iraq | IRQ | 964 |
Ireland | IRL | 353 |
Israel | ISR | 972 |
Italy | ITA | 39 |
Jamaica | JAM | 1 |
Japan | JPN | 81 |
Jordan | JOR | 962 |
Kazakhstan | KAZ | 7 |
Kenya | KEN | 254 |
Kiribati | KIR | 686 |
Kuwait | KWT | 965 |
Kyrgyzstan | KGZ | 996 |
Laos | LAO | 856 |
Latvia | LVA | 371 |
Lebanon | LBN | 961 |
Lesotho | LSO | 266 |
Liberia | LBR | 231 |
Libya | LBY | 218 |
Liechtenstein | LIE | 423 |
Lithuania | LTU | 370 |
Luxembourg | LUX | 352 |
Macedonia | MKD | 389 |
Madagascar | MDG | 261 |
Malawi | MWI | 265 |
Malaysia | MYS | 60 |
Maldives | MDV | 960 |
Mali | MLI | 223 |
Malta | MLT | 356 |
Marshall Islands | MHL | 692 |
Mauritania | MRT | 222 |
Mauritius | MUS | 230 |
Mexico | MEX | 52 |
Micronesia | FSM | 691 |
Moldova | MDA | 373 |
Monaco | MCO | 377 |
Mongolia | MNG | 976 |
Montenegro | MNE | 382 |
Morocco | MAR | 212 |
Mozambique | MOZ | 258 |
Myanmar | MMR | 95 |
Namibia | NAM | 264 |
Nauru | NRU | 674 |
Nepal | NPL | 977 |
Netherlands | NLD | 31 |
New Zealand | NZL | 64 |
Nicaragua | NIC | 505 |
Niger | NER | 227 |
Nigeria | NGA | 234 |
North Korea | PRK | 850 |
Norway | NOR | 47 |
Oman | OMN | 968 |
Pakistan | PAK | 92 |
Palau | PLW | 680 |
Panama | PAN | 507 |
Papua New Guinea | PNG | 675 |
Paraguay | PRY | 595 |
Peru | PER | 51 |
Philippines | PHL | 63 |
Poland | POL | 48 |
Portugal | PRT | 351 |
Qatar | QAT | 974 |
Romania | ROU | 40 |
Russia | RUS | 7 |
Rwanda | RWA | 250 |
Samoa | WSM | 685 |
San Marino | SMR | 378 |
São Tomé & Príncipe | STP | 239 |
Saudi Arabia | SAU | 966 |
Senegal | SEN | 221 |
Serbia | SRB | 381 |
Seychelles | SYC | 248 |
Sierra Leone | SLE | 232 |
Singapore | SGP | 65 |
Slovakia | SVK | 421 |
Slovenia | SVN | 386 |
Solomon Islands | SLB | 677 |
Somalia | SOM | 252 |
South Africa | ZAF | 27 |
South Korea | KOR | 82 |
South Sudan | SSD | 211 |
Spain | ESP | 34 |
Sri Lanka | LKA | 94 |
St. Kitts & Nevis | KNA | 1 |
St. Lucia | LCA | 1 |
St. Vincent & Grenadines | VCT | 1 |
Sudan | SDN | 249 |
Suriname | SUR | 597 |
Swaziland | SWZ | 268 |
Sweden | SWE | 46 |
Switzerland | CHE | 41 |
Syria | SYR | 963 |
Taiwan | TWN | 886 |
Tajikistan | TJK | 992 |
Tanzania | TZA | 255 |
Thailand | THA | 66 |
Timor-Leste | TLS | 670 |
Togo | TGO | 228 |
Tonga | TON | 676 |
Trinidad & Tobago | TTO | 1 |
Tunisia | TUN | 216 |
Turkey | TUR | 90 |
Turkmenistan | TKM | 993 |
Tuvalu | TUV | 688 |
Uganda | UGA | 256 |
UK | GBR | 44 |
Ukraine | UKR | 380 |
United Arab Emirates | ARE | 971 |
Uruguay | URY | 598 |
US | USA | 1 |
Uzbekistan | UZB | 998 |
Vanuatu | VUT | 678 |
Vatican City | VAT | 39 |
Venezuela | VEN | 58 |
Vietnam | VNM | 84 |
Yemen | YEM | 967 |
Zambia | ZMB | 260 |
Zimbabwe | ZWE | 263 |