Indicates whether order has separate delivery address or not.
customer
customer object
Customer information.
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.
insertedAt
string Format: date-time
Indicates the creation of the specific element (e.g. orderDetails).
updatedAt
string Format: date-time
Indicates the time of the latest change of the element.
imageUrl
string <= 2048 characters
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.
Supported image formats are: gif, jpeg (jpg), png, webp.
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.
googleAnalyticsUserId
string <= 50 characters
Google Analytics User ID.
orderItems
array of orderItems
Order items.
Array () [
orderId
string Format: uuid
Order ID
insertedAt
string Format: date-time
Inserted at
updatedAt
string Format: date-time
Updated at
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.
googleProductCategoryId
integer
Google product category ID.
googleProductCategory
string <= 255 characters
Indicates the category of the item based on the Google product taxonomy. Categorizing the product helps ensure that the ad is shown with the right search results.
merchantProductType
string <= 255 characters
Categorization used by Merchant as a complement to Google Taxonomy.
lineNumber
integer
Line number. The merchant may add a line number to each order item, to sort them in a particular order.
productUrl
string <= 2048 characters
URL to the product.
marketPlaceSellerId
string <= 32 characters
ID of an individual seller on a marketplace.
parentTransactionReference
string <= 128 characters
A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.
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.
]
expirationDate
string Format: date
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.
Indicates the time when the capture was last updated.
directDebitBankAccount
string <= 34 characters
Direct debit bank account.
directDebitSwift
string <= 11 characters
Direct debit swift.
accountProfileNumber
integer
Account profile number.
numberOfInstallments
integer
Number of installments.
installmentAmount
number
Installment amount.
contractDate
string Format: date-time
Contract date.
orderDate
string Format: date-time
Order date.
installmentProfileNumber
integer
Installment profile number.
parentTransactionReference
string <= 128 characters
A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.
transactionReference
string <= 100 characters
A unique reference for each transaction (separate for transactions within an order),
generated and provided to Riverty by a third party (merchant or Payment Service Provider).
It is used to identify transactions during back-end settlement between Core systems and the PSP.
dueDate
string Format: date-time
Due date.
invoiceDate
string Format: date-time
Invoice date.
yourReference
string <= 20 characters
Reference number. Only to be used if advised by Riverty integration manager.
ourReference
string <= 20 characters
Reference number. Only to be used if advised by Riverty integration manager.
invoiceProfileNumber
integer
Invoice profile number.
ocr
string <= 27 characters
OCR (Optical Character Recognition) number bound to this capture.
installmentCustomerInterestRate
number
Installment customer interest rate.
imageUrl
string <= 2048 characters
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.
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.
captureItems
array of captureItems
Capture 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.
googleProductCategoryId
integer
Google product category ID.
googleProductCategory
string <= 255 characters
Indicates the category of the item based on the Google product taxonomy. Categorizing the product helps ensure that the ad is shown with the right search results.
merchantProductType
string <= 255 characters
Categorization used by Merchant as a complement to Google Taxonomy.
lineNumber
integer
Line number. The merchant may add a line number to each order item, to sort them in a particular order.
productUrl
string <= 2048 characters
URL to the product.
marketPlaceSellerId
string <= 32 characters
ID of an individual seller on a marketplace.
parentTransactionReference
string <= 128 characters
A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.
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.
]
shippingDetails
array of shippingDetails
Shipping details.
Array () [
shippingNumber
required
integer
Unique shipping number within one capture
type
required
string
Enum:ShipmentReturn
Shipping type
shippingCompany
required
string <= 200 characters
Company name providing shipping
trackingId
required
string <= 100 characters
Tracking ID
trackingUrl
string <= 2083 characters
Webpage URL to track shipping status
]
]
refunds
array of refunds
Collection of refunds
Array () [
reservationId
string Format: uuid
Reservation ID
customerNumber
string <= 100 characters
Customer number
refundNumber
string <= 50 characters
Refund number
orderNumber
string <= 50 characters
Order number
amount
number
Refunded amount
balance
number
Remaining amount to be refunded
currency
string
Enum:EURNOKSEKDKKCHF
Currency code
insertedAt
string Format: date-time
Indicates the Refund creation time
updatedAt
string Format: date-time
Indicates the time when the refund was last updated
captureNumber
string <= 50 characters
Capture number
refundItems
array of refundItems
Refund 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.
googleProductCategoryId
integer
Google product category ID.
googleProductCategory
string <= 255 characters
Indicates the category of the item based on the Google product taxonomy. Categorizing the product helps ensure that the ad is shown with the right search results.
merchantProductType
string <= 255 characters
Categorization used by Merchant as a complement to Google Taxonomy.
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.
]
parentTransactionReference
string <= 128 characters
A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.
transactionReference
string <= 100 characters
Transaction-specific reference from and for the PSP's system
]
cancellations
array of cancellations
Cancellation info
Array () [
cancellationNo
string <= 50 characters
Order number
cancellationAmount
number
Amount of the cancelled items
cancellationItems
array of cancellationItems
The list of items to be cancelled
Array () [
cancellationNumber
string <= 50 characters
Refund ID
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.
googleProductCategoryId
integer
Google product category ID.
googleProductCategory
string <= 255 characters
Indicates the category of the item based on the Google product taxonomy. Categorizing the product helps ensure that the ad is shown with the right search results.
merchantProductType
string <= 255 characters
Categorization used by Merchant as a complement to Google Taxonomy.
lineNumber
integer
Line number. The merchant may add a line number to each order item, to sort them in a particular order.
productUrl
string <= 2048 characters
URL to the product.
marketPlaceSellerId
string <= 32 characters
ID of an individual seller on a marketplace.
parentTransactionReference
string <= 128 characters
A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.
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.
]
parentTransactionReference
string <= 128 characters
A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.