Void Authorization

Void (cancel) an authorization that has not been captured.

More information can be found in our Documentation.

Path

POST /api/v3/orders/{orderNumber}/voids

Request Parameters

orderNumber

required

string

Order number

Request Body

application/json

required

object

Order details

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

Max length: 4096

Booking reference

object

array

Passengers

array

Itineraries

object

bookingReference

string

Max length: 4096

Booking reference

object

array

Passengers

array

Itineraries

object

bookingReference

string

Max length: 4096

Booking reference

object

array

Passengers

array

Itineraries

object

bookingReference

string

Max length: 4096

Booking reference

object

company

string

Max length: 4096

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

Max length: 20

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

birthDate

required

string

yyyy-MM-dd

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

object

Customer address

legalForm

required in

string

Max length: 255

Type of business. This field is mandatory for processing B2B transactions in 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

Max length: 255

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

Max length: 50

Unique value for identifying a profile tracking session

ipAddress

string

Max length: 39

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

Max length: 4096

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

Max length: 255

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

Max length: 100

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

salutation

string

Enum:

Mrs

Miss

Salutation

firstName

string

Max length: 50

First name. Everything over 50 characters will be truncated

lastName

string

Max length: 50

Last name. Everything over 50 characters will be truncated

companyName

string

Max length: 255

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

Max length: 255

phone

required in

string

Max length: 16

Customer’s fixed-line phone number. The number will be normalised by us, removing non-numeric characters and converting it to international format. The resulting number can contain up to 16 characters, including the country code.

mobilePhone

required in

string

Max length: 16

Customer’s mobile phone number. The number will be normalised by us, removing non-numeric characters and converting it to international format. The resulting number can contain up to 16 characters, including the country code.

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

Max length: 50

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

Max length: 4096

Booking reference

object

company

string

Max length: 4096

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

Max length: 20

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

birthDate

required

string

yyyy-MM-dd

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

object

Customer address

legalForm

required in

string

Max length: 255

Type of business. This field is mandatory for processing B2B transactions in 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

Max length: 255

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

Max length: 50

Unique value for identifying a profile tracking session

ipAddress

string

Max length: 39

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

Max length: 4096

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

Max length: 255

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

Max length: 100

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

salutation

string

Enum:

Mrs

Miss

Salutation

firstName

string

Max length: 50

First name. Everything over 50 characters will be truncated

lastName

string

Max length: 50

Last name. Everything over 50 characters will be truncated

companyName

string

Max length: 255

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

Max length: 255

phone

required in

string

Max length: 16

mobilePhone

required in

string

Max length: 16

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

Max length: 50

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

Max length: 4096

Booking reference

merchantImageUrl

string

Max length: 2048

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.

array

Array of order items. Maximum allowed 500 items.

productId

required

string

Max length: 100

Merchant Product identification number.

groupId

string

Max length: 255

Item group ID. The group this item belongs to. Provided by the merchant. Everything over 255 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

Max length: 50

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

Max length: 2048

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

Google product category ID.

googleProductCategory

string

Max length: 255

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

Max length: 255

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

Max length: 2048

URL to the product.

marketPlaceSellerId

string

Max length: 32

ID of an individual seller on a marketplace. If this field is used, an entry in the element additionalData -> marketplace must also be provided.

parentTransactionReference

string

Max length: 128

A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.

additionalInformation

string

Max length: 4096

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

Max length: 50

Product User

costCenter

string

Max length: 50

Used for B2B to specify the costCenter e.g. Marketing or Sales Department - Displayed on the invoice.

parentTransactionReference

string

Max length: 128

A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.

merchantId

string

Max length: 50

Optional field. Used only in specific setups where merchant-specific profiles are required. Most integrations do not need this field.

Responses

Successful Request, Full Void

Successful Request, Partial Void

Unsuccessful Request, Order Already Captured

Request Example

    
        null

Response Example

    
        {
 "totalCapturedAmount": 0,
 "totalRefundedAmount": 0,
 "totalAuthorizedAmount": 185,
 "remainingAuthorizedAmount": 0
}

Request Example

    
        {
 "cancellationDetails": {
  "items": [
   {
    "imageUrl": "https://developer-sandbox.riverty.com/images/grey_socks.jpg",
    "quantity": 5,
    "productId": "5745-GRY-M",
    "vatAmount": 1.6,
    "vatPercent": 19,
    "description": "Socks, Grey, Size M",
    "netUnitPrice": 8.4,
    "grossUnitPrice": 10
   }
  ],
  "totalNetAmount": 42,
  "totalGrossAmount": 50
 }
}

Response Example

    
        {
 "TotalCapturedAmount": 0,
 "totalRefundedAmount": 0,
 "TotalAuthorizedAmount": 185,
 "remainingAuthorizedAmount": 135
}

Request Example

    
        null

Response Example

    
        [
 {
  "code": "400.129",
  "type": "BusinessError",
  "message": "Cannot cancel the order, because it is partially or fully captured.",
  "actionCode": "Unavailable",
  "fieldReference": "",
  "customerFacingMessage": "Cannot cancel the order, because it is partially or fully captured."
 }
]