# Reference
# Address
Property | Type | Description |
---|---|---|
street | string | Must match regular expression ^[\w -,\.\-\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF]+$ |
zip_code | string | Must match regular expression ^[A-Z0-9]+$ |
city | string | Must match regular expression ^[\w -,\.\-\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF]+$ |
country_code | Alpha2 |
# Example:
{
"street": "Storgatan 1",
"zipCode": "111 23",
"city": "Stockholm",
"countryCode": "SE"
}
# Addresses
Property | Type | Optional |
---|---|---|
primary | Address | |
billing | Address | Yes |
delivery | Address | Yes |
visit | Address | Yes |
# Alpha2
ISO 3166-1 Alpha-2 code, e.g. "FR"
for France and "SE"
for Sweden
# Browser
# Creatable
Use the javascript commands in the description column below to get browser information from a user of your website. This is recommended when creating Order, Customer, Payment Method or Authorization for use when verifying card-holder.
Property | Type | Description | Optional |
---|---|---|---|
color_depth | number | screen.colorDepth | Yes |
java | boolean | navigator.javaEnabled() | Yes |
javascript | boolean | true | Yes |
locale | Locale | navigator.language | Yes |
timezone | number | new Date().getTimezoneOffset() | Yes |
resolution | [number, number] | [screen.width, screen.height] | Yes |
ip_country | Alpha2 | SE | Yes |
# Browser
The final Browser
object is the same as the Browser.Creatable
but with these added fields:
Property | Type | Optional |
---|---|---|
accept_header | string | Yes |
user_agent | string | Yes |
ip | string | Yes |
# Contact
Data type representing a contact.
Property | Type | Description | Optional |
---|---|---|---|
type | "organization" or "person" | Yes | |
identity_number | string | Yes | |
id | string | Yes | |
number | string | Yes | |
name | Name | Required for funding category. | Yes |
address | Address | Required for funding category. | Yes |
email | string | Yes | |
phone | string | Yes | |
account_number | string | Required for funding category. | |
account_type | string Allowed account types are | Required for funding category. | Yes |
# Currency
String set according to ISO 4217 Currency codes, formated as e.g. "EUR"
for Euros, "USD"
for United Stated Dollar, and "SEK"
for Swedish krona.
# Date
String written as "YYYY-MM-DD"
, e.g. "2021-12-31"
.
# DateTime
String formated as "YYYY-MM-DDThh:mm:ss.fffK"
, e.g. "2020-12-31T23:59:59.999Z"
.
# EmailAddresses
For EmailAddresses
atleast one primary
of billing
must be defined.
Property | Type | Description | Optional |
---|---|---|---|
primary | string | primary email address | Yes |
billing | string | billing email address | Yes |
Example:
{
"primary": "main@company.com",
"billing": "billing@company.com"
}
# Item
The data type Item
is used to specify what products are included in an order.
For Item
, all properties are optional, but if vat
is included, price
must be included too. Quantity will be treated as 1 if it's not included.
Note
All amount fields (price
, vat
and rebate
) on Item
are in major units (e.g. 4.5
is equivalent to 4.50 EUR
)
Property | Type | Description | Optional |
---|---|---|---|
number | string | product number in your system | Yes |
name | string | name or description of the product | Yes |
price | number | price per unit (excluding VAT) | Yes |
quantity | number | number of units | Yes |
unit | string | unit for measuring the product | Yes |
vat | number | VAT per unit | Yes |
rebate | number | rebate per unit | Yes |
Item Example:
{
"number": "abc123",
"name": "ceramic vase",
"price": 100,
"quantity": 2,
"unit": "pcs",
"vat": 25,
"rebate": 0
}
# Locale
String defined by language ISO 639-1, followed by a dash "-"
then a ISO 3166-1 Alpha-2 code. E.g. "en-US"
for the English-United States or "sv-SE"
for Swedish-Sweden. This is defined by navigator.language
in the browser. All acceptable locales can be found here (opens new window).
# Name
Property | Type | Description | Optional |
---|---|---|---|
first | string | Must match regular expression ^[\w -,\.\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF]+$ | Yes |
last | string | Must match regular expression ^[\w -,\.\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF]+$ | Yes |
# PhoneNumbers
For PhoneNumbers
atleast one property must be defined.
Property | Type | Description | Optional |
---|---|---|---|
primary | string | primary phone number | Yes |
cellphone | string | cellphone number | Yes |
landline | string | landline number | Yes |
# Scheme
String set as "unknown"
, "electron"
, "maestro"
, "mastercard"
or "visa"
.
# Wallet
Note
Both payout
and preliminaryFee
are in major units (e.g. 4.5
is equivalent to 4.50 EUR
)
Property | Type | Description | Optional |
---|---|---|---|
payout | number | ||
preliminary_fee | number |