Unique string provided by Riverty if the merchant is using tokenization.
Contact your Integration Manager for more details.
recurringDirectDebit
recurringDirectDebit object
Recurring direct debit information
directDebitAgreement
required
string
Enum:UseExistingCreateNew
bankCode
string <= 11 characters
Direct debit swift, BIC, SortCode
bankAccount
string <= 34 characters
Direct debit bank account. Required when directDebitAgreement value is CreateNew
campaign
campaign object
Campaign information
campaignNumber
required
integer
Campaign number
invoice
Invoice information. Reserved for future use.
account
account object
Used when consumer has chosen flexible installment plan (minimum amount to pay)
profileNo
required
integer
Account Profile number
consolidatedInvoice
consolidatedInvoice object
Consolidate invoice information
invoiceDate
string Format: date-time
Date when invoice will be created.
installment
installment object
Installment information
profileNo
required
integer
Installment profile number
numberOfInstallments
integer
Number of installments
customerInterestRate
number
Customer interest rate
payinX
Pay In X information. Reserverd for future use
customer
required
customer object
CheckoutCustomer object
identificationNumber
string <= 20 characters
National ID number (if the customer is a physical person). Registration number (if the customer is a company).
address
required
address object
Address
careOf
string <= 50 characters
Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”).
This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.
street
string <= 100 characters
Name of street or packstation
streetNumber
string <= 10 characters
Street or packstation number
streetNumberAdditional
string <= 10 characters
Additional street number
postalCode
string <= 10 characters
Postal code
postalPlace
string <= 100 characters
Postal place
countryCode
string
Enum:NOSEFIDKDEATCHNLBE
Country code
legalForm
string <= 255 characters
Type of business. Required for Austria, Germany and Switzerland.
riskData
required
riskData object
Risk related data. Merchants can do external risk checks and provide that information to Riverty.
existingCustomer
boolean
Is customer an existing customer for merchant
verifiedCustomerIdentification
boolean
Is identification verified
marketingOptIn
boolean
Shows if merchant is allowed to send marketing information to customer
Specify the channel which consumer has used for accessing merchant page
hasCustomerCard
boolean
Shows if customer has loyalty card
customerCardSince
string Format: date-time
The date when the loyalty card was issued to the customer
customerCardClassification
string
Specifies the level of the loyalty card (e.g Gold member).
For DE, AT, CH, this must be an integer from 1 to 5, where 5 is the highest VIP level.
profileTrackingId
string <= 50 characters
Unique Id of the device for profile tracking
ipAddress
required
string <= 39 characters
Customer’s IP address
numberOfTransactions
integer
Total number of successful purchases that have been made by the specific consumer
customerIndividualScore
string
The customer's individual risk score provided by the merchant.
Accepts a number from -10000 to 10000 (can be encased in quotation marks or not), or a single case-insensitive letter from 'a' to 'z'.
userAgent
string <= 4096 characters
UserAgent of this specific consumer
amountOfTransactions
number
Amount of paid orders last 12 months
otherPaymentMethods
boolean
Other payment method than MI in wallet
customerNumber
string <= 100 characters
Customer number has to be unique, if no customer number available please leave empty
salutation
string
Enum:MrMrsMissDiverse
Salutation.
firstName
required
string <= 50 characters
First name. Everything over 50 characters will be truncated
lastName
required
string <= 50 characters
Last name. Everything over 255 characters will be truncated
companyName
string <= 255 characters
Purchasing company name. Required if customerCategory is 'Company'. Everything over 50 characters will be truncated.
email
required
string <= 255 characters
Email
phone
string <= 20 characters
Phone
mobilePhone
string <= 20 characters
Mobile phone
birthDate
required
string Format: date
Date of birth. Not required if customerCategory is 'Company'.
customerCategory
required
string
Enum:CompanyPerson
Customer category.
conversationLanguage
string
Enum:NOSVSEFIDADKENDENLFR
Conversation language. 'SE' and 'DK' are obsolete values, and will be removed in the future. Use 'SV' instead of 'SE', and 'DA' instead of 'DK'.
distributionType
string
Enum:PaperEmailSms
Specifies how information (invoices, notices, etc.) will be distributed to customer.
vatId
string <= 50 characters
VAT registration number, the unique number that identifies a business. This field is mandatory for processing B2B transactions in Austria, Germany and Switzerland.
deliveryCustomer
deliveryCustomer object
To be used if the receiver of the order differs from the billing customer
address
address object
Address
addressType
string
Enum:StandardShipToPickUpPointInStore
Address type
careOf
string <= 50 characters
Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”).
This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.
street
string <= 100 characters
Name of street or packstation
streetNumber
string <= 10 characters
Street or packstation number
streetNumberAdditional
string <= 10 characters
Additional street number
postalCode
string <= 10 characters
Postal code
postalPlace
string <= 100 characters
Postal place
countryCode
string
Enum:NOSEFIDKDEATCHNLBE
Country code
customerNumber
string <= 100 characters
Customer number has to be unique, if no customer number available please leave empty
salutation
string
Enum:MrMrsMissDiverse
Salutation.
firstName
string <= 50 characters
First name. Everything over 50 characters will be truncated
lastName
string <= 50 characters
Last name. Everything over 255 characters will be truncated
companyName
string <= 255 characters
Purchasing company name. Everything over 255 characters will be truncated. This field is mandatory for processing B2B transactions in Austria, Belgium, Germany, the Netherlands and Switzerland.
email
string <= 255 characters
Email
phone
string <= 20 characters
Phone
mobilePhone
string <= 20 characters
Mobile phone
birthDate
required
string Format: date
Date of birth. Not required if customerCategory is 'Company'.
customerCategory
required
string
Enum:CompanyPerson
Customer category.
conversationLanguage
string
Enum:NOSVSEFIDADKENDENLFR
Conversation language. 'SE' and 'DK' are obsolete values, and will be removed in the future. Use 'SV' instead of 'SE', and 'DA' instead of 'DK'.
distributionType
string
Enum:PaperEmailSms
Specifies how information (invoices, notices, etc.) will be distributed to customer.
vatId
string <= 50 characters
VAT registration number, the unique number that identifies a business. This field is mandatory for processing B2B transactions in Austria, Germany and Switzerland.
order
required
order object
Order object
number
string <= 50 characters
Order number. Unique order number provided by the merchant. A valid order number can include alphanumeric characters, dashes and underscores.
totalNetAmount
required
number
Total net amount of order.
totalGrossAmount
required
number
Total gross amount of order. Must match the grossUnitPrice * quantity of order items
currency
required
string
Enum:EURNOKSEKDKKCHF
Currency of the order
risk
risk object
Order related risk data. If you were not provided these credentials by your Integration Manager, leave empty.
channelType
string
Enum:InternetCatalogCallCenterStationaryOther
Order channel type
deliveryType
string
Enum:NormalExpress
Order delivery type
ticketDeliveryMethod
string
Enum:NotSetPickUpEmailPostPhone
Name of the tickets' method
airline
airline object
Airline information when airline tickets or services are ordered
passengers
array of passengers
Passengers
Array () [
id
integer
Continuous numbering.
firstName
string <= 4096 characters
First name.
lastName
string <= 4096 characters
Last name.
salutation
string
Enum:MrMrsMissDiverse
Salutation.
dateOfBirth
string Format: date
Date birth of passenger.
]
itineraries
array of itineraries
Itineraries
Array () [
operator
string <= 4096 characters
Name or Airport code (2-letter IATA) of the carrier
departure
string <= 4096 characters
Departure city or Airport Code (3-letter IATA)
arrival
string <= 4096 characters
Arrival city or Airport Code (3-letter IATA)
routeNumber
string <= 4096 characters
Number of this itinerary. Assumes String ordering.
National ID number (if the customer is a physical person). Registration number (if the customer is a company).
address
required
address object
Address
careOf
string <= 50 characters
Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”).
This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.
street
string <= 100 characters
Name of street or packstation
streetNumber
string <= 10 characters
Street or packstation number
streetNumberAdditional
string <= 10 characters
Additional street number
postalCode
string <= 10 characters
Postal code
postalPlace
string <= 100 characters
Postal place
countryCode
string
Enum:NOSEFIDKDEATCHNLBE
Country code
legalForm
string <= 255 characters
Type of business. Required for Austria, Germany and Switzerland.
riskData
required
riskData object
Risk related data. Merchants can do external risk checks and provide that information to Riverty.
existingCustomer
boolean
Is customer an existing customer for merchant
verifiedCustomerIdentification
boolean
Is identification verified
marketingOptIn
boolean
Shows if merchant is allowed to send marketing information to customer
Specify the channel which consumer has used for accessing merchant page
hasCustomerCard
boolean
Shows if customer has loyalty card
customerCardSince
string Format: date-time
The date when the loyalty card was issued to the customer
customerCardClassification
string
Specifies the level of the loyalty card (e.g Gold member).
For DE, AT, CH, this must be an integer from 1 to 5, where 5 is the highest VIP level.
profileTrackingId
string <= 50 characters
Unique Id of the device for profile tracking
ipAddress
required
string <= 39 characters
Customer’s IP address
numberOfTransactions
integer
Total number of successful purchases that have been made by the specific consumer
customerIndividualScore
string
The customer's individual risk score provided by the merchant.
Accepts a number from -10000 to 10000 (can be encased in quotation marks or not), or a single case-insensitive letter from 'a' to 'z'.
userAgent
string <= 4096 characters
UserAgent of this specific consumer
amountOfTransactions
number
Amount of paid orders last 12 months
otherPaymentMethods
boolean
Other payment method than MI in wallet
customerNumber
string <= 100 characters
Customer number has to be unique, if no customer number available please leave empty
salutation
string
Enum:MrMrsMissDiverse
Salutation.
firstName
required
string <= 50 characters
First name. Everything over 50 characters will be truncated
lastName
required
string <= 50 characters
Last name. Everything over 255 characters will be truncated
companyName
string <= 255 characters
Purchasing company name. Required if customerCategory is 'Company'. Everything over 50 characters will be truncated.
email
required
string <= 255 characters
Email
phone
string <= 20 characters
Phone
mobilePhone
string <= 20 characters
Mobile phone
birthDate
required
string Format: date
Date of birth. Not required if customerCategory is 'Company'.
customerCategory
required
string
Enum:CompanyPerson
Customer category.
conversationLanguage
string
Enum:NOSVSEFIDADKENDENLFR
Conversation language. 'SE' and 'DK' are obsolete values, and will be removed in the future. Use 'SV' instead of 'SE', and 'DA' instead of 'DK'.
distributionType
string
Enum:PaperEmailSms
Specifies how information (invoices, notices, etc.) will be distributed to customer.
vatId
string <= 50 characters
VAT registration number, the unique number that identifies a business. This field is mandatory for processing B2B transactions in Austria, Germany and Switzerland.
]
price
number
Price of a rental car
currency
string
Enum:EURNOKSEKDKKCHF
Currency
bookingReference
string <= 4096 characters
Booking reference
hotel
hotel object
Hotel information
company
string <= 4096 characters
address
address object
Hotel address
street
string <= 100 characters
Name of street or packstation
streetNumber
string <= 10 characters
Street or packstation number
streetNumberAdditional
string <= 10 characters
Additional street number
postalCode
string <= 10 characters
Postal code
postalPlace
string <= 100 characters
Postal place
countryCode
string
Enum:NOSEFIDKDEATCHNLBE
Country code
checkin
string Format: date-time
Check-in date and time
checkout
string Format: date-time
Check-out date and time
guests
array of guests
Guests information
Array () [
identificationNumber
string <= 20 characters
National ID number (if the customer is a physical person). Registration number (if the customer is a company).
address
required
address object
Address
careOf
string <= 50 characters
Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”).
This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.
street
string <= 100 characters
Name of street or packstation
streetNumber
string <= 10 characters
Street or packstation number
streetNumberAdditional
string <= 10 characters
Additional street number
postalCode
string <= 10 characters
Postal code
postalPlace
string <= 100 characters
Postal place
countryCode
string
Enum:NOSEFIDKDEATCHNLBE
Country code
legalForm
string <= 255 characters
Type of business. Required for Austria, Germany and Switzerland.
riskData
required
riskData object
Risk related data. Merchants can do external risk checks and provide that information to Riverty.
existingCustomer
boolean
Is customer an existing customer for merchant
verifiedCustomerIdentification
boolean
Is identification verified
marketingOptIn
boolean
Shows if merchant is allowed to send marketing information to customer
Specify the channel which consumer has used for accessing merchant page
hasCustomerCard
boolean
Shows if customer has loyalty card
customerCardSince
string Format: date-time
The date when the loyalty card was issued to the customer
customerCardClassification
string
Specifies the level of the loyalty card (e.g Gold member).
For DE, AT, CH, this must be an integer from 1 to 5, where 5 is the highest VIP level.
profileTrackingId
string <= 50 characters
Unique Id of the device for profile tracking
ipAddress
required
string <= 39 characters
Customer’s IP address
numberOfTransactions
integer
Total number of successful purchases that have been made by the specific consumer
customerIndividualScore
string
The customer's individual risk score provided by the merchant.
Accepts a number from -10000 to 10000 (can be encased in quotation marks or not), or a single case-insensitive letter from 'a' to 'z'.
userAgent
string <= 4096 characters
UserAgent of this specific consumer
amountOfTransactions
number
Amount of paid orders last 12 months
otherPaymentMethods
boolean
Other payment method than MI in wallet
customerNumber
string <= 100 characters
Customer number has to be unique, if no customer number available please leave empty
salutation
string
Enum:MrMrsMissDiverse
Salutation.
firstName
required
string <= 50 characters
First name. Everything over 50 characters will be truncated
lastName
required
string <= 50 characters
Last name. Everything over 255 characters will be truncated
companyName
string <= 255 characters
Purchasing company name. Required if customerCategory is 'Company'. Everything over 50 characters will be truncated.
email
required
string <= 255 characters
Email
phone
string <= 20 characters
Phone
mobilePhone
string <= 20 characters
Mobile phone
birthDate
required
string Format: date
Date of birth. Not required if customerCategory is 'Company'.
customerCategory
required
string
Enum:CompanyPerson
Customer category.
conversationLanguage
string
Enum:NOSVSEFIDADKENDENLFR
Conversation language. 'SE' and 'DK' are obsolete values, and will be removed in the future. Use 'SV' instead of 'SE', and 'DA' instead of 'DK'.
distributionType
string
Enum:PaperEmailSms
Specifies how information (invoices, notices, etc.) will be distributed to customer.
vatId
string <= 50 characters
VAT registration number, the unique number that identifies a business. This field is mandatory for processing B2B transactions in Austria, Germany and Switzerland.
]
numberOfRooms
integer
Number of rooms
price
number
Price of the hotel accommodation
currency
string
Enum:EURNOKSEKDKKCHF
Currency
bookingReference
string <= 4096 characters
Booking reference
merchantImageUrl
string <= 2048 characters
Image URL for the merchants brand. This image is shown at the top of the order page in Riverty. Supported image formats are: gif, jpeg (jpg), png, webp.
items
required
array of items
Array of order items. Maximum allowed 200 items.
Array () [
productId
required
string <= 100 characters
Merchant Product identification number.
groupId
string <= 50 characters
Item group ID. The group this item belongs to. Provided by the merchant. Everything over 50 characters will be truncated.
description
required
string
Product name. For example "Black music player 64GB". Everything over 255 characters will be truncated.
URL for the image of this product. It will be turned into a thumbnail and displayed in Riverty, on the invoice line next to the order item.
The linked image must be a rectangle or square, width between 100 pixels and 1280 pixels.
productUrl
string <= 2048 characters
URL to the product.
marketPlaceSellerId
string <= 32 characters
ID of an individual seller on a marketplace.
additionalInformation
string <= 4096 characters
Extended description of the order item.
specification
object
Specification.
serviceStart
string Format: date-time
Capture start time.
serviceEnd
string Format: date-time
Capture end time.
]
productUser
string <= 50 characters
Product User
costCenter
string <= 50 characters
Used for B2B to specify the costCenter e.g. Marketing or Sales Department - Displayed on the invoice.
parentTransactionReference
string <= 128 characters
A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.
additionalData
additionalData object
Additional Information - to be provided by PSP, plugin or marketplace integrations
pluginProvider
string <= 50 characters
Plugin Provider Name
pluginVersion
string <= 50 characters
Plugin Version
shopUrl
string <= 2048 characters
URL of the Webshop
shopPlatform
string <= 50 characters
Name of the platform used for the Webshop
shopPlatformVersion
string <= 50 characters
Version of the webshop platform
marketplace
array of marketplace
Additional information for marketplace set-ups
Array () [
id
string <= 32 characters
ID of the marketplace seller
merchantCategoryCode
string <= 4 characters
A four-digit merchant categoryCode number of the marketplace seller
name
string <= 50 characters
Name of the marketplace seller
registeredSince
string Format: date-time
Registration date of the marketplace seller
rating
string <= 20 characters
Rating of the marketplace seller
transactions
integer
Number of transaction processed by the marketplace seller
]
subscription
subscription object
Additional information for subscription businesses
name
string <= 50 characters
Name / Description of the subscription
start
string Format: date-time
Startdate of the subscription
end
string Format: date-time
Enddate of the subscription
type
string
Enum:FixedPeriodAutoRenewal
Information if subscription will be autorenewed if not canceled or if subscription is for a fixed period (e.g. 6 months)
partnerData
partnerData object
Additional data to be provided by PSP or platform provider
pspName
string <= 50 characters
Name of the PSP
pspType
string
Enum:CollectingDistributingSuperMerchantMLevel
Type of the PSP
trackingProvider
string <= 50 characters
If device fingerprinting is applied, please specify the name of the provider
trackingSessionId
string <= 50 characters
Session id of tracking script
trackingScore
string <= 20 characters
Score provided by tracking provider
challengedScore
string <= 20 characters
Score provided by partner if transaction is challenged
additionalPaymentInfo
string <= 250 characters
Additional payment information
inStore
inStore object
Additional information about instore
storeId
string <= 16 characters
Number of Store
address
address object
Address
street
string <= 100 characters
Name of street or packstation
streetNumber
string <= 10 characters
Street or packstation number
streetNumberAdditional
string <= 10 characters
Additional street number
postalCode
string <= 10 characters
Postal code
postalPlace
string <= 100 characters
Postal place
countryCode
string
Enum:NOSEFIDKDEATCHNLBE
Country code
clerkId
string <= 16 characters
ClerkId
yourReference
string <= 20 characters
Can be used by purchasing company if they would like to provide internal reference
ourReference
string <= 20 characters
Can be used by selling company if they would like to provide specific reference for purchasing company
einvoiceInformation
einvoiceInformation object
Includes information to be able to send e-invoice to customer.
reference
string
The customer's e-invoice reference
referenceType
string
Enum:GLNOrgNoPEPPOL
Type of the refernce.
party
string <= 50 characters
Reference to the invoice party that should be used. For Finland the max length is 35 chars.
nonce
string
Unique string provided by Riverty if the merchant is using Hosted Fields. Contact your Integration Manager for more details.
RESPONSES:
200 OK
RESPONSE SCHEMA:
outcome
string
Enum:AcceptedPendingRejectedNotEvaluated
Outcome
customer
customer object
Customer
customerNumber
string <= 100 characters
Customer number
customerAccountId
string <= 50 characters
Customer account id
firstName
string <= 50 characters
First name
lastName
string <= 50 characters
Last name
addressList
array of addressList
Address list
Array () [
careOf
string <= 50 characters
Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”).
This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.
street
string <= 100 characters
Name of street or packstation
streetNumber
string <= 10 characters
Street or packstation number
streetNumberAdditional
string <= 10 characters
Additional street number
postalCode
string <= 10 characters
Postal code
postalPlace
string <= 100 characters
Postal place
countryCode
string
Enum:NOSEFIDKDEATCHNLBE
Country code
]
deliveryCustomer
deliveryCustomer object
To be used if the receiver of the order differs from the billing customer
customerNumber
string <= 100 characters
Customer number
customerAccountId
string <= 50 characters
Customer account id
firstName
string <= 50 characters
First name
lastName
string <= 50 characters
Last name
addressList
array of addressList
Address list
Array () [
careOf
string <= 50 characters
Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”).
This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.
street
string <= 100 characters
Name of street or packstation
streetNumber
string <= 10 characters
Street or packstation number
streetNumberAdditional
string <= 10 characters
Additional street number
postalCode
string <= 10 characters
Postal code
postalPlace
string <= 100 characters
Postal place
countryCode
string
Enum:NOSEFIDKDEATCHNLBE
Country code
]
reservationId
string Format: uuid
checkoutId
string Format: uuid
secureLoginUrl
string
Url where consumer can be redirected to perform strong authentication. Filled only in case the
risk check decides that purchase is not allowed without strong authentication.
Contact your Integration Manager to enable the feature.
The date and time when this authorization will expire if you did not make a Capture call.
If the deadline has passed, you must make a new Authorize call before Capturing this order.