Riverty Logo

Voided authorizations

Voided authorizations

PATH:

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

PATH PARAMETERS:

orderNumber
required

string

Order number

voidNumber
required

string

Void number

RESPONSES:

200 OK

RESPONSE SCHEMA:

cancellations

array of cancellations

Array of the Cancellations objects

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.

type

string

Enum:PhysicalArticleDigitalArticleGiftCardDiscountShippingFeeSurchargeInfo

Order item type.

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

VAT category.

vatPercent
required

number

Tax percent.

vatAmount
required

number

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.

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.

]
400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum:BusinessErrorTechnicalErrorNotificationMessage

Message type

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

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error

]
401 Authorization has been denied for this request.
500 Internal server error.

Path

get

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

Response samples

200400
  • {
    • "cancellations":[...
      • {
        • "cancellationNo": "string",
        • "cancellationAmount": 1.00,
        • "cancellationItems":[...
          • {
            • "cancellationNumber": "string",
            • "productId": "string",
            • "groupId": "string",
            • "description": "string",
            • "type": "string",
            • "netUnitPrice": 1.00,
            • "grossUnitPrice": 1.00,
            • "quantity": 1.00,
            • "unitCode": "string",
            • "vatCategory": "string",
            • "vatPercent": 1.00,
            • "vatAmount": 1.00,
            • "imageUrl": "string",
            • "googleProductCategoryId": 1,
            • "googleProductCategory": "string",
            • "merchantProductType": "string",
            • "lineNumber": 1,
            • "productUrl": "string",
            • "marketPlaceSellerId": "string",
            • "parentTransactionReference": "string",
            • "additionalInformation": "string",
            • "specification": X,
            • "serviceStart": "string",
            • "serviceEnd": "string"
            }
          ],
        • "parentTransactionReference": "string"
        }
      ]
    }
  • {
    • "type": "string",
    • "code": "string",
    • "message": "string",
    • "customerFacingMessage": "string",
    • "actionCode": "string",
    • "fieldReference": "string"
    }
Riverty 2022