Attachment Schema

The Checkout, Payments and Customer Token APIs expect the attachment.bodyrequest property to have a string value containing a serialized JSON object, whose structure is reflected by the the following JSON Schema.

Array of objects

Details about the reservation of airline tickets

Array
pnr
string

Trip booking number, e.g. VH67899

Array of objects

Itinerary data, one per segment

Array
departure
string 3 characters

IATA Airport Code (three letters)

departure_city
string
arrival
string 3 characters

IATA Airport Code (three letters)

arrival_city
string
carrier
string

IATA Airline standard (two letters or digits)

segment_price
number

Local currency

departure_date
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

ticket_delivery_method
any
Enum: "pick_up" "email" "post" "phone"
ticket_delivery_recipient
string

The name of the recipient the ticket is delivered to. If email or phone, then use either the email address or the phone number.

passenger_id
Array of integers
class
string
Array of objects

Insurance data

Array
insurance_company
string
insurance_type
any
Enum: "cancellation" "travel" "cancellation_travel" "bankruptcy"
insurance_price
number

Local currency

Array of objects

Passengers data

Array
id
integer
title
any

Mr, Mrs, Ms or blank if under 12 years

Enum: "mr" "mrs" "ms" ""
first_name
string
last_name
string
affiliate_name
string

Name of the affiliate that originated the purchase. If none, leave blank.

Array of objects

Details about the reservation of bus tickets

Array
pnr
string

Trip booking number, e.g. VH67899

Array of objects

Itinerary data, one per segment

Array
departure
string

City code or name

departure_city
string
arrival
string

City code or name

arrival_city
string
carrier
string

Name of transportation company

segment_price
integer

Local currency

departure_date
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

ticket_delivery_method
any
Enum: "pick_up" "email" "post" "phone"
ticket_delivery_recipient
string

The name of the recipient the ticket is delivered to. If email or phone, then use either the email address or the phone number.

passenger_id
Array of integers
class
string
Array of objects

Insurance data

Array
insurance_company
string
insurance_type
any
Enum: "cancellation" "travel" "cancellation_travel" "bankruptcy"
insurance_price
number

Local currency

Array of objects

Passengers data

Array
id
integer
title
any

Mr, Mrs, Ms or blank if under 12 years

Enum: "mr" "mrs" "ms" ""
first_name
string
last_name
string
affiliate_name
string

Name of the affiliate that originated the purchase. If none, leave blank.

Array of objects

Details about the reservation of train tickets

Array
pnr
string

Trip booking number, e.g. VH67899

Array of objects

Itinerary data, one per segment

Array
departure
string

City code or name

departure_city
string
arrival
string

City code or name

arrival_city
string
carrier
string

Name of transportation company

segment_price
integer

Local currency

departure_date
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

ticket_delivery_method
any
Enum: "pick_up" "email" "post" "phone"
ticket_delivery_recipient
string

The name of the recipient the ticket is delivered to. If email or phone, then use either the email address or the phone number.

passenger_id
Array of integers
class
string
Array of objects

Insurance data

Array
insurance_company
string
insurance_type
any
Enum: "cancellation" "travel" "cancellation_travel" "bankruptcy"
insurance_price
number

Local currency

Array of objects

Passengers data

Array
id
integer
title
any

Mr, Mrs, Ms or blank if under 12 years

Enum: "mr" "mrs" "ms" ""
first_name
string
last_name
string
affiliate_name
string

Name of the affiliate that originated the purchase. If none, leave blank.

Array of objects

Details about the reservation of ferry tickets

Array
pnr
string

Trip booking number, e.g. VH67899

Array of objects

Itinerary data, one per segment

Array
departure
string

City code or name

departure_city
string
arrival
string

City code or name

arrival_city
string
carrier
string

Name of transportation company

segment_price
integer

Local currency

departure_date
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

ticket_delivery_method
any
Enum: "pick_up" "email" "post" "phone"
ticket_delivery_recipient
string

The name of the recipient the ticket is delivered to. If email or phone, then use either the email address or the phone number.

passenger_id
Array of integers
class
string
Array of objects

Insurance data

Array
insurance_company
string
insurance_type
any
Enum: "cancellation" "travel" "cancellation_travel" "bankruptcy"
insurance_price
number

Local currency

Array of objects

Passengers data

Array
id
integer
title
any

Mr, Mrs, Ms or blank if under 12 years

Enum: "mr" "mrs" "ms" ""
first_name
string
last_name
string
affiliate_name
string

Name of the affiliate that originated the purchase. If none, leave blank.

Array of objects

Details about the reservation of hotel rooms

Array
pnr
string

Trip booking number, e.g. VH67899

Array of objects

Hotel itinerary data, one per hotel stay

Array
hotel_name
string

Name of hotel

object
street_address
string
postal_code
string
city
string
country
string
start_time
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

end_time
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

number_of_rooms
integer
passenger_id
Array of integers
ticket_delivery_method
any
Enum: "pick_up" "email" "post" "phone"
ticket_delivery_recipient
string

The name of the recipient the ticket is delivered to. If email or phone, then use either the email address or the phone number.

hotel_price
number

Local currency

class
string
Array of objects

Insurance data

Array
insurance_company
string
insurance_type
any
Enum: "cancellation" "travel" "cancellation_travel" "bankruptcy"
insurance_price
number

Local currency

Array of objects

Passengers data

Array
id
integer
title
any

Mr, Mrs, Ms or blank if under 12 years

Enum: "mr" "mrs" "ms" ""
first_name
string
last_name
string
affiliate_name
string

Name of the affiliate that originated the purchase. If none, leave blank.

Array of objects

Details about the reservation of rental cars

Array
pnr
string

Trip booking number, e.g. VH67899

Array of objects

Car rental itinerary data

Array
rental_company
string

Name of rental company

drivers_id
Array of integers
object
street_address
string
postal_code
string
city
string
country
string
start_time
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

object
street_address
string
postal_code
string
city
string
country
string
end_time
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

car_price
number

Local currency

class
string
Array of objects

Insurance data

Array
insurance_company
string
insurance_type
any
Enum: "cancellation" "travel" "cancellation_travel" "bankruptcy"
insurance_price
number

Local currency

Array of objects
Array
id
integer
title
any

Mr, Mrs, Ms or blank if under 12 years

Enum: "mr" "mrs" "ms" ""
first_name
string
last_name
string
affiliate_name
string

Name of the affiliate that originated the purchase. If none, leave blank.

Array of objects
Array
event_name
string

Name of the event, e.g. "Fancy Singer"

event_company
string

Name of the company arranging the event, e.g. "Happy Parties Ltd."

genre_of_event
string

Category or type of venue, "Pop"

arena_name
string

Name of the venue, "Song Arena"

object

Location of the arena.

street_address
string
postal_code
string
city
string
country
string
start_time
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

end_time
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

access_controlled_venue
boolean

Tickets are digitally checked when enetering the venue

ticket_delivery_method
any
Enum: "pick_up" "email" "post" "phone"
ticket_delivery_recipient
string

The name of the recipient the ticket is delivered to. If email or phone, then use either the email address or the phone number.

affiliate_name
string

Name of the affiliate that originated the purchase. If none, leave blank.

Array of objects
Array
voucher_name
string

Description of the product the voucher entitles to, e.g. "China trip"

voucher_company
string

Name of the company that will provide good / service upon voucher (not the same as the selling merchant), e.g. "Sun Trips Ltd."

start_time
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

end_time
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

affiliate_name
string

Name of the affiliate that originated the purchase. If none, leave blank.

Array of objects
Array
subscription_name
string

Name of the product on subscription, e.g. "Contact lenses"

start_time
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

end_time
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

auto_renewal_of_subscription
boolean

Info whether the subscription will be auto renewed upon expiry.

affiliate_name
string

Name of the affiliate that originated the purchase. If none, leave blank.

Array of objects
Array
object
email
string
pno
string
other
string
sub_merchant_id
string

Name or unique number of the selling / delivering merchant, e.g. "Marketbrick Ltd."

product_category
string

Name of the overall category to which the specific good(s) belong to, according to the selling merchants categorization. E.g. "Computers"

product_name
string

Name of the specific good purchased, e.g. "Acer 5400"

account_registration_date
string <date-time>

ISO 8601 e.g. 2012-11-24T15:00

object
password
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

email
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

listing
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

login
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

address
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

seller_rating
number

Current rating. Partner should provide upfront their rating scale, e.g. 65

number_of_trades
integer

Number of trades the sub-merchant did since 12 months back, e.g. 23

volume_of_trades
integer

Volumes of trades the sub-merchant did since 12 months back, e.g. 230.5

Array of objects
Array
object
email
string
pno
string
other
string
account_registration_date
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

object
password
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

email
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

listing
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

login
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

address
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

number_of_trades
integer

Number of trades the winner did since 12 months back, e.g. 5

volume_of_trades
integer

Volume of trades the winner did since 12 months back, 230.5

Array of objects
Array
unique_account_identifier
string

Unique name / number to identify the specific customer account. Max 24 characters. E.g. "Adam Adamsson"

account_registration_date
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

account_last_modified
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

Array of objects
Array
unique_account_identifier
string

Unique name / number to identify the specific customer account. Max 24 characters. E.g. "Adam Adamsson"

payment_option
string
Enum: "card" "direct banking" "non klarna credit" "sms" "other"
number_paid_purchases
integer

Total number of successful purchases

total_amount_paid_purchases
number

Total amount of successful purchases (local currency), e.g. 1234.00

date_of_last_paid_purchase
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

date_of_first_paid_purchase
string <date-time> ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[...

ISO 8601 e.g. 2012-11-24T15:00

Array of objects
Array
unique_account_identifier
string

Unique name / number to identify the specific customer account. Max 24 characters. E.g. "Adam Adamsson"

paid_before
boolean

Whether the customer has paid before or not

Array of objects
Array
shipping_method
any
Enum: "store pick-up" "pick-up point" "registered box" "unregistered box"
shipping_type
any
Enum: "normal" "express"
first_name
string
last_name
string
street_address
string
street_number
string
postal_code
string
city
string
country
string