Authorize Payment

More information can be found in our Documentation.

Path

POST /api/v3/checkout/authorize

Request Body application/json

checkoutId

string <uuid>

Unique identifier of checkout process in UUID format. Required only in the Two-Step Authorize use-case.

merchantId

string > 50 Characters

Merchant ID within the Riverty system, part of the credentials used for Riverty Netherlands and Belgium. If you were not provided these credentials by your Account Manager, leave empty.

payment
required

object (payment)

Payment information

type
required

string

Enum:InvoiceInstallmentAccountConsolidatedinvoicePayinX

Payment method type

contractId

string <uuid>

Contract ID

directDebit

object (directDebit)

Required for Fixed Installments payments in Germany, Austria and Switzerland

bankCode

string > 11 Characters

Direct debit swift, BIC, SortCode

bankAccount
required

string > 34 Characters

Direct debit bank account

token

string > 50 Characters

Unique string provided by Riverty if the merchant is using tokenization. Contact your Key Account Manager for more details.

recurringDirectDebit

object (recurringDirectDebit)

The information about recurring direct debit agreement

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

object (campaign)

campaignNumber
required

integer <int32>

Campaign number

invoice

object (invoice)

account

object (account)

profileNo
required

integer <int32>

Account Profile number

consolidatedInvoice

object (consolidatedInvoice)

Consolidated invoice information

invoiceDate

string <date-time>

Date when invoice will be created.

installment

object (installment)

profileNo
required

integer <int32>

Installment profile number

numberOfInstallments

integer <int32>

Number of installments

customerInterestRate

number <double>

Customer interest rate

payinX

object (payinX)

Input data for authorize request with PayInX payment type. Currently empty

customer

object (customer)

Checkout customer. Can be remitter or receiver of the order.

identificationNumber

string > 20 Characters

National ID number (if the customer is a physical person). Registration number (if the customer is a company).

address

object (address)

Customer 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

object (riskData)

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

customerSince

string <date-time>

Since when customer has been merchant's client

customerClassification

string > 255 Characters

Customer reputation (e.g. VIP client)

acquisitionChannel

string

Enum:NotSetAdvertismentSocialNetworkDirectSearchEngineOther

Customer acquisition channel

hasCustomerCard

boolean

Shows if customer has loyalty card

customerCardSince

string <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

string > 39 Characters

Customer’s IP address

numberOfTransactions

integer <int32>

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 <double>

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:MrMrsMiss

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 <email> > 255 Characters

Email

phone

string > 20 Characters

Phone

mobilePhone

string > 20 Characters

Mobile phone

birthDate
required

string <date>

Date of birth. Not required if customerCategory is 'Company'.

customerCategory
required

string

Enum:CompanyPerson

Customer category

conversationLanguage

string

Enum:NOSVFIDAENDENLFR

Language code

distributionType

string

Enum:PaperEmailSms

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

object (deliveryCustomer)

Checkout customer. Can be remitter or receiver of the order.

address

object (address)

Customer address

addressType

string

Enum:StandardShipToPickUpPointInStore

Delivery 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:MrMrsMiss

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 <email> > 255 Characters

Email

phone

string > 20 Characters

Phone

mobilePhone

string > 20 Characters

Mobile phone

birthDate
required

string <date>

Date of birth. Not required if customerCategory is 'Company'.

customerCategory
required

string

Enum:CompanyPerson

Customer category

conversationLanguage

string

Enum:NOSVFIDAENDENLFR

Language code

distributionType

string

Enum:PaperEmailSms

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

object (order)

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 <double>

Total net amount of order.

totalGrossAmount
required

number <double>

Total gross amount of order. Must match the grossUnitPrice * quantity of order items

currency

string

Enum:EURNOKSEKDKKCHF

Currency

risk

object (risk)

channelType

string

Enum:InternetCatalogCallCenterStationaryOther

Order channel type

deliveryType

string

Enum:NormalExpress

Order delivery type

ticketDeliveryMethod

string

Enum:NotSetPickUpEmailPostPhone

airline

object (airline)

passengers

array

Passengers

Array () [
id

integer <int32>

Continuous numbering.

firstName

string > 4096 Characters

First name.

lastName

string > 4096 Characters

Last name.

salutation

string

Enum:MrMrsMiss

Salutation

dateOfBirth

string <date>

Date birth of passenger.

]
itineraries

array

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.

dateOfTravel

string <date-time>

Departure date and time

price

number <double>

Price

currency

string

Enum:EURNOKSEKDKKCHF

Currency

]
insurance

object (insurance)

company

string > 4096 Characters

Name of insurance company

type

string

Enum:NotSetCancellationTravelCancellationTravelBankruptcy

price

number <double>

Price of insurance

currency

string

Enum:EURNOKSEKDKKCHF

Currency

bookingReference

string > 4096 Characters

Booking reference

bus

object (bus)

passengers

array

Passengers

Array () [
id

integer <int32>

Continuous numbering.

firstName

string > 4096 Characters

First name.

lastName

string > 4096 Characters

Last name.

salutation

string

Enum:MrMrsMiss

Salutation

dateOfBirth

string <date>

Date birth of passenger.

]
itineraries

array

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.

dateOfTravel

string <date-time>

Departure date and time

price

number <double>

Price

currency

string

Enum:EURNOKSEKDKKCHF

Currency

]
insurance

object (insurance)

company

string > 4096 Characters

Name of insurance company

type

string

Enum:NotSetCancellationTravelCancellationTravelBankruptcy

price

number <double>

Price of insurance

currency

string

Enum:EURNOKSEKDKKCHF

Currency

bookingReference

string > 4096 Characters

Booking reference

train

object (train)

passengers

array

Passengers

Array () [
id

integer <int32>

Continuous numbering.

firstName

string > 4096 Characters

First name.

lastName

string > 4096 Characters

Last name.

salutation

string

Enum:MrMrsMiss

Salutation

dateOfBirth

string <date>

Date birth of passenger.

]
itineraries

array

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.

dateOfTravel

string <date-time>

Departure date and time

price

number <double>

Price

currency

string

Enum:EURNOKSEKDKKCHF

Currency

]
insurance

object (insurance)

company

string > 4096 Characters

Name of insurance company

type

string

Enum:NotSetCancellationTravelCancellationTravelBankruptcy

price

number <double>

Price of insurance

currency

string

Enum:EURNOKSEKDKKCHF

Currency

bookingReference

string > 4096 Characters

Booking reference

ferry

object (ferry)

passengers

array

Passengers

Array () [
id

integer <int32>

Continuous numbering.

firstName

string > 4096 Characters

First name.

lastName

string > 4096 Characters

Last name.

salutation

string

Enum:MrMrsMiss

Salutation

dateOfBirth

string <date>

Date birth of passenger.

]
itineraries

array

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.

dateOfTravel

string <date-time>

Departure date and time

price

number <double>

Price

currency

string

Enum:EURNOKSEKDKKCHF

Currency

]
insurance

object (insurance)

company

string > 4096 Characters

Name of insurance company

type

string

Enum:NotSetCancellationTravelCancellationTravelBankruptcy

price

number <double>

Price of insurance

currency

string

Enum:EURNOKSEKDKKCHF

Currency

bookingReference

string > 4096 Characters

Booking reference

rental

object (rental)

company

string > 4096 Characters

Name of rental company

pickupLocation

object (pickupLocation)

Base class of Address fields

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

dropoffLocation

object (dropoffLocation)

Base class of Address fields

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

startDate

string <date-time>

Pick up date and time

endDate

string <date-time>

End date and time

drivers

array

Information about drivers who have rented a car

Array () [
identificationNumber

string > 20 Characters

National ID number (if the customer is a physical person). Registration number (if the customer is a company).

address

object (address)

Customer 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

object (riskData)

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

customerSince

string <date-time>

Since when customer has been merchant's client

customerClassification

string > 255 Characters

Customer reputation (e.g. VIP client)

acquisitionChannel

string

Enum:NotSetAdvertismentSocialNetworkDirectSearchEngineOther

Customer acquisition channel

hasCustomerCard

boolean

Shows if customer has loyalty card

customerCardSince

string <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

string > 39 Characters

Customer’s IP address

numberOfTransactions

integer <int32>

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 <double>

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:MrMrsMiss

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 <email> > 255 Characters

Email

phone

string > 20 Characters

Phone

mobilePhone

string > 20 Characters

Mobile phone

birthDate
required

string <date>

Date of birth. Not required if customerCategory is 'Company'.

customerCategory
required

string

Enum:CompanyPerson

Customer category

conversationLanguage

string

Enum:NOSVFIDAENDENLFR

Language code

distributionType

string

Enum:PaperEmailSms

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 <double>

Price of a rental car

currency

string

Enum:EURNOKSEKDKKCHF

Currency

bookingReference

string > 4096 Characters

Booking reference

hotel

object (hotel)

company

string > 4096 Characters

address

object (address)

Base class of Address fields

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 <date-time>

Check-in date and time

checkout

string <date-time>

Check-out date and time

guests

array

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

object (address)

Customer 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

object (riskData)

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

customerSince

string <date-time>

Since when customer has been merchant's client

customerClassification

string > 255 Characters

Customer reputation (e.g. VIP client)

acquisitionChannel

string

Enum:NotSetAdvertismentSocialNetworkDirectSearchEngineOther

Customer acquisition channel

hasCustomerCard

boolean

Shows if customer has loyalty card

customerCardSince

string <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

string > 39 Characters

Customer’s IP address

numberOfTransactions

integer <int32>

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 <double>

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:MrMrsMiss

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 <email> > 255 Characters

Email

phone

string > 20 Characters

Phone

mobilePhone

string > 20 Characters

Mobile phone

birthDate
required

string <date>

Date of birth. Not required if customerCategory is 'Company'.

customerCategory
required

string

Enum:CompanyPerson

Customer category

conversationLanguage

string

Enum:NOSVFIDAENDENLFR

Language code

distributionType

string

Enum:PaperEmailSms

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 <int32>

Number of rooms

price

number <double>

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.

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.

googleAnalyticsUserId

string > 50 Characters

User ID identifies a user that may interact with content using different browser instances and devices

googleAnalyticsClientId

string > 50 Characters

Client ID is the identifier used by Google Analytics to represent a browser instance or device

items

array

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.

type

string

Enum:PhysicalArticleDigitalArticleGiftCardDiscountShippingFeeSurchargeInfoSubscription

netUnitPrice
required

number <double>

Net unit price.

grossUnitPrice
required

number <double>

Gross price per item.

quantity
required

number <double>

Quantity. Use of integer is strongly proposed. If you want to use decimal, please contact your integration manager.

unitCode

string > 50 Characters

Unit code (for example pieces, liters, kilograms, etc.).

vatCategory

string

Enum:HighCategoryLowCategoryNullCategoryNoCategoryMiddleCategoryOtherCategory

Vat category

vatPercent
required

number <double>

Tax percent.

vatAmount
required

number <double>

Tax amount per item.

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.

googleProductCategoryId

integer <int32>

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 <int32>

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

undefined

Specification.

serviceStart

string <date-time>

Capture start time.

serviceEnd

string <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

object (additionalData)

Additional data

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

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 <date-time>

Registration date of the marketplace seller

rating

string > 20 Characters

Rating of the marketplace seller

transactions

integer <int32>

Number of transaction processed by the marketplace seller

]
subscription

object (subscription)

Subscription information

name

string > 50 Characters

Name / Description of the subscription

start

string <date-time>

Startdate of the subscription

end

string <date-time>

Enddate of the subscription

type

string

Enum:FixedPeriodAutoRenewal

Subscription type

partnerData

object (partnerData)

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

object (inStore)

inStore object

storeId

string > 16 Characters

Number of Store

address

object (address)

Base class of Address fields

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

Can be used by selling company if they would like to provide specific reference for purchasing company. This field is limited to 20 characters, longer values will be truncated to fit within the specified limit.

einvoiceInformation

object (einvoiceInformation)

e-invoice references information

reference

string

The customer's e-invoice reference

referenceType

string

Enum:GLNOrgNoPEPPOL

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 Key Account Manager for more details.

Responses

200 Success

RESPONSE SCHEMA:

outcome

string

Enum:AcceptedPendingRejected

Check risk outcome

customerNumber

string > 100 Characters

Customer number

customer

object (customer)

Customer response

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

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

object (deliveryCustomer)

Customer response

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

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 <uuid>

checkoutId

string <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 Account Manager to enable the feature.

expirationDate

string <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.

400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum:BusinessErrorTechnicalErrorNotificationMessage

code

string > 100 Characters

Confirmation or error code

message

string > 4096 Characters

Message content

customerFacingMessage

string > 4096 Characters

Message to display to customer

actionCode

string

Enum:UnavailableAskConsumerToConfirmAskConsumerToReEnterDataOfferSecurePaymentMethodsRequiresSsnAskConsumerToIdentify

Action codes

fieldReference

string > 100 Characters

Reference to field that caused an error

]
401 Authorization has been denied for this request.
429 Too many requests.
500 Internal server error.

Request Example

Please select an example:

{
  "payment": {
    "type": "Invoice"
  },
  "customer": {
    "identificationNumber": "800119-3989",
    "firstName": "Astrid",
    "lastName": "Svensson",
    "salutation": "Mrs",
    "email": "astrid.svensson@example.com",
    "birthDate": "1999-01-02",
    "mobilePhone": "12345678900",
    "customerCategory": "Person",
    "address": {
      "street": "Gütersloher Straße",
      "streetNumber": "123",
      "postalCode": "33415",
      "postalPlace": "Berlin",
      "countryCode": "DE"
    },
    "conversationLanguage": "EN"
  },
  "order": {
    "number": "riverty1",
    "totalGrossAmount": 185,
    "totalNetAmount": 155.41,
    "currency": "EUR",
    "items": [
      {
        "productId": "4534-BLK-M",
        "description": "Leather jacket, Black, size M",
        "grossUnitPrice": 100,
        "netUnitPrice": 84,
        "quantity": 1,
        "vatPercent": 19,
        "vatAmount": 16,
        "imageUrl": "https://developer-sandbox.riverty.com/images/black_leather_jacket.jpg"
      },
      {
        "productId": "5745-GRY-M",
        "description": "Socks, Grey, Size M",
        "grossUnitPrice": 10,
        "netUnitPrice": 8.4,
        "quantity": 5,
        "vatPercent": 19,
        "vatAmount": 1.6,
        "imageUrl": "https://developer-sandbox.riverty.com/images/grey_socks.jpg"
      },
      {
        "productId": "3323-BRN-M",
        "description": "Woolen hat, brown, Size M",
        "grossUnitPrice": 30,
        "netUnitPrice": 25.21,
        "quantity": 1,
        "vatPercent": 19,
        "vatAmount": 4.79,
        "imageUrl": "https://developer-sandbox.riverty.com/images/brown_wool_hat.jpg"
      },
      {
        "productId": "SHIP",
        "description": "Shipping",
        "type": "ShippingFee",
        "grossUnitPrice": 5,
        "netUnitPrice": 4.2,
        "quantity": 1,
        "vatPercent": 19,
        "vatAmount": 0.8
      }
    ]
  }
}

Response Example

{
  "outcome": "Accepted",
  "customerNumber": "AP000100888",
  "reservationId": "f0d7e939-6e43-4fe6-93e5-79b6aba984cf",
  "checkoutId": "e907c794-de5a-436e-9676-904ee0c55360",
  "expirationDate": "2023-10-22"
}