Hosted Checkout

More information can be found in our Documentation.

Path

POST /api/v3/hosted-checkout/request

Request Body

application/json

merchantUrl

string

URL to redirect the customer to after the payment process

webhookUrl

string

WebhookUrl used for callback when order has final state

array

Payment selection object used for request payment selection page

object

Authorize payment request. In case of One-Step Authorize, customer and order objects must be filled in addition to payment info. In case of Two-Step Authorize, only the checkoutId field must be filled.

checkoutId

string

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.

required

object

Payment information

type

required

string

Enum:

Invoice

Installment

Account

Consolidatedinvoice

PayinX

Payment method type

contractId

required in

string

Contract ID

object

Required for Fixed Installments payments in Germany, Austria and Switzerland

object

The information about recurring direct debit agreement

object

invoice

object

Consolidated invoice information

object

payinX

object

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

object

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

identificationNumber

required in

string

> 20 Characters

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

object

Customer address

legalForm

required in

string

> 255 Characters

Type of business. Required for Austria, Germany and Switzerland.

object

existingCustomer

boolean

Is customer an existing customer for merchant

verifiedCustomerIdentification

boolean

This field signifies whether the customer's identification has been successfully verified.

marketingOptIn

boolean

Shows if merchant is allowed to send marketing information to customer

customerSince

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Since when customer has been merchant's client

customerClassification

string

> 255 Characters

Customer reputation (e.g. VIP client)

acquisitionChannel

string

Enum:

NotSet

Advertisment

SocialNetwork

Direct

SearchEngine

Other

Customer acquisition channel

hasCustomerCard

boolean

Shows if customer has loyalty card

customerCardSince

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

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 value for identifying a profile tracking session

ipAddress

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

verifiedCustomerIdentificationType

string

> 255 Characters

Specific method or category used to authenticate or verify a customer's identity

verifiedCustomerIdentificationDate

string

yyyy-MM-dd

Date on which a customer's identification details have been successfully confirmed or authenticated dateformat: yyyy-MM-dd

customerNumber

string

> 100 Characters

Customer number has to be unique, if no customer number available please leave empty

salutation

string

Enum:

Mrs

Miss

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.

required in

string

> 255 Characters

phone

required in

string

> 20 Characters

Phone

mobilePhone

required in

string

> 20 Characters

Mobile phone

birthDate

required

string

yyyy-MM-dd

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

customerCategory

required

string

Enum:

Company

Person

Customer category

conversationLanguage

string

Enum:

The language code used for client communication. If not provided, the system will default to the language configured for the client.

distributionType

string

Enum:

Paper

Sms

How information (invoices, notices, etc.) will be distributed to customer.

vatId

required in

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.

object

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

object

Customer address

customerNumber

string

> 100 Characters

Customer number has to be unique, if no customer number available please leave empty

salutation

string

Enum:

Mrs

Miss

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.

required in

string

> 255 Characters

phone

required in

string

> 20 Characters

Phone

mobilePhone

required in

string

> 20 Characters

Mobile phone

birthDate

required

string

yyyy-MM-dd

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

customerCategory

required

string

Enum:

Company

Person

Customer category

conversationLanguage

string

Enum:

The language code used for client communication. If not provided, the system will default to the language configured for the client.

distributionType

string

Enum:

Paper

Sms

How information (invoices, notices, etc.) will be distributed to customer.

vatId

required in

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.

object

Order object

number

required

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

string

Enum:

EUR

NOK

SEK

DKK

CHF

Currency

object

channelType

string

Enum:

Internet

Catalog

CallCenter

Stationary

Other

Order channel type

deliveryType

string

Enum:

Normal

Express

Order delivery type

ticketDeliveryMethod

string

Enum:

NotSet

PickUp

Post

Phone

object

array

Passengers

array

Itineraries

object

bookingReference

string

> 4096 Characters

Booking reference

object

array

Passengers

array

Itineraries

object

bookingReference

string

> 4096 Characters

Booking reference

object

array

Passengers

array

Itineraries

object

bookingReference

string

> 4096 Characters

Booking reference

object

array

Passengers

array

Itineraries

object

bookingReference

string

> 4096 Characters

Booking reference

object

company

string

> 4096 Characters

Name of rental company

object

Base class of Address fields

object

Base class of Address fields

startDate

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Pick up date and time

endDate

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

End date and time

array

Information about drivers who have rented a car

identificationNumber

required in

string

> 20 Characters

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

object

Customer address

legalForm

required in

string

> 255 Characters

Type of business. Required for Austria, Germany and Switzerland.

object

existingCustomer

boolean

Is customer an existing customer for merchant

verifiedCustomerIdentification

boolean

This field signifies whether the customer's identification has been successfully verified.

marketingOptIn

boolean

Shows if merchant is allowed to send marketing information to customer

customerSince

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Since when customer has been merchant's client

customerClassification

string

> 255 Characters

Customer reputation (e.g. VIP client)

acquisitionChannel

string

Enum:

NotSet

Advertisment

SocialNetwork

Direct

SearchEngine

Other

Customer acquisition channel

hasCustomerCard

boolean

Shows if customer has loyalty card

customerCardSince

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

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 value for identifying a profile tracking session

ipAddress

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

verifiedCustomerIdentificationType

string

> 255 Characters

Specific method or category used to authenticate or verify a customer's identity

verifiedCustomerIdentificationDate

string

yyyy-MM-dd

Date on which a customer's identification details have been successfully confirmed or authenticated dateformat: yyyy-MM-dd

customerNumber

string

> 100 Characters

Customer number has to be unique, if no customer number available please leave empty

salutation

string

Enum:

Mrs

Miss

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.

required in

string

> 255 Characters

phone

required in

string

> 20 Characters

Phone

mobilePhone

required in

string

> 20 Characters

Mobile phone

birthDate

required

string

yyyy-MM-dd

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

customerCategory

required

string

Enum:

Company

Person

Customer category

conversationLanguage

string

Enum:

The language code used for client communication. If not provided, the system will default to the language configured for the client.

distributionType

string

Enum:

Paper

Sms

How information (invoices, notices, etc.) will be distributed to customer.

vatId

required in

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:

EUR

NOK

SEK

DKK

CHF

Currency

bookingReference

string

> 4096 Characters

Booking reference

object

company

string

> 4096 Characters

object

Base class of Address fields

checkin

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Check-in date and time

checkout

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Check-out date and time

array

Guests information

identificationNumber

required in

string

> 20 Characters

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

object

Customer address

legalForm

required in

string

> 255 Characters

Type of business. Required for Austria, Germany and Switzerland.

object

existingCustomer

boolean

Is customer an existing customer for merchant

verifiedCustomerIdentification

boolean

This field signifies whether the customer's identification has been successfully verified.

marketingOptIn

boolean

Shows if merchant is allowed to send marketing information to customer

customerSince

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Since when customer has been merchant's client

customerClassification

string

> 255 Characters

Customer reputation (e.g. VIP client)

acquisitionChannel

string

Enum:

NotSet

Advertisment

SocialNetwork

Direct

SearchEngine

Other

Customer acquisition channel

hasCustomerCard

boolean

Shows if customer has loyalty card

customerCardSince

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

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 value for identifying a profile tracking session

ipAddress

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

verifiedCustomerIdentificationType

string

> 255 Characters

Specific method or category used to authenticate or verify a customer's identity

verifiedCustomerIdentificationDate

string

yyyy-MM-dd

Date on which a customer's identification details have been successfully confirmed or authenticated dateformat: yyyy-MM-dd

customerNumber

string

> 100 Characters

Customer number has to be unique, if no customer number available please leave empty

salutation

string

Enum:

Mrs

Miss

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.

required in

string

> 255 Characters

phone

required in

string

> 20 Characters

Phone

mobilePhone

required in

string

> 20 Characters

Mobile phone

birthDate

required

string

yyyy-MM-dd

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

customerCategory

required

string

Enum:

Company

Person

Customer category

conversationLanguage

string

Enum:

The language code used for client communication. If not provided, the system will default to the language configured for the client.

distributionType

string

Enum:

Paper

Sms

How information (invoices, notices, etc.) will be distributed to customer.

vatId

required in

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:

EUR

NOK

SEK

DKK

CHF

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

array

Array of order items. Maximum allowed 200 items.

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:

PhysicalArticle

DigitalArticle

GiftCard

Discount

ShippingFee

Surcharge

Info

Subscription

netUnitPrice

required

number

Net unit price.

grossUnitPrice

required

number

Gross price per item.

quantity

required

number

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:

HighCategory

LowCategory

NullCategory

NoCategory

MiddleCategory

OtherCategory

Vat category

vatPercent

required

number

Tax percent.

vatAmount

required

number

Tax amount per item.

imageUrl

string

> 2048 Characters

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

N/A

Specification.

serviceStart

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Capture start time.

serviceEnd

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

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.

object

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

array

Additional information for marketplace set-ups

object

Subscription information

object

additionalPaymentInfo

string

> 250 Characters

Additional payment information

object

inStore object

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.

object

e-invoice references information

nonce

string

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

object

Responses

Successful Request, Invoice

Successful Request, Direct Debit

Unsuccessful Call, Validation Error

Request Example

    
        {
 "merchantUrl": "https://example.com",
 "authorizeRequest": {
  "payment": {
   "type": "Invoice"
  },
  "customer": {
   "firstName": "Astrid",
   "lastName": "Svensson",
   "email": "astrid.svensson@example.com",
   "customerCategory": "Person",
   "address": {
    "street": "Gütersloher Straße",
    "streetNumber": "123",
    "postalCode": "33415",
    "postalPlace": "Berlin",
    "countryCode": "DE"
   },
   "conversationLanguage": "DE"
  },
  "order": {
   "number": "RIVERTY01",
   "totalNetAmount": 250,
   "totalGrossAmount": 300,
   "items": [
    {
     "productId": "0001",
     "groupId": "0011",
     "description": "item 1 description",
     "netUnitPrice": 10,
     "grossUnitPrice": 12,
     "quantity": 5,
     "vatPercent": 20,
     "vatAmount": 2
    },
    {
     "productId": "0002",
     "groupId": "0022",
     "description": "item 2 description",
     "netUnitPrice": 100,
     "grossUnitPrice": 120,
     "quantity": 2,
     "vatPercent": 20,
     "vatAmount": 20
    }
   ]
  }
 }
}

Response Example

    
        {
 "redirectUrl": "https://hosted-checkout.bnpl.riverty.io/pay/nl/098?token=123"
}

Request Example

    
        {
 "merchantUrl": "https://example.com",
 "authorizeRequest": {
  "payment": {
   "type": "Invoice",
   "directDebit": {
    "available": true
   }
  },
  "customer": {
   "firstName": "Astrid",
   "lastName": "Svensson",
   "email": "astrid.svensson@example.com",
   "customerCategory": "Person",
   "address": {
    "street": "Gütersloher Straße",
    "streetNumber": "123",
    "postalCode": "33415",
    "postalPlace": "Berlin",
    "countryCode": "DE"
   },
   "conversationLanguage": "DE"
  },
  "order": {
   "number": "RIVERTY01",
   "totalNetAmount": 250,
   "totalGrossAmount": 300,
   "items": [
    {
     "productId": "0001",
     "groupId": "0011",
     "description": "item 1 description",
     "netUnitPrice": 10,
     "grossUnitPrice": 12,
     "quantity": 5,
     "vatPercent": 20,
     "vatAmount": 2
    },
    {
     "productId": "0002",
     "groupId": "0022",
     "description": "item 2 description",
     "netUnitPrice": 100,
     "grossUnitPrice": 120,
     "quantity": 2,
     "vatPercent": 20,
     "vatAmount": 20
    }
   ]
  }
 }
}

Response Example

    
        {
 "redirectUrl": "https://hosted-checkout.bnpl.riverty.io/pay/nl/098?token=123"
}

Request Example

    
        {
 "merchantUrl": "https://example.com",
 "authorizeRequest": {
  "payment": {
   "type": "Invoice"
  },
  "customer": {
   "firstName": "Astrid",
   "lastName": "Svensson",
   "email": "astrid.svensson@example.com",
   "customerCategory": "Person",
   "address": {
    "street": "Gütersloher Straße",
    "streetNumber": "123",
    "postalCode": "33415",
    "postalPlace": "Berlin",
    "countryCode": "DE"
   },
   "conversationLanguage": "DE"
  },
  "order": {
   "number": "",
   "totalNetAmount": 250,
   "totalGrossAmount": 300,
   "items": [
    {
     "productId": "0001",
     "groupId": "0011",
     "description": "item 1 description",
     "netUnitPrice": 10,
     "grossUnitPrice": 12,
     "quantity": 5,
     "vatPercent": 20,
     "vatAmount": 2
    },
    {
     "productId": "0002",
     "groupId": "0022",
     "description": "item 2 description",
     "netUnitPrice": 100,
     "grossUnitPrice": 120,
     "quantity": 2,
     "vatPercent": 20,
     "vatAmount": 20
    }
   ]
  }
 }
}

Response Example

    
        [
 {
  "type": "BusinessError",
  "code": "400.002",
  "message": "Value is required.",
  "customerFacingMessage": "Value is required.",
  "actionCode": "Unavailable",
  "fieldReference": "order.number"
 }
]